MSL-IO API Documentation

The following functions are available to read a file

read(file, **kwargs)	Read a file that has a Reader implemented.
read_table(file, **kwargs)	Read data in a table format from a file.
ExcelReader(file, **kwargs)	Read an Excel spreadsheet (.xls and .xlsx).
GSheetsReader(file, **kwargs)	Read a Google Sheets spreadsheet.

the following classes are available as Writers

HDF5Writer([file])	Create a HDF5 writer.
JSONWriter([file])	Create a JSON writer.

and general helper functions

checksum(file[, algorithm, chunk_size, ...])	Get the checksum of a file.
copy(source, destination[, overwrite, ...])	Copy a file.
git_head(directory)	Get information about the HEAD of a repository.
is_admin()	Check if the current process is being run as an administrator.
is_dir_accessible(path[, strict])	Check if a directory exists and is accessible.
is_file_readable(file[, strict])	Check if a file exists and is readable.
remove_write_permissions(path)	Remove all write permissions of a file.
run_as_admin([args, executable, cwd, ...])	Run a process as an administrator and return its output.
search(folder[, pattern, levels, ...])	Search for files starting from a root folder.
send_email(config, recipients[, sender, ...])	Send an email.

Package Structure

• msl.io
  • read()
  • read_table()
  • version_info
• msl.io.base
  • Reader
    • Reader.can_read()
    • Reader.get_bytes()
    • Reader.get_extension()
    • Reader.get_lines()
    • Reader.read()
  • Root
    • Root.file
    • Root.tree()
  • Writer
    • Writer.save()
    • Writer.set_root()
    • Writer.update_context_kwargs()
    • Writer.write()
• msl.io.constants
  • HOME_DIR
  • IS_PYTHON2
  • IS_PYTHON3
• msl.io.dataset
  • Dataset
    • Dataset.copy()
    • Dataset.data
    • Dataset.read_only
• msl.io.dataset_logging
  • DatasetLogging
    • DatasetLogging.attributes
    • DatasetLogging.date_fmt
    • DatasetLogging.logger
    • DatasetLogging.remove_empty_rows()
    • DatasetLogging.remove_handler()
    • DatasetLogging.set_logger()
• msl.io.dictionary
  • Dictionary
    • Dictionary.clear()
    • Dictionary.items()
    • Dictionary.keys()
    • Dictionary.read_only
    • Dictionary.values()
• msl.io.google_api
  • GDrive
    • GDrive.MIME_TYPE_FOLDER
    • GDrive.ROOT_NAMES
    • GDrive.copy()
    • GDrive.create_folder()
    • GDrive.delete()
    • GDrive.download()
    • GDrive.empty_trash()
    • GDrive.file_id()
    • GDrive.folder_id()
    • GDrive.is_file()
    • GDrive.is_folder()
    • GDrive.is_read_only()
    • GDrive.move()
    • GDrive.path()
    • GDrive.read_only()
    • GDrive.rename()
    • GDrive.shared_drives()
    • GDrive.upload()
  • GMail
    • GMail.profile()
    • GMail.send()
  • GSheets
    • GSheets.MIME_TYPE
    • GSheets.SERIAL_NUMBER_ORIGIN
    • GSheets.add_sheets()
    • GSheets.append()
    • GSheets.cells()
    • GSheets.copy()
    • GSheets.create()
    • GSheets.delete_sheets()
    • GSheets.rename_sheet()
    • GSheets.sheet_id()
    • GSheets.sheet_names()
    • GSheets.to_datetime()
    • GSheets.values()
    • GSheets.write()
  • GoogleAPI
    • GoogleAPI.close()
    • GoogleAPI.service
  • GValueOption
    • GValueOption.FORMATTED
    • GValueOption.FORMULA
    • GValueOption.UNFORMATTED
  • GDateTimeOption
    • GDateTimeOption.FORMATTED_STRING
    • GDateTimeOption.SERIAL_NUMBER
  • GCellType
    • GCellType.BOOLEAN
    • GCellType.CURRENCY
    • GCellType.DATE
    • GCellType.DATE_TIME
    • GCellType.EMPTY
    • GCellType.ERROR
    • GCellType.NUMBER
    • GCellType.PERCENT
    • GCellType.SCIENTIFIC
    • GCellType.STRING
    • GCellType.TIME
    • GCellType.UNKNOWN
  • GCell
    • GCell.value
    • GCell.type
    • GCell.formatted
• msl.io.group
  • Group
    • Group.add_dataset()
    • Group.add_dataset_logging()
    • Group.add_group()
    • Group.ancestors()
    • Group.create_dataset()
    • Group.create_dataset_logging()
    • Group.create_group()
    • Group.datasets()
    • Group.descendants()
    • Group.groups()
    • Group.is_dataset()
    • Group.is_dataset_logging()
    • Group.is_group()
    • Group.remove()
    • Group.require_dataset()
    • Group.require_dataset_logging()
    • Group.require_group()
• msl.io.metadata
  • Metadata
    • Metadata.copy()
    • Metadata.fromkeys()
• msl.io.tables
  • extension_delimiter_map
  • read_table_excel()
  • read_table_gsheets()
  • read_table_text()
• msl.io.utils
  • checksum()
  • copy()
  • get_basename()
  • git_head()
  • is_admin()
  • is_dir_accessible()
  • is_file_readable()
  • register()
  • remove_write_permissions()
  • run_as_admin()
  • search()
  • send_email()
• msl.io.vertex
  • Vertex
    • Vertex.add_metadata()
    • Vertex.metadata
    • Vertex.name
    • Vertex.parent
    • Vertex.read_only
• msl.io.readers
  • Submodules
    • msl.io.readers.detector_responsivity_system module
      • DRSReader
        • DRSReader.can_read()
        • DRSReader.read()
    • msl.io.readers.excel module
      • ExcelReader
        • ExcelReader.close()
        • ExcelReader.read()
        • ExcelReader.sheet_names()
        • ExcelReader.workbook
    • msl.io.readers.gsheets module
      • GSheetsReader
        • GSheetsReader.read()
        • GSheetsReader.sheet_names()
    • msl.io.readers.hdf5 module
      • HDF5Reader
        • HDF5Reader.can_read()
        • HDF5Reader.read()
    • msl.io.readers.json_ module
      • JSONReader
        • JSONReader.can_read()
        • JSONReader.read()
    • msl.io.readers.spreadsheet module
      • Spreadsheet
        • Spreadsheet.file
        • Spreadsheet.read()
        • Spreadsheet.sheet_names()
        • Spreadsheet.to_indices()
        • Spreadsheet.to_letters()
        • Spreadsheet.to_slices()
• msl.io.writers
  • Submodules
    • msl.io.writers.hdf5 module
      • HDF5Writer
        • HDF5Writer.write()
    • msl.io.writers.json_ module
      • JSONWriter
        • JSONWriter.write()