vcorelib.io.arbiter.base
index
/home/vkottler/src/vkottler/workspace/vcorelib/vcorelib/io/arbiter/base.py

A module exposing data-file encoders and decoders.

 
Modules
       
logging

 
Classes
       
builtins.object
DataArbiterBase

 
class DataArbiterBase(builtins.object)
    DataArbiterBase(logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = <Logger vcorelib.io.arbiter.base (WARNING)>, encoding: str = 'utf-8') -> None
 
A class for looking up encode and decode functions for given data types.
 
  Methods defined here:
__init__(self, logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = <Logger vcorelib.io.arbiter.base (WARNING)>, encoding: str = 'utf-8') -> None
Initialize a new data arbiter.
decode(self, pathlike: Union[pathlib.Path, str, NoneType], logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = None, require_success: bool = False, includes_key: str = None, preprocessor: Callable[[Union[TextIO, _io.StringIO]], Union[TextIO, _io.StringIO]] = None, maxsplit: int = 1, expect_overwrite: bool = False, strategy: vcorelib.dict.MergeStrategy = <MergeStrategy.RECURSIVE: 1>, files_loaded: List[pathlib.Path] = None, **kwargs) -> vcorelib.io.types.LoadResult
Attempt to load data from a file.
decode_stream(self, ext: str, stream: Union[TextIO, _io.StringIO], logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = None, **kwargs) -> vcorelib.io.types.LoadResult
Attempt to load data from a text stream.
encode(self, pathlike: Union[pathlib.Path, str, NoneType], data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]], logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = None, maxsplit: int = 1, **kwargs) -> Tuple[bool, int]
Encode data to a file on disk.
encode_stream(self, ext: str, stream: Union[TextIO, _io.StringIO], data: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]], logger: Union[logging.Logger, logging.LoggerAdapter[Any]] = None, **kwargs) -> Tuple[bool, int]
Serialize data to an output stream.

Data descriptors defined here:
__dict__
dictionary for instance variables
__weakref__
list of weak references to the object

 
Data
        List = typing.List
LoggerType = typing.Union[logging.Logger, logging.LoggerAdapter[typing.Any]]