Merge pull request #153 from uhd-urz/dev

Merge dev into main

Author: mhxion

CHANGELOG.md

@@ -5,6 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.3.2] - 2025-06-17
+
+This is a hotfix release.
+
+### Fixed
+
+- Newly installed elAPI, without `elapi.yml` configuration file aborts (
+  GH https://github.com/uhd-urz/elAPI/issues/151)
+
 ## [2.3.1] - 2025-05-23
 
 This release brings some minor bug fixes and improvements.
@@ -23,7 +32,6 @@ This release brings some minor bug fixes and improvements.
 
 - Migrated from Poetry from uv (GH #148)
 
-
 ## [2.3.0] - 2024-12-21
 
 This release mainly revamps and completes the `bill-teams` plugin that is used for billing eLabFTW usage at the

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "elapi"
-version = "2.3.1"
+version = "2.3.2"
 description = "elAPI is a powerful, extensible API client for eLabFTW."
 authors = [{ name = "Alexander Haller, Mahadi Xion", email = "elabftw@uni-heidelberg.de" }]
 requires-python = ">=3.9.0,<4"

src/elapi/VERSION

@@ -1 +1 @@
-2.3.1
+2.3.2

src/elapi/cli/_plugin_handler.py

@@ -339,7 +339,7 @@ def get_typer_apps(self) -> Generator[Optional[PluginInfo], None, None]:
                 try:
                     module = self.load_plugin(plugin_name, cli_script, project_dir)
                 except (Exception, BaseException) as e:
-                    if get_development_mode() is True:
+                    if get_development_mode(skip_validation=True) is True:
                         raise e
                     message: str = (
                         f"An exception occurred while trying to load a local "
@@ -387,7 +387,7 @@ def get_typer_apps(self) -> Generator[Optional[PluginInfo], None, None]:
                                 plugin_name, cli_script, project_dir
                             )
                         except (Exception, BaseException) as e:
-                            if get_development_mode() is True:
+                            if get_development_mode(skip_validation=True) is True:
                                 raise e
                             message: str = (
                                 f"An exception occurred while trying to load a local "
@@ -415,7 +415,7 @@ def get_typer_apps(self) -> Generator[Optional[PluginInfo], None, None]:
                     try:
                         module = self.load_plugin(plugin_name, cli_script, project_dir)
                     except (Exception, BaseException) as e:
-                        if get_development_mode() is True:
+                        if get_development_mode(skip_validation=True) is True:
                             raise e
                         message: str = (
                             f"An exception occurred while trying to load a local "

src/elapi/cli/elapi.py

@@ -342,7 +342,6 @@ def messages_panel():
                 ),
             )
             grid.add_row(f"{i}.", message)
-        logger.handlers[-1]._log_render.show_path = True
         grid.add_row(
             "",
             NoteText(

src/elapi/configuration/config.py

@@ -1,7 +1,7 @@
 import logging
 import os
 from pathlib import Path
-from typing import Optional
+from typing import Optional, Union
 
 from dynaconf import Dynaconf
 
@@ -83,10 +83,11 @@
     env_switcher=f"{env_var_app_name}_ENV",
     # environment variable to apply mode of environment (e.g., dev, production)
     core_loaders=["YAML"],  # will not read any file extensions except YAML
-    # loaders=['conf'],  # will not work without properly defining a custom loader for .conf first
+    # loaders=['conf'], # will not work without properly defining a custom loader for .conf first
     yaml_loader="safe_load",  # safe load doesn't execute arbitrary Python code in YAML files
     settings_files=[SYSTEM_CONFIG_LOC, LOCAL_CONFIG_LOC, PROJECT_CONFIG_LOC],
-    # the order of settings_files list is the overwrite priority order. PROJECT_CONFIG_LOC has the highest priority.
+    # Order of the "settings_files" list is the overwrite priority order.
+    # PROJECT_CONFIG_LOC has the highest priority.
 )
 
 history = ConfigHistory(settings)
@@ -136,13 +137,13 @@ def _mask(self) -> str:
             if len(self._token) in r:
                 expose = expose_table[r]
                 break
-        return f"{self.token[:expose]}{self.mask_char * (expose + 1)}{self.token[:-expose-1:-1][::-1]}"
+        return f"{self.token[:expose]}{self.mask_char * (expose + 1)}{self.token[: -expose - 1 : -1][::-1]}"
 
 
 # Note elabftw-python uses the term "api_key" for "API_TOKEN"
 API_TOKEN: str = settings.get(KEY_API_TOKEN, None)
 
-# Here, bearer term "Authorization" already follows convention, that's why it's not part of the configuration file
+# Here, the bearer term "Authorization" already follows convention, that's why it's not part of the configuration file
 TOKEN_BEARER: str = "Authorization"
 # Reference: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
 
@@ -171,23 +172,23 @@ def _mask(self) -> str:
 # The history is ready to be inspected
 inspect = InspectConfigHistory(history)
 
-# UNSAFE_TOKEN_WARNING falls back to True if not defined in configuration
+# UNSAFE_TOKEN_WARNING falls back to True if not defined in the configuration
 UNSAFE_TOKEN_WARNING_DEFAULT_VAL: bool = True
 UNSAFE_TOKEN_WARNING = settings.get(KEY_UNSAFE_TOKEN_WARNING, None)
 
-# ENABLE_HTTP2 falls back to False if not defined in configuration
+# ENABLE_HTTP2 falls back to False if not defined in the configuration
 ENABLE_HTTP2_DEFAULT_VAL: bool = False
 ENABLE_HTTP2 = settings.get(KEY_ENABLE_HTTP2, None)
 
-# VERIFY_SSL falls back to True if not defined in configuration
+# VERIFY_SSL falls back to True if not defined in the configuration
 VERIFY_SSL_DEFAULT_VAL: bool = True
 VERIFY_SSL = settings.get(KEY_VERIFY_SSL, None)
 
 # TIMEOUT falls back to 90.0 seconds if not defined in configuration
 TIMEOUT_DEFAULT_VAL: float = 90.0  # from httpx._config import DEFAULT_TIMEOUT_CONFIG
 TIMEOUT = settings.get(KEY_TIMEOUT, None)
 
-# DEVELOPMENT_MODE falls back to false if not defined in configuration
+# DEVELOPMENT_MODE falls back to false if not defined in the configuration
 DEVELOPMENT_MODE_DEFAULT_VAL: bool = False
 DEVELOPMENT_MODE = settings.get(KEY_DEVELOPMENT_MODE, None)
 
@@ -223,7 +224,7 @@ def _mask(self) -> str:
 
 # Temporary data storage location
 # This location is not currently used anywhere, for potential future use only.
-TMP_DIR: [ProperPath, Path, Missing] = ProperPath(TMP_DIR, err_logger=logger)
+TMP_DIR: Union[ProperPath, Path, Missing] = ProperPath(TMP_DIR, err_logger=logger)
 try:
     TMP_DIR.create()
 except TMP_DIR.PathException:

src/elapi/configuration/overridable_vars.py

@@ -2,87 +2,94 @@
 from typing import Union
 
 from ._overload_history import reinitiate_config
-from .config import APIToken
+from .config import (
+    MinimalActiveConfiguration,
+    APIToken,
+    KEY_HOST,
+    ELAB_HOST_URL_API_SUFFIX,
+    KEY_API_TOKEN,
+    KEY_EXPORT_DIR,
+    KEY_UNSAFE_TOKEN_WARNING,
+    KEY_ENABLE_HTTP2,
+    KEY_VERIFY_SSL,
+    KEY_TIMEOUT,
+    KEY_DEVELOPMENT_MODE,
+    KEY_PLUGIN_KEY_NAME,
+)
 from ..styles import Missing
 
 
-def _run_validation_once() -> None:
-    if get_development_mode() is False or get_development_mode() == Missing():
-        reinitiate_config()
-
-
-def get_active_host() -> str:
-    from .config import KEY_HOST, MinimalActiveConfiguration
-
-    _run_validation_once()
+def get_active_host(*, skip_validation: bool = False) -> str:
+    if not skip_validation:
+        _development_mode_validation_switch()
     return MinimalActiveConfiguration().get_value(KEY_HOST)
 
 
-def get_active_host_url_without_api_subdir() -> Union[str, Missing]:
+def get_active_host_url_without_api_subdir(
+    *, skip_validation: bool = False
+) -> Union[str, Missing]:
     import re
-    from .config import ELAB_HOST_URL_API_SUFFIX
 
-    if (host := get_active_host()) != Missing():
+    if (host := get_active_host(skip_validation=skip_validation)) != Missing():
         return re.sub(
             ELAB_HOST_URL_API_SUFFIX,
             r"",
-            get_active_host(),
+            get_active_host(skip_validation=skip_validation),
             count=1,
             flags=re.IGNORECASE,
         )
     return host
 
 
-def get_active_api_token() -> APIToken:
-    from .config import KEY_API_TOKEN, MinimalActiveConfiguration
-
-    _run_validation_once()
+def get_active_api_token(*, skip_validation: bool = False) -> APIToken:
+    if not skip_validation:
+        _development_mode_validation_switch()
     return MinimalActiveConfiguration().get_value(KEY_API_TOKEN)
 
 
-def get_active_export_dir() -> Path:
-    from .config import KEY_EXPORT_DIR, MinimalActiveConfiguration
-
-    _run_validation_once()
+def get_active_export_dir(*, skip_validation: bool = False) -> Path:
+    if not skip_validation:
+        _development_mode_validation_switch()
     return MinimalActiveConfiguration().get_value(KEY_EXPORT_DIR)
 
 
-def get_active_unsafe_token_warning() -> bool:
-    from .config import KEY_UNSAFE_TOKEN_WARNING, MinimalActiveConfiguration
-
-    _run_validation_once()
+def get_active_unsafe_token_warning(*, skip_validation: bool = False) -> bool:
+    if not skip_validation:
+        _development_mode_validation_switch()
     return MinimalActiveConfiguration().get_value(KEY_UNSAFE_TOKEN_WARNING)
 
 
-def get_active_enable_http2() -> bool:
-    from .config import KEY_ENABLE_HTTP2, MinimalActiveConfiguration
-
-    _run_validation_once()
+def get_active_enable_http2(*, skip_validation: bool = False) -> bool:
+    if not skip_validation:
+        _development_mode_validation_switch()
     return MinimalActiveConfiguration().get_value(KEY_ENABLE_HTTP2)
 
 
-def get_active_verify_ssl() -> bool:
-    from .config import KEY_VERIFY_SSL, MinimalActiveConfiguration
-
-    _run_validation_once()
+def get_active_verify_ssl(*, skip_validation: bool = False) -> bool:
+    if not skip_validation:
+        _development_mode_validation_switch()
     return MinimalActiveConfiguration().get_value(KEY_VERIFY_SSL)
 
 
-def get_active_timeout() -> float:
-    from .config import KEY_TIMEOUT, MinimalActiveConfiguration
-
-    _run_validation_once()
+def get_active_timeout(*, skip_validation: bool = False) -> float:
+    if not skip_validation:
+        _development_mode_validation_switch()
     return MinimalActiveConfiguration().get_value(KEY_TIMEOUT)
 
 
-def get_development_mode() -> bool:
-    from .config import KEY_DEVELOPMENT_MODE, MinimalActiveConfiguration
+def _development_mode_validation_switch() -> None:
+    _value = MinimalActiveConfiguration().get_value(KEY_DEVELOPMENT_MODE)
+    if _value is False or _value == Missing():
+        reinitiate_config()
 
-    return MinimalActiveConfiguration().get_value(KEY_DEVELOPMENT_MODE)
 
+def get_development_mode(*, skip_validation: bool = False) -> bool:
+    if not skip_validation:
+        _development_mode_validation_switch()
+    return MinimalActiveConfiguration().get_value(KEY_DEVELOPMENT_MODE)
 
-def get_active_plugin_configs() -> dict:
-    from .config import KEY_PLUGIN_KEY_NAME, MinimalActiveConfiguration
 
-    _run_validation_once()
+def get_active_plugin_configs(*, skip_validation: bool = False) -> dict:
+    if not skip_validation:
+        _development_mode_validation_switch()
     return MinimalActiveConfiguration().get_value(KEY_PLUGIN_KEY_NAME)

src/elapi/core_validators/base.py

@@ -27,7 +27,7 @@ def __new__(cls, *args, **kwargs):
 
 class RuntimeValidationError(Exit, ValidationError):
     def __init__(self, *args) -> None:
-        super().__init__(*args or (1,))  # default error code is always 1
+        super().__init__(*args or (1,))  # the default error code is always 1
 
 
 class CriticalValidationError(Exit, ValidationError): ...

src/elapi/plugins/bill_teams/configuration.py

@@ -1,23 +1,26 @@
 from pathlib import Path
 
 from .names import CONFIG_PLUGIN_NAME, PLUGIN_LINK, CONFIG_KEY_ROOT_DIR
-from ...configuration import get_active_plugin_configs, CONFIG_FILE_NAME, ConfigurationValidation
+from ...configuration import (
+    get_active_plugin_configs,
+    CONFIG_FILE_NAME,
+    ConfigurationValidation,
+)
 from ...core_validators import Validator, Validate, CriticalValidationError
 from ...loggers import Logger
 from ...path import ProperPath
 
 logger = Logger()
 
-bill_teams_plugin_config: dict = get_active_plugin_configs().get(
-    CONFIG_PLUGIN_NAME, dict()
-)
-
 
 class RootDirConfigurationValidator(ConfigurationValidation, Validator):
     ALREADY_VALIDATED: bool = False
     __slots__ = ()
 
     def __init__(self):
+        bill_teams_plugin_config: dict = get_active_plugin_configs().get(
+            CONFIG_PLUGIN_NAME, dict()
+        )
         super().__init__(bill_teams_plugin_config)
 
     def validate(self) -> Path: