Cli Dataflow¶

class dffml.cli.dataflow.CreateConfig(operations: List[str], configloader: dffml.configloader.configloader.BaseConfigLoader = <class 'dffml.configloader.json.JSONConfigLoader'>, not_linked: bool = False, inputs: List[str] = <factory>, flow: List[str] = <factory>, config: List[str] = <factory>)[source]¶

no_enforce_immutable()¶

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.cli.dataflow.DiagramConfig(dataflow: str, configloader: dffml.configloader.configloader.BaseConfigLoader = None, stages: List[str] = <factory>, simple: bool = False, display: str = 'TD')[source]¶

no_enforce_immutable()¶

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.cli.dataflow.MergeConfig(dataflows: List[pathlib.Path], configloader: dffml.configloader.configloader.BaseConfigLoader = <class 'dffml.configloader.json.JSONConfigLoader'>, not_linked: bool = False)[source]¶

no_enforce_immutable()¶

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.cli.dataflow.Run(extra_config=None, **kwargs)[source]¶

Run dataflow

records¶

alias of RunRecords

class dffml.cli.dataflow.RunAllRecords(*args, **kwargs)[source]¶

Run dataflow for all records in sources

CONFIG¶

alias of RunAllRecordsConfig

async records(sctx)[source]¶

This method exists so that it can be overriden by RunRecordSet

class dffml.cli.dataflow.RunAllRecordsConfig(dataflow: str, configloader: dffml.configloader.configloader.BaseConfigLoader = None, sources: dffml.source.source.Sources = <factory>, caching: List[str] = <factory>, no_update: bool = False, no_echo: bool = False, no_strict: bool = False, orchestrator: dffml.df.base.BaseOrchestrator = <class 'dffml.df.memory.MemoryOrchestrator'>, inputs: List[str] = <factory>, record_def: str = False)[source]¶

no_enforce_immutable()¶

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.cli.dataflow.RunCMDConfig(dataflow: str, configloader: dffml.configloader.configloader.BaseConfigLoader = None, sources: dffml.source.source.Sources = <factory>, caching: List[str] = <factory>, no_update: bool = False, no_echo: bool = False, no_strict: bool = False, orchestrator: dffml.df.base.BaseOrchestrator = <class 'dffml.df.memory.MemoryOrchestrator'>, inputs: List[str] = <factory>, record_def: str = False)[source]¶

no_enforce_immutable()¶

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.cli.dataflow.RunContextsConfig(dataflow: str, no_echo: bool = False, configloader: dffml.configloader.configloader.BaseConfigLoader = None, orchestrator: dffml.df.base.BaseOrchestrator = <class 'dffml.df.memory.MemoryOrchestrator'>, inputs: List[str] = <factory>, no_strict: bool = False, context_def: str = False, contexts: List[str] = <factory>)[source]¶

no_enforce_immutable()¶

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.cli.dataflow.RunRecordSet(*args, **kwargs)[source]¶

Run dataflow for single record or set of records

CONFIG¶

alias of RunRecordSetConfig

async records(sctx)[source]¶

This method exists so that it can be overriden by RunRecordSet

class dffml.cli.dataflow.RunRecordSetConfig(keys: List[str], dataflow: str, configloader: dffml.configloader.configloader.BaseConfigLoader = None, sources: dffml.source.source.Sources = <factory>, caching: List[str] = <factory>, no_update: bool = False, no_echo: bool = False, no_strict: bool = False, orchestrator: dffml.df.base.BaseOrchestrator = <class 'dffml.df.memory.MemoryOrchestrator'>, inputs: List[str] = <factory>, record_def: str = False)[source]¶

no_enforce_immutable()¶

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1

class dffml.cli.dataflow.RunRecords(extra_config=None, **kwargs)[source]¶

Run DataFlow and assign output to a record

class dffml.cli.dataflow.RunSingleConfig(dataflow: str, no_echo: bool = False, configloader: dffml.configloader.configloader.BaseConfigLoader = None, orchestrator: dffml.df.base.BaseOrchestrator = <class 'dffml.df.memory.MemoryOrchestrator'>, inputs: List[str] = <factory>, no_strict: bool = False)[source]¶

no_enforce_immutable()¶

By default, all properties of a config object are immutable. If you would like to mutate immutable properties, you must explicitly call this method using it as a context manager.

Examples

>>> from dffml import config
>>>
>>> @config
... class MyConfig:
...     C: int
>>>
>>> config = MyConfig(C=2)
>>> with config.no_enforce_immutable():
...     config.C = 1