oe-python-template 0.13.14__py3-none-any.whl → 0.13.16__py3-none-any.whl

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/utils/_sentry.py

@@ -77,7 +77,7 @@ def _validate_sentry_domain(netloc_with_auth: str) -> None:
         raise ValueError(_ERR_MSG_INVALID_DOMAIN)
 
 
-def validate_https_dsn(value: SecretStr | None) -> SecretStr | None:
+def _validate_https_dsn(value: SecretStr | None) -> SecretStr | None:
     """Validate that the Sentry DSN is a valid HTTPS URL.
 
     Args:
@@ -124,7 +124,7 @@ class SentrySettings(OpaqueSettings):
     dsn: Annotated[
         SecretStr | None,
         BeforeValidator(strip_to_none_before_validator),
-        AfterValidator(validate_https_dsn),
+        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-0.13.14.dist-info → oe_python_template-0.13.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oe-python-template
-Version: 0.13.14
+Version: 0.13.16
 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.14.dist-info → oe_python_template-0.13.16.dist-info}/RECORD

@@ -24,17 +24,17 @@ oe_python_template/utils/_constants.py,sha256=FRe5ZNaBwpBPwOHZVWYOlI-ijamfzdBVr8
 oe_python_template/utils/_di.py,sha256=KdjiD4xZ_QSfbddkKWwsPJmG5YrIg6dzuBrlsd-FhxA,2189
 oe_python_template/utils/_gui.py,sha256=PmMTSmUOxbf6pmYCIgKrK5wNheh35aGd90I12y3L7Uc,5720
 oe_python_template/utils/_health.py,sha256=35QOWe2r5InrEpGtuVMym9dI5aRHS0HWf4BHBRAUIj0,4102
-oe_python_template/utils/_log.py,sha256=ZW4gs540SdjVK-2KeheLfDY15d_3xpO5FyGn7wTXyaM,3592
+oe_python_template/utils/_log.py,sha256=5tMW1xY_FlpPEfZNeaTCdngBF3FKp8VWmQatt4_7RFU,4863
 oe_python_template/utils/_logfire.py,sha256=wZYNVowQx7kh3XJoJ59FjUKdrta7tp6cXOJRUT6lDU8,2128
 oe_python_template/utils/_notebook.py,sha256=oBQw9IBcXjuhzd1ECfOEPN4WJHGOm9xiPtrs11GtWG4,1777
 oe_python_template/utils/_process.py,sha256=40R0NZMqJUn0iUPERzohSUpJgU1HcJApIg1HipIxFCw,941
-oe_python_template/utils/_sentry.py,sha256=7nONiWZP0hWX0QAEPcg7No3FF1BF4S-Sl0wgG7xLw8g,6367
+oe_python_template/utils/_sentry.py,sha256=6SZknbGBpdZHYUpF-11qk6UYBM-c79U8D9sF4517kdU,6369
 oe_python_template/utils/_service.py,sha256=atHAejvBucKXjzhsMSdOBBFa7rRD74zcV70Pp0pl0Tg,1038
 oe_python_template/utils/_settings.py,sha256=owFoaHEzJnVD3EVyOWF4rfIY7g6eLnU6rN0m4VHhCbA,2464
 oe_python_template/utils/boot.py,sha256=Qgq1sjT8d3fcfibnMyx5CVUJ_KKXgFI3ozZUIJbhh4I,2921
 oe_python_template/utils/.vendored/bottle.py,sha256=kZAZmh3nRzCUf-9IKGpv0yqlMciZMA_DNaaMDdcQmt0,175437
-oe_python_template-0.13.14.dist-info/METADATA,sha256=535E3ddxUlLQusQdLrJGP0NyadIxqL-_H8v7p_NVYgk,34476
-oe_python_template-0.13.14.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-oe_python_template-0.13.14.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
-oe_python_template-0.13.14.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
-oe_python_template-0.13.14.dist-info/RECORD,,
+oe_python_template-0.13.16.dist-info/METADATA,sha256=zqRR7YIXUY-XV10xXh4MvmdN2SFKaPGJNmcuvsyDAuo,34476
+oe_python_template-0.13.16.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+oe_python_template-0.13.16.dist-info/entry_points.txt,sha256=IroSSWhLGxus9rxcashkYQda39TTvf7LbUMYtOKXUBE,66
+oe_python_template-0.13.16.dist-info/licenses/LICENSE,sha256=5H409K6xzz9U5eUaoAHQExNkoWJRlU0LEj6wL2QJ34s,1113
+oe_python_template-0.13.16.dist-info/RECORD,,