nannyml.io.base module

class nannyml.io.base.Reader

Bases: ABC

Base class for reading data

read() → DataFrame

class nannyml.io.base.Writer

Bases: ABC

Base class for writing Result instances to an external medium such as disk, database or API.

write(result: Result, **kwargs) → Any

class nannyml.io.base.WriterFactory

Bases: object

A factory class that produces Writer instances for a given key.

The value for this key is passed along explicitly by the user, either by providing it directly during Writer initialization or passed along in the nann.yml configuration file.

classmethod create(key, kwargs: Optional[Dict[str, Any]] = None) → Writer

Returns a Writer instance for a given string.

classmethod register(key) → Callable

registry: Dict[str, Type[Writer]] = {'database': <class 'nannyml.io.db.database_writer.DatabaseWriter'>, 'pickle': <class 'nannyml.io.pickle_file_writer.PickleFileWriter'>, 'raw_files': <class 'nannyml.io.raw_files_writer.RawFilesWriter'>}

nannyml.io.base.get_filepath_str(path: str, protocol: str) → str