solidipes.loaders.cached_metadata module

class solidipes.loaders.cached_metadata.CachedMetadata(**kwargs)

Bases: DataContainer

classmethod _cancel_scheduled_commit() → None

Cancel scheduled commit.

classmethod _commit() → None

Update cached metadata database.

_get_default_cached_attributes() → set

Build the list of cached fields from the class description.

classmethod _get_zodb_file_storage(path: str) → FileStorage

_global_cached_metadata = None

classmethod _init_cached_metadata(initial_path='.') → None

classmethod _populate_cached_metadata_from_yaml(initial_path='.') → None

Populate cached metadata from YAML file.

classmethod _schedule_commit() → None

Schedule later update of metadata database.

_scheduled_commit = None

_scheduler = <sched.scheduler object>

_storage = None

_transaction_manager = <transaction._manager.TransactionManager object>

classmethod _write_cached_metadata_to_yaml(initial_path='.') → None

Write cached metadata to YAML file.

class cached_loadable(func)

Bases: loadable

Decorator class to indicate that a loadable must be cached.

foo(obj, *args, **kwargs)

foo_setter(obj, value, *args, **kwargs) → None

class cached_property(fget=None, fset=None, fdel=None, doc=None)

Bases: property

Decorator class to indicate that a property must be cached.

classmethod clear_cache(exclude=[]) → None

clear_cached_metadata(fields=[]) → None

classmethod close_cached_metadata() → None

disable_validator(name: str) → None

Disable a specific validator.

enable_validator(name: str) → None

Enable a specific validator.

static force_unlock() → None

get_cached_metadata()

static get_global_cached_metadata() → OOBTree

property global_cached_metadata: OOBTree

static is_cache_database_locked() → bool

is_cache_invalid()

load_cached_metadata()

Load cached metadata and put in _data_collection (as attributes).

property modified_time: NoReturn

save_field_to_cache(key) → None

set_cached_metadata_entry(key, value) → None

update_cached_metadata() → None

Update cached metadata with instance’s fields listed in cached_attributes.

classmethod update_global_cached_metadata(unique_identifier=None) → None

Update cached metadata dictionary.

property validator_enabled

Dictionary of validator names and enabled status.

solidipes.loaders.cached_metadata._default_cached_attributes = {}

List of @cached_property and @cached_loadable in the class

class solidipes.loaders.cached_metadata.cached_loadable(func)

Bases: loadable

Decorator class to indicate that a loadable must be cached.

foo(obj, *args, **kwargs)

foo_setter(obj, value, *args, **kwargs) → None

class solidipes.loaders.cached_metadata.cached_property(fget=None, fset=None, fdel=None, doc=None)

Bases: property

Decorator class to indicate that a property must be cached.