taps.app

taps/app.py

App

Bases: Protocol

Application protocol.

run()

run(engine: AppEngine, run_dir: Path) -> None

Run the application.

Source code in taps/app.py

def run(
    self,
    engine: AppEngine,
    run_dir: pathlib.Path,
) -> None:
    """Run the application."""
    ...

close()

close() -> None

Close the application.

Source code in taps/app.py

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

AppConfig

Bases: ABC, Config

Application config protocol.

Application configs inherit from Config and define the create_app() method.

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

create_app() abstractmethod

create_app() -> App

Initialize an app instance from this config.

Source code in taps/app.py

@abc.abstractmethod
def create_app(self) -> App:
    """Initialize an app instance from this config."""
    ...