aac.plugins.gen_plugin

__init__.py module for the Gen Plugin plugin.

Functions

register_plugin()	Returns information about the plugin.
run_gen_plugin(aac_plugin_file, code_output, ...)	Generate code and stubs for an AaC plugin.
run_gen_project(aac_project_file, output, ...)	Generate code and stubs for an AaC project.

aac.plugins.gen_plugin.register_plugin() → None

Returns information about the plugin.

Returns:

A collection of information about the plugin and what it contributes.

Return type:

None

aac.plugins.gen_plugin.run_gen_plugin(aac_plugin_file: str, code_output: str, test_output: str, doc_output: str, no_prompt: bool, force_overwrite: bool, evaluate: bool) → ExecutionResult

Generate code and stubs for an AaC plugin. Overwrites will backup existing files.

Parameters:

• aac_plugin_file (str)

• code_output (str)

• test_output (str)

• doc_output (str)

• no_prompt (bool)

• force_overwrite (bool)

• evaluate (bool)

Return type:

ExecutionResult

aac.plugins.gen_plugin.run_gen_project(aac_project_file: str, output: str, no_prompt: bool, force_overwrite: bool, evaluate: bool) → ExecutionResult

Generate code and stubs for an AaC project. Overwrites will backup existing files.

Parameters:

• aac_project_file (str)

• output (str)

• no_prompt (bool)

• force_overwrite (bool)

• evaluate (bool)

Return type:

ExecutionResult

Modules

gen_plugin_impl

AaC Plugin implementation module for the Version plugin.