"""LowerLookup class."""
from typing import TYPE_CHECKING
from text_lint.config import LOOKUP_TRANSFORMATION_PREFIX
from text_lint.operations.lookups.bases.lookup_encoder_base import (
LookupEncoderBase,
)
from text_lint.operations.lookups.encoders.lower import LowerCaseEncoder
from text_lint.utilities.translations import _
if TYPE_CHECKING: # pragma: no cover
from text_lint.linter.states import LookupState
YAML_EXAMPLE_COMPONENTS = (
_("lowercase save id transformation lookup example"),
)
YAML_EXAMPLE = """
- name: {0}
operation: validate_debug
saved:
- example.capture(1).to_lower()
""".format(*YAML_EXAMPLE_COMPONENTS)
[Doku]
class LowerLookup(LookupEncoderBase):
"""LowerLookup operation for ResultForest instances."""
encoder_class = LowerCaseEncoder
hint = _("convert a save id's values to lowercase")
operation = LOOKUP_TRANSFORMATION_PREFIX + "lower"
yaml_example = YAML_EXAMPLE
[Doku]
def apply(
self,
state: "LookupState",
) -> None:
"""Convert the current result set to lowercase characters."""
state.results = self.encode(state.results)