text_lint.operations.mixins.parameter_validation.ParameterValidationMixin

class text_lint.operations.mixins.parameter_validation.ParameterValidationMixin[source]

Bases: object

A mixin class to validate constructor parameters.

__parse_parameter_definition__(attribute_name: str) → ParameterDefinition[source]

Generate a ParameterDefinition instance from the given attribute name.

Parameters:: attribute_name (str) – The name of the attribute that will be parsed.
Returns:: The generated ParameterDefinition instance.
Raises:: InvalidParameterValidation
Return type:: ParameterDefinition

__raise_type_error__(definition: ParameterDefinition) → None[source]

Raise a TypeError derived from the given ParameterDefinition.

Parameters:: definition (ParameterDefinition) – The ParameterDefinition instance that will be used.
Raises:: TypeError

__validate_attribute__(definition: ParameterDefinition) → None[source]

Validate the mixed-in class with a ParameterDefinition.

Parameters:: definition (ParameterDefinition) – The ParameterDefinition instance that will be used.
Returns:: The generated ParameterDefinition instance.
Raises:: TypeError
Return type:: None

__validate_container_attribute__(definition: ParameterDefinition) → None[source]

Validate a container-type attribute value with a ParameterDefinition.

Parameters:: definition (ParameterDefinition) – The ParameterDefinition instance that will be used.
Raises:: TypeError

__validate_dict_attribute__(definition: ParameterDefinition) → None[source]

Validate a dictionary attribute value with a ParameterDefinition.

Parameters:: definition (ParameterDefinition) – The ParameterDefinition instance that will be used.
Raises:: TypeError

__validate_iterable_attribute__(definition: ParameterDefinition) → None[source]

Validate an iterable attribute value with a ParameterDefinition.

Parameters:: definition (ParameterDefinition) – The ParameterDefinition instance that will be used.
Raises:: TypeError

__validate_numeric_attribute__(definition: ParameterDefinition) → None[source]

Validate a numeric attribute value with a ParameterDefinition.

Parameters:: definition (ParameterDefinition) – The ParameterDefinition instance that will be used.
Raises:: TypeError

validate_parameters() → None[source]

Validate the parameters used to instantiate a mixed-in class.