aac.plugins.generate.generate_impl

AaC Plugin implementation module for the Version plugin.

Functions

backup_file(file_path)

Backs up a file by appending .aac_backup to the file name.

clean(aac_file, code_output, test_output, ...)

Clean up generated code, tests, and docs.

generate(aac_file, generator_file, ...)

Generate content from your AaC architecture.

generate_content(evaluate, force_overwrite, ...)

Generates file content for use by the jinja template.

generate_data_from_source(evaluate, ...)

Extracts data from a generator source and uses it to generate content.

get_callable(package_name, file_name, ...)

Returns a callable function from a package, file, and function name.

get_output_directories(message, ...)

Returns the output directories for code, tests, and docs.

get_output_file_path(root_output_directory, ...)

Returns the output file path for a generator template.

load_template(template_abs_path[, ...])

Load a jinja2 template from a file.

output_to_jinja_template(evaluate, ...)

Outputs generation data to a jinja2 template file.

process_parser_error(pe)

Process the message(s) from ParserError in a way which accounts for one or two entries.
aac.plugins.generate.generate_impl.backup_file(file_path: str) → str[source]

Backs up a file by appending .aac_backup to the file name.

Parameters:

file_path (str) – The file being backed up.

Returns:

The file path to the backup file.

Return type:

str

Exceptions:

IOError: Exception raised when the file path cannot be parsed. Exception: Generic exception raised when an unexpected error is encountered.

aac.plugins.generate.generate_impl.clean(aac_file: str, code_output: str, test_output: str, doc_output: str, no_prompt: bool) → ExecutionResult[source]

Clean up generated code, tests, and docs.

Parameters:

  • aac_file (str) – Content used for generating the target files.

  • code_out_dir (str) – Output path for target code files.

  • test_out_dir (str) – Output path for target test files.

  • doc_out_dir (str) – Output path for target doc files.

  • no_prompt (bool) – Command argument. If true, executes with no prompt. Primarily used for testing or by other plugins.

  • code_output (str)

  • test_output (str)

  • doc_output (str)

Returns:

The result of executing the clean command.

Return type:

ExecutionResult

aac.plugins.generate.generate_impl.generate(aac_file: str, generator_file: str, code_output: str, test_output: str, doc_output: str, no_prompt: bool, force_overwrite: bool, evaluate: bool) → ExecutionResult[source]

Generate content from your AaC architecture.

Parameters:

  • aac_file (str) – Content to be used for generation.

  • generator_file (str) – AaC generator file.

  • code_out_dir (str) – Output path for generated code files.

  • test_out_dir (str) – Output path for generated test files.

  • doc_out_dir (str) – Output path for generated doc files.

  • no_prompt (bool) – Command argument. If true, generates files with no prompt. Primarily used for testing or by other plugins.

  • force_overwrite (bool) – Command argument. If true, forces generate to overwrite any already existing files.

  • evaluate (bool) – Command argument. If true, generate only writes evaluation files with no impact to existing files.

  • code_output (str)

  • test_output (str)

  • doc_output (str)

Returns:

The result of executing the generate command.

Return type:

ExecutionResult

Raises:

OperationCancelled – When the operation is canceled by the user.

aac.plugins.generate.generate_impl.generate_content(evaluate: bool, force_overwrite: bool, source: Any, template: Any, jinja_template: Template, code_out_dir: str, test_out_dir: str, doc_out_dir: str, source_data_def: Definition)[source]

Generates file content for use by the jinja template.

Parameters:

  • evaluate (bool) – Command argument from the generate command. If true, generate only writes evaluation files with no impact to existing files.

  • force_overwrite (bool) – Command argument from the generate command. If true, forces generate to overwrite any already existing files.

  • source (Any) – An instance of the source generator file definition.

  • template (Any) – An instance of the generator template definition.

  • jinja_template (Template) – Jinja2 template file.

  • code_out_dir (str) – Output path for generated code files.

  • test_out_dir (str) – Output path for generated test files.

  • doc_out_dir (str) – Output path for generated doc files.

  • source_data_def (Definition) – The definition of the source aac data.

Raises:

ExecutionError – When the content of the data source file is invalid.

aac.plugins.generate.generate_impl.generate_data_from_source(evaluate: bool, force_overwrite: bool, source: Any, parsed_definitions: list[Definition], code_out_dir: str, test_out_dir: str, doc_out_dir: str, generator_file: str)[source]

Extracts data from a generator source and uses it to generate content.

Parameters:

  • evaluate (bool) – Command argument from the generate command. If true, generate only writes evaluation files with no impact to existing files.

  • force_overwrite (bool) – Command argument from the generate command. If true, forces generate to overwrite any already existing files.

  • source (Any) – An instance of the source generator file definition.

  • parsed_definitions (list[Definition]) – List of parsed definitions to be used in file generation.

  • code_out_dir (str) – Output path for generated code files.

  • test_out_dir (str) – Output path for generated test files.

  • doc_out_dir (str) – Output path for generated doc files.

  • generator_file (str) – AaC generator file.

aac.plugins.generate.generate_impl.get_callable(package_name: str, file_name: str, function_name: str) → Callable[source]

Returns a callable function from a package, file, and function name.

Parameters:

  • package_name (str) – Package name where the function resides.

  • file_name (str) – File name where the function resides.

  • function_name (str) – Name of the Function.

Returns:

Callable form of the function.

Return type:

Callable

aac.plugins.generate.generate_impl.get_output_directories(message: str, aac_plugin_file: str, code_output: str, test_output: str, doc_output: str, no_prompt: bool) → tuple[str, str, str][source]

Returns the output directories for code, tests, and docs.

Parameters:

  • message (str) – Output message.

  • aac_plugin_file (str) – Content to be used for generation.

  • code_output (str) – Output path for generated code files.

  • test_output (str) – Output path for generated test files.

  • doc_output (str) – Output path for generated doc files.

  • no_prompt (bool) – Command argument. If true, generates files with no prompt. Primarily used for testing or by other plugins.

Returns:

A tuple containing the three output paths.

Return type:

tuple[str, str, str]

Raises:
aac.plugins.generate.generate_impl.get_output_file_path(root_output_directory: str, generator_template, source_package: str, source_name: str) → str[source]

Returns the output file path for a generator template.

Parameters:

  • root_output_directory (str) – Root directory of the output path.

  • generator_template – Template for the aac generator file.

  • source_package (str) – Package containing the definition source.

  • source_name (str) – Name of the definition.

Returns:

Output file path for a generator template.

Return type:

str

aac.plugins.generate.generate_impl.load_template(template_abs_path: str, helper_functions: dict[str, Callable] = {}) → Template[source]

Load a jinja2 template from a file.

Parameters:

  • template_abs_path (str) – Absolute Path of the Jinja2 Template.

  • helper_functions (dict[str, Callable]) – Helper Functions for the template.

Returns:

Jinja2 Template object.

Return type:

template (Template)

aac.plugins.generate.generate_impl.output_to_jinja_template(evaluate: bool, force_overwrite: bool, source: Any, template: Any, jinja_template: Template, code_out_dir: str, test_out_dir: str, doc_out_dir: str, source_data_structure: dict, source_data_def: Definition)[source]

Outputs generation data to a jinja2 template file.

Parameters:

  • evaluate (bool) – Command argument from the generate command. If true, generate only writes evaluation files with no impact to existing files.

  • force_overwrite (bool) – Command argument from the generate command. If true, forces generate to overwrite any already existing files.

  • source (Any) – An instance of the source generator file definition.

  • template (Any) – An instance of the generator template definition.

  • jinja_template (Template) – Jinja2 template file.

  • code_out_dir (str) – Output path for generated code files.

  • test_out_dir (str) – Output path for generated test files.

  • doc_out_dir (str) – Output path for generated doc files.

  • source_data_structure (dict) – A dictionary containing the source data structure.

  • source_data_def (Definition) – The definition of the source aac data.

aac.plugins.generate.generate_impl.process_parser_error(pe: ParserError) → str[source]

Process the message(s) from ParserError in a way which accounts for one or two entries.

Parameters:

pe (ParserError) – The ParserError instance to have messages extracted.

Returns:

The result constructed error_message string.

Return type:

str