yera.apps.builtin.registry

Declare Yera's built-in applications and their visibility.

Symbols

class BuiltinAppDefinition — Describe a built-in application.
def merge_with_visible_builtins — Combine project apps with visible built-ins.
def visible_builtin_apps — Return built-in apps intended for the Apps screen.

BuiltinAppDefinition

Describe a built-in application.

Parameters

app
type: AppFunctionWrapper

Wrapped Yera application exposed by the definition.

visible_in_apps
type: bool = True

Whether the app appears in the Apps screen.

merge_with_visible_builtins

merge_with_visible_builtins(
    project_apps: dict[str, AppFunctionWrapper],
) → dict[str, AppFunctionWrapper]

Combine project apps with visible built-ins.

Parameters

project_apps
type: dict[str, AppFunctionWrapper]

Applications discovered from a user project.

Returns

type: dict[str, AppFunctionWrapper]

Visible built-ins followed by the supplied project apps.

Raises

ValueError

If a project app uses the reserved builtin/ namespace.

visible_builtin_apps

visible_builtin_apps() → dict[str, AppFunctionWrapper]

Return built-in apps intended for the Apps screen.

Returns

type: dict[str, AppFunctionWrapper]

A new mapping containing each visible built-in app.