voltwire-fastapi-logging 0.0.1__tar.gz

voltwire_fastapi_logging-0.0.1/.gitignore

@@ -0,0 +1,221 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Local tool state
+.omc/

voltwire_fastapi_logging-0.0.1/PKG-INFO

@@ -0,0 +1,40 @@
+Metadata-Version: 2.5
+Name: voltwire-fastapi-logging
+Version: 0.0.1
+Summary: Logging utilities for FastAPI apps
+Author-email: Hermann Steidel <hsteidel.software@gmail.com>
+License-Expression: MIT
+Requires-Python: <4.0,>=3.13
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: starlette>=0.27.0
+Description-Content-Type: text/markdown
+
+<img src="https://raw.githubusercontent.com/hsteidel/voltwire/main/assets/icons/fastapi-logging.svg" alt="" width="56" height="56" align="left">
+
+# voltwire-fastapi-logging
+
+Logging utilities for FastAPI apps: request-context-enriching middleware.
+
+## Installation
+
+```bash
+pip install voltwire-fastapi-logging
+```
+
+## Quickstart
+
+```python
+from voltwire.fastapi.logging import setup_logging, DefaultLogSettings
+
+setup_logging(DefaultLogSettings(enable_json=False, level="INFO"))
+```
+
+Add `LoggingContextMiddleware` to enrich every log entry within a request with a correlation
+ID, method, and path:
+
+```python
+from voltwire.fastapi.logging import LoggingContextMiddleware, DefaultLoggingMiddlewareSettings
+
+app.add_middleware(LoggingContextMiddleware, settings=DefaultLoggingMiddlewareSettings())
+```

voltwire_fastapi_logging-0.0.1/README.md

@@ -0,0 +1,28 @@
+<img src="https://raw.githubusercontent.com/hsteidel/voltwire/main/assets/icons/fastapi-logging.svg" alt="" width="56" height="56" align="left">
+
+# voltwire-fastapi-logging
+
+Logging utilities for FastAPI apps: request-context-enriching middleware.
+
+## Installation
+
+```bash
+pip install voltwire-fastapi-logging
+```
+
+## Quickstart
+
+```python
+from voltwire.fastapi.logging import setup_logging, DefaultLogSettings
+
+setup_logging(DefaultLogSettings(enable_json=False, level="INFO"))
+```
+
+Add `LoggingContextMiddleware` to enrich every log entry within a request with a correlation
+ID, method, and path:
+
+```python
+from voltwire.fastapi.logging import LoggingContextMiddleware, DefaultLoggingMiddlewareSettings
+
+app.add_middleware(LoggingContextMiddleware, settings=DefaultLoggingMiddlewareSettings())
+```

voltwire_fastapi_logging-0.0.1/pyproject.toml

@@ -0,0 +1,23 @@
+[project]
+name = "voltwire-fastapi-logging"
+version = "0.0.1"
+description = "Logging utilities for FastAPI apps"
+authors = [{name = "Hermann Steidel", email = "hsteidel.software@gmail.com"}]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.13,<4.0"
+dependencies = [
+    "pydantic>=2.0.0",
+    "loguru>=0.7.0",
+    "starlette>=0.27.0",
+]
+
+[dependency-groups]
+dev = ["pytest>=8.0"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/voltwire"]

voltwire_fastapi_logging-0.0.1/src/voltwire/fastapi/logging/__init__.py

@@ -0,0 +1,35 @@
+__version__ = "0.0.0"
+
+from typing import Any, Protocol
+
+from pydantic import BaseModel
+
+from voltwire.fastapi.logging._constants import log_context
+from voltwire.fastapi.logging.middleware import ContextEnricher
+
+__all__ = ["ContextEnricher", "log_context", "integration_logger", "log_banner", "IntegrationLogContext", "AppRuntimeSettings"]
+
+
+class IntegrationLogContext(BaseModel):
+    integration: str
+    message: str
+
+
+class AppRuntimeSettings(Protocol):
+    app_name: str
+    version: str
+    environment: str
+
+
+def log_banner(settings: AppRuntimeSettings):
+    print(
+        f"Application: '{settings.app_name}' Version: '{settings.version}' Environment: '{settings.environment}'",
+        flush=True,
+    )
+
+
+def integration_logger(context: IntegrationLogContext, **extra: Any):
+    from loguru import logger
+
+    context_dict = {**context.model_dump(), **extra}
+    return logger.contextualize(**context_dict)

voltwire_fastapi_logging-0.0.1/src/voltwire/fastapi/logging/_constants.py

@@ -0,0 +1,11 @@
+from typing import Any
+
+from loguru import logger
+
+APP_LOG_FORMAT = (
+    "<level>{level}</level>: <green>{time:YYYY-MM-DDTHH:mm:s:SSS!UTC}</green> "
+    "| {process}:{thread} | {name}:{line} - {message} | {extra}"
+)
+
+def log_context(**extra: Any):
+    return logger.contextualize(**extra)

voltwire_fastapi_logging-0.0.1/src/voltwire/fastapi/logging/base.py

@@ -0,0 +1,81 @@
+import logging
+import sys
+from dataclasses import dataclass
+from typing import Protocol
+
+from loguru import logger
+
+from voltwire.fastapi.logging._constants import APP_LOG_FORMAT
+
+
+class LogSettings(Protocol):
+    level: str
+
+
+@dataclass
+class DefaultLogSettings:
+    level: str = "INFO"
+
+
+# Loggers known to attach their own handlers directly (bypassing propagation
+# to root) rather than relying on the standard logging tree.
+_DIRECTLY_HANDLED_LOGGERS = (
+    "uvicorn",
+    "uvicorn.access",
+    "uvicorn.error",
+    "gunicorn",
+    "gunicorn.access",
+    "gunicorn.error",
+    "sqlalchemy",
+    "sqlalchemy.engine",
+)
+
+
+class InterceptHandler(logging.Handler):
+    """Forwards stdlib `logging` records into loguru.
+
+    Installed on the root logger so any code using plain
+    `logging.getLogger(__name__)` (this codebase, other voltwire
+    packages, or third-party dependencies) is routed through loguru
+    without those callers needing to know loguru exists.
+    """
+
+    def emit(self, record: logging.LogRecord) -> None:
+        try:
+            level = logger.level(record.levelname).name
+        except ValueError:
+            level = record.levelno
+
+        frame, depth = logging.currentframe(), 0
+        while frame and (depth == 0 or frame.f_code.co_filename == logging.__file__):
+            frame = frame.f_back
+            depth += 1
+
+        logger.opt(depth=depth, exception=record.exc_info).log(
+            level, record.getMessage()
+        )
+
+
+def setup_logging(settings: LogSettings):
+
+    # ensure all python and loguru loggers are clean
+    logger.remove()
+    root = logging.getLogger()
+    for handler in root.handlers[:]:
+        root.removeHandler(handler)
+
+    logging.basicConfig(handlers=[InterceptHandler()], level=0, force=True)
+
+    # some libraries attach handlers directly to their own named logger
+    # instead of propagating to root - strip those so they route through
+    # the intercept handler too.
+    for name in _DIRECTLY_HANDLED_LOGGERS:
+        named_logger = logging.getLogger(name)
+        named_logger.handlers = []
+        named_logger.propagate = True
+
+    logger.add(
+        sys.stdout,
+        format=APP_LOG_FORMAT,
+        level=settings.level,
+    )

voltwire_fastapi_logging-0.0.1/src/voltwire/fastapi/logging/middleware.py

@@ -0,0 +1,55 @@
+from dataclasses import dataclass, field
+from typing import Protocol, Callable, Awaitable, Any
+
+from loguru import logger
+from starlette.middleware.base import BaseHTTPMiddleware
+from starlette.requests import Request
+
+from voltwire.fastapi.logging._constants import log_context
+
+ContextEnricher = Callable[[Request, dict[str, Any]], Awaitable[None]]
+
+
+class LoggingMiddlewareSettings(Protocol):
+    context_enrichers: list[ContextEnricher]
+
+@dataclass
+class DefaultLoggingMiddlewareSettings:
+    context_enrichers: list[ContextEnricher] = field(default_factory=list)
+
+class LoggingContextMiddleware(BaseHTTPMiddleware):
+    """
+    This middleware enriches every log entry with request context.
+    - Adds method and path to all logs within the request scope
+    - Executes custom context enrichers to add additional context
+    
+    Custom context enrichers can be registered via settings:
+        async def custom_enricher(request: Request, context: dict[str, Any]) -> None:
+            context["custom_field"] = "custom_value"
+        
+        settings = DefaultLoggingMiddlewareSettings(
+            context_enrichers=[custom_enricher]
+        )
+        app.add_middleware(LoggingContextMiddleware, settings=settings)
+    """
+
+    def __init__(self, app, settings: LoggingMiddlewareSettings):
+        super().__init__(app)
+        self.settings = settings
+
+    async def dispatch(self, request: Request, call_next):
+        request_context = {"method": request.method, "path": request.url.path}
+
+        # Execute custom context enrichers
+        for enricher in self.settings.context_enrichers:
+            try:
+                await enricher(request, request_context)
+            except Exception as e:
+                logger.warning(f"Context enricher {enricher.__name__} failed: {str(e)}")
+
+        # Process the request within loguru context
+        with log_context(**request_context):
+            logger.trace(f"Request started: {request.method} {request.url.path}")
+            response = await call_next(request)
+            logger.trace(f"Request completed: {request.method} {request.url.path} - {response.status_code}")
+            return response

voltwire_fastapi_logging-0.0.1/tests/test_sample.py

@@ -0,0 +1,6 @@
+from voltwire.fastapi.logging import __version__
+
+
+def test_version():
+    assert isinstance(__version__, str)
+    assert len(__version__) > 0