"""ValidatorBase class."""
import abc
from typing import TYPE_CHECKING
from text_lint.operations.bases.operation_base import OperationBase
if TYPE_CHECKING: # pragma: no cover
from text_lint.linter import states
[docs]
class ValidatorBase(
OperationBase["states.ValidatorState"],
abc.ABC,
):
"""Validation operation base class."""
operation: str
hint: str
[docs]
def __init__(self, name: str) -> None:
"""Initialize ValidatorBase instances.
:param name: The configured name of this validator.
:raises: TypeError
"""
self.name = name
self.validate_parameters()
[docs]
class Parameters:
"""Parameter validation for this operation."""
name = {"type": str}
[docs]
@abc.abstractmethod
def apply(
self,
state: "states.ValidatorState",
) -> None:
"""Apply this operation to the given state object.
:param state: The state object to apply this operation to.
"""