Merge pull request #27 from redb0/fix-style

Correction of stylistic errors and typos

Author: redb0

CHANGELOG.md

@@ -6,7 +6,7 @@
 
 ### Fix
 
-- **middleware**: sefe receipt of response status
+- **middleware**: safe receipt of response status
 - **base_formatter**: make `in_file` to keyword-only argument.
 
 ## 0.6.1 (2025-02-18)
@@ -92,7 +92,7 @@
 
 ### Fix
 
-- **all**: add logger name, level in model, message chenge to json
+- **all**: add logger name, level in model, message change to json
 
 ## 0.3.4 (2024-07-22)
 

docs_src/example_2.py

@@ -1,3 +1,4 @@
+from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
 from typing import Any
 
@@ -20,7 +21,7 @@ class Settings(BaseSettingsModel):
 
 
 @asynccontextmanager
-async def lifespan(_: FastAPI):
+async def lifespan(_: FastAPI) -> AsyncGenerator[Any, Any]:
     queue_listener = setup_logger(settings.log)
 
     if queue_listener:

docs_src/example_8.py

@@ -1,6 +1,6 @@
 from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
-from typing import Optional
+from typing import Annotated, Optional
 
 from fastapi import FastAPI, Query, Request
 from starlette.middleware import Middleware
@@ -120,9 +120,9 @@ async def test(request: Request) -> str:
 def foo(
     item_id: int,
     item: dict[str, str],
-    bar: str = Query(),
-    password: str = Query(),
-    baz: str = Query(),
+    bar: Annotated[str, Query()],
+    password: Annotated[str, Query()],
+    baz: Annotated[str, Query()],
 ) -> dict[str, str]:
     return item | {'item_id': str(item_id), 'bar': bar, 'password': password, 'baz': baz}
 

fastapi_structlog/__init__.py

@@ -96,15 +96,15 @@ def setup_logger(  # noqa: PLR0913
 
 
 __all__ = (
+    'BaseSettingsModel',
+    'DatabaseHandlerFactory',
+    'FileHandlerFactory',
+    'HandlerFactory',
     'LogSettings',
     'LogType',
-    'setup_logger',
     'LoggerConfigurator',
-    'DatabaseHandlerFactory',
-    'SyslogHandlerFactory',
     'StreamHandlerFactory',
-    'FileHandlerFactory',
-    'HandlerFactory',
+    'SyslogHandlerFactory',
     'base_formatter',
-    'BaseSettingsModel',
+    'setup_logger',
 )

fastapi_structlog/db_handler/__init__.py

@@ -2,8 +2,8 @@
 from fastapi_structlog.db_handler.model import LogModel
 
 __all__ = (
-    'LogModel',
-    'QueueHandler',
     'BaseDatabaseHandler',
     'DatabaseHandler',
+    'LogModel',
+    'QueueHandler',
 )

fastapi_structlog/log.py

@@ -207,7 +207,11 @@ def configure_structlog(logger: str, processors: list[Processor]) -> None:
     )
 
 
-def base_formatter(settings: LogSettings, *, in_file=False) -> structlog.stdlib.ProcessorFormatter:
+def base_formatter(
+    settings: LogSettings,
+    *,
+    in_file: bool=False,
+) -> structlog.stdlib.ProcessorFormatter:
     """Create a basic formatter based on the configuration."""
     shared_processors = configure_processor(
         json_logs=settings.json_logs,

fastapi_structlog/sentry/__init__.py

@@ -7,7 +7,7 @@
 from .settings import Environment, SentrySettings
 
 __all__ = (
-    'setup_sentry',
-    'SentrySettings',
     'Environment',
+    'SentrySettings',
+    'setup_sentry',
 )

pyproject.toml

@@ -135,7 +135,7 @@ line-length = 100
 keep-runtime-typing = true
 
 [tool.ruff.lint.per-file-ignores]
-"docs_src/*" = ["D100", "D101", "D103", "T201", "S104"]
+"docs_src/*" = ["D100", "D101", "D103", "T201", "S104", "INP001", "ERA001", "G004"]
 
 
 [tool.ruff.lint.flake8-quotes]