Skip to content

Body Registry API

Source: ui/body_registry.py

Shared access to active shell bodies when navigation or search needs to reuse existing tile containers. See the Body registry concept.

Store shared tile bodies used by home and export screens (and in-place search).

BodyRegistry

Process-wide registry for reusable home and export tile containers.

Source code in src/learning_app/ui/body_registry.py 
 6
 7
 8
 9
10
11
12
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class BodyRegistry:
    """Process-wide registry for reusable home and export tile containers."""

    _home: TilesContainer | None = None
    _export: TilesContainer | None = None

    @classmethod
    def set_home(cls, body: TilesContainer):
        """Register the tile container used by the home route.

        Args:
            body: Home tile container to retain.
        """
        cls._home = body

    @classmethod
    def get_home(cls) -> TilesContainer:
        """Return the registered home tile container.

        Returns:
            The current home tile container.

        Raises:
            AssertionError: If no home body has been registered.
        """
        assert cls._home is not None, "Home body is not set"
        return cls._home

    @classmethod
    def has_home(cls) -> bool:
        """Return whether a home tile container is registered.

        Returns:
            ``True`` when a home body is available.
        """
        return cls._home is not None

    @classmethod
    def set_export(cls, body: TilesContainer):
        """Register the tile container used by the export workflow.

        Args:
            body: Export tile container to retain.
        """
        cls._export = body

    @classmethod
    def get_export(cls) -> TilesContainer:
        """Return the registered export tile container.

        Returns:
            The current export tile container.

        Raises:
            AssertionError: If no export body has been registered.
        """
        assert cls._export is not None, "Export body is not set"
        return cls._export

    @classmethod
    def has_export(cls) -> bool:
        """Return whether an export tile container is registered.

        Returns:
            ``True`` when an export body is available.
        """
        return cls._export is not None

set_home classmethod 

set_home(body: TilesContainer)

Register the tile container used by the home route.

Parameters:

Name Type Description Default
body TilesContainer

Home tile container to retain.

 required
Source code in src/learning_app/ui/body_registry.py 
12
13
14
15
16
17
18
19
@classmethod
def set_home(cls, body: TilesContainer):
    """Register the tile container used by the home route.

    Args:
        body: Home tile container to retain.
    """
    cls._home = body

get_home classmethod 

get_home() -> TilesContainer

Return the registered home tile container.

Returns:

Type Description
TilesContainer

The current home tile container.

Raises:

Type Description
AssertionError

If no home body has been registered.
Source code in src/learning_app/ui/body_registry.py 
21
22
23
24
25
26
27
28
29
30
31
32
@classmethod
def get_home(cls) -> TilesContainer:
    """Return the registered home tile container.

    Returns:
        The current home tile container.

    Raises:
        AssertionError: If no home body has been registered.
    """
    assert cls._home is not None, "Home body is not set"
    return cls._home

has_home classmethod 

has_home() -> bool

Return whether a home tile container is registered.

Returns:

Type Description
bool

True when a home body is available.
Source code in src/learning_app/ui/body_registry.py 
34
35
36
37
38
39
40
41
@classmethod
def has_home(cls) -> bool:
    """Return whether a home tile container is registered.

    Returns:
        ``True`` when a home body is available.
    """
    return cls._home is not None

set_export classmethod 

set_export(body: TilesContainer)

Register the tile container used by the export workflow.

Parameters:

Name Type Description Default
body TilesContainer

Export tile container to retain.

 required
Source code in src/learning_app/ui/body_registry.py 
43
44
45
46
47
48
49
50
@classmethod
def set_export(cls, body: TilesContainer):
    """Register the tile container used by the export workflow.

    Args:
        body: Export tile container to retain.
    """
    cls._export = body

get_export classmethod 

get_export() -> TilesContainer

Return the registered export tile container.

Returns:

Type Description
TilesContainer

The current export tile container.

Raises:

Type Description
AssertionError

If no export body has been registered.
Source code in src/learning_app/ui/body_registry.py 
52
53
54
55
56
57
58
59
60
61
62
63
@classmethod
def get_export(cls) -> TilesContainer:
    """Return the registered export tile container.

    Returns:
        The current export tile container.

    Raises:
        AssertionError: If no export body has been registered.
    """
    assert cls._export is not None, "Export body is not set"
    return cls._export

has_export classmethod 

has_export() -> bool

Return whether an export tile container is registered.

Returns:

Type Description
bool

True when an export body is available.
Source code in src/learning_app/ui/body_registry.py 
65
66
67
68
69
70
71
72
@classmethod
def has_export(cls) -> bool:
    """Return whether an export tile container is registered.

    Returns:
        ``True`` when an export body is available.
    """
    return cls._export is not None