pycnfg.Producer

class pycnfg.Producer(objects, oid, path_id='path__default', logger_id='logger__default')[source]

Bases: object

Execute configuration steps.

Interface: run, dump_cache, load_cache, dict_api.

Parameters

  • objects (dict) – Dictionary with resulted objects from previous executed producers: {‘section_id__config__id’, object}.

  • oid (str) – Unique identifier of produced object.

  • path_id (str, optional (default='path_default')) – Unique identifier of project path in objects. If not exist, raise error if used by producer.

  • logger_id (str, optional (default='logger_default')) – Unique identifier of logger either in objects or logging.root.manager.loggerDict . If not found, attach new logger to stdout (with logger_id name and ‘info’ level).

objects

Dictionary with resulted objects from previous executed producers: {‘section_id__config__id’, object,}

Type

dict

oid

Unique identifier of produced object.

Type

str

logger

Logger.

Type

logger object

project_path

Absolute path to project dir.

Type

None

Methods

dict_api(obj[, method])

Forwarding api for dictionary object.

dump_cache(obj[, prefix, cachedir, pkg])

Dump intermediate object state to IO.

load_cache(obj[, prefix, cachedir, pkg])

Load intermediate object state from IO.

run(init, steps)

Execute configuration steps.

update(obj, items)

Update key(s) for dictionary object.
__init__(objects, oid, path_id='path__default', logger_id='logger__default')[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(objects, oid[, path_id, logger_id])

Initialize self.

dict_api(obj[, method])

Forwarding api for dictionary object.

dump_cache(obj[, prefix, cachedir, pkg])

Dump intermediate object state to IO.

load_cache(obj[, prefix, cachedir, pkg])

Load intermediate object state from IO.

run(init, steps)

Execute configuration steps.

update(obj, items)

Update key(s) for dictionary object.
dict_api(obj, method='update', **kwargs)[source]

Forwarding api for dictionary object.

Could be useful to add/pop keys via configuration steps. For example to proceed update: (‘dict_api’, {‘b’:7} )

dump_cache(obj, prefix=None, cachedir=None, pkg='pickle', **kwargs)[source]

Dump intermediate object state to IO.

Parameters

  • obj (picklable) – Object to dump.

  • prefix (str, optional (default=None)) – File identifier, added to filename. If None, ‘self.oid’ is used.

  • cachedir (str, optional(default=None)) – Absolute path to dump dir or relative to ‘project_path’ started with ‘./’. Created, if not exists. If None, “sproject_path/ .temp/objects” is used.

  • pkg (str, optional (default='pickle')) – Import package and try pkg.dump(obj, file, **kwargs).

  • **kwargs (kwargs) – Additional parameters to pass in .dump().

Returns

obj – Unchanged input for compliance with producer logic.

Return type

picklable

load_cache(obj, prefix=None, cachedir=None, pkg='pickle', **kwargs)[source]

Load intermediate object state from IO.

Parameters

  • obj (picklable) – Object template, for producer logic only (ignored).

  • prefix (str, optional (default=None)) – File identifier. If None, ‘self.oid’ is used.

  • pkg (str, optional default('pickle')) – Import package and try obj = pkg.load(file, **kwargs).

  • cachedir (str, optional(default=None)) – Absolute path to load dir or relative to ‘project_path’ started with ‘./’. If None, ‘project_path/.temp/objects’ is used.

  • **kwargs (kwargs) – Additional parameters to pass in .load().

Returns

obj – Loaded cache.

Return type

picklable object

run(init, steps)[source]

Execute configuration steps.

Consecutive call (with decorators):

init = getattr(self, 'method_id')(init, objects=objects, **kwargs)

Parameters

  • init (object) – Will be passed as arg in each step and get back as result.

  • steps (list of tuples) – List of self methods to run consecutive with kwargs: (‘method_id’, kwargs, decorators ).

Returns

configs – List of configurations, prepared for execution: [(‘section_id__config__id’, config), …].

Return type

list of tuple

Notes

Object identifier oid auto added, if produced object has oid attribute.

update(obj, items)[source]

Update key(s) for dictionary object.

Parameters

  • obj (dict) – Object to update.

  • items (dict, list, optional (default=None)) – Either dictionary or items [(key,val),] to update obj.

Returns

obj – Updated input.

Return type

dict