oe-python-template-example 0.4.9__py3-none-any.whl → 0.4.10__py3-none-any.whl

oe_python_template_example/api.py

@@ -16,7 +16,7 @@ from .utils import (
     __base__url__,
     __documentation__url__,
     __repository_url__,
-    locate_implementations,
+    load_modules,
 )
 
 TITLE = "OE Python Template Example"
@@ -67,12 +67,13 @@ for version, semver in API_VERSIONS.items():
         terms_of_service=TERMS_OF_SERVICE_URL,
     )
 
-# Register routers with appropriate API versions
-for router in locate_implementations(VersionedAPIRouter):
-    router_instance: VersionedAPIRouter = router
-    version = router_instance.version
+load_modules()
+
+# Register routers with appropriate API versions using the tracked instances
+for router in VersionedAPIRouter.get_instances():
+    version = router.version  # type: ignore
     if version in API_VERSIONS:
-        api_instances[version].include_router(router_instance)
+        api_instances[version].include_router(router)  # type: ignore
 
 # Mount all API versions to the main app
 for version in API_VERSIONS:

oe_python_template_example/hello/_api.py

@@ -8,7 +8,7 @@ This module provides a webservice API with several operations:
 from collections.abc import Generator
 from typing import Annotated
 
-from fastapi import Depends
+from fastapi import APIRouter, Depends
 from pydantic import BaseModel, Field
 
 from oe_python_template_example.utils import VersionedAPIRouter
@@ -20,8 +20,8 @@ HELLO_WORLD_EXAMPLE = "Hello, world!"
 
 # VersionedAPIRouters exported by modules via their __init__.py are automatically registered
 # and injected into the main API app, see ../api.py.
-api_v1 = VersionedAPIRouter("v1", prefix="/hello", tags=["hello"])
-api_v2 = VersionedAPIRouter("v2", prefix="/hello", tags=["hello"])
+api_v1: APIRouter = VersionedAPIRouter("v1", prefix="/hello", tags=["hello"])  # type: ignore
+api_v2: APIRouter = VersionedAPIRouter("v2", prefix="/hello", tags=["hello"])  # type: ignore
 
 
 def get_service() -> Generator[Service, None, None]:

oe_python_template_example/hello/_gui.py

@@ -2,8 +2,6 @@
 
 from pathlib import Path
 
-from nicegui import ui
-
 from oe_python_template_example.utils import BasePageBuilder, GUILocalFilePicker
 
 from ._service import Service
@@ -11,13 +9,17 @@ from ._service import Service
 
 async def pick_file() -> None:
     """Open a file picker dialog and show notifier when closed again."""
-    result = await GUILocalFilePicker(str(Path.cwd() / "examples"), multiple=True)
+    from nicegui import ui  # noqa: PLC0415
+
+    result = await GUILocalFilePicker(str(Path.cwd() / "examples"), multiple=True)  # type: ignore
     ui.notify(f"You chose {result}")
 
 
 class PageBuilder(BasePageBuilder):
     @staticmethod
     def register_pages() -> None:
+        from nicegui import ui  # noqa: PLC0415
+
         @ui.page("/")
         def page_index() -> None:
             """Homepage of GUI."""

oe_python_template_example/system/_api.py

@@ -110,7 +110,7 @@ def register_info_endpoint(router: APIRouter) -> Callable[..., dict[str, Any]]:
 
 api_routers = {}
 for version in API_VERSIONS:
-    router = VersionedAPIRouter(version, tags=["system"])
+    router: APIRouter = VersionedAPIRouter(version, tags=["system"])  # type: ignore
     api_routers[version] = router
     health = register_health_endpoint(api_routers[version])
     info = register_info_endpoint(api_routers[version])

oe_python_template_example/system/_cli.py

@@ -194,7 +194,7 @@ def fail() -> None:
 
 @cli.command()
 def sleep(
-    seconds: Annotated[int, typer.Option(help="Duration in seconds")] = 10,
+    seconds: Annotated[int, typer.Option(help="Duration in seconds")] = 2,
 ) -> None:
     """Sleep given for given number of seconds.
 

oe_python_template_example/system/_gui.py

@@ -1,7 +1,5 @@
 """Homepage (index) of GUI."""
 
-from nicegui import ui
-
 from ..utils import BasePageBuilder, __project_name__, __version__  # noqa: TID252
 from ._service import Service
 
@@ -9,6 +7,8 @@ from ._service import Service
 class PageBuilder(BasePageBuilder):
     @staticmethod
     def register_pages() -> None:
+        from nicegui import ui  # noqa: PLC0415
+
         @ui.page("/info")
         def page_info() -> None:
             """Homepage of GUI."""

oe_python_template_example/utils/__init__.py

@@ -12,12 +12,13 @@ from ._constants import (
     __env_file__,
     __is_development_mode__,
     __is_running_in_container__,
+    __is_running_in_read_only_environment__,
     __project_name__,
     __project_path__,
     __repository_url__,
     __version__,
 )
-from ._di import locate_implementations, locate_subclasses
+from ._di import load_modules, locate_implementations, locate_subclasses
 from ._health import Health
 from ._log import LogSettings, get_logger
 from ._logfire import LogfireSettings
@@ -46,6 +47,7 @@ __all__ = [
     "__env_file__",
     "__is_development_mode__",
     "__is_running_in_container__",
+    "__is_running_in_read_only_environment__",
     "__project_name__",
     "__project_path__",
     "__repository_url__",
@@ -54,6 +56,7 @@ __all__ = [
     "console",
     "get_logger",
     "get_process_info",
+    "load_modules",
     "load_settings",
     "locate_implementations",
     "locate_subclasses",

oe_python_template_example/utils/_api.py

@@ -1,7 +1,9 @@
-from fastapi import APIRouter
+"""API router utilities for versioned FastAPI routers."""
 
+from typing import ClassVar
 
-class VersionedAPIRouter(APIRouter):
+
+class VersionedAPIRouter:
     """APIRouter with version attribute.
 
     - Use this class to create versioned routers for your FastAPI application
@@ -11,8 +13,53 @@ class VersionedAPIRouter(APIRouter):
     - See constants.por versions defined for this system.
     """
 
-    version: str
+    # Class variable to track all created instances
+    _instances: ClassVar[list["VersionedAPIRouter"]] = []
+
+    @classmethod
+    def get_instances(cls) -> list["VersionedAPIRouter"]:
+        """Get all created router instances.
+
+        Returns:
+            A list of all router instances created.
+        """
+        return cls._instances.copy()
+
+    def __new__(cls, version: str, *args, **kwargs) -> "VersionedAPIRouter":  # type: ignore[no-untyped-def]
+        """Create a new instance with lazy-loaded dependencies.
+
+        Args:
+            version: The API version this router belongs to.
+            *args: Arguments to pass to the FastAPI APIRouter.
+            **kwargs: Keyword arguments to pass to the FastAPI APIRouter.
+
+        Returns:
+            An instance of VersionedAPIRouter with lazy-loaded dependencies.
+        """
+        from fastapi import APIRouter  # Import only when creating an instance  # noqa: PLC0415
+
+        # Define the actual implementation class with the imports available
+        class VersionedAPIRouterImpl(APIRouter):
+            """Implementation of VersionedAPIRouter with lazy-loaded dependencies."""
+
+            version: str
+
+            def __init__(self, version: str, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]
+                """Initialize the router.
+
+                Args:
+                    version: The API version this router belongs to.
+                    *args: Arguments to pass to the FastAPI APIRouter.
+                    **kwargs: Keyword arguments to pass to the FastAPI APIRouter.
+                """
+                super().__init__(*args, **kwargs)
+                self.version = version
+
+        # Create an instance
+        instance = VersionedAPIRouterImpl(version, *args, **kwargs)
+
+        # Add to registry of instances
+        cls._instances.append(instance)  # type: ignore
 
-    def __init__(self, version: str, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]
-        super().__init__(*args, **kwargs)
-        self.version = version
+        # Return the instance but tell mypy it's a VersionedAPIRouter
+        return instance  # type: ignore[return-value]

oe_python_template_example/utils/_constants.py

@@ -15,6 +15,14 @@ __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")
 
+# Determine if we're running in a read-only runtime environment
+READ_ONLY_ENV_INDICATORS = [
+    f"{__project_name__.upper()}_RUNNING_IN_CONTAINER",
+    "VERCEL_ENV",
+    "RAILWAY_ENVIRONMENT",
+]
+__is_running_in_read_only_environment__ = any(os.getenv(env_var) is not None for env_var in READ_ONLY_ENV_INDICATORS)
+
 # Determine environment we are deployed on
 ENV_VAR_MAPPINGS = {
     "ENV": lambda env: env,

oe_python_template_example/utils/_di.py

@@ -11,6 +11,12 @@ _implementation_cache: dict[Any, list[Any]] = {}
 _subclass_cache: dict[Any, list[Any]] = {}
 
 
+def load_modules() -> None:
+    package = importlib.import_module(__project_name__)
+    for _, name, _ in pkgutil.iter_modules(package.__path__):
+        importlib.import_module(f"{__project_name__}.{name}")
+
+
 def locate_implementations(_class: type[Any]) -> list[Any]:
     """
     Dynamically discover all instances of some class.

oe_python_template_example/utils/_gui.py

@@ -3,9 +3,6 @@ from abc import ABC, abstractmethod
 from pathlib import Path
 from types import EllipsisType
 
-from nicegui import app, events, ui
-from nicegui import native as native_app
-
 from ._constants import __is_running_in_container__, __project_name__
 from ._di import locate_subclasses
 from ._log import get_logger
@@ -58,6 +55,9 @@ def gui_run(  # noqa: PLR0913, PLR0917
         ValueError: If with_notebook is True but notebook_path is None,
             or trying to run native within container.
     """
+    from nicegui import app, ui  # noqa: PLC0415
+    from nicegui import native as native_app  # noqa: PLC0415
+
     if __is_running_in_container__ and native:
         message = "Native GUI cannot be run in a container. Please run with uvx or in browser."
         raise ValueError(message)
@@ -81,98 +81,132 @@ def gui_run(  # noqa: PLR0913, PLR0917
     )
 
 
-class GUILocalFilePicker(ui.dialog):
-    def __init__(
-        self,
+class GUILocalFilePicker:
+    """Local File Picker dialog class that lazy-loads NiceGUI dependencies."""
+
+    def __new__(  # noqa: C901
+        cls,
         directory: str,
         *,
         upper_limit: str | EllipsisType | None = ...,
         multiple: bool = False,
         show_hidden_files: bool = False,
-    ) -> None:
-        """Local File Picker.
-
-        A simple file picker that allows selecting files from the local filesystem where NiceGUI is running.
+    ) -> "GUILocalFilePicker":
+        """Create a new instance with lazy-loaded dependencies.
 
         Args:
             directory: The directory to start in.
             upper_limit: The directory to stop at. None for no limit, default is same as starting directory.
             multiple: Whether to allow multiple files to be selected.
             show_hidden_files: Whether to show hidden files.
+
+        Returns:
+            An instance of the dialog with lazy-loaded dependencies.
         """
-        super().__init__()
-
-        self.path = Path(directory).expanduser()
-        if upper_limit is None:
-            self.upper_limit = None
-        elif upper_limit is ...:
-            self.upper_limit = Path(directory).expanduser()
-        else:
-            self.upper_limit = Path(upper_limit).expanduser()
-        self.show_hidden_files = show_hidden_files
-
-        with self, ui.card():
-            self.add_drives_toggle()
-            self.grid = (
-                ui.aggrid(
+        from nicegui import events, ui  # noqa: PLC0415
+        # Lazy import ui only when actually creating an instance
+
+        # Define the actual implementation class with the imports available
+        class GUILocalFilePickerImpl(ui.dialog):
+            def __init__(
+                self,
+                directory: str,
+                *,
+                upper_limit: str | EllipsisType | None = ...,
+                multiple: bool = False,
+                show_hidden_files: bool = False,
+            ) -> None:
+                """Local File Picker.
+
+                A simple file picker that allows selecting files from the local filesystem where NiceGUI is running.
+
+                Args:
+                    directory: The directory to start in.
+                    upper_limit: The directory to stop at. None for no limit, default is same as starting directory.
+                    multiple: Whether to allow multiple files to be selected.
+                    show_hidden_files: Whether to show hidden files.
+                """
+                super().__init__()
+
+                self.path = Path(directory).expanduser()
+                if upper_limit is None:
+                    self.upper_limit = None
+                elif upper_limit is ...:
+                    self.upper_limit = Path(directory).expanduser()
+                else:
+                    self.upper_limit = Path(upper_limit).expanduser()
+                self.show_hidden_files = show_hidden_files
+
+                with self, ui.card():
+                    self.add_drives_toggle()
+                    self.grid = (
+                        ui.aggrid(
+                            {
+                                "columnDefs": [{"field": "name", "headerName": "File"}],
+                                "rowSelection": "multiple" if multiple else "single",
+                            },
+                            html_columns=[0],
+                        )
+                        .classes("w-96")
+                        .on("cellDoubleClicked", self.handle_double_click)
+                    )
+                    with ui.row().classes("w-full justify-end"):
+                        ui.button("Cancel", on_click=self.close).props("outline").mark("BUTTON_CANCEL")
+                        ui.button("Ok", on_click=self._handle_ok).mark("BUTTON_OK")
+                self.update_grid()
+
+            def add_drives_toggle(self) -> None:
+                if platform.system() == "Windows":
+                    import win32api  # noqa: PLC0415
+
+                    drives = win32api.GetLogicalDriveStrings().split("\000")[:-1]
+                    self.drives_toggle = ui.toggle(drives, value=drives[0], on_change=self.update_drive)
+
+            def update_drive(self) -> None:
+                self.path = Path(self.drives_toggle.value).expanduser()
+                self.update_grid()
+
+            def update_grid(self) -> None:
+                paths = list(self.path.glob("*"))
+                if not self.show_hidden_files:
+                    paths = [p for p in paths if not p.name.startswith(".")]
+                paths.sort(key=lambda p: p.name.lower())
+                paths.sort(key=lambda p: not p.is_dir())
+
+                self.grid.options["rowData"] = [
                     {
-                        "columnDefs": [{"field": "name", "headerName": "File"}],
-                        "rowSelection": "multiple" if multiple else "single",
-                    },
-                    html_columns=[0],
-                )
-                .classes("w-96")
-                .on("cellDoubleClicked", self.handle_double_click)
-            )
-            with ui.row().classes("w-full justify-end"):
-                ui.button("Cancel", on_click=self.close).props("outline").mark("BUTTON_CANCEL")
-                ui.button("Ok", on_click=self._handle_ok).mark("BUTTON_OK")
-        self.update_grid()
-
-    def add_drives_toggle(self) -> None:
-        if platform.system() == "Windows":
-            import win32api  # noqa: PLC0415
-
-            drives = win32api.GetLogicalDriveStrings().split("\000")[:-1]
-            self.drives_toggle = ui.toggle(drives, value=drives[0], on_change=self.update_drive)
-
-    def update_drive(self) -> None:
-        self.path = Path(self.drives_toggle.value).expanduser()
-        self.update_grid()
-
-    def update_grid(self) -> None:
-        paths = list(self.path.glob("*"))
-        if not self.show_hidden_files:
-            paths = [p for p in paths if not p.name.startswith(".")]
-        paths.sort(key=lambda p: p.name.lower())
-        paths.sort(key=lambda p: not p.is_dir())
-
-        self.grid.options["rowData"] = [
-            {
-                "name": f"📁 <strong>{p.name}</strong>" if p.is_dir() else p.name,
-                "path": str(p),
-            }
-            for p in paths
-        ]
-        if (self.upper_limit is None and self.path != self.path.parent) or (
-            self.upper_limit is not None and self.path != self.upper_limit
-        ):
-            self.grid.options["rowData"].insert(
-                0,
-                {
-                    "name": "📁 <strong>..</strong>",
-                    "path": str(self.path.parent),
-                },
-            )
-        self.grid.update()
-
-    def handle_double_click(self, e: events.GenericEventArguments) -> None:
-        self.path = Path(e.args["data"]["path"])
-        if self.path.is_dir():
-            self.update_grid()
-        else:
-            self.submit([str(self.path)])
-
-    async def _handle_ok(self) -> None:
-        rows = await self.grid.get_selected_rows()
-        self.submit([r["path"] for r in rows])
+                        "name": f"📁 <strong>{p.name}</strong>" if p.is_dir() else p.name,
+                        "path": str(p),
+                    }
+                    for p in paths
+                ]
+                if (self.upper_limit is None and self.path != self.path.parent) or (
+                    self.upper_limit is not None and self.path != self.upper_limit
+                ):
+                    self.grid.options["rowData"].insert(
+                        0,
+                        {
+                            "name": "📁 <strong>..</strong>",
+                            "path": str(self.path.parent),
+                        },
+                    )
+                self.grid.update()
+
+            def handle_double_click(self, e: events.GenericEventArguments) -> None:
+                self.path = Path(e.args["data"]["path"])
+                if self.path.is_dir():
+                    self.update_grid()
+                else:
+                    self.submit([str(self.path)])
+
+            async def _handle_ok(self) -> None:
+                rows = await self.grid.get_selected_rows()
+                self.submit([r["path"] for r in rows])
+
+        # Create and return an instance but tell mypy it's a GUILocalFilePicker
+        return GUILocalFilePickerImpl(  # type: ignore[return-value]
+            directory=directory,
+            upper_limit=upper_limit,
+            multiple=multiple,
+            show_hidden_files=show_hidden_files,
+        )

oe_python_template_example/utils/_log.py

@@ -1,18 +1,20 @@
 """Logging configuration and utilities."""
 
 import logging as python_logging
+import os
 import typing as t
 from logging import FileHandler
+from pathlib import Path
 from typing import Annotated, Literal
 
 import click
 import logfire
-from pydantic import Field
+from pydantic import AfterValidator, Field
 from pydantic_settings import BaseSettings, SettingsConfigDict
 from rich.console import Console
 from rich.logging import RichHandler
 
-from ._constants import __env_file__, __project_name__
+from ._constants import __env_file__, __is_running_in_read_only_environment__, __project_name__
 from ._settings import load_settings
 
 
@@ -31,6 +33,44 @@ def get_logger(name: str | None) -> python_logging.Logger:
     return python_logging.getLogger(f"{__project_name__}.{name}")
 
 
+def _validate_file_name(file_name: str | None) -> str | None:
+    """Validate the file_name is valid and the file writeable.
+
+    - Checks file_name does not yet exist or is a file
+    - If not yet existing, checks it can be created
+    - If existing file, checks file is writeable
+
+    Args:
+        file_name: The file name of the log file
+
+    Returns:
+        str | None: The validated file name
+
+    Raises:
+        ValueError: If file name is not valid or the file not writeable
+    """
+    if file_name is None:
+        return file_name
+
+    file_path = Path(file_name)
+    if file_path.exists():
+        if not file_path.is_file() and not file_path.is_symlink():
+            message = f"File name {file_path.absolute()} is not a file or symlink"
+            raise ValueError(message)
+        if not os.access(file_path, os.W_OK):
+            message = f"File {file_path.absolute()} is not writable"
+            raise ValueError(message)
+    else:
+        try:
+            file_path.touch(exist_ok=True)
+            file_path.unlink()
+        except OSError as e:
+            message = f"File {file_path.absolute()} cannot be created: {e}"
+            raise ValueError(message) from e
+
+    return file_name
+
+
 class LogSettings(BaseSettings):
     """Settings for configuring logging behavior."""
 
@@ -51,7 +91,11 @@ class LogSettings(BaseSettings):
     ]
     file_name: Annotated[
         str,
-        Field(description="Name of the log file", default=f"{__project_name__}.log"),
+        AfterValidator(_validate_file_name),
+        Field(
+            description="Name of the log file",
+            default="/dev/stdout" if __is_running_in_read_only_environment__ else f"{__project_name__}.log",
+        ),
     ]
     console_enabled: Annotated[
         bool,

oe_python_template_example/utils/_notebook.py

@@ -1,9 +1,7 @@
-"""System service."""
+"""Notebook server utilities."""
 
 from collections.abc import Callable
-
-import marimo
-from fastapi import APIRouter, FastAPI
+from typing import Any
 
 from ..constants import NOTEBOOK_APP, NOTEBOOK_FOLDER  # noqa: TID252
 from ._health import Health
@@ -12,7 +10,7 @@ from ._log import get_logger
 logger = get_logger(__name__)
 
 
-def register_health_endpoint(router: APIRouter) -> Callable[..., Health]:
+def register_health_endpoint(router: Any) -> Callable[..., Health]:  # noqa: ANN401
     """Register health endpoint to the given router.
 
     Args:
@@ -21,6 +19,7 @@ def register_health_endpoint(router: APIRouter) -> Callable[..., Health]:
     Returns:
         Callable[..., Health]: The health endpoint function.
     """
+    # We accept 'Any' instead of APIRouter to avoid importing fastapi at module level
 
     @router.get("/healthz")
     def health_endpoint() -> Health:
@@ -31,10 +30,12 @@ def register_health_endpoint(router: APIRouter) -> Callable[..., Health]:
         """
         return Health(status=Health.Code.UP)
 
-    return health_endpoint
+    # Explicitly type the return value to satisfy mypy
+    result: Callable[..., Health] = health_endpoint
+    return result
 
 
-def create_marimo_app() -> FastAPI:
+def create_marimo_app() -> Any:  # noqa: ANN401
     """Create a FastAPI app with marimo notebook server.
 
     Returns:
@@ -43,6 +44,10 @@ def create_marimo_app() -> FastAPI:
     Raises:
         ValueError: If the notebook directory does not exist.
     """
+    # Import dependencies only when function is called
+    import marimo  # noqa: PLC0415
+    from fastapi import APIRouter, FastAPI  # noqa: PLC0415
+
     server = marimo.create_asgi_app(include_code=True)
     if not NOTEBOOK_FOLDER.is_dir():
         logger.critical(

oe_python_template_example/utils/_sentry.py

@@ -1,15 +1,115 @@
 """Sentry integration for application monitoring."""
 
+import re
+import urllib.parse
 from typing import Annotated
 
 import sentry_sdk
-from pydantic import BeforeValidator, Field, PlainSerializer, SecretStr
+from pydantic import AfterValidator, BeforeValidator, 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 OpaqueSettings, load_settings, strip_to_none_before_validator
 
+_ERR_MSG_MISSING_SCHEME = "Sentry DSN is missing URL scheme (protocol)"
+_ERR_MSG_MISSING_NETLOC = "Sentry DSN is missing network location (domain)"
+_ERR_MSG_NON_HTTPS = "Sentry DSN must use HTTPS protocol for security"
+_ERR_MSG_INVALID_DOMAIN = "Sentry DSN must use a valid Sentry domain (ingest.us.sentry.io or ingest.de.sentry.io)"
+_ERR_MSG_INVALID_FORMAT = "Invalid Sentry DSN format"
+_VALID_SENTRY_DOMAIN_PATTERN = r"^[a-f0-9]+@o\d+\.ingest\.(us|de)\.sentry\.io$"
+
+
+def _validate_url_scheme(parsed_url: urllib.parse.ParseResult) -> None:
+    """Validate that the URL has a scheme.
+
+    Args:
+        parsed_url: The parsed URL to validate
+
+    Raises:
+        ValueError: If URL is missing scheme
+    """
+    if not parsed_url.scheme:
+        raise ValueError(_ERR_MSG_MISSING_SCHEME)
+
+
+def _validate_url_netloc(parsed_url: urllib.parse.ParseResult) -> None:
+    """Validate that the URL has a network location.
+
+    Args:
+        parsed_url: The parsed URL to validate
+
+    Raises:
+        ValueError: If URL is missing network location
+    """
+    if not parsed_url.netloc:
+        raise ValueError(_ERR_MSG_MISSING_NETLOC)
+
+
+def _validate_https_scheme(parsed_url: urllib.parse.ParseResult) -> None:
+    """Validate that the URL uses HTTPS scheme.
+
+    Args:
+        parsed_url: The parsed URL to validate
+
+    Raises:
+        ValueError: If URL doesn't use HTTPS scheme
+    """
+    if parsed_url.scheme != "https":
+        raise ValueError(_ERR_MSG_NON_HTTPS)
+
+
+def _validate_sentry_domain(netloc_with_auth: str) -> None:
+    """Validate that the URL uses a valid Sentry domain.
+
+    Args:
+        netloc_with_auth: The network location with auth part
+
+    Raises:
+        ValueError: If URL doesn't use a valid Sentry domain
+    """
+    if "@" not in netloc_with_auth:
+        raise ValueError(_ERR_MSG_INVALID_DOMAIN)
+
+    user_pass, domain = netloc_with_auth.split("@", 1)
+    full_auth = f"{user_pass}@{domain}"
+    if not re.match(_VALID_SENTRY_DOMAIN_PATTERN, full_auth):
+        raise ValueError(_ERR_MSG_INVALID_DOMAIN)
+
+
+def _validate_https_dsn(value: SecretStr | None) -> SecretStr | None:
+    """Validate that the Sentry DSN is a valid HTTPS URL.
+
+    Args:
+        value: The DSN value to validate
+
+    Returns:
+        SecretStr | None: The validated DSN value
+
+    Raises:
+        ValueError: If DSN isn't a valid HTTPS URL with specific error details
+    """
+    if value is None:
+        return value
+
+    dsn = value.get_secret_value()
+    try:
+        parsed_url = urllib.parse.urlparse(dsn)
+
+        # Call validation functions outside of the try block
+        _validate_url_scheme(parsed_url)
+        _validate_url_netloc(parsed_url)
+        _validate_https_scheme(parsed_url)
+        _validate_sentry_domain(parsed_url.netloc)
+
+    except ValueError as exc:
+        raise exc from None
+    except Exception as exc:
+        error_message = _ERR_MSG_INVALID_FORMAT
+        raise ValueError(error_message) from exc
+
+    return value
+
 
 class SentrySettings(OpaqueSettings):
     """Configuration settings for Sentry integration."""
@@ -24,6 +124,7 @@ class SentrySettings(OpaqueSettings):
     dsn: Annotated[
         SecretStr | None,
         BeforeValidator(strip_to_none_before_validator),
+        AfterValidator(_validate_https_dsn),
         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_example-0.4.9.dist-info → oe_python_template_example-0.4.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template-example
-Version: 0.4.9
+Version: 0.4.10
 Summary: 🧠 Example project scaffolded and kept up to date with OE Python Template (oe-python-template).
 Project-URL: Homepage, https://oe-python-template-example.readthedocs.io/en/latest/
 Project-URL: Documentation, https://oe-python-template-example.readthedocs.io/en/latest/

{oe_python_template_example-0.4.9.dist-info → oe_python_template_example-0.4.10.dist-info}/RECORD

@@ -1,40 +1,40 @@
 oe_python_template_example/__init__.py,sha256=_Z3Xb-x95UODU66avOiwROVaouk_s0ZNB25KFnPoS40,226
-oe_python_template_example/api.py,sha256=gwUAW_pWUABFtAAiuIg3-X-dG25m1l0rqpnMqlaGEJo,2206
+oe_python_template_example/api.py,sha256=4Rja-8Zu_rHxsIVcSbgb5R1wsbWNku9K1afuoKULx2M,2197
 oe_python_template_example/cli.py,sha256=hZUPTuuUkIOpgTN6dP3nUh7gflxe6pdY2trruq3Eqhs,1709
 oe_python_template_example/constants.py,sha256=eRFVkR2qwafucpx5ppJSohr5wpSRm4yh1deLpOTep9A,346
 oe_python_template_example/hello/__init__.py,sha256=F7aJ_uhTPPnFLT_4GjI2GzjAmKrUhfe4KxqzrljuCVo,485
-oe_python_template_example/hello/_api.py,sha256=B4gCojmEkvh-ScKPz0rXW70r4gVvg7SX2dfbZpUd2vU,2302
+oe_python_template_example/hello/_api.py,sha256=0woWJedvP1-PyXJruQITp4_mO37Viqiq8jTDaXqxVVo,2367
 oe_python_template_example/hello/_cli.py,sha256=D1RZyz8sk7wpH1a9VDx1QtsNorOr9owxK8N7SxaaMWM,1200
 oe_python_template_example/hello/_constants.py,sha256=6aRleAIcdgC13TeTzI07YwjoSwqGb2g131dw8aEoM4I,109
-oe_python_template_example/hello/_gui.py,sha256=cYzag6lLD-zQGgTBcgXRDfbuxjtF927OVrvLAcFfpHs,1470
+oe_python_template_example/hello/_gui.py,sha256=l3b7dHEezyOZPNnBPRCjSlCfkGi1HcYCuPElBfDY5GQ,1556
 oe_python_template_example/hello/_models.py,sha256=JtI7wGT72u23NOxFa-oeWzdyiMg7PnHL5eg22im2_yQ,574
 oe_python_template_example/hello/_service.py,sha256=o9sgk-yFX5zRi06sAOdSPqkgT93naxn-JRknwK2Nnvs,3183
 oe_python_template_example/hello/_settings.py,sha256=Q14SqSvBJYFuofA-tbvBwO30sVygSaXsgaYC7x1uCfo,1562
 oe_python_template_example/system/__init__.py,sha256=7e2z8HATzy3dAIBXy5PM9rlCC7Rbu8m8NapROdrf3Wk,624
-oe_python_template_example/system/_api.py,sha256=rE9Aau3IIHXdEkOBUXOwJ7SxN3cZpgtYEuojnSWfT_4,3687
-oe_python_template_example/system/_cli.py,sha256=D19TuXtGGmxzQ-VkmCD7fmuqKQ5TQoJq9O0VzJKvWVE,6960
-oe_python_template_example/system/_gui.py,sha256=uKI-tlBSJXMaxY79wgdYtMttEyu8BLQC1UQLEPOcoZg,653
+oe_python_template_example/system/_api.py,sha256=pBBCL1gXM7W5dgJqBLKuNFWES0pQF8mbUgQ7H7oHwh8,3714
+oe_python_template_example/system/_cli.py,sha256=0cGwSicK0j7P53SMm9nSyQqj0WYpHKvFvkISCcjeTPU,6959
+oe_python_template_example/system/_gui.py,sha256=9U4QMkl1mVJargg_gQ7U8tMlvec4b1cqkTgRcmmyTTc,678
 oe_python_template_example/system/_service.py,sha256=f-EtWEAanajo4S2KeGm26K9_RezYgPza1qVqPRBOFvY,6376
 oe_python_template_example/system/_settings.py,sha256=MwMAJYifJ6jGImeSh4e9shmIXmiUSuQGHXz_Ts0mSdk,901
-oe_python_template_example/utils/__init__.py,sha256=ggcc7xvH6MJ3kP45lfjmp8yZSPDTeQRaQYbZbG0M7yM,1924
-oe_python_template_example/utils/_api.py,sha256=w3hPQK1pL2gBI4_1qNWNa2b4S_oH-8mY-ckRX0KrCWM,617
+oe_python_template_example/utils/__init__.py,sha256=oM8v1ozMOeBQG-EbBtEGbnuGk52mYNDAmNoR7vNQ7MY,2050
+oe_python_template_example/utils/_api.py,sha256=GSI-HPtSdTFv0qP5aTDPa2WS3ewVa1slusG6dvxSu0Y,2474
 oe_python_template_example/utils/_cli.py,sha256=J_mFtXZ1gGeovGrE5i3wlokTOBfiTTKEz5magiRP7GA,2091
 oe_python_template_example/utils/_console.py,sha256=u0-utcdRmVu4rabrYUyNOx8yPxLhxB3E92m22kSCwPQ,293
-oe_python_template_example/utils/_constants.py,sha256=FRe5ZNaBwpBPwOHZVWYOlI-ijamfzdBVr8gl7gHMGT0,2932
-oe_python_template_example/utils/_di.py,sha256=KdjiD4xZ_QSfbddkKWwsPJmG5YrIg6dzuBrlsd-FhxA,2189
-oe_python_template_example/utils/_gui.py,sha256=PmMTSmUOxbf6pmYCIgKrK5wNheh35aGd90I12y3L7Uc,5720
+oe_python_template_example/utils/_constants.py,sha256=fPS1leVqg7NRo_FFE3Xs3QI7un5_YRrY8cKQAfThwgg,3247
+oe_python_template_example/utils/_di.py,sha256=J1-f6xtbnR88VfRAsRMl5m6eqt-Lf3c7ABSJOxNzlvU,2399
+oe_python_template_example/utils/_gui.py,sha256=mm7-PFPZsVAYISENM91ezlefs_Ax5dEOPzT7-u5xQe0,7749
 oe_python_template_example/utils/_health.py,sha256=35QOWe2r5InrEpGtuVMym9dI5aRHS0HWf4BHBRAUIj0,4102
-oe_python_template_example/utils/_log.py,sha256=ZW4gs540SdjVK-2KeheLfDY15d_3xpO5FyGn7wTXyaM,3592
+oe_python_template_example/utils/_log.py,sha256=9aalm3FzkIgx38Em4a49m5SrXvg0DiTzodTPTICUNuc,5042
 oe_python_template_example/utils/_logfire.py,sha256=wZYNVowQx7kh3XJoJ59FjUKdrta7tp6cXOJRUT6lDU8,2128
-oe_python_template_example/utils/_notebook.py,sha256=oBQw9IBcXjuhzd1ECfOEPN4WJHGOm9xiPtrs11GtWG4,1777
+oe_python_template_example/utils/_notebook.py,sha256=IZOQTRKVV5htwXZIpZIZbAAOo86NK1L8vYkg1o7HW1Q,2114
 oe_python_template_example/utils/_process.py,sha256=40R0NZMqJUn0iUPERzohSUpJgU1HcJApIg1HipIxFCw,941
-oe_python_template_example/utils/_sentry.py,sha256=2sXrDSZSYoDEM87v7CakJ6eGBtcIhDI48PsQCLwOHgg,3319
+oe_python_template_example/utils/_sentry.py,sha256=6SZknbGBpdZHYUpF-11qk6UYBM-c79U8D9sF4517kdU,6369
 oe_python_template_example/utils/_service.py,sha256=atHAejvBucKXjzhsMSdOBBFa7rRD74zcV70Pp0pl0Tg,1038
 oe_python_template_example/utils/_settings.py,sha256=owFoaHEzJnVD3EVyOWF4rfIY7g6eLnU6rN0m4VHhCbA,2464
 oe_python_template_example/utils/boot.py,sha256=Qgq1sjT8d3fcfibnMyx5CVUJ_KKXgFI3ozZUIJbhh4I,2921
 oe_python_template_example/utils/.vendored/bottle.py,sha256=kZAZmh3nRzCUf-9IKGpv0yqlMciZMA_DNaaMDdcQmt0,175437
-oe_python_template_example-0.4.9.dist-info/METADATA,sha256=PjMZgt6PGQaKG4xrZy7iHacjvWmDaNoiYol3lLoagIk,26186
-oe_python_template_example-0.4.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template_example-0.4.9.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
-oe_python_template_example-0.4.9.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template_example-0.4.9.dist-info/RECORD,,
+oe_python_template_example-0.4.10.dist-info/METADATA,sha256=Ip4GIwCvMfKzi4c1P7QcYAmvjaCqDbd7dH049AARTWE,26187
+oe_python_template_example-0.4.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template_example-0.4.10.dist-info/entry_points.txt,sha256=S2eCPB45b1Wgj_GsDRFAN-e4h7dBA5UPxT8od98erDE,82
+oe_python_template_example-0.4.10.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template_example-0.4.10.dist-info/RECORD,,