доработка логирования

Author: albertalexandrov

docs/Логирование.md

@@ -1,5 +1,3 @@
-from fastapi_django.utils.logging import logging_context
-
 # Логирование
 
 Логирование реализовано как в Django. Настройки логирования прописываются в LOGGING. Значение может быть словарем
@@ -17,13 +15,12 @@ uvicorn.run(**params, log_config=None)
 
 ## Контекстно зависимое логирование
 
-Чтобы добавить в лог дополнительных полей, используйте контекстный менеджер `fastapi_django.utils.logging.logging_context`.
+Чтобы добавить в лог дополнительных полей, используйте контекстный менеджер `fastapi_django.logging.logging_context`.
 Пример применения:
 
 ```python
 import logging
-from fastapi_django.utils.logging import logging_context
-
+from fastapi_django.logging import logging_context
 
 with logging_context(num=1):
     logging.info("лог с контекстом")
@@ -39,53 +36,6 @@ logging.info("лог БЕЗ контекста")
 # }
 ```
 
-## Обновление контекста логирования
-
-Иногда необходимо добавить в контекст логирования, но нет возможности применить контекстный менеджер. Например, 
-при успешной аутентификации необходимо добавить информацию о пользователе (логин, идентификатор), но использования 
-контекстного менеджера вот так:
-
-```python
-from fastapi.security import HTTPBearer
-from fastapi import Request
-from fastapi_django.utils.logging import logging_context
-
-
-class UsrAdmAuth(HTTPBearer):
-
-    async def __call__(self, request: Request):
-        # аутентификация...
-        user = self._get_user()
-        with logging_context(username=user.username):
-            return user
-
-    async def _get_user(self) -> User:
-        # получаем пользователя кз
-```
-
-не сработает. Поэтому предлагается использовать функцию `fastapi_django.utils.logging.update_logging_context`.
-Перепишем код выше:
-
-```python
-from fastapi.security import HTTPBearer
-from fastapi import Request
-from fastapi_django.utils.logging import update_logging_context
-
-
-class UsrAdmAuth(HTTPBearer):
-
-    async def __call__(self, request: Request):
-        # аутентификация...
-        user = self._get_user()
-        update_logging_context(username=user.username)
-        return user
-
-    async def _get_user(self) -> User:
-        # получаем пользователя кз
-```
-
-тогда username появится в последующих логах.
-
 ## Пример
 
 Пример настройки LOGGING см. по ссылке https://github.com/albertalexandrov/fastapi-django-example/blob/main/src/settings.py

fastapi_django/__init__.py

@@ -1,5 +1,5 @@
 def setup():
     # последовательность действий, которые должны быть выполнены перед запуском какого-либо
     # процесса.  одним из таких действий является, например, настройка логирования
-    from fastapi_django.utils.logging import configure_logging
+    from fastapi_django.logging import configure_logging
     configure_logging()

fastapi_django/conf/__init__.py

@@ -53,6 +53,14 @@ def __dir__(self):
             self._setup()
         return dir(self._wrapped)
 
+    def extend(self, settings_module=None):
+        mod = importlib.import_module(settings_module)
+        for setting in dir(mod):
+            if setting.isupper() and not hasattr(self, setting):
+                value = getattr(mod, setting)
+                setattr(self, setting, value)
+        return self
+
 
 class Settings:
     def __init__(self, settings_module):

fastapi_django/logging.py

@@ -0,0 +1,28 @@
+import logging
+from contextlib import contextmanager
+from contextvars import ContextVar
+from logging.config import dictConfig
+from typing import Any
+
+from fastapi_django.conf import settings
+
+# контекст логирования.  когда необходимо в контекст добавляются желаемые значения,
+# которые затем будут доступны в LogRecord
+logging_context_var = ContextVar("logging_context", default={})
+
+
+def configure_logging():
+    if settings.LOGGING:
+        logging.config.dictConfig(settings.LOGGING)
+
+
+@contextmanager
+def logging_context(**kw: Any):
+    # добавляет в контекст логирования желаемые значения
+    current_context = logging_context_var.get()
+    new_context = {**current_context, **kw}
+    token = logging_context_var.set(new_context)
+    try:
+        yield
+    finally:
+        logging_context_var.reset(token)

fastapi_django/management/cli.py

@@ -1,9 +1,9 @@
 import uvicorn
+from IPython import embed
 from typer import Typer
 
 from fastapi_django.conf import settings
 from fastapi_django.exceptions import ImproperlyConfigured
-from fastapi_django.utils.logging import get_logging_config
 
 typer = Typer(rich_markup_mode="markdown")
 
@@ -24,7 +24,7 @@ def runserver():
         if (param := param.lower()) == "log_config":
             raise ImproperlyConfigured("Настройки логирования необходимо определять в настройке LOGGING")
         params[param] = getattr(settings, setting)
-    uvicorn.run(**params, log_config=get_logging_config())
+    uvicorn.run(**params, log_config=settings.LOGGING)
 
 
 @typer.command()
@@ -33,3 +33,11 @@ def echo(message: str):
     Эхо-команда
     """
     print(f"Echo: {message}")
+
+
+@typer.command()
+def shell() -> None:
+    """
+    Runs a Python interactive interpreter (iPython)
+    """
+    embed()