text_lint.schema.bases.section_base.SchemaSectionBase

class text_lint.schema.bases.section_base.SchemaSectionBase(schema: Schema)

Bases: Generic[TypeOperation]

A section of the schema file containing operation definitions.

__init__(schema: Schema) → None

Initialize SchemaSectionBase instances.

Parameters:

schema (Schema) – The schema instance this section is found in.

hook_create_operation_instance(operation_class: Type[TypeOperation], yaml_definition: Dict[str, Any]) → Dict[str, Any]

Modify the yaml definition prior to creating the operation instance.

Parameters:

• operation_class (Type[TypeOperation]) – The operation class being created.

• yaml_definition (Dict[str, Any]) – The YAML config for this operation.

Returns:

The modified YAML config.

Return type:

Dict[str, Any]

hook_load_operation_instances(operation_instances: List[TypeOperation], operation_definitions: List[Dict[str, Any]]) → List[TypeOperation]

Modify the operation instances prior to returning loaded results.

Parameters:

• operation_instances (List[TypeOperation]) – The newly created operation instances.

• operation_definitions (List[Dict[str, Any]]) – The YAML config for the operations.

Returns:

The modified operation instances.

Return type:

List[TypeOperation]

load(source: List[Dict[str, Any]]) → List[TypeOperation]

Load the operation instances from the schema.

Parameters:

source (List[Dict[str, Any]]) – The YAML source that defines the section’s operations.

Returns:

The new operation instances.

Raises:

SchemaError

Return type:

List[TypeOperation]