"""LookupEncoderBase class."""
import abc
import json
from typing import TYPE_CHECKING, Any, Dict, Type
from .lookup_base import AliasLookupParams, LookupBase
if TYPE_CHECKING: # pragma: no cover
from text_lint.operations.validators.args.lookup_expression import (
LookupExpression,
)
[Doku]
class LookupEncoderBase(LookupBase, abc.ABC):
"""Lookup result encoding operation base class."""
encoder_class: Type[json.JSONEncoder]
encoder_params: Dict[str, Any]
[Doku]
def __init__(
self,
lookup_name: str,
lookup_expression: "LookupExpression",
lookup_params: "AliasLookupParams",
requesting_operation_name: str,
) -> None:
"""Initialize LookupEncoderBase instances.
:param lookup_name: The name of this lookup operation.
:param lookup_expression: The lookup expression this lookup is a part of.
:param lookup_params: The parameters being used with this lookup operation.
:param requesting_operation_name: The name of the validation operation.
"""
super().__init__(
lookup_name,
lookup_expression,
lookup_params,
requesting_operation_name,
)
self.encoder_params = {}
[Doku]
def encode(self, value_set: Any) -> Any:
"""Apply the configured encoder to the given value set.
:param value_set: The value or values being encoded.
:returns: The encoded value or values.
"""
return json.loads(
self.encoder_class(**self.encoder_params).encode(value_set)
)