Capability Run Pipeline

class ds_capability.components.abstract_common_component.AbstractCommonComponent(property_manager: Any, intent_model: Any, default_save: bool | None = None, reset_templates: bool | None = None, template_path: str | None = None, template_module: str | None = None, template_source_handler: str | None = None, template_persist_handler: str | None = None, align_connectors: bool | None = None)

An abstract common component class that contains the methods shared across all capabilities. This allows all capability instances to share common behavior in initialization, connectivity management, reporting and running the component.

run_component_pipeline(intent_levels: [<class 'str'>, <class 'int'>, <class 'list'>] = None, run_book: str = None, seed: int = None, reset_changed: bool = None, has_changed: bool = None, **kwargs)

runs the synthetic component pipeline. By passing an int value as the canonical will generate a synthetic file of that size

Parameters:

  • intent_levels – (optional) a single or list of intent levels to run

  • run_book – (optional) a saved runbook to run

  • seed – (optional) a seed value for this run

  • reset_changed – (optional) resets the has_changed boolean to True

  • has_changed – (optional) tests if the underline canonical has changed since last load else error returned

  • kwargs – any additional kwargs

class ds_capability.components.controller.Controller(property_manager: ControllerPropertyManager, intent_model: ControllerIntentModel, default_save=None, reset_templates: bool | None = None, template_path: str | None = None, template_module: str | None = None, template_source_handler: str | None = None, template_persist_handler: str | None = None, align_connectors: bool | None = None)

Controller Class is a special capability that controls a pipeline flow. It still inherits core AbstractComponent but not child AbstractCommonComponent that the other capabilities inherit from.

run_controller(run_book: [<class 'str'>, <class 'list'>, <class 'dict'>] = None, repeat: int = None, sleep: int = None, run_time: int = None, source_check_uri: str = None, run_cycle_report: str = None)

Runs the components pipeline based on the runbook instructions. The run_book is a pre-registered Controller run_book names to execute. If no run book is given, default values are substituted, finally taking the intent list if all else fails.

The run_cycle_report automatically generates the connector contract with the name ‘run_cycle_report’. To reload the report for observation use the controller method ‘load_canonical(…) passing the name ‘run_cycle_report’.

Parameters:

  • run_book – (optional) a run_book reference, a list of task names (intent levels)

  • repeat – (optional) the number of times this intent should be repeated. None or -1 -> never, 0 -> forever

  • sleep – (optional) number of seconds to sleep before repeating

  • run_time – (optional) number of seconds to run the controller using repeat and sleep cycles time is up

  • source_check_uri – (optional) The source uri to check for change since last controller instance cycle

  • run_cycle_report – (optional) a full name for the run cycle report