Skip to content

taps.run.apps.registry

taps/run/apps/registry.py

AppConfigT module-attribute 

AppConfigT = TypeVar('AppConfigT', bound=AppConfig)

Application config type.

register_app() 

register_app(
    *, name: str
) -> Callable[[type[AppConfigT]], type[AppConfigT]]

Decorator for registering an app config type.

Example

An app config can be defined and registered using a name. 

from pydantic import Field

from taps.apps.app import App
from taps.config import Config
from taps.run.app import register_app

@register('foo')
class FooConfig(Config):
    n: int = Field(1, description='count')

    def create_app(self) -> App:
        from taps.apps.foo import FooApp

        return FooApp(n=self.n)

Registration will make the app named "foo" available within the CLI. 

python -m taps.run foo --n 1 ...
```

Parameters:

  • name (str) –

    Name of the application. This will be used as the app option within the CLI.

Source code in taps/run/apps/registry.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def register_app(
    *,
    name: str,
) -> Callable[[type[AppConfigT]], type[AppConfigT]]:
    """Decorator for registering an app config type.

    Example:
        An app config can be defined and registered using a name.
        ```python
        from pydantic import Field

        from taps.apps.app import App
        from taps.config import Config
        from taps.run.app import register_app

        @register('foo')
        class FooConfig(Config):
            n: int = Field(1, description='count')

            def create_app(self) -> App:
                from taps.apps.foo import FooApp

                return FooApp(n=self.n)
        ```

        Registration will make the app named "foo" available within the CLI.
        ```bash
        python -m taps.run foo --n 1 ...
        ```
        ```

    Args:
        name: Name of the application. This will be used as the app option
            within the CLI.
    """

    def _decorator(cls: type[AppConfigT]) -> type[AppConfigT]:
        _REGISTERED_APP_CONFIGS[name] = cls
        return cls

    return _decorator

get_registered_apps() 

get_registered_apps() -> dict[str, type[AppConfig]]

Get all registered application configs.

Returns:

Source code in taps/run/apps/registry.py 
56
57
58
59
60
61
62
def get_registered_apps() -> dict[str, type[AppConfig]]:
    """Get all registered application configs.

    Returns:
        Mapping of application name to the config type.
    """
    return _REGISTERED_APP_CONFIGS.copy()