sleap.io.format.adaptor

File format adaptor base class.

class sleap.io.format.adaptor.Adaptor

File format adaptor base class.

An adaptor handles reading and/or writing a specific file format. To add support for a new file format, you’ll create a new class which inherits from the Adaptor base class and implements the relevant functions.

property all_exts: List[str]

List of all file extensions supported by adaptor.

can_read_file(file: FileHandle) → bool

Returns whether this adaptor can read this file.

can_write_filename(filename: str) → bool

Returns whether this adaptor can write format of this filename.

property default_ext: str

The default file extension, e.g., ‘json’ (without ‘.’).

does_match_ext(filename: str) → bool

Returns whether this adaptor can write format of this filename.

does_read() → bool

Returns whether this adaptor supports reading.

does_write() → bool

Returns whether this adaptor supports writing.

property formatted_ext_options

String for Qt file dialog extension options.

property handles: SleapObjectType

Returns the type of object that can be read/written.

The Dispatch class calls this method on all registered adaptors to determine which to use for reading/writing.

property name: str

Human-reading name of the file format

read(file: FileHandle) → object

Reads the file and returns the appropriate deserialized object.

write(filename: str, source_object: object)

Writes the object to a file.

class sleap.io.format.adaptor.SleapObjectType(value)

Types of files that an adaptor could read/write.