taps.data.null

taps/data/null.py

NullTransformerConfig

Bases: DataTransformerConfig

Null transformer config.

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()

get_transformer() -> NullTransformer

Create a transformer instance from the config.

Source code in taps/data/null.py

def get_transformer(self) -> NullTransformer:
    """Create a transformer instance from the config."""
    return NullTransformer()

NullTransformer

Null transformer that does no transformations.

close()

close() -> None

Close the transformer.

Source code in taps/data/null.py

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

is_identifier()

is_identifier(obj: Any) -> bool

Check if the object is an identifier instance.

Always False in this implementation.

Source code in taps/data/null.py

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

    Always `False` in this implementation.
    """
    return False

transform()

transform(obj: T) -> T

Transform the object into an identifier.

Parameters:

• obj (T) –

  Object to transform.

Returns:

• T –

  Identifier object that can be usd to resolve obj.

Source code in taps/data/null.py

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

    Args:
        obj: Object to transform.

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

resolve()

resolve(identifier: Any) -> NoReturn

Resolve an object from an identifier.

Parameters:

• identifier (Any) –

  Identifier to an object.

Returns:

• NoReturn –

  The resolved object.

Source code in taps/data/null.py

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

    Args:
        identifier: Identifier to an object.

    Returns:
        The resolved object.
    """
    raise NotImplementedError(
        f'{self.__class__.__name__} does not support identifiers',
    )