Source code for docarray.array.mixins.io.common

from typing import Union, TextIO, BinaryIO, TYPE_CHECKING, Type

if TYPE_CHECKING:
    from ....typing import T


[docs]class CommonIOMixin: """The common IO helper function for arrays."""
[docs] def save( self, file: Union[str, TextIO, BinaryIO], file_format: str = 'binary', encoding: str = 'utf-8', ) -> None: """Save array elements into a JSON, a binary file or a CSV file. :param file: File or filename to which the data is saved. :param file_format: `json` or `binary` or `csv`. JSON and CSV files are human-readable, but binary format gives much smaller size and faster save/load speed. Note that, CSV file has very limited compatability, complex DocumentArray with nested structure can not be restored from a CSV file. :param encoding: encoding used to save data into a file (it only applies to `JSON` and `CSV` format). By default, ``utf-8`` is used. """ if file_format == 'json': self.save_json(file, encoding=encoding) elif file_format == 'binary': self.save_binary(file) elif file_format == 'csv': self.save_csv(file, encoding=encoding) else: raise ValueError('`format` must be one of [`json`, `binary`, `csv`]')
[docs] @classmethod def load( cls: Type['T'], file: Union[str, TextIO, BinaryIO], file_format: str = 'binary', encoding: str = 'utf-8', **kwargs ) -> 'T': """Load array elements from a JSON or a binary file, or a CSV file. :param file: File or filename to which the data is saved. :param file_format: `json` or `binary` or `csv`. JSON and CSV files are human-readable, but binary format gives much smaller size and faster save/load speed. CSV file has very limited compatability, complex DocumentArray with nested structure can not be restored from a CSV file. :param encoding: encoding used to load data from a file (it only applies to `JSON` and `CSV` format). By default, ``utf-8`` is used. :return: the loaded DocumentArray object """ if file_format == 'json': return cls.load_json(file, encoding=encoding, **kwargs) elif file_format == 'binary': return cls.load_binary(file) elif file_format == 'csv': return cls.load_csv(file, encoding=encoding) else: raise ValueError('`format` must be one of [`json`, `binary`, `csv`]')