taps.data.transform

taps/data/transform.py

DataTransformerConfig

Bases: Config, ABC

Data transformer configuration abstract base class.

add_argument_group() classmethod

add_argument_group(
    parser: ArgumentParser,
    *,
    argv: Sequence[str] | None = None,
    required: bool = True
) -> None

Add model fields as arguments of an argument group on the parser.

Parameters:

• parser (ArgumentParser) –

  Parser to add a new argument group to.

• argv (Sequence[str] | None, default: None ) –

  Optional sequence of string arguments.

• required (bool, default: True ) –

  Mark arguments without defaults as required.

Source code in taps/config.py

@classmethod
def add_argument_group(
    cls,
    parser: argparse.ArgumentParser,
    *,
    argv: Sequence[str] | None = None,
    required: bool = True,
) -> None:
    """Add model fields as arguments of an argument group on the parser.

    Args:
        parser: Parser to add a new argument group to.
        argv: Optional sequence of string arguments.
        required: Mark arguments without defaults as required.
    """
    group = parser.add_argument_group(cls.__name__)
    for field_name, field_info in cls.model_fields.items():
        arg_name = field_name.replace('_', '-').lower()
        group.add_argument(
            f'--{arg_name}',
            dest=field_name,
            # type=field_info.annotation,
            default=field_info.get_default(),
            required=field_info.is_required() and required,
            help=field_info.description,
        )

get_transformer() abstractmethod

get_transformer() -> DataTransformer[Any]

Create a transformer instance from the config.

Source code in taps/data/transform.py

@abc.abstractmethod
def get_transformer(self) -> DataTransformer[Any]:
    """Create a transformer instance from the config."""
    ...

DataTransformer

Bases: Protocol[IdentifierT]

Object transformer protocol.

close()

close() -> None

Close the transformer.

The transformer is only closed by the client once the application has finished executing (or raised an exception).

Source code in taps/data/transform.py

def close(self) -> None:
    """Close the transformer.

    The transformer is only closed by the client once the application
    has finished executing (or raised an exception).
    """
    ...

is_identifier()

is_identifier(obj: T) -> bool

Check if the object is an identifier instance.

Source code in taps/data/transform.py

def is_identifier(self, obj: T) -> bool:
    """Check if the object is an identifier instance."""
    ...

transform()

transform(obj: T) -> IdentifierT

Transform the object into an identifier.

Parameters:

• obj (T) –

  Object to transform.

Returns:

• IdentifierT –

  Identifier object that can be used to resolve obj.

Source code in taps/data/transform.py

def transform(self, obj: T) -> IdentifierT:
    """Transform the object into an identifier.

    Args:
        obj: Object to transform.

    Returns:
        Identifier object that can be used to resolve `obj`.
    """
    ...

resolve()

resolve(identifier: IdentifierT) -> Any

Resolve an object from an identifier.

Parameters:

• identifier (IdentifierT) –

  Identifier to an object.

Returns:

• Any –

  The resolved object.

Source code in taps/data/transform.py

def resolve(self, identifier: IdentifierT) -> Any:
    """Resolve an object from an identifier.

    Args:
        identifier: Identifier to an object.

    Returns:
        The resolved object.
    """
    ...