text_lint.operations.validators.bases.validator_comparison_base.ValidationComparisonBase

class text_lint.operations.validators.bases.validator_comparison_base.ValidationComparisonBase(name: str, saved_a: AliasYamlLookupExpressionSet, saved_b: AliasYamlLookupExpressionSet)[source]

Bases: ValidatorBase, ABC

A base validator to compare sets of result lookups.

__init__(name: str, saved_a: AliasYamlLookupExpressionSet, saved_b: AliasYamlLookupExpressionSet) → None[source]

Initialize ValidationComparisonBase instances.

Parameters:

  • name (str) – The configured name of this validator.

  • saved_a (AliasYamlLookupExpressionSet) – A list of YAML lookup expressions to evaluate.

  • saved_b (AliasYamlLookupExpressionSet) – A second list of YAML lookup expressions to compare with.

Raises:

TypeError

apply(state: ValidatorState) → None[source]

Apply this operation to the given state object.

Parameters:

state (ValidatorState) – The state object to apply this operation to.

Raises:

TypeError, ValidationInvalidComparison, ValidationFailure

abstract comparison(result_a: AliasLookupResult, result_b: AliasLookupResult) → bool[source]

Perform the comparison between each pair of lookup expression results.

Parameters:

  • result_a (AliasLookupResult) – A lookup expression result to compare.

  • result_b (AliasLookupResult) – A second lookup expression result to compare against.

Returns:

Whether the comparison

Raises:

TypeError

Return type:

bool

create_invalid_comparison_exception(result_a: AliasLookupResult, result_b: AliasLookupResult, lookup_expression_a: LookupExpression, lookup_expression_b: LookupExpression) → ValidationInvalidComparison[source]

Create an exception for an invalid comparison.

Parameters:

  • result_a (AliasLookupResult) – A lookup expression result to compare.

  • result_b (AliasLookupResult) – A second lookup expression result to compare against.

  • lookup_expression_a (LookupExpression) – The first lookup expression evaluated.

  • lookup_expression_b (LookupExpression) – The second lookup expression evaluated.

Returns:

A properly formatted invalid comparison exception.

Return type:

ValidationInvalidComparison

create_validation_failure_exception(result_a: AliasLookupResult, result_b: AliasLookupResult, requested_result_a: LookupExpression, requested_result_b: LookupExpression) → ValidationFailure[source]

Create the appropriate validation failure exception.

Parameters:

  • result_a (AliasLookupResult) – A lookup expression result to compare.

  • result_b (AliasLookupResult) – A second lookup expression result to compare against.

  • requested_result_a (LookupExpression) – The first lookup expression evaluated.

  • requested_result_b (LookupExpression) – The second lookup expression evaluated.

Returns:

A properly formatted validation failure exception.

Return type:

ValidationFailure