qwikstart.parser package

Submodules

qwikstart.parser.operations module

class qwikstart.parser.operations.OperationDefinition(name, config)

Bases: tuple

config

Alias for field number 1

name

Alias for field number 0

parsed_config

Return operation configuration parsed from raw config input.

Any configuration that is not a reserved word will be added to the local_context passed to the operation initializer.

qwikstart.parser.operations.parse_operation(op_def: Union[str, Dict[str, Dict[str, Any]], Tuple[str, Dict[str, Any]]], known_operations: Optional[Dict[str, Type[qwikstart.operations.base.BaseOperation[qwikstart.base_context.BaseContext, Optional[Mapping[str, Any]]]]]] = None) → qwikstart.operations.base.BaseOperation[qwikstart.base_context.BaseContext, Optional[Mapping[str, Any]]]

qwikstart.parser.tasks module

class qwikstart.parser.tasks.TaskSpec

Bases: dict

qwikstart.parser.tasks.normalize_context(task_spec: qwikstart.parser.tasks.TaskSpec, source_path: Optional[pathlib.Path] = None) → None

qwikstart.parser.tasks.normalize_operations_list(operations_list: Union[List[Union[str, Dict[str, Dict[str, Any]], Tuple[str, Dict[str, Any]]]], Dict[str, Union[str, Dict[str, Dict[str, Any]], Tuple[str, Dict[str, Any]]]]]) → List[Dict[str, Any]]

qwikstart.parser.tasks.parse_task(task_spec: qwikstart.parser.tasks.TaskSpec, source_path: Optional[pathlib.Path] = None) → qwikstart.tasks.Task

Return task parsed from a task specification dictionary.

Module contents

qwikstart.parser.OperationMapping

alias of typing.Dict

class qwikstart.parser.TaskSpec

Bases: dict

qwikstart.parser.get_operations_mapping() → Dict[str, Type[qwikstart.operations.base.BaseOperation[qwikstart.base_context.BaseContext, Optional[Mapping[str, Any]]]]]

Return mapping of known operation names to their respective operation classes.

qwikstart.parser.parse_task(task_spec: qwikstart.parser.tasks.TaskSpec, source_path: Optional[pathlib.Path] = None) → qwikstart.tasks.Task

Return task parsed from a task specification dictionary.