qwikstart.operations package¶
Submodules¶
- qwikstart.operations.add_file module
- qwikstart.operations.add_file_tree module
- qwikstart.operations.append_text module
- qwikstart.operations.base module
- qwikstart.operations.context_from_regex module
- qwikstart.operations.define_context module
- qwikstart.operations.echo module
- qwikstart.operations.edit_json module
- qwikstart.operations.edit_yaml module
- qwikstart.operations.find_files module
- qwikstart.operations.find_tag_and_insert_text module
- qwikstart.operations.find_tagged_line module
- qwikstart.operations.insert_text module
- qwikstart.operations.prompt module
- qwikstart.operations.search_and_replace module
- qwikstart.operations.shell module
- qwikstart.operations.subtask module
- qwikstart.operations.utils module
Module contents¶
-
class
qwikstart.operations.
BaseOperation
(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')¶ Bases:
typing.Generic
An operation within a qwikstart
Task
-
aliases
: Optional[List[str]] = None¶
-
default_opconfig
: Dict[str, Any] = {}¶
-
execute
(global_context: Mapping[str, Any]) → Dict[str, Any]¶
-
classmethod
get_context_class
() → TContext¶
-
classmethod
get_output_class
() → TOutput¶
-
name
: str = None¶
-
post_run
(output: TOutput) → Mapping[str, Any]¶
-
pre_run
(context_dict: Mapping[str, Any]) → TContext¶
-
abstract
run
(context: TContext) → TOutput¶ Override with action
-
-
qwikstart.operations.
GenericOperation
¶
-
class
qwikstart.operations.
OperationConfig
(input_mapping:Mapping[str, str], output_mapping:Mapping[str, str], input_namespace:Union[str, NoneType], output_namespace:Union[str, NoneType], display_description:bool)¶ Bases:
object
-
classmethod
create
(**kwargs: Any) → TOperationConfig¶
-
display_description
: Union[bool] = None¶
-
classmethod
from_config_dicts
(*opconfig_dicts: Dict[str, Any]) → TOperationConfig¶ Return OperationConfig from multiple opconfig dictionaries.
Note that values in the later dictionaries take precendence over earlier ones.
-
input_mapping
: Union[ContextMapping] = None¶
-
input_namespace
: Union[str, None] = None¶
-
output_mapping
: Union[ContextMapping] = None¶
-
output_namespace
: Union[str, None] = None¶
-
classmethod