"""
Provide the Command Line Interface.
"""
from __future__ import annotations
import logging
from contextlib import suppress
from functools import wraps
from importlib import metadata
from pathlib import Path
from typing import (
Any,
Concatenate,
ParamSpec,
ClassVar,
TYPE_CHECKING,
Mapping,
overload,
TypeVar,
cast,
)
import click
from betty import about
from betty.assertion.error import AssertionFailed
from betty.asyncio import wait_to_thread
from betty.cli.error import user_facing_error_to_bad_parameter
from betty.config import assert_configuration_file
from betty.contextlib import SynchronizedContextManager
from betty.error import UserFacingError, FileNotFound
from betty.locale.localizable import _, Localizable, plain
from betty.locale.localizer import DEFAULT_LOCALIZER
from betty.plugin import Plugin, PluginRepository
from betty.plugin.lazy import LazyPluginRepositoryBase
from betty.project import Project
from betty.serde.format import FormatRepository
from click import Context, option, Parameter
from typing_extensions import override
if TYPE_CHECKING:
from betty.app import App
from betty.machine_name import MachineName
from collections.abc import Callable, Coroutine
_P = ParamSpec("_P")
[docs]
class Command(Plugin):
"""
Define a CLI command plugin.
Read more about :doc:`/development/plugin/command`.
"""
_click_command: ClassVar[click.Command]
[docs]
@classmethod
def click_command(cls) -> click.Command:
"""
Get the plugin's Click command.
"""
return cls._click_command
[docs]
@override
@classmethod
def plugin_id(cls) -> MachineName:
return cls.click_command().name
[docs]
@override
@classmethod
def plugin_label(cls) -> Localizable:
return plain(cls.click_command().name)
[docs]
@override
@classmethod
def plugin_description(cls) -> Localizable | None:
command_help = cls.click_command().short_help
if command_help is None:
return None
return plain(command_help)
class _CommandRepository(LazyPluginRepositoryBase[Command]):
"""
Discover and manage CLI commands.
"""
async def _load_plugins(self) -> Mapping[str, type[Command]]:
plugins = self._load_plugins_group("betty.command")
if about.is_development():
plugins = {**plugins, **(self._load_plugins_group("betty.dev.command"))}
return plugins
def _load_plugins_group(
self, entry_point_group: str
) -> Mapping[str, type[Command]]:
plugins = {}
for entry_point in metadata.entry_points(
group=entry_point_group,
):
class _Command(Command):
_click_command = entry_point.load()
plugins[_Command.plugin_id()] = _Command
return plugins
COMMAND_REPOSITORY: PluginRepository[Command] = _CommandRepository()
"""
The Command Line Interface command repository.
Read more about :doc:`/development/plugin/command`.
"""
def _command_build_init_ctx_verbosity(
betty_logger_level: int,
root_logger_level: int | None = None,
) -> Callable[[click.Context, click.Option | click.Parameter | None, bool], None]:
def _init_ctx_verbosity(
_: click.Context,
__: click.Option | click.Parameter | None = None,
is_verbose: bool = False,
) -> None:
if is_verbose:
for logger_name, logger_level in (
("betty", betty_logger_level),
(None, root_logger_level),
):
logger = logging.getLogger(logger_name)
if (
logger_level is not None
and logger.getEffectiveLevel() > logger_level
):
logger.setLevel(logger_level)
return _init_ctx_verbosity
[docs]
class BettyCommand(click.Command):
"""
A Click command for Betty.
See :py:func:`betty.cli.commands.command`.
"""
[docs]
@override
def invoke(self, ctx: click.Context) -> Any:
from betty.cli import ctx_app
try:
return super().invoke(ctx)
except UserFacingError as error:
raise click.ClickException(
error.localize(ctx_app(ctx).localizer)
) from error
_BettyCommandT = TypeVar("_BettyCommandT", bound=BettyCommand)
@overload
def command(name: Callable[..., Coroutine[Any, Any, Any]]) -> BettyCommand:
pass
@overload
def command(
name: str | None,
cls: type[_BettyCommandT],
**attrs: Any,
) -> Callable[[Callable[..., Coroutine[Any, Any, Any]]], _BettyCommandT]:
pass
@overload
def command(
name: None = None,
*,
cls: type[_BettyCommandT],
**attrs: Any,
) -> Callable[[Callable[..., Coroutine[Any, Any, Any]]], _BettyCommandT]:
pass
@overload
def command(
name: str | None = None, cls: None = None, **attrs: Any
) -> Callable[[Callable[..., Coroutine[Any, Any, Any]]], BettyCommand]:
pass
[docs]
def command(
name: str | None | Callable[..., Coroutine[Any, Any, Any]] = None,
cls: type[BettyCommand] | None = None,
**attrs: Any,
) -> (
click.Command
| Callable[[Callable[..., Coroutine[Any, Any, Any]]], click.Command | BettyCommand]
):
"""
Mark something a Betty command.
This is almost identical to :py:func:`click.command`, except that ``cls`` must extend
:py:class:`betty.cli.commands.BettyCommand`.
Functions decorated with ``@command`` may choose to raise :py:class:`betty.error.UserFacingError`, which will
automatically be localized and reraised as :py:class:`click.ClickException`.
Read more about :doc:`/development/plugin/command`.
"""
if cls is None:
cls = BettyCommand
def decorator(f: Callable[..., Coroutine[Any, Any, Any]]) -> BettyCommand:
@click.command(cast(str | None, name), cls, **attrs)
@click.option(
"-v",
"--verbose",
is_eager=True,
default=False,
is_flag=True,
expose_value=False,
help="Show verbose output, including informative log messages.",
callback=_command_build_init_ctx_verbosity(logging.INFO),
)
@click.option(
"-vv",
"--more-verbose",
"more_verbose",
is_eager=True,
default=False,
is_flag=True,
expose_value=False,
help="Show more verbose output, including debug log messages.",
callback=_command_build_init_ctx_verbosity(logging.DEBUG),
)
@click.option(
"-vvv",
"--most-verbose",
"most_verbose",
is_eager=True,
default=False,
is_flag=True,
expose_value=False,
help="Show most verbose output, including all log messages.",
callback=_command_build_init_ctx_verbosity(logging.NOTSET, logging.NOTSET),
)
@wraps(f)
def _command(*args: _P.args, **kwargs: _P.kwargs) -> None:
wait_to_thread(f(*args, **kwargs))
return _command # type: ignore[return-value]
if callable(name):
return decorator(name)
return decorator
_ReturnT = TypeVar("_ReturnT")
[docs]
def pass_app(
f: Callable[Concatenate[App, _P], _ReturnT],
) -> Callable[_P, _ReturnT]:
"""
Decorate a command to receive the currently running :py:class:`betty.app.App` as its first argument.
"""
from betty.cli import ctx_app
@wraps(f)
def _command(*args: _P.args, **kwargs: _P.kwargs) -> _ReturnT:
return f(ctx_app(click.get_current_context()), *args, **kwargs)
return _command
async def _read_project_configuration(
project: Project, provided_configuration_file_path_str: str | None
) -> None:
project_directory_path = Path.cwd()
if provided_configuration_file_path_str is None:
try_configuration_file_paths = [
project_directory_path / f"betty{extension}"
for extension in FormatRepository().extensions
]
for try_configuration_file_path in try_configuration_file_paths:
with suppress(FileNotFound):
return await _read_project_configuration_file(
project, try_configuration_file_path
)
raise AssertionFailed(
_(
"Could not find any of the following configuration files in {project_directory_path}: {configuration_file_names}."
).format(
configuration_file_names=", ".join(
str(try_configuration_file_path.relative_to(project_directory_path))
for try_configuration_file_path in try_configuration_file_paths
),
project_directory_path=str(project_directory_path),
)
)
else:
await _read_project_configuration_file(
project,
(project_directory_path / provided_configuration_file_path_str)
.expanduser()
.resolve(),
)
async def _read_project_configuration_file(
project: Project, configuration_file_path: Path
) -> None:
logger = logging.getLogger(__name__)
assert_configuration = assert_configuration_file(project.configuration)
try:
assert_configuration(configuration_file_path)
except UserFacingError as error:
logger.debug(error.localize(project.app.localizer))
raise
else:
project.configuration.configuration_file_path = configuration_file_path
logger.info(
project.app.localizer._(
"Loaded the configuration from {configuration_file_path}."
).format(configuration_file_path=str(configuration_file_path)),
)
[docs]
def pass_project(
f: Callable[Concatenate[Project, _P], _ReturnT],
) -> Callable[_P, _ReturnT]:
"""
Decorate a command to receive the currently running :py:class:`betty.project.Project` as its first argument.
"""
from betty.cli import ctx_app
def _project(
ctx: Context, __: Parameter, configuration_file_path: str | None
) -> Project:
project: Project = ctx.with_resource( # type: ignore[attr-defined]
SynchronizedContextManager(Project.new_temporary(ctx_app(ctx)))
)
wait_to_thread(_read_project_configuration(project, configuration_file_path))
ctx.with_resource( # type: ignore[attr-defined]
SynchronizedContextManager(project)
)
return project
return option( # type: ignore[return-value]
"--configuration",
"-c",
"project",
help="The path to a Betty project configuration file. Defaults to betty.json|yaml|yml in the current working directory.",
callback=user_facing_error_to_bad_parameter(DEFAULT_LOCALIZER)(_project),
)(f)