betty.cli.commands package¶
Submodules¶
Module contents¶
Provide the Command Line Interface.
- betty.cli.commands.COMMAND_REPOSITORY: PluginRepository[Command] = <betty.cli.commands._CommandRepository object>¶
The Command Line Interface command repository.
- class betty.cli.commands.Command[source]¶
Bases:
Plugin
Define a CLI command plugin.
- classmethod click_command() click.core.Command [source]¶
Get the plugin’s Click command.
- Return type:
- classmethod plugin_description() betty.locale.localizable.Localizable | None [source]¶
Get the human-readable long plugin description.
- Return type:
- classmethod plugin_id() str [source]¶
Get the plugin ID.
IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.
- Return type:
- classmethod plugin_label() betty.locale.localizable.Localizable [source]¶
Get the human-readable short plugin label.
- Return type:
- betty.cli.commands.command(f: collections.abc.Callable[[_P], collections.abc.Coroutine[Any, Any, None]]) collections.abc.Callable[[_P], None] [source]¶
Mark something a Betty command.
- Parameters:
f (
collections.abc.Callable
[[typing.ParamSpec
(_P
, bound=None
)],collections.abc.Coroutine
[typing.Any
,typing.Any
,None
]])- Return type:
collections.abc.Callable
[[typing.ParamSpec
(_P
, bound=None
)],None
]
- betty.cli.commands.pass_app(f: collections.abc.Callable[[Concatenate[betty.app.App, _P]], None]) collections.abc.Callable[[_P], None] [source]¶
Decorate a command to receive the currently running
betty.app.App
as its first argument.- Parameters:
f (
collections.abc.Callable
[[typing.Concatenate
[betty.app.App
,typing.ParamSpec
(_P
, bound=None
)]],None
])- Return type:
collections.abc.Callable
[[typing.ParamSpec
(_P
, bound=None
)],None
]
- betty.cli.commands.pass_project(f: collections.abc.Callable[[Concatenate[betty.project.Project, _P]], None]) collections.abc.Callable[[_P], None] [source]¶
Decorate a command to receive the currently running
betty.project.Project
as its first argument.- Parameters:
f (
collections.abc.Callable
[[typing.Concatenate
[betty.project.Project
,typing.ParamSpec
(_P
, bound=None
)]],None
])- Return type:
collections.abc.Callable
[[typing.ParamSpec
(_P
, bound=None
)],None
]