beans-logging 5.0.0__tar.gz → 6.0.0__tar.gz

{beans_logging-5.0.0 → beans_logging-6.0.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: beans_logging
-Version: 5.0.0
+Version: 6.0.0
 Summary: 'beans_logging' is a python package for simple logger and easily managing logging modules. It is a Loguru based custom logging package for python projects.
 Home-page: https://github.com/bybatkhuu/module.python-logging
-Download-URL: https://github.com/bybatkhuu/module.python-logging/archive/v5.0.0.tar.gz
+Download-URL: https://github.com/bybatkhuu/module.python-logging/archive/v6.0.0.tar.gz
 Author: Batkhuu Byambajav
 Author-email: batkhuu10@gmail.com
 License: MIT
@@ -22,6 +22,8 @@ License-File: LICENSE.txt
 Requires-Dist: PyYAML<7.0,>=6.0
 Requires-Dist: pydantic!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.10.0
 Requires-Dist: loguru<1.0.0,>=0.7.2
+Provides-Extra: fastapi
+Requires-Dist: beans-logging-fastapi<2.0.0,>=1.0.0; extra == "fastapi"
 
 # beans_logging
 
@@ -47,7 +49,6 @@ It is a `Loguru` based custom logging package for python projects.
 - Custom logging **formats**
 - **Multiprocess** compatibility (Linux, macOS - 'fork')
 - Add custom **handlers**
-- **FastAPI** HTTP access logging **middleware**
 - **Base** logging module
 - Support **Pydantic-v1** and **Pydantic-v2**
 
@@ -236,157 +237,12 @@ Traceback (most recent call last):
 ZeroDivisionError: division by zero
 ```
 
-### **Advanced (FastAPI)**
+### **FastAPI**
 
-[**`configs/logger.yml`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/configs/logger.yml):
+Checkout `beans_logging_fastapi` package: <https://github.com/bybatkhuu/module.fastapi-logging>
 
-```yaml
-logger:
-  app_name: "fastapi-app"
-  level: "TRACE"
-  use_diagnose: false
-  stream:
-    use_color: true
-    use_icon: false
-    format_str: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{level_short:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>"
-    std_handler:
-      enabled: true
-  file:
-    logs_dir: "./logs"
-    rotate_size: 10000000 # 10MB
-    rotate_time: "00:00:00"
-    backup_count: 90
-    log_handlers:
-      enabled: true
-      format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}"
-      log_path: "{app_name}.std.all.log"
-      err_path: "{app_name}.std.err.log"
-    json_handlers:
-      enabled: true
-      use_custom: false
-      log_path: "json/{app_name}.json.all.log"
-      err_path: "json/{app_name}.json.err.log"
-  intercept:
-    auto_load:
-      enabled: true
-      only_base: false
-      ignore_modules: []
-    include_modules: []
-    mute_modules: ["uvicorn.access", "uvicorn.error"]
-  extra:
-    http_std_debug_format: '<n>[{request_id}]</n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-    http_std_msg_format: '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-    http_file_enabled: true
-    http_log_path: "http/{app_name}.http.access.log"
-    http_err_path: "http/{app_name}.http.err.log"
-    http_json_enabled: true
-    http_json_path: "json.http/{app_name}.json.http.access.log"
-    http_json_err_path: "json.http/{app_name}.json.http.err.log"
-```
-
-[**`.env`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/.env):
-
-```sh
-ENV=development
-DEBUG=true
-```
-
-[**`logger.py`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/logger.py):
-
-```python
-from beans_logging import Logger, LoggerLoader
-from beans_logging.fastapi import add_http_file_handler, add_http_file_json_handler
-
-
-logger_loader = LoggerLoader()
-logger: Logger = logger_loader.load()
-
-if logger_loader.config.extra.http_file_enabled:
-    add_http_file_handler(
-        logger_loader=logger_loader,
-        log_path=logger_loader.config.extra.http_log_path,
-        err_path=logger_loader.config.extra.http_err_path,
-    )
-
-if logger_loader.config.extra.http_json_enabled:
-    add_http_file_json_handler(
-        logger_loader=logger_loader,
-        log_path=logger_loader.config.extra.http_json_path,
-        err_path=logger_loader.config.extra.http_json_err_path,
-    )
-```
-
-[**`main.py`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/main.py):
-
-```python
-from typing import Union
-from contextlib import asynccontextmanager
-
-from dotenv import load_dotenv
-from fastapi import FastAPI, HTTPException
-from fastapi.responses import RedirectResponse
-
-load_dotenv()
-
-from beans_logging.fastapi import HttpAccessLogMiddleware
-
-from logger import logger, logger_loader
-from __version__ import __version__
-
-
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    logger.info("Preparing to startup...")
-    logger.success("Finished preparation to startup.")
-    logger.info(f"API version: {__version__}")
-
-    yield
-    logger.info("Praparing to shutdown...")
-    logger.success("Finished preparation to shutdown.")
-
-app = FastAPI(lifespan=lifespan, version=__version__)
-app.add_middleware(
-    HttpAccessLogMiddleware,
-    has_proxy_headers=True,
-    debug_format=logger_loader.config.extra.http_std_debug_format,
-    msg_format=logger_loader.config.extra.http_std_msg_format,
-)
-
-@app.get("/")
-def root():
-    return {"Hello": "World"}
-```
-
-Run the [**`examples/advanced`**](https://github.com/bybatkhuu/module.python-logging/tree/main/examples/advanced):
-
-```sh
-cd ./examples/advanced
-# Install python dependencies for examples:
-pip install -r ./requirements.txt
-
-uvicorn main:app --host=0.0.0.0 --port=8000
-```
-
-**Output**:
-
-```txt
-[2023-09-01 00:00:00.000 +09:00 | TRACE | beans_logging._base:576]: Intercepted modules: ['watchfiles.watcher', 'dotenv', 'asyncio', 'dotenv.main', 'watchfiles.main', 'concurrent.futures', 'uvicorn', 'fastapi', 'concurrent', 'watchfiles']; Muted modules: ['uvicorn.access', 'uvicorn.error'];
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:76]: Started server process [17146]
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:46]: Waiting for application startup.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:21]: Preparing to startup...
-[2023-09-01 00:00:00.000 +09:00 | OK    | main:22]: Finished preparation to startup.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:23]: API version: 0.0.1-000000
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:60]: Application startup complete.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:218]: Uvicorn running on http://0.0.0.0:9000 (Press CTRL+C to quit)
-[2023-09-01 00:00:00.000 +09:00 | DEBUG | anyio._backends._asyncio:833]: [f635ebbc3f2348db9dcff681be1bd52a] 127.0.0.1 - "GET / HTTP/1.1"
-[2023-09-01 00:00:00.000 +09:00 | OK    | anyio._backends._asyncio:833]: [f635ebbc3f2348db9dcff681be1bd52a] 127.0.0.1 - "GET / HTTP/1.1" 200 17B 0.7ms
-^C[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:264]: Shutting down
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:65]: Waiting for application shutdown.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:26]: Praparing to shutdown...
-[2023-09-01 00:00:00.000 +09:00 | OK    | main:27]: Finished preparation to shutdown.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:76]: Application shutdown complete.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:86]: Finished server process [17146]
-```
+- FastAPI HTTP access logging middleware
+- Install with pip: `pip install -U beans-logging[fastapi]` or `pip install -U beans-logging-fastapi`
 
 ---
 
@@ -467,3 +323,4 @@ logger:
 - <https://github.com/Delgan/loguru>
 - <https://loguru.readthedocs.io/en/stable/api/logger.html>
 - <https://loguru.readthedocs.io/en/stable/resources/recipes.html>
+- <https://github.com/bybatkhuu/module.fastapi-logging>

{beans_logging-5.0.0 → beans_logging-6.0.0}/README.md

@@ -22,7 +22,6 @@ It is a `Loguru` based custom logging package for python projects.
 - Custom logging **formats**
 - **Multiprocess** compatibility (Linux, macOS - 'fork')
 - Add custom **handlers**
-- **FastAPI** HTTP access logging **middleware**
 - **Base** logging module
 - Support **Pydantic-v1** and **Pydantic-v2**
 
@@ -211,157 +210,12 @@ Traceback (most recent call last):
 ZeroDivisionError: division by zero
 ```
 
-### **Advanced (FastAPI)**
+### **FastAPI**
 
-[**`configs/logger.yml`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/configs/logger.yml):
+Checkout `beans_logging_fastapi` package: <https://github.com/bybatkhuu/module.fastapi-logging>
 
-```yaml
-logger:
-  app_name: "fastapi-app"
-  level: "TRACE"
-  use_diagnose: false
-  stream:
-    use_color: true
-    use_icon: false
-    format_str: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{level_short:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>"
-    std_handler:
-      enabled: true
-  file:
-    logs_dir: "./logs"
-    rotate_size: 10000000 # 10MB
-    rotate_time: "00:00:00"
-    backup_count: 90
-    log_handlers:
-      enabled: true
-      format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}"
-      log_path: "{app_name}.std.all.log"
-      err_path: "{app_name}.std.err.log"
-    json_handlers:
-      enabled: true
-      use_custom: false
-      log_path: "json/{app_name}.json.all.log"
-      err_path: "json/{app_name}.json.err.log"
-  intercept:
-    auto_load:
-      enabled: true
-      only_base: false
-      ignore_modules: []
-    include_modules: []
-    mute_modules: ["uvicorn.access", "uvicorn.error"]
-  extra:
-    http_std_debug_format: '<n>[{request_id}]</n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-    http_std_msg_format: '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-    http_file_enabled: true
-    http_log_path: "http/{app_name}.http.access.log"
-    http_err_path: "http/{app_name}.http.err.log"
-    http_json_enabled: true
-    http_json_path: "json.http/{app_name}.json.http.access.log"
-    http_json_err_path: "json.http/{app_name}.json.http.err.log"
-```
-
-[**`.env`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/.env):
-
-```sh
-ENV=development
-DEBUG=true
-```
-
-[**`logger.py`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/logger.py):
-
-```python
-from beans_logging import Logger, LoggerLoader
-from beans_logging.fastapi import add_http_file_handler, add_http_file_json_handler
-
-
-logger_loader = LoggerLoader()
-logger: Logger = logger_loader.load()
-
-if logger_loader.config.extra.http_file_enabled:
-    add_http_file_handler(
-        logger_loader=logger_loader,
-        log_path=logger_loader.config.extra.http_log_path,
-        err_path=logger_loader.config.extra.http_err_path,
-    )
-
-if logger_loader.config.extra.http_json_enabled:
-    add_http_file_json_handler(
-        logger_loader=logger_loader,
-        log_path=logger_loader.config.extra.http_json_path,
-        err_path=logger_loader.config.extra.http_json_err_path,
-    )
-```
-
-[**`main.py`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/main.py):
-
-```python
-from typing import Union
-from contextlib import asynccontextmanager
-
-from dotenv import load_dotenv
-from fastapi import FastAPI, HTTPException
-from fastapi.responses import RedirectResponse
-
-load_dotenv()
-
-from beans_logging.fastapi import HttpAccessLogMiddleware
-
-from logger import logger, logger_loader
-from __version__ import __version__
-
-
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    logger.info("Preparing to startup...")
-    logger.success("Finished preparation to startup.")
-    logger.info(f"API version: {__version__}")
-
-    yield
-    logger.info("Praparing to shutdown...")
-    logger.success("Finished preparation to shutdown.")
-
-app = FastAPI(lifespan=lifespan, version=__version__)
-app.add_middleware(
-    HttpAccessLogMiddleware,
-    has_proxy_headers=True,
-    debug_format=logger_loader.config.extra.http_std_debug_format,
-    msg_format=logger_loader.config.extra.http_std_msg_format,
-)
-
-@app.get("/")
-def root():
-    return {"Hello": "World"}
-```
-
-Run the [**`examples/advanced`**](https://github.com/bybatkhuu/module.python-logging/tree/main/examples/advanced):
-
-```sh
-cd ./examples/advanced
-# Install python dependencies for examples:
-pip install -r ./requirements.txt
-
-uvicorn main:app --host=0.0.0.0 --port=8000
-```
-
-**Output**:
-
-```txt
-[2023-09-01 00:00:00.000 +09:00 | TRACE | beans_logging._base:576]: Intercepted modules: ['watchfiles.watcher', 'dotenv', 'asyncio', 'dotenv.main', 'watchfiles.main', 'concurrent.futures', 'uvicorn', 'fastapi', 'concurrent', 'watchfiles']; Muted modules: ['uvicorn.access', 'uvicorn.error'];
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:76]: Started server process [17146]
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:46]: Waiting for application startup.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:21]: Preparing to startup...
-[2023-09-01 00:00:00.000 +09:00 | OK    | main:22]: Finished preparation to startup.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:23]: API version: 0.0.1-000000
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:60]: Application startup complete.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:218]: Uvicorn running on http://0.0.0.0:9000 (Press CTRL+C to quit)
-[2023-09-01 00:00:00.000 +09:00 | DEBUG | anyio._backends._asyncio:833]: [f635ebbc3f2348db9dcff681be1bd52a] 127.0.0.1 - "GET / HTTP/1.1"
-[2023-09-01 00:00:00.000 +09:00 | OK    | anyio._backends._asyncio:833]: [f635ebbc3f2348db9dcff681be1bd52a] 127.0.0.1 - "GET / HTTP/1.1" 200 17B 0.7ms
-^C[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:264]: Shutting down
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:65]: Waiting for application shutdown.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:26]: Praparing to shutdown...
-[2023-09-01 00:00:00.000 +09:00 | OK    | main:27]: Finished preparation to shutdown.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:76]: Application shutdown complete.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:86]: Finished server process [17146]
-```
+- FastAPI HTTP access logging middleware
+- Install with pip: `pip install -U beans-logging[fastapi]` or `pip install -U beans-logging-fastapi`
 
 ---
 
@@ -442,3 +296,4 @@ logger:
 - <https://github.com/Delgan/loguru>
 - <https://loguru.readthedocs.io/en/stable/api/logger.html>
 - <https://loguru.readthedocs.io/en/stable/resources/recipes.html>
+- <https://github.com/bybatkhuu/module.fastapi-logging>

{beans_logging-5.0.0 → beans_logging-6.0.0}/beans_logging/__version__.py

@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 
-__version__ = "5.0.0"
+__version__ = "6.0.0"

{beans_logging-5.0.0 → beans_logging-6.0.0}/beans_logging.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: beans-logging
-Version: 5.0.0
+Version: 6.0.0
 Summary: 'beans_logging' is a python package for simple logger and easily managing logging modules. It is a Loguru based custom logging package for python projects.
 Home-page: https://github.com/bybatkhuu/module.python-logging
-Download-URL: https://github.com/bybatkhuu/module.python-logging/archive/v5.0.0.tar.gz
+Download-URL: https://github.com/bybatkhuu/module.python-logging/archive/v6.0.0.tar.gz
 Author: Batkhuu Byambajav
 Author-email: batkhuu10@gmail.com
 License: MIT
@@ -22,6 +22,8 @@ License-File: LICENSE.txt
 Requires-Dist: PyYAML<7.0,>=6.0
 Requires-Dist: pydantic!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.10.0
 Requires-Dist: loguru<1.0.0,>=0.7.2
+Provides-Extra: fastapi
+Requires-Dist: beans-logging-fastapi<2.0.0,>=1.0.0; extra == "fastapi"
 
 # beans_logging
 
@@ -47,7 +49,6 @@ It is a `Loguru` based custom logging package for python projects.
 - Custom logging **formats**
 - **Multiprocess** compatibility (Linux, macOS - 'fork')
 - Add custom **handlers**
-- **FastAPI** HTTP access logging **middleware**
 - **Base** logging module
 - Support **Pydantic-v1** and **Pydantic-v2**
 
@@ -236,157 +237,12 @@ Traceback (most recent call last):
 ZeroDivisionError: division by zero
 ```
 
-### **Advanced (FastAPI)**
+### **FastAPI**
 
-[**`configs/logger.yml`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/configs/logger.yml):
+Checkout `beans_logging_fastapi` package: <https://github.com/bybatkhuu/module.fastapi-logging>
 
-```yaml
-logger:
-  app_name: "fastapi-app"
-  level: "TRACE"
-  use_diagnose: false
-  stream:
-    use_color: true
-    use_icon: false
-    format_str: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{level_short:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>"
-    std_handler:
-      enabled: true
-  file:
-    logs_dir: "./logs"
-    rotate_size: 10000000 # 10MB
-    rotate_time: "00:00:00"
-    backup_count: 90
-    log_handlers:
-      enabled: true
-      format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}"
-      log_path: "{app_name}.std.all.log"
-      err_path: "{app_name}.std.err.log"
-    json_handlers:
-      enabled: true
-      use_custom: false
-      log_path: "json/{app_name}.json.all.log"
-      err_path: "json/{app_name}.json.err.log"
-  intercept:
-    auto_load:
-      enabled: true
-      only_base: false
-      ignore_modules: []
-    include_modules: []
-    mute_modules: ["uvicorn.access", "uvicorn.error"]
-  extra:
-    http_std_debug_format: '<n>[{request_id}]</n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-    http_std_msg_format: '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-    http_file_enabled: true
-    http_log_path: "http/{app_name}.http.access.log"
-    http_err_path: "http/{app_name}.http.err.log"
-    http_json_enabled: true
-    http_json_path: "json.http/{app_name}.json.http.access.log"
-    http_json_err_path: "json.http/{app_name}.json.http.err.log"
-```
-
-[**`.env`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/.env):
-
-```sh
-ENV=development
-DEBUG=true
-```
-
-[**`logger.py`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/logger.py):
-
-```python
-from beans_logging import Logger, LoggerLoader
-from beans_logging.fastapi import add_http_file_handler, add_http_file_json_handler
-
-
-logger_loader = LoggerLoader()
-logger: Logger = logger_loader.load()
-
-if logger_loader.config.extra.http_file_enabled:
-    add_http_file_handler(
-        logger_loader=logger_loader,
-        log_path=logger_loader.config.extra.http_log_path,
-        err_path=logger_loader.config.extra.http_err_path,
-    )
-
-if logger_loader.config.extra.http_json_enabled:
-    add_http_file_json_handler(
-        logger_loader=logger_loader,
-        log_path=logger_loader.config.extra.http_json_path,
-        err_path=logger_loader.config.extra.http_json_err_path,
-    )
-```
-
-[**`main.py`**](https://github.com/bybatkhuu/module.python-logging/blob/main/examples/advanced/main.py):
-
-```python
-from typing import Union
-from contextlib import asynccontextmanager
-
-from dotenv import load_dotenv
-from fastapi import FastAPI, HTTPException
-from fastapi.responses import RedirectResponse
-
-load_dotenv()
-
-from beans_logging.fastapi import HttpAccessLogMiddleware
-
-from logger import logger, logger_loader
-from __version__ import __version__
-
-
-@asynccontextmanager
-async def lifespan(app: FastAPI):
-    logger.info("Preparing to startup...")
-    logger.success("Finished preparation to startup.")
-    logger.info(f"API version: {__version__}")
-
-    yield
-    logger.info("Praparing to shutdown...")
-    logger.success("Finished preparation to shutdown.")
-
-app = FastAPI(lifespan=lifespan, version=__version__)
-app.add_middleware(
-    HttpAccessLogMiddleware,
-    has_proxy_headers=True,
-    debug_format=logger_loader.config.extra.http_std_debug_format,
-    msg_format=logger_loader.config.extra.http_std_msg_format,
-)
-
-@app.get("/")
-def root():
-    return {"Hello": "World"}
-```
-
-Run the [**`examples/advanced`**](https://github.com/bybatkhuu/module.python-logging/tree/main/examples/advanced):
-
-```sh
-cd ./examples/advanced
-# Install python dependencies for examples:
-pip install -r ./requirements.txt
-
-uvicorn main:app --host=0.0.0.0 --port=8000
-```
-
-**Output**:
-
-```txt
-[2023-09-01 00:00:00.000 +09:00 | TRACE | beans_logging._base:576]: Intercepted modules: ['watchfiles.watcher', 'dotenv', 'asyncio', 'dotenv.main', 'watchfiles.main', 'concurrent.futures', 'uvicorn', 'fastapi', 'concurrent', 'watchfiles']; Muted modules: ['uvicorn.access', 'uvicorn.error'];
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:76]: Started server process [17146]
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:46]: Waiting for application startup.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:21]: Preparing to startup...
-[2023-09-01 00:00:00.000 +09:00 | OK    | main:22]: Finished preparation to startup.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:23]: API version: 0.0.1-000000
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:60]: Application startup complete.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:218]: Uvicorn running on http://0.0.0.0:9000 (Press CTRL+C to quit)
-[2023-09-01 00:00:00.000 +09:00 | DEBUG | anyio._backends._asyncio:833]: [f635ebbc3f2348db9dcff681be1bd52a] 127.0.0.1 - "GET / HTTP/1.1"
-[2023-09-01 00:00:00.000 +09:00 | OK    | anyio._backends._asyncio:833]: [f635ebbc3f2348db9dcff681be1bd52a] 127.0.0.1 - "GET / HTTP/1.1" 200 17B 0.7ms
-^C[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:264]: Shutting down
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:65]: Waiting for application shutdown.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | main:26]: Praparing to shutdown...
-[2023-09-01 00:00:00.000 +09:00 | OK    | main:27]: Finished preparation to shutdown.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.lifespan.on:76]: Application shutdown complete.
-[2023-09-01 00:00:00.000 +09:00 | INFO  | uvicorn.server:86]: Finished server process [17146]
-```
+- FastAPI HTTP access logging middleware
+- Install with pip: `pip install -U beans-logging[fastapi]` or `pip install -U beans-logging-fastapi`
 
 ---
 
@@ -467,3 +323,4 @@ logger:
 - <https://github.com/Delgan/loguru>
 - <https://loguru.readthedocs.io/en/stable/api/logger.html>
 - <https://loguru.readthedocs.io/en/stable/resources/recipes.html>
+- <https://github.com/bybatkhuu/module.fastapi-logging>

{beans_logging-5.0.0 → beans_logging-6.0.0}/beans_logging.egg-info/SOURCES.txt

@@ -19,11 +19,6 @@ beans_logging.egg-info/SOURCES.txt
 beans_logging.egg-info/dependency_links.txt
 beans_logging.egg-info/requires.txt
 beans_logging.egg-info/top_level.txt
-beans_logging/fastapi/__init__.py
-beans_logging/fastapi/_filters.py
-beans_logging/fastapi/_formats.py
-beans_logging/fastapi/_handlers.py
-beans_logging/fastapi/_middlewares.py
 tests/__init__.py
 tests/conftest.py
 tests/test_beans_logging.py

{beans_logging-5.0.0 → beans_logging-6.0.0}/beans_logging.egg-info/requires.txt

@@ -1,3 +1,6 @@
 PyYAML<7.0,>=6.0
 pydantic!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.10.0
 loguru<1.0.0,>=0.7.2
+
+[fastapi]
+beans-logging-fastapi<2.0.0,>=1.0.0

{beans_logging-5.0.0 → beans_logging-6.0.0}/setup.py

@@ -40,6 +40,7 @@ setup(
         "pydantic>=1.10.0,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0",
         "loguru>=0.7.2,<1.0.0",
     ],
+    extras_require={"fastapi": ["beans-logging-fastapi>=1.0.0,<2.0.0"]},
     classifiers=[
         "Development Status :: 4 - Beta",
         "Intended Audience :: Developers",

beans_logging-5.0.0/beans_logging/fastapi/__init__.py

@@ -1,6 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from ._filters import use_http_filter
-from ._formats import http_file_format, http_file_json_format
-from ._handlers import add_http_file_handler, add_http_file_json_handler
-from ._middlewares import HttpAccessLogMiddleware

beans_logging-5.0.0/beans_logging/fastapi/_filters.py

@@ -1,22 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from beans_logging.filters import use_all_filter
-
-
-def use_http_filter(record: dict) -> bool:
-    """Filter message only for http access log handler by checking 'http_info' key in extra.
-
-    Args:
-        record (dict): Log record as dictionary.
-
-    Returns:
-        bool: True if record has 'http_info' key in extra, False otherwise.
-    """
-
-    if not use_all_filter(record):
-        return False
-
-    if "http_info" not in record["extra"]:
-        return False
-
-    return True

beans_logging-5.0.0/beans_logging/fastapi/_formats.py

@@ -1,62 +0,0 @@
-# -*- coding: utf-8 -*-
-
-
-def http_file_format(record: dict) -> str:
-    """Http access log file format.
-
-    Args:
-        record (dict): Log record as dictionary.
-
-    Returns:
-        str: Format for http access log record.
-    """
-
-    _MSG_FORMAT = '{client_host} {request_id} {user_id} [{datetime}] "{method} {url_path} HTTP/{http_version}" {status_code} {content_length} "{h_referer}" "{h_user_agent}" {response_time}'
-
-    if "http_info" not in record["extra"]:
-        return ""
-
-    if "http_message" not in record:
-        _http_info = record["extra"]["http_info"]
-        if "datetime" not in _http_info:
-            _http_info["datetime"] = record["time"].isoformat()
-
-        if "content_length" not in _http_info:
-            _http_info["content_length"] = 0
-
-        if "h_referer" not in _http_info:
-            _http_info["h_referer"] = "-"
-
-        if "h_user_agent" not in _http_info:
-            _http_info["h_user_agent"] = "-"
-
-        if "response_time" not in _http_info:
-            _http_info["response_time"] = 0
-
-        record["extra"]["http_info"] = _http_info
-
-        _msg = _MSG_FORMAT.format(**_http_info)
-        record["http_message"] = _msg
-
-    return "{http_message}\n"
-
-
-def http_file_json_format(record: dict) -> str:
-    """Http access json log file format.
-
-    Args:
-        record (dict): Log record as dictionary.
-
-    Returns:
-        str: Format for http access json log record.
-    """
-
-    if "http_info" not in record["extra"]:
-        return ""
-
-    _http_info = record["extra"]["http_info"]
-    if "datetime" not in _http_info:
-        _http_info["datetime"] = record["time"].isoformat()
-        record["extra"]["http_info"] = _http_info
-
-    return "{extra[http_info]}\n"

beans_logging-5.0.0/beans_logging/fastapi/_handlers.py

@@ -1,79 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from typing import Union, Callable
-
-import pydantic
-
-if "2.0.0" <= pydantic.__version__:
-    from pydantic import validate_call
-else:
-    from pydantic import validate_arguments as validate_call
-
-from beans_logging import LoggerLoader
-
-from ._filters import use_http_filter
-from ._formats import http_file_format, http_file_json_format
-
-
-@validate_call(config=dict(arbitrary_types_allowed=True))
-def add_http_file_handler(
-    logger_loader: LoggerLoader,
-    log_path: str = "http/{app_name}.http.access.log",
-    err_path: str = "http/{app_name}.http.err.log",
-    formatter: Union[Callable, str] = http_file_format,
-):
-    """Add http access log file and error file handler.
-
-    Args:
-        logger_loader (LoggerLoader,         required): LoggerLoader instance.
-        log_path      (str,                  optional): Log file path. Defaults to "http/{app_name}.http.access.log".
-        err_path      (str,                  optional): Error log file path. Defaults to "http/{app_name}.http.err.log".
-        formatter     (Union[Callable, str], optional): Log formatter. Defaults to `http_file_format` function.
-    """
-
-    logger_loader.add_custom_handler(
-        handler_name="FILE.HTTP",
-        sink=log_path,
-        filter=use_http_filter,
-        format=formatter,
-    )
-
-    logger_loader.add_custom_handler(
-        handler_name="FILE.HTTP_ERR",
-        sink=err_path,
-        level="WARNING",
-        filter=use_http_filter,
-        format=formatter,
-    )
-
-
-@validate_call(config=dict(arbitrary_types_allowed=True))
-def add_http_file_json_handler(
-    logger_loader: LoggerLoader,
-    log_path: str = "json.http/{app_name}.json.http.access.log",
-    err_path: str = "json.http/{app_name}.json.http.err.log",
-    formatter: Union[Callable, str] = http_file_json_format,
-):
-    """Add http access json log file and json error file handler.
-
-    Args:
-        logger_loader (LoggerLoader,         required): LoggerLoader instance.
-        log_path      (str,                  optional): Json log file path. Defaults to "http.json/{app_name}.json.http.access.log".
-        err_path      (str,                  optional): Json error log file path. Defaults to "http.json/{app_name}.json.http.err.log".
-        formatter     (Union[Callable, str], optional): Log formatter. Defaults to `http_file_json_format` function.
-    """
-
-    logger_loader.add_custom_handler(
-        handler_name="FILE.JSON.HTTP",
-        sink=log_path,
-        filter=use_http_filter,
-        format=formatter,
-    )
-
-    logger_loader.add_custom_handler(
-        handler_name="FILE.JSON.HTTP_ERR",
-        sink=err_path,
-        level="WARNING",
-        filter=use_http_filter,
-        format=formatter,
-    )

beans_logging-5.0.0/beans_logging/fastapi/_middlewares.py

@@ -1,262 +0,0 @@
-# -*- coding: utf-8 -*-
-
-import json
-import time
-from uuid import uuid4
-
-from fastapi import Request, Response
-from fastapi.concurrency import run_in_threadpool
-from starlette.middleware.base import BaseHTTPMiddleware
-
-from beans_logging import logger
-
-
-class HttpAccessLogMiddleware(BaseHTTPMiddleware):
-    """Http access log middleware for FastAPI.
-
-    Inherits:
-        BaseHTTPMiddleware: Base HTTP middleware class from starlette.
-
-    Attributes:
-        _DEBUG_FORMAT     (str ): Default http access log debug message format. Defaults to '<n>[{request_id}]</n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'.
-        _MSG_FORMAT       (str ): Default http access log message format. Defaults to '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'.
-
-        has_proxy_headers (bool): If True, use proxy headers to get http request info. Defaults to False.
-        has_cf_headers    (bool): If True, use cloudflare headers to get http request info. Defaults to False.
-        debug_format      (str ): Http access log debug message format. Defaults to `HttpAccessLogMiddleware._DEBUG_FORMAT`.
-        msg_format        (str ): Http access log message format. Defaults to `HttpAccessLogMiddleware._MSG_FORMAT`.
-        use_debug_log     (bool): If True, use debug log to log http access log. Defaults to True.
-    """
-
-    _DEBUG_FORMAT = '<n>[{request_id}]</n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}"'
-    _MSG_FORMAT = '<n><w>[{request_id}]</w></n> {client_host} {user_id} "<u>{method} {url_path}</u> HTTP/{http_version}" {status_code} {content_length}B {response_time}ms'
-
-    def __init__(
-        self,
-        app,
-        has_proxy_headers: bool = False,
-        has_cf_headers: bool = False,
-        debug_format: str = _DEBUG_FORMAT,
-        msg_format: str = _MSG_FORMAT,
-        use_debug_log: bool = True,
-    ):
-        super().__init__(app)
-        self.has_proxy_headers = has_proxy_headers
-        self.has_cf_headers = has_cf_headers
-        self.debug_format = debug_format
-        self.msg_format = msg_format
-        self.use_debug_log = use_debug_log
-
-    async def dispatch(self, request: Request, call_next) -> Response:
-        _logger = logger.opt(colors=True, record=True)
-
-        _http_info = {}
-        _http_info["request_id"] = uuid4().hex
-        if "X-Request-ID" in request.headers:
-            _http_info["request_id"] = request.headers.get("X-Request-ID")
-        elif "X-Correlation-ID" in request.headers:
-            _http_info["request_id"] = request.headers.get("X-Correlation-ID")
-
-        ## Set request_id to request state:
-        request.state.request_id = _http_info["request_id"]
-
-        _http_info["client_host"] = request.client.host
-        _http_info["request_proto"] = request.url.scheme
-        _http_info["request_host"] = (
-            request.url.hostname if request.url.hostname else ""
-        )
-        if (request.url.port != 80) and (request.url.port != 443):
-            _http_info[
-                "request_host"
-            ] = f"{_http_info['request_host']}:{request.url.port}"
-
-        _http_info["request_port"] = request.url.port
-        _http_info["http_version"] = request.scope["http_version"]
-
-        if self.has_proxy_headers:
-            if "X-Real-IP" in request.headers:
-                _http_info["client_host"] = request.headers.get("X-Real-IP")
-            elif "X-Forwarded-For" in request.headers:
-                _http_info["client_host"] = request.headers.get(
-                    "X-Forwarded-For"
-                ).split(",")[0]
-                _http_info["h_x_forwarded_for"] = request.headers.get("X-Forwarded-For")
-
-            if "X-Forwarded-Proto" in request.headers:
-                _http_info["request_proto"] = request.headers.get("X-Forwarded-Proto")
-
-            if "X-Forwarded-Host" in request.headers:
-                _http_info["request_host"] = request.headers.get("X-Forwarded-Host")
-            elif "Host" in request.headers:
-                _http_info["request_host"] = request.headers.get("Host")
-
-            if "X-Forwarded-Port" in request.headers:
-                try:
-                    _http_info["request_port"] = int(
-                        request.headers.get("X-Forwarded-Port")
-                    )
-                except ValueError:
-                    logger.warning(
-                        f"`X-Forwarded-Port` header value '{request.headers.get('X-Forwarded-Port')}' is invalid, should be parseable to <int>!"
-                    )
-
-            if "Via" in request.headers:
-                _http_info["h_via"] = request.headers.get("Via")
-
-            if self.has_cf_headers:
-                if "CF-Connecting-IP" in request.headers:
-                    _http_info["client_host"] = request.headers.get("CF-Connecting-IP")
-                    _http_info["h_cf_connecting_ip"] = request.headers.get(
-                        "CF-Connecting-IP"
-                    )
-                elif "True-Client-IP" in request.headers:
-                    _http_info["client_host"] = request.headers.get("True-Client-IP")
-                    _http_info["h_true_client_ip"] = request.headers.get(
-                        "True-Client-IP"
-                    )
-
-                if "CF-IPCountry" in request.headers:
-                    _http_info["client_country"] = request.headers.get("CF-IPCountry")
-                    _http_info["h_cf_ipcountry"] = request.headers.get("CF-IPCountry")
-
-                if "CF-RAY" in request.headers:
-                    _http_info["h_cf_ray"] = request.headers.get("CF-RAY")
-
-                if "cf-ipcontinent" in request.headers:
-                    _http_info["h_cf_ipcontinent"] = request.headers.get(
-                        "cf-ipcontinent"
-                    )
-
-                if "cf-ipcity" in request.headers:
-                    _http_info["h_cf_ipcity"] = request.headers.get("cf-ipcity")
-
-                if "cf-iplongitude" in request.headers:
-                    _http_info["h_cf_iplongitude"] = request.headers.get(
-                        "cf-iplongitude"
-                    )
-
-                if "cf-iplatitude" in request.headers:
-                    _http_info["h_cf_iplatitude"] = request.headers.get("cf-iplatitude")
-
-                if "cf-postal-code" in request.headers:
-                    _http_info["h_cf_postal_code"] = request.headers.get(
-                        "cf-postal-code"
-                    )
-
-                if "cf-timezone" in request.headers:
-                    _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 request.url.query:
-            _http_info["url_path"] = f"{request.url.path}?{request.url.query}"
-
-        _http_info["url_query_params"] = request.query_params._dict
-        _http_info["url_path_params"] = request.path_params
-
-        _http_info["h_referer"] = request.headers.get("Referer", "-")
-        _http_info["h_user_agent"] = request.headers.get("User-Agent", "-")
-        _http_info["h_accept"] = request.headers.get("Accept", "")
-        _http_info["h_content_type"] = request.headers.get("Content-Type", "")
-
-        if "Origin" in request.headers:
-            _http_info["h_origin"] = request.headers.get("Origin")
-
-        _http_info["user_id"] = "-"
-        if hasattr(request.state, "user_id"):
-            _http_info["user_id"] = str(request.state.user_id)
-
-        ## Debug log:
-        if self.use_debug_log:
-            _debug_msg = self.debug_format.format(**_http_info)
-
-            # _logger.debug(_debug_msg)
-            await run_in_threadpool(
-                _logger.debug,
-                _debug_msg,
-            )
-        ## Debug log
-
-        ## Set http info to request state:
-        request.state.http_info = _http_info
-
-        _start_time = time.time()
-        ## Process request:
-        response = await call_next(request)
-        ## Response processed.
-        _http_info["response_time"] = round((time.time() - _start_time) * 1000, 1)
-
-        if "X-Process-Time" in response.headers:
-            try:
-                _http_info["response_time"] = float(
-                    response.headers.get("X-Process-Time")
-                )
-            except ValueError:
-                logger.warning(
-                    f"`X-Process-Time` header value '{response.headers.get('X-Process-Time')}' is invalid, should be parseable to <float>!"
-                )
-        else:
-            response.headers["X-Process-Time"] = str(_http_info["response_time"])
-
-        if "X-Request-ID" not in response.headers:
-            response.headers["X-Request-ID"] = _http_info["request_id"]
-
-        if hasattr(request.state, "user_id"):
-            _http_info["user_id"] = str(request.state.user_id)
-
-        _http_info["status_code"] = response.status_code
-        _http_info["content_length"] = 0
-        if "Content-Length" in response.headers:
-            try:
-                _http_info["content_length"] = int(
-                    response.headers.get("Content-Length")
-                )
-            except ValueError:
-                logger.warning(
-                    f"`Content-Length` header value '{response.headers.get('Content-Length')}' is invalid, should be parseable to <int>!"
-                )
-
-        try:
-            json.dumps(_http_info)
-        except TypeError:
-            logger.warning(
-                "Can not serialize `http_info` to json string in HttpAccessLogMiddleware!"
-            )
-
-        ## Http access log:
-        _LEVEL = "INFO"
-        _msg_format = self.msg_format
-        if _http_info["status_code"] < 200:
-            _LEVEL = "DEBUG"
-            _msg_format = f'<d>{_msg_format.replace("{status_code}", "<n><b><k>{status_code}</k></b></n>")}</d>'
-        elif (200 <= _http_info["status_code"]) and (_http_info["status_code"] < 300):
-            _LEVEL = "SUCCESS"
-            _msg_format = f'<w>{_msg_format.replace("{status_code}", "<lvl>{status_code}</lvl>")}</w>'
-        elif (300 <= _http_info["status_code"]) and (_http_info["status_code"] < 400):
-            _LEVEL = "INFO"
-            _msg_format = f'<d>{_msg_format.replace("{status_code}", "<n><b><c>{status_code}</c></b></n>")}</d>'
-        elif (400 <= _http_info["status_code"]) and (_http_info["status_code"] < 500):
-            _LEVEL = "WARNING"
-            _msg_format = _msg_format.replace("{status_code}", "<r>{status_code}</r>")
-        elif 500 <= _http_info["status_code"]:
-            _LEVEL = "ERROR"
-            _msg_format = (
-                f'{_msg_format.replace("{status_code}", "<n>{status_code}</n>")}'
-            )
-
-        _msg = _msg_format.format(**_http_info)
-        # _logger.bind(http_info=_http_info).log(_LEVEL, _msg)
-        await run_in_threadpool(
-            _logger.bind(http_info=_http_info).log,
-            _LEVEL,
-            _msg,
-        )
-        ## Http access log
-
-        return response