Create a global settings file for the CLI

Author: CasperWA

dlite_entities_service/utils_cli/config.py

@@ -17,19 +17,19 @@
 from rich.console import Console
 
 from dlite_entities_service.service.config import CONFIG
+from dlite_entities_service.utils_cli.global_settings import STATUS
 
 ERROR_CONSOLE = Console(stderr=True)
 CLI_DOTENV_FILE = Path(__file__).resolve().parent / ".env"
 SERVICE_DOTENV_FILE = Path(__file__).resolve().parent.parent.parent / ".env"
 
 APP = typer.Typer(
     name=__file__.rsplit("/", 1)[-1].replace(".py", ""),
+    help="Manage configuration options.",
     no_args_is_help=True,
     invoke_without_command=True,
 )
 
-STATUS = {"use_service_dotenv": False}
-
 
 class ConfigFields(str, Enum):
     """Configuration options."""
@@ -111,7 +111,7 @@ def unset(
         show_default=False,
     ),
 ) -> None:
-    """Unset a configuration option."""
+    """Unset a single configuration option."""
     if STATUS["use_service_dotenv"]:
         dotenv_file = SERVICE_DOTENV_FILE
     else:
@@ -121,6 +121,26 @@ def unset(
     print(f"Unset {CONFIG.Config.env_prefix}{key}.")
 
 
+@APP.command()
+def unset_all() -> None:
+    """Unset all configuration options."""
+    typer.confirm(
+        "Are you sure you want to unset (remove) all configuration options in "
+        f"{'Service' if STATUS['use_service_dotenv'] else 'CLI'}-specific .env file?",
+        abort=True,
+    )
+
+    if STATUS["use_service_dotenv"]:
+        dotenv_file = SERVICE_DOTENV_FILE
+    else:
+        dotenv_file = CLI_DOTENV_FILE
+    if dotenv_file.exists():
+        dotenv_file.unlink()
+        print(f"Unset all configuration options. (Removed {dotenv_file}.)")
+    else:
+        print(f"Unset all configuration options. ({dotenv_file} file not found.)")
+
+
 @APP.command()
 def show(
     reveal_sensitive: bool = typer.Option(
@@ -151,44 +171,3 @@ def show(
         if not reveal_sensitive and key.is_sensitive():
             value = "***"
         print(f"[bold]{CONFIG.Config.env_prefix}{key}[/bold]: {value}")
-
-
-@APP.callback()
-def main(
-    use_service_dotenv: bool = typer.Option(
-        False,
-        "--use-service-dotenv/--use-cli-dotenv",
-        help=(
-            "Use the .env file also used for the DLite Entities Service or one only "
-            "for the CLI."
-        ),
-        is_flag=True,
-    ),
-    unset_all: bool = typer.Option(
-        False,
-        "--unset-all",
-        help="Unset (remove) all configuration options in dotenv file.",
-        show_default=False,
-        is_flag=True,
-    ),
-) -> None:
-    """Set DLite entities service configuration options."""
-    STATUS["use_service_dotenv"] = use_service_dotenv
-
-    if unset_all:
-        typer.confirm(
-            "Are you sure you want to unset (remove) all configuration options in "
-            f"{'Service' if use_service_dotenv else 'CLI'}-specific .env file?",
-            abort=True,
-        )
-
-        if use_service_dotenv:
-            dotenv_file = SERVICE_DOTENV_FILE
-        else:
-            dotenv_file = CLI_DOTENV_FILE
-
-        if dotenv_file.exists():
-            dotenv_file.unlink()
-            print(f"Removed {dotenv_file}.")
-        else:
-            print(f"No {dotenv_file} file found.")

dlite_entities_service/utils_cli/global_settings.py

@@ -0,0 +1,47 @@
+"""Global settings for the CLI."""
+from pathlib import Path
+from typing import Optional
+
+try:
+    import typer
+except ImportError as exc:
+    raise ImportError(
+        "Please install the DLite entities service utility CLI with "
+        f"'pip install {Path(__file__).resolve().parent.parent.parent.resolve()}[cli]'"
+    ) from exc
+
+from rich import print  # pylint: disable=redefined-builtin
+
+from dlite_entities_service import __version__
+
+STATUS = {"use_service_dotenv": False}
+
+
+def _print_version(value: bool) -> None:
+    """Print version and exit."""
+    if value:
+        print(f"dlite-entities-service version: {__version__}")
+        raise typer.Exit()
+
+
+def global_options(
+    _: Optional[bool] = typer.Option(
+        None,
+        "--version",
+        help="Show version and exit",
+        is_eager=True,
+        callback=_print_version,
+    ),
+    use_service_dotenv: bool = typer.Option(
+        False,
+        "--use-service-dotenv/--use-cli-dotenv",
+        help=(
+            "Use the .env file also used for the DLite Entities Service or one only "
+            "for the CLI."
+        ),
+        is_flag=True,
+        rich_help_panel="Global options",
+    ),
+) -> None:
+    """Global options for the CLI."""
+    STATUS["use_service_dotenv"] = use_service_dotenv

dlite_entities_service/utils_cli/main.py

@@ -27,6 +27,7 @@
     get_collection,
 )
 from dlite_entities_service.utils_cli.config import APP as config_APP
+from dlite_entities_service.utils_cli.global_settings import global_options
 
 if TYPE_CHECKING:  # pragma: no cover
     from typing import Any
@@ -50,15 +51,9 @@ class EntityFileFormats(str, Enum):
     help="DLite entities service utility CLI",
     no_args_is_help=True,
     pretty_exceptions_show_locals=False,
+    callback=global_options,
 )
-APP.add_typer(config_APP)
-
-
-def _print_version(value: bool) -> None:
-    """Print version and exit."""
-    if value:
-        print(f"dlite-entities-service version: {__version__}")
-        raise typer.Exit()
+APP.add_typer(config_APP, callback=global_options)
 
 
 def _get_backend() -> "Collection":
@@ -77,19 +72,6 @@ def _get_backend() -> "Collection":
     return ENTITIES_COLLECTION
 
 
-@APP.callback()
-def main(
-    _: Optional[bool] = typer.Option(
-        None,
-        "--version",
-        help="Show version and exit",
-        is_eager=True,
-        callback=_print_version,
-    ),
-) -> None:
-    """DLite entities service utility CLI."""
-
-
 @APP.command(no_args_is_help=True)
 def upload(
     filepaths: Optional[list[Path]] = typer.Option(