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 definitions intended for the Apps screen.

BuiltinAppDefinition

Describe a built-in application.

Parameters

metadata
type: AppMetadata

Static metadata describing the application.

attribute
type: str

Name of the wrapped application within its module.

visible_in_apps
type: bool = True

Whether the app appears in the Apps screen.

Fields

metadata
type: 'AppMetadata' (required)
attribute
type: 'str' (required)
visible_in_apps
type: 'bool' = True

Methods


BuiltinAppDefinition.__init__

__init__(
    metadata: AppMetadata,
    attribute: str,
    visible_in_apps: bool = True,
) → None

merge_with_visible_builtins

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

Combine project apps with visible built-ins.

Parameters

project_apps
type: dict[str, AppFunctionWrapper]

Applications discovered from a user project.

Returns

type: dict[str, AppReference]

Visible built-in definitions 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, BuiltinAppDefinition]

Return built-in definitions intended for the Apps screen.

Returns

type: dict[str, BuiltinAppDefinition]

A new mapping containing each visible built-in definition.