neuralib.persistence.persistence.GzipHandler

class neuralib.persistence.persistence.GzipHandler[source]

Bases: PersistenceHandler[T]

Support field type: all python objects.

__init__(data_cls, save_root, ext='.pkl.gz', compression=9)[source]
Parameters:

  • data_cls (type[T])

  • save_root (Path)

  • ext (str)

  • compression (int)

filepath(result, **kwargs)

build filepath for persistence instance.

Parameters:

  • result (T | None) – persistence instance

  • kwargs – overwrite field value in result.

Returns:

file path of result

Raises:

RuntimeError – result’s autoinc field not resolved, or errors from filename()

Return type:

Path

load_all(result, **kwargs)

load all persistent result under save_root. missing is used to make a field becomes a wildcard field.

>>> template = Example(use_animal='A00', use_session='test', use_date='20200101')
>>> # find all animal A00's persistent result.
>>> found = PickleHandler(Example, Path('.')).load_all(template, use_date=missing)
Parameters:

result (T | None)

Return type:

Iterator[tuple[Path, T]]

load_persistence(path)

Load data as data_cls from path without validation.

Parameters:

path (Path | T | dict[str, Any]) – load from path.

Returns:

persistence instance

Raises:

IsADirectoryError –

Return type:

T

property persistence_info: PersistentClass[T]

information for persistence class

save_persistence(result, path=None)

save persistence result under path.

Parameters:

  • result (T)

  • path (str | Path | None) – save path.

Returns:

result. autoinc field will be resolved after saving.

Raises:

AutoIncFieldNotResolvedError –

Return type:

T

validate(ref, res)
Parameters:

  • ref (T)

  • res (T)

Return type:

bool

property persistence_class: type[T]
Returns:

type T

property save_root: Path

saving directory

filename(result, **kwargs)[source]

build filename for persistence instance.

Parameters:

  • result (T | None) – persistence instance

  • kwargs – overwrite field value in result.

Returns:

file name of result, may contains ‘{}’ if result’s autoinc field not resolved

Return type:

str