oe-python-template 0.13.13__tar.gz → 0.13.15__tar.gz

{oe_python_template-0.13.13 → oe_python_template-0.13.15}/.gitignore

@@ -4,6 +4,7 @@
 .env
 .env.backup
 .env.bak
+.env.orig
 ENV/
 env/
 .envrc

{oe_python_template-0.13.13 → oe_python_template-0.13.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.13.13
+Version: 0.13.15
 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.13.13 → oe_python_template-0.13.15}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "oe-python-template"
-version = "0.13.13"
+version = "0.13.15"
 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" }]
@@ -279,7 +279,7 @@ source = ["src/"]
 
 
 [tool.bumpversion]
-current_version = "0.13.13"
+current_version = "0.13.15"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{oe_python_template-0.13.13 → oe_python_template-0.13.15}/src/oe_python_template/utils/_log.py

@@ -1,13 +1,15 @@
 """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
@@ -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():
+            message = f"File name {file_path.absolute()} is not a file"
+            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=False)
+            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,6 +91,7 @@ class LogSettings(BaseSettings):
     ]
     file_name: Annotated[
         str,
+        AfterValidator(_validate_file_name),
         Field(description="Name of the log file", default=f"{__project_name__}.log"),
     ]
     console_enabled: Annotated[

{oe_python_template-0.13.13 → oe_python_template-0.13.15}/src/oe_python_template/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),
     ]