oe-python-template 0.10.1__tar.gz → 0.10.3__tar.gz

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.10.1
+Version: 0.10.3
 Summary: 🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling.
 Project-URL: Homepage, https://oe-python-template.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template.readthedocs.io/en/latest/

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.10.1"
+version = "0.10.3"
 description = "🧠 Copier template to scaffold Python projects compliant with best practices and modern tooling."
 readme = "README.md"
 authors = [{ name = "Helmut Hoffer von Ankershoffen", email = "helmuthva@gmail.com" }]
@@ -275,7 +275,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.10.1"
+current_version = "0.10.3"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/src/oe_python_template/hello/_service.py

@@ -23,7 +23,7 @@ class Service(BaseService):
 
     def __init__(self) -> None:
         """Initialize service."""
-        super().__init__(Settings)
+        super().__init__(Settings)  # automatically loads and validates the settings
 
     def info(self) -> dict[str, Any]:  # noqa: PLR6301
         """Determine info of this service.

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/src/oe_python_template/system/__init__.py

@@ -3,9 +3,11 @@
 from ._api import api_routers
 from ._cli import cli
 from ._service import Service
+from ._settings import Settings
 
 __all__ = [
     "Service",
+    "Settings",
     "api_routers",
     "cli",
 ]

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/src/oe_python_template/system/_api.py

@@ -7,7 +7,7 @@ The endpoints use Pydantic models for request and response validation.
 """
 
 from collections.abc import Callable, Generator
-from typing import Annotated
+from typing import Annotated, Any
 
 from fastapi import APIRouter, Depends, Response, status
 
@@ -41,11 +41,11 @@ def register_health_endpoint(router: APIRouter) -> Callable[..., Health]:
     """
 
     @router.get("/healthz")
-    @router.get("/health")
+    @router.get("/system/health")
     def health_endpoint(service: Annotated[Service, Depends(get_service)], response: Response) -> Health:
         """Determine aggregate health of the system.
 
-        The health is aggregated from all modules that make
+        The health is aggregated from all modules making
             up this system including external dependencies.
 
         The response is to be interpreted as follows:
@@ -71,8 +71,46 @@ def register_health_endpoint(router: APIRouter) -> Callable[..., Health]:
     return health_endpoint
 
 
+def register_info_endpoint(router: APIRouter) -> Callable[..., dict[str, Any]]:
+    """Register info endpoint to the given router.
+
+    Args:
+        router: The router to register the info endpoint to.
+
+    Returns:
+        Callable[..., Health]: The health endpoint function.
+    """
+
+    @router.get("/system/info")
+    def info_endpoint(
+        service: Annotated[Service, Depends(get_service)], response: Response, token: str
+    ) -> dict[str, Any]:
+        """Determine aggregate info of the system.
+
+        The info is aggregated from all modules making up this system.
+
+        If the token does not match the setting, a 403 Forbidden status code is returned.
+
+        Args:
+            service (Service): The service instance.
+            response (Response): The FastAPI response object.
+            token (str): Token to present.
+
+        Returns:
+            dict[str, Any]: The aggregate info of the system.
+        """
+        if service.is_token_valid(token):
+            return service.info(include_environ=True, filter_secrets=False)
+
+        response.status_code = status.HTTP_403_FORBIDDEN
+        return {"error": "Forbidden"}
+
+    return info_endpoint
+
+
 api_routers = {}
 for version in API_VERSIONS:
     router = VersionedAPIRouter(version, tags=["system"])
     api_routers[version] = router
     health = register_health_endpoint(api_routers[version])
+    info = register_info_endpoint(api_routers[version])

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/src/oe_python_template/system/_service.py

@@ -11,6 +11,7 @@ from typing import Any
 from pydantic_settings import BaseSettings
 
 from ..utils import (  # noqa: TID252
+    UNHIDE_SENSITIVE_INFO,
     BaseService,
     Health,
     __env__,
@@ -18,18 +19,24 @@ from ..utils import (  # noqa: TID252
     __project_path__,
     __repository_url__,
     __version__,
+    get_logger,
     get_process_info,
     load_settings,
     locate_subclasses,
 )
+from ._settings import Settings
+
+logger = get_logger(__name__)
 
 
 class Service(BaseService):
     """System service."""
 
+    _settings: Settings
+
     def __init__(self) -> None:
         """Initialize service."""
-        super().__init__()
+        super().__init__(Settings)
 
     @staticmethod
     def _is_healthy() -> bool:
@@ -60,6 +67,18 @@ class Service(BaseService):
         reason = None if self._is_healthy() else "System marked as unhealthy"
         return Health(status=status, components=components, reason=reason)
 
+    def is_token_valid(self, token: str) -> bool:
+        """Check if the presented token is valid.
+
+        Returns:
+            bool: True if the token is valid, False otherwise.
+        """
+        logger.info(token)
+        if not self._settings.token:
+            logger.warning("Token is not set in settings.")
+            return False
+        return token == self._settings.token.get_secret_value()
+
     @staticmethod
     def info(include_environ: bool = False, filter_secrets: bool = True) -> dict[str, Any]:
         """
@@ -126,7 +145,7 @@ class Service(BaseService):
         for settings_class in locate_subclasses(BaseSettings):
             settings_instance = load_settings(settings_class)
             env_prefix = settings_instance.model_config.get("env_prefix", "")
-            settings_dict = json.loads(settings_instance.model_dump_json())
+            settings_dict = settings_instance.model_dump(context={UNHIDE_SENSITIVE_INFO: not filter_secrets})
             for key, value in settings_dict.items():
                 flat_key = f"{env_prefix}{key}".upper()
                 settings[flat_key] = value

oe_python_template-0.10.3/src/oe_python_template/system/_settings.py

@@ -0,0 +1,31 @@
+"""Settings of the system module."""
+
+from typing import Annotated
+
+from pydantic import Field, PlainSerializer, SecretStr
+from pydantic_settings import SettingsConfigDict
+
+from ..utils import OpaqueSettings, __env_file__, __project_name__  # noqa: TID252
+
+
+class Settings(OpaqueSettings):
+    """Settings."""
+
+    model_config = SettingsConfigDict(
+        env_prefix=f"{__project_name__.upper()}_SYSTEM_",
+        extra="ignore",
+        env_file=__env_file__,
+        env_file_encoding="utf-8",
+    )
+
+    token: Annotated[
+        SecretStr | None,
+        PlainSerializer(func=OpaqueSettings.serialize_sensitive_info, return_type=str, when_used="always"),
+        Field(
+            description=(
+                "Secret token to present when performing sensitive operations such as "
+                "retrieving info via webservice API"
+            ),
+            default=None,
+        ),
+    ]

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/src/oe_python_template/utils/__init__.py

@@ -23,15 +23,17 @@ from ._logfire import LogfireSettings
 from ._process import ProcessInfo, get_process_info
 from ._sentry import SentrySettings
 from ._service import BaseService
-from ._settings import load_settings
+from ._settings import UNHIDE_SENSITIVE_INFO, OpaqueSettings, load_settings
 from .boot import boot
 
 __all__ = [
+    "UNHIDE_SENSITIVE_INFO",
     "BaseService",
     "Health",
     "LogSettings",
     "LogSettings",
     "LogfireSettings",
+    "OpaqueSettings",
     "ProcessInfo",
     "SentrySettings",
     "VersionedAPIRouter",

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/src/oe_python_template/utils/_constants.py

@@ -10,7 +10,7 @@ __project_path__ = str(Path(__file__).parent.parent.parent)
 __version__ = metadata.version(__project_name__)
 __is_development_mode__ = "uvx" not in sys.argv[0].lower()
 __is_running_in_container__ = os.getenv(f"{__project_name__.upper()}_RUNNING_IN_CONTAINER")
-__env__ = os.getenv("ENV", "local")
+__env__ = os.getenv("ENV", os.getenv("VERCEL_ENV", "local"))
 __env_file__ = [
     Path.home() / f".{__project_name__}" / ".env",
     Path.home() / f".{__project_name__}" / f".env.{__env__}",

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/src/oe_python_template/utils/_logfire.py

@@ -3,14 +3,14 @@
 from typing import Annotated
 
 import logfire
-from pydantic import Field, SecretStr
-from pydantic_settings import BaseSettings, SettingsConfigDict
+from pydantic import Field, PlainSerializer, SecretStr
+from pydantic_settings import SettingsConfigDict
 
 from ._constants import __env__, __env_file__, __project_name__, __repository_url__, __version__
-from ._settings import load_settings
+from ._settings import OpaqueSettings, load_settings
 
 
-class LogfireSettings(BaseSettings):
+class LogfireSettings(OpaqueSettings):
     """Configuration settings for Logfire integration."""
 
     model_config = SettingsConfigDict(
@@ -22,6 +22,7 @@ class LogfireSettings(BaseSettings):
 
     token: Annotated[
         SecretStr | None,
+        PlainSerializer(func=OpaqueSettings.serialize_sensitive_info, return_type=str, when_used="always"),
         Field(description="Logfire token. Leave empty to disable logfire.", examples=["YOUR_TOKEN"], default=None),
     ]
     instrument_system_metrics: Annotated[

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/src/oe_python_template/utils/_sentry.py

@@ -3,15 +3,15 @@
 from typing import Annotated
 
 import sentry_sdk
-from pydantic import Field, SecretStr
-from pydantic_settings import BaseSettings, SettingsConfigDict
+from pydantic import Field, PlainSerializer, SecretStr
+from pydantic_settings import SettingsConfigDict
 from sentry_sdk.integrations.typer import TyperIntegration
 
 from ._constants import __env__, __env_file__, __project_name__, __version__
-from ._settings import load_settings
+from ._settings import OpaqueSettings, load_settings
 
 
-class SentrySettings(BaseSettings):
+class SentrySettings(OpaqueSettings):
     """Configuration settings for Sentry integration."""
 
     model_config = SettingsConfigDict(
@@ -23,6 +23,7 @@ class SentrySettings(BaseSettings):
 
     dsn: Annotated[
         SecretStr | None,
+        PlainSerializer(func=OpaqueSettings.serialize_sensitive_info, return_type=str, when_used="always"),
         Field(description="Sentry DSN", examples=["https://SECRET@SECRET.ingest.de.sentry.io/SECRET"], default=None),
     ]
 

{oe_python_template-0.10.1 → oe_python_template-0.10.3}/src/oe_python_template/utils/_settings.py

@@ -6,7 +6,7 @@ import sys
 from pathlib import Path
 from typing import TypeVar
 
-from pydantic import ValidationError
+from pydantic import FieldSerializationInfo, SecretStr, ValidationError
 from pydantic_settings import BaseSettings
 from rich.panel import Panel
 from rich.text import Text
@@ -17,6 +17,18 @@ T = TypeVar("T", bound=BaseSettings)
 
 logger = logging.getLogger(__name__)
 
+UNHIDE_SENSITIVE_INFO = "unhide_sensitive_info"
+
+
+class OpaqueSettings(BaseSettings):
+    @staticmethod
+    def serialize_sensitive_info(input_value: SecretStr, info: FieldSerializationInfo) -> str | None:
+        if not input_value:
+            return None
+        if info.context.get(UNHIDE_SENSITIVE_INFO, False):  # type: ignore
+            return input_value.get_secret_value()
+        return str(input_value)
+
 
 def load_settings(settings_class: type[T]) -> T:
     """