"""NoopLookup class."""
from typing import TYPE_CHECKING
from text_lint.operations.lookups.bases.lookup_base import LookupBase
from text_lint.utilities.translations import _
if TYPE_CHECKING: # pragma: no cover
from text_lint.linter.states import LookupState
YAML_EXAMPLE_COMPONENTS = (
_("noop lookup example"),
)
YAML_EXAMPLE = """
- name: {0}
operation: validate_debug
saved:
- example.noop()
""".format(*YAML_EXAMPLE_COMPONENTS)
[Doku]
class NoopLookup(LookupBase):
"""NoopLookup operation for ResultForest instances."""
hint = _("a simple no-operation")
internal_use_only = True
operation = "noop"
yaml_example = YAML_EXAMPLE
[Doku]
def apply(
self,
state: "LookupState",
) -> None:
"""No modifications to the results or the ResultForest cursor."""