qwikstart.operations package

Submodules

qwikstart.operations.add_file module

class qwikstart.operations.add_file.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation to add a file to a project.

name = 'add_file'

run(context: qwikstart.operations.add_file.Context) → None

Override with action

qwikstart.operations.add_file_tree module

class qwikstart.operations.add_file_tree.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation to add a file tree (a.k.a. directory) to a project.

name = 'add_file_tree'

run(context: qwikstart.operations.add_file_tree.Context) → None

Override with action

qwikstart.operations.append_text module

class qwikstart.operations.append_text.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation for appending text to a given file.

get_text(context: qwikstart.operations.append_text.Context) → str

name = 'append_text'

run(context: qwikstart.operations.append_text.Context) → None

Override with action

qwikstart.operations.base module

class qwikstart.operations.base.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 = None

default_opconfig = {}

execute(global_context: Mapping[str, Any]) → Dict[str, Any]

classmethod get_context_class() → TContext

classmethod get_output_class() → TOutput

post_run(output: TOutput) → Mapping[str, Any]

pre_run(context_dict: Mapping[str, Any]) → TContext

run(context: TContext) → TOutput

Override with action

qwikstart.operations.base.GenericOperation

alias of qwikstart.operations.base.BaseOperation

class qwikstart.operations.base.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) → TOperationConfig

classmethod from_config_dicts(*opconfig_dicts) → TOperationConfig

Return OperationConfig from multiple opconfig dictionaries.

Note that values in the later dictionaries take precendence over earlier ones.

qwikstart.operations.define_context module

class qwikstart.operations.define_context.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation to context variables to the operation context.

default_opconfig = {'display_description': False}

name = 'define_context'

run(context: qwikstart.operations.define_context.Context) → Dict[str, Any]

Override with action

qwikstart.operations.echo module

class qwikstart.operations.echo.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation to echo a message to the console.

default_opconfig = {'display_description': False}

name = 'echo'

run(context: qwikstart.operations.echo.Context) → None

Override with action

qwikstart.operations.edit_json module

class qwikstart.operations.edit_json.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation edit json by merging data into existing json data.

name = 'edit_json'

run(context: qwikstart.operations.edit_json.Context) → None

Override with action

qwikstart.operations.edit_yaml module

class qwikstart.operations.edit_yaml.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation edit yaml by merging data into existing yaml data.

name = 'edit_yaml'

run(context: qwikstart.operations.edit_yaml.Context) → None

Override with action

qwikstart.operations.find_files module

class qwikstart.operations.find_files.Context(execution_context:qwikstart.base_context.ExecutionContext, regex:str='', directory:str='.', output_name:str='matching_files', path_filter:Union[str, NoneType]=None, regex_flags:List[str]=<factory>)

Bases: qwikstart.base_context.BaseContext

directory = '.'

classmethod help(field_name: str) → Optional[str]

output_name = 'matching_files'

path_filter = None

regex = ''

class qwikstart.operations.find_files.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation for searching for text within files and returning file paths.

name = 'find_files'

run(context: qwikstart.operations.find_files.Context) → Dict[str, List[str]]

Override with action

qwikstart.operations.find_tag_and_insert_text module

class qwikstart.operations.find_tag_and_insert_text.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation to find a tag and insert text below that tag.

This is a simple combination of the find_tagged_line and insert_text operations.

get_text(context: qwikstart.operations.find_tag_and_insert_text.Context, column: int) → str

name = 'find_tag_and_insert_text'

run(context: qwikstart.operations.find_tag_and_insert_text.Context) → None

Override with action

qwikstart.operations.find_tagged_line module

class qwikstart.operations.find_tagged_line.Context(execution_context:qwikstart.base_context.ExecutionContext, file_path:pathlib.Path, tag:str)

Bases: qwikstart.base_context.BaseContext

classmethod help(field_name: str) → Optional[str]

class qwikstart.operations.find_tagged_line.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation inserting text on a given line

name = 'find_tagged_line'

run(context: qwikstart.operations.find_tagged_line.Context) → qwikstart.operations.find_tagged_line.Output

Override with action

class qwikstart.operations.find_tagged_line.Output

Bases: dict

qwikstart.operations.insert_text module

class qwikstart.operations.insert_text.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation inserting text on a given line

get_text(context: qwikstart.operations.insert_text.Context) → str

name = 'insert_text'

run(context: qwikstart.operations.insert_text.Context) → None

Override with action

qwikstart.operations.prompt module

class qwikstart.operations.prompt.Operation(**kwargs)

Bases: qwikstart.operations.base.BaseOperation

Operation to prompt user for input values.

The input values will be added to a dictionary in the context with a name matching output_dict_name.

aliases = ['prompt_user']

default_opconfig = {'display_description': False, 'output_namespace': 'template_variables'}

name = 'prompt'

run(context: qwikstart.operations.prompt.Context) → Dict[str, Any]

Override with action

qwikstart.operations.search_and_replace module

class qwikstart.operations.search_and_replace.Context(execution_context:qwikstart.base_context.ExecutionContext, file_path:pathlib.Path, search:str, replace:str, use_regex:bool=False)

Bases: qwikstart.base_context.BaseContext

classmethod help(field_name: str) → Optional[str]

use_regex = False

class qwikstart.operations.search_and_replace.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation for searching for text and replacing it with new text.

name = 'search_and_replace'

run(context: qwikstart.operations.search_and_replace.Context) → None

Override with action

qwikstart.operations.shell module

class qwikstart.operations.shell.Operation(local_context: Optional[Mapping[str, Any]] = None, opconfig: Optional[Dict[str, Any]] = None, description: str = '')

Bases: qwikstart.operations.base.BaseOperation

Operation to run an arbitrary shell command.

name = 'shell'

run(context: qwikstart.operations.shell.Context) → Dict[str, Any]

Override with action

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 = None

default_opconfig = {}

execute(global_context: Mapping[str, Any]) → Dict[str, Any]

classmethod get_context_class() → TContext

classmethod get_output_class() → TOutput

post_run(output: TOutput) → Mapping[str, Any]

pre_run(context_dict: Mapping[str, Any]) → TContext

run(context: TContext) → TOutput

Override with action

qwikstart.operations.GenericOperation

alias of qwikstart.operations.base.BaseOperation

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) → TOperationConfig

classmethod from_config_dicts(*opconfig_dicts) → TOperationConfig

Return OperationConfig from multiple opconfig dictionaries.

Note that values in the later dictionaries take precendence over earlier ones.