| | |
- collections.UserDict(collections.abc.MutableMapping)
-
- FlatDirectoryCache(collections.UserDict, collections.abc.MutableMapping, typing.Generic)
- collections.abc.MutableMapping(collections.abc.Mapping)
-
- FlatDirectoryCache(collections.UserDict, collections.abc.MutableMapping, typing.Generic)
- typing.Generic(builtins.object)
-
- FlatDirectoryCache(collections.UserDict, collections.abc.MutableMapping, typing.Generic)
class FlatDirectoryCache(collections.UserDict, collections.abc.MutableMapping, typing.Generic) |
| |
FlatDirectoryCache(root: pathlib.Path, initialdata: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, archive_encoding: str = 'tar.gz', data_encoding: str = 'json', arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7f47ec48ebd0>, **load_kwargs) -> None
A class implementing a dictionary that can be saved and loaded from disk,
with a specified encoding scheme.
|
| |
- Method resolution order:
- FlatDirectoryCache
- collections.UserDict
- collections.abc.MutableMapping
- collections.abc.Mapping
- collections.abc.Collection
- collections.abc.Sized
- collections.abc.Iterable
- collections.abc.Container
- typing.Generic
- builtins.object
Methods defined here:
- __init__(self, root: pathlib.Path, initialdata: Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]] = None, archive_encoding: str = 'tar.gz', data_encoding: str = 'json', arbiter: vcorelib.io.arbiter.DataArbiter = <vcorelib.io.arbiter.DataArbiter object at 0x7f47ec48ebd0>, **load_kwargs) -> None
- Initialize this data cache.
- clean(self, path: pathlib.Path = None, logger: logging.Logger = None, level: int = 10) -> None
- Remove cached data from disk.
- load(self, path: pathlib.Path = None, logger: logging.Logger = None, level: int = 10, **kwargs) -> Dict[str, Union[str, int, float, bool, NoneType, Dict[str, Union[str, int, float, bool, NoneType]], List[Union[str, int, float, bool, NoneType]]]]
- Load data from disk.
- load_directory(self, path: 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]]]], **kwargs) -> int
- Load a directory and update data, return time taken to load.
- save(self, path: pathlib.Path = None, logger: logging.Logger = None, level: int = 10, archive: bool = False, **kwargs) -> None
- Save data to disk.
- save_directory(self, path: pathlib.Path, **kwargs) -> int
- Write data in this cache to a directory.
Data and other attributes defined here:
- __abstractmethods__ = frozenset()
- __orig_bases__ = (<class 'collections.UserDict'>, typing.MutableMapping[str, typing.Union[str, int...[typing.Union[str, int, float, bool, NoneType]]]])
- __parameters__ = ()
Methods inherited from collections.UserDict:
- __contains__(self, key)
- # Modify __contains__ and get() to work like dict
# does when __missing__ is present.
- __copy__(self)
- __delitem__(self, key)
- __getitem__(self, key)
- __ior__(self, other)
- __iter__(self)
- __len__(self)
- __or__(self, other)
- Return self|value.
- __repr__(self)
- Return repr(self).
- __ror__(self, other)
- Return value|self.
- __setitem__(self, key, item)
- copy(self)
- get(self, key, default=None)
- D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
Class methods inherited from collections.UserDict:
- fromkeys(iterable, value=None) from abc.ABCMeta
Data descriptors inherited from collections.UserDict:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
Methods inherited from collections.abc.MutableMapping:
- clear(self)
- D.clear() -> None. Remove all items from D.
- pop(self, key, default=<object object at 0x7f47ec9901c0>)
- D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
If key is not found, d is returned if given, otherwise KeyError is raised.
- popitem(self)
- D.popitem() -> (k, v), remove and return some (key, value) pair
as a 2-tuple; but raise KeyError if D is empty.
- setdefault(self, key, default=None)
- D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
- update(self, other=(), /, **kwds)
- D.update([E, ]**F) -> None. Update D from mapping/iterable E and F.
If E present and has a .keys() method, does: for k in E: D[k] = E[k]
If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v
In either case, this is followed by: for k, v in F.items(): D[k] = v
Methods inherited from collections.abc.Mapping:
- __eq__(self, other)
- Return self==value.
- items(self)
- D.items() -> a set-like object providing a view on D's items
- keys(self)
- D.keys() -> a set-like object providing a view on D's keys
- values(self)
- D.values() -> an object providing a view on D's values
Data and other attributes inherited from collections.abc.Mapping:
- __hash__ = None
- __reversed__ = None
Class methods inherited from collections.abc.Collection:
- __subclasshook__(C) from abc.ABCMeta
- Abstract classes can override this to customize issubclass().
This is invoked early on by abc.ABCMeta.__subclasscheck__().
It should return True, False or NotImplemented. If it returns
NotImplemented, the normal algorithm is used. Otherwise, it
overrides the normal algorithm (and the outcome is cached).
Class methods inherited from collections.abc.Iterable:
- __class_getitem__ = GenericAlias(...) from abc.ABCMeta
- Represent a PEP 585 generic type
E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
Class methods inherited from typing.Generic:
- __init_subclass__(...) from abc.ABCMeta
- Function to initialize subclasses.
| |