beans-logging-fastapi 8.0.0__tar.gz → 8.0.2__tar.gz

{beans_logging_fastapi-8.0.0/src/beans_logging_fastapi.egg-info → beans_logging_fastapi-8.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beans_logging_fastapi
-Version: 8.0.0
+Version: 8.0.2
 Summary: This is a HTTP access log module for FastAPI based on 'beans-logging' package.
 Author-email: Batkhuu Byambajav <batkhuu10@gmail.com>
 Project-URL: Homepage, https://github.com/bybatkhuu/module-fastapi-logging
@@ -22,7 +22,7 @@ Requires-Python: <4.0,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: fastapi<1.0.0,>=0.99.1
-Requires-Dist: beans-logging<13.0.0,>=12.0.0
+Requires-Dist: beans-logging<13.0.0,>=12.0.3
 Provides-Extra: test
 Requires-Dist: pytest<10.0.0,>=8.0.2; extra == "test"
 Requires-Dist: pytest-cov<8.0.0,>=5.0.0; extra == "test"

beans_logging_fastapi-8.0.2/requirements.txt

@@ -0,0 +1,2 @@
+fastapi>=0.99.1,<1.0.0
+beans-logging>=12.0.3,<13.0.0

beans_logging_fastapi-8.0.2/src/beans_logging_fastapi/__version__.py

@@ -0,0 +1 @@
+__version__ = "8.0.2"

{beans_logging_fastapi-8.0.0 → beans_logging_fastapi-8.0.2}/src/beans_logging_fastapi/formats.py

@@ -109,7 +109,7 @@ def id_std_format(record: "Record") -> str:
     _format = (
         "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w>"
         f"{_request_id_part}{_trace_id_part}{_user_id_part}"
-        "]: <level>{message}</level>\n"
+        "]: <level>{message}</level>\n{exception}"
     )
     return _format
 
@@ -134,7 +134,7 @@ def id_file_format(record: "Record") -> str:
     _format = (
         "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line}"
         f"{_request_id_part}{_trace_id_part}{_user_id_part}"
-        "]: {message}\n"
+        "]: {message}\n{exception}"
     )
     return _format
 

beans_logging_fastapi-8.0.2/src/beans_logging_fastapi/http_error.py

@@ -0,0 +1,131 @@
+from typing import Any
+
+from pydantic import validate_call
+from fastapi import Request
+from fastapi.concurrency import run_in_threadpool
+
+from beans_logging import logger, Logger
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+async def async_log_http_error(
+    request: Request,
+    status_code: int,
+    exc: Exception | None = None,
+    sub_format: str = (
+        '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
+    ),
+) -> None:
+    """Async Log HTTP error for unhandled Exception.
+
+    Args:
+        request     (Request  , required): Request instance.
+        status_code (int      , required): HTTP status code.
+        exc         (Exception, optional): Exception instance. Defaults to None.
+        sub_format  (str      , optional): Message format. Defaults to
+            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'.
+    """
+
+    _http_info: dict[str, Any] = {}
+    if hasattr(request.state, "http_info") and isinstance(
+        request.state.http_info, dict
+    ):
+        _http_info = request.state.http_info
+
+    _http_info.setdefault("request_id", "")
+    if hasattr(request.state, "request_id") and isinstance(
+        request.state.request_id, str
+    ):
+        _http_info["request_id"] = request.state.request_id
+
+    if "url_path" not in _http_info:
+        _url_path = request.url.path
+        if request.url.query:
+            _url_path = f"{_url_path}?{request.url.query}"
+        _url_path = _url_path.replace("{", "{{").replace("}", "}}").replace("<", "\\<")
+        _http_info["url_path"] = _url_path
+
+    _http_info.setdefault("client_host", request.client.host if request.client else "")
+    _http_info.setdefault("user_id", "-")
+    _http_info.setdefault("method", request.method)
+    _http_info.setdefault("http_version", request.scope.get("http_version", "1.1"))
+    _http_info["status_code"] = status_code
+
+    _msg = sub_format.format(**_http_info)
+    _logger: Logger = logger.opt(colors=True, record=True).bind(
+        http_info=_http_info,
+        request_id=_http_info.get("request_id"),
+        disable_std_handler=True,
+    )
+
+    if exc:
+        await run_in_threadpool(_logger.opt(exception=exc).error, _msg)
+    else:
+        await run_in_threadpool(_logger.error, _msg)
+
+    return
+
+
+@validate_call(config={"arbitrary_types_allowed": True})
+def log_http_error(
+    request: Request,
+    status_code: int,
+    exc: Exception | None = None,
+    sub_format: str = (
+        '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
+    ),
+) -> None:
+    """Log HTTP error for unhandled Exception.
+
+    Args:
+        request     (Request  , required): Request instance.
+        status_code (int      , required): HTTP status code.
+        exc         (Exception, optional): Exception instance. Defaults to None.
+        sub_format  (str      , optional): Message format. Defaults to
+            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'.
+    """
+
+    _http_info: dict[str, Any] = {}
+    if hasattr(request.state, "http_info") and isinstance(
+        request.state.http_info, dict
+    ):
+        _http_info = request.state.http_info
+
+    _http_info.setdefault("request_id", "")
+    if hasattr(request.state, "request_id") and isinstance(
+        request.state.request_id, str
+    ):
+        _http_info["request_id"] = request.state.request_id
+
+    if "url_path" not in _http_info:
+        _url_path = request.url.path
+        if request.url.query:
+            _url_path = f"{_url_path}?{request.url.query}"
+        _url_path = _url_path.replace("{", "{{").replace("}", "}}").replace("<", "\\<")
+        _http_info["url_path"] = _url_path
+
+    _http_info.setdefault("client_host", request.client.host if request.client else "")
+    _http_info.setdefault("user_id", "-")
+    _http_info.setdefault("method", request.method)
+    _http_info.setdefault("http_version", request.scope.get("http_version", "1.1"))
+    _http_info["status_code"] = status_code
+
+    _msg = sub_format.format(**_http_info)
+    _logger: Logger = logger.opt(colors=True, record=True, depth=3).bind(
+        http_info=_http_info,
+        request_id=_http_info.get("request_id"),
+        disable_std_handler=True,
+    )
+
+    if exc:
+        _logger.opt(exception=exc).error(_msg)
+    else:
+        _logger.error(_msg)
+
+    return
+
+
+__all__ = [
+    "async_log_http_error",
+    "log_http_error",
+]

{beans_logging_fastapi-8.0.0 → beans_logging_fastapi-8.0.2}/src/beans_logging_fastapi/middlewares.py

@@ -137,15 +137,12 @@ class RequestHTTPInfoMiddleware(BaseHTTPMiddleware):
                     _http_info["h_cf_timezone"] = request.headers.get("cf-timezone")
 
         _http_info["method"] = request.method
-        _http_info["url_path"] = request.url.path
-        if "{" in _http_info["url_path"]:
-            _http_info["url_path"] = _http_info["url_path"].replace("{", "{{")
-        if "}" in _http_info["url_path"]:
-            _http_info["url_path"] = _http_info["url_path"].replace("}", "}}")
-        if "<" in _http_info["url_path"]:
-            _http_info["url_path"] = _http_info["url_path"].replace("<", "\\<")
+
+        _url_path = request.url.path
         if request.url.query:
-            _http_info["url_path"] = f"{request.url.path}?{request.url.query}"
+            _url_path = f"{_url_path}?{request.url.query}"
+        _url_path = _url_path.replace("{", "{{").replace("}", "}}").replace("<", "\\<")
+        _http_info["url_path"] = _url_path
 
         _http_info["url_query_params"] = request.query_params._dict
         _http_info["url_path_params"] = request.path_params

{beans_logging_fastapi-8.0.0 → beans_logging_fastapi-8.0.2}/src/beans_logging_fastapi/mode.py

@@ -1,3 +1,4 @@
+import sys
 from typing import TYPE_CHECKING
 
 from pydantic import validate_call
@@ -42,9 +43,11 @@ async def async_log_at(
 
     if warn_mode == WarnEnum.ALWAYS:
         if level == LogLevelEnum.EXCEPTION:
-            await run_in_threadpool(logger.exception, message)
+            _exc_info = sys.exc_info()
+            await run_in_threadpool(logger.opt(exception=_exc_info).error, message)
         else:
             await run_in_threadpool(logger.log, level.name, message)
+
     elif warn_mode == WarnEnum.DEBUG:
         await run_in_threadpool(logger.debug, message)
 

{beans_logging_fastapi-8.0.0 → beans_logging_fastapi-8.0.2/src/beans_logging_fastapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beans_logging_fastapi
-Version: 8.0.0
+Version: 8.0.2
 Summary: This is a HTTP access log module for FastAPI based on 'beans-logging' package.
 Author-email: Batkhuu Byambajav <batkhuu10@gmail.com>
 Project-URL: Homepage, https://github.com/bybatkhuu/module-fastapi-logging
@@ -22,7 +22,7 @@ Requires-Python: <4.0,>=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: fastapi<1.0.0,>=0.99.1
-Requires-Dist: beans-logging<13.0.0,>=12.0.0
+Requires-Dist: beans-logging<13.0.0,>=12.0.3
 Provides-Extra: test
 Requires-Dist: pytest<10.0.0,>=8.0.2; extra == "test"
 Requires-Dist: pytest-cov<8.0.0,>=5.0.0; extra == "test"

{beans_logging_fastapi-8.0.0 → beans_logging_fastapi-8.0.2}/src/beans_logging_fastapi.egg-info/requires.txt

@@ -1,5 +1,5 @@
 fastapi<1.0.0,>=0.99.1
-beans-logging<13.0.0,>=12.0.0
+beans-logging<13.0.0,>=12.0.3
 
 [build]
 setuptools<83.0.0,>=70.3.0

beans_logging_fastapi-8.0.0/requirements.txt

@@ -1,2 +0,0 @@
-fastapi>=0.99.1,<1.0.0
-beans-logging>=12.0.0,<13.0.0

beans_logging_fastapi-8.0.0/src/beans_logging_fastapi/__version__.py

@@ -1 +0,0 @@
-__version__ = "8.0.0"

beans_logging_fastapi-8.0.0/src/beans_logging_fastapi/http_error.py

@@ -1,81 +0,0 @@
-from typing import Any
-
-from pydantic import validate_call
-from fastapi import Request
-from fastapi.concurrency import run_in_threadpool
-
-from beans_logging import logger, Logger
-
-
-@validate_call(config={"arbitrary_types_allowed": True})
-async def async_log_http_error(
-    request: Request,
-    status_code: int,
-    sub_format: str = (
-        '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
-    ),
-) -> None:
-    """Async Log HTTP error for unhandled Exception.
-
-    Args:
-        request     (Request, required): Request instance.
-        status_code (int    , required): HTTP status code.
-        sub_format  (str    , optional): Message format. Defaults to
-            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'.
-    """
-
-    _http_info: dict[str, Any] = {"request_id": request.state.request_id}
-    if hasattr(request.state, "http_info") and isinstance(
-        request.state.http_info, dict
-    ):
-        _http_info: dict[str, Any] = request.state.http_info
-    _http_info["status_code"] = status_code
-
-    _msg = sub_format.format(**_http_info)
-    _logger: Logger = logger.opt(colors=True, record=True).bind(
-        http_info=_http_info,
-        request_id=_http_info.get("request_id", ""),
-        disable_std_handler=True,
-    )
-    await run_in_threadpool(_logger.error, _msg)
-    return
-
-
-@validate_call(config={"arbitrary_types_allowed": True})
-def log_http_error(
-    request: Request,
-    status_code: int,
-    sub_format: str = (
-        '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'
-    ),
-) -> None:
-    """Log HTTP error for unhandled Exception.
-
-    Args:
-        request     (Request, required): Request instance.
-        status_code (int    , required): HTTP status code.
-        sub_format  (str    , optional): Message format. Defaults to
-            '{client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" <n>{status_code}</n>'.
-    """
-
-    _http_info: dict[str, Any] = {"request_id": request.state.request_id}
-    if hasattr(request.state, "http_info") and isinstance(
-        request.state.http_info, dict
-    ):
-        _http_info: dict[str, Any] = request.state.http_info
-    _http_info["status_code"] = status_code
-
-    _msg = sub_format.format(**_http_info)
-    _logger: Logger = logger.opt(colors=True, record=True, depth=3).bind(
-        http_info=_http_info,
-        request_id=_http_info.get("request_id", ""),
-        disable_std_handler=True,
-    )
-    _logger.error(_msg)
-    return
-
-
-__all__ = [
-    "async_log_http_error",
-    "log_http_error",
-]