aac.plugins.aac_primitives

__init__.py module for the AaC primitive constraints plugin.

Functions

register_plugin()

Returns information about the plugin.

run_check_bool(value, type_declaration, ...)

Verify that a boolen value is True, False, or None.

run_check_dataref(value, type_declaration, ...)

Verify that a data reference value is interpretable and exists.

run_check_date(value, type_declaration, ...)

Verify that a date value is interpretable as a date.

run_check_directory(value, type_declaration, ...)

Verify that a directory value is interpretable as a directory.

run_check_file(value, type_declaration, ...)

Verify that a file value is interpretable as a file.

run_check_int(value, type_declaration, ...)

Verify that an integer value is interpretable as an integer.

run_check_number(value, type_declaration, ...)

Verify that a number value is interpretable as a number.

run_check_string(value, type_declaration, ...)

Verify that a string value is interpretable as a string.

run_check_typeref(value, type_declaration, ...)

Verify that a type reference value is interpretable and exists.
aac.plugins.aac_primitives.register_plugin() → None[source]

Returns information about the plugin.

Returns:

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

Return type:

None

aac.plugins.aac_primitives.run_check_bool(value: str, type_declaration: str, arguments: Any, source: AaCFile, location: SourceLocation) → ExecutionResult[source]

Verify that a boolen value is True, False, or None. None is considered False by python, so we allow None as a valid value.

Parameters:
Return type:

ExecutionResult

aac.plugins.aac_primitives.run_check_dataref(value: str, type_declaration: str, arguments: Any, source: AaCFile, location: SourceLocation) → ExecutionResult[source]

Verify that a data reference value is interpretable and exists.

Parameters:
Return type:

ExecutionResult

aac.plugins.aac_primitives.run_check_date(value: str, type_declaration: str, arguments: Any, source: AaCFile, location: SourceLocation) → ExecutionResult[source]

Verify that a date value is interpretable as a date.

Parameters:
Return type:

ExecutionResult

aac.plugins.aac_primitives.run_check_directory(value: str, type_declaration: str, arguments: Any, source: AaCFile, location: SourceLocation) → ExecutionResult[source]

Verify that a directory value is interpretable as a directory.

Parameters:
Return type:

ExecutionResult

aac.plugins.aac_primitives.run_check_file(value: str, type_declaration: str, arguments: Any, source: AaCFile, location: SourceLocation) → ExecutionResult[source]

Verify that a file value is interpretable as a file.

Parameters:
Return type:

ExecutionResult

aac.plugins.aac_primitives.run_check_int(value: str, type_declaration: str, arguments: Any, source: AaCFile, location: SourceLocation) → ExecutionResult[source]

Verify that an integer value is interpretable as an integer.

Parameters:
Return type:

ExecutionResult

aac.plugins.aac_primitives.run_check_number(value: str, type_declaration: str, arguments: Any, source: AaCFile, location: SourceLocation) → ExecutionResult[source]

Verify that a number value is interpretable as a number.

Parameters:
Return type:

ExecutionResult

aac.plugins.aac_primitives.run_check_string(value: str, type_declaration: str, arguments: Any, source: AaCFile, location: SourceLocation) → ExecutionResult[source]

Verify that a string value is interpretable as a string.

Parameters:
Return type:

ExecutionResult

aac.plugins.aac_primitives.run_check_typeref(value: str, type_declaration: str, arguments: Any, source: AaCFile, location: SourceLocation) → ExecutionResult[source]

Verify that a type reference value is interpretable and exists.

Parameters:
Return type:

ExecutionResult

Modules

aac_primitive_constraints_impl

The AaC AaC primitive constraints plugin implementation module.