The cleanmymac.registry
Module¶
The module holds an internal registry of targets loaded from the cleanmymac.builtins
module and
from the globally registered ones at cleanmymac.constants.TARGET_ENTRY_POINT
.
-
cleanmymac.registry.
get_target
(name)[source]¶ get a registered target
Parameters: name (str) – the target name Returns: the target Return type: cleanmymac.target.Target
-
cleanmymac.registry.
iter_targets
()[source]¶ generator over all registered targets
Returns: pairs of (name: target)
-
cleanmymac.registry.
load_target
(yaml_file, config, update=False, verbose=False, strict=True)[source]¶ load a target given its description from a YAML file. The file is validated according to its type before loading.
Parameters: Returns: the target
Return type:
-
cleanmymac.registry.
register_target
(name, target)[source]¶ register a target type to a given target name
Parameters: - name (str) – the target name (case sensitive)
- target (
cleanmymac.target.Target
) – the target to register