fastapi-basic 0.0.999992__py3-none-any.whl → 0.1.1__py3-none-any.whl

fastapi_basic/base_config.py

@@ -0,0 +1,17 @@
+from pydantic_settings import BaseSettings
+
+class BaseConfig(BaseSettings):
+    # Swagger docs config
+    DOCS_URL: str|None = '/docs'
+    REDOC_URL: str|None = '/redoc'
+    OPENAPI_URL: str|None = '/openapi.json'
+
+    # Logging config
+    LOGGER_NAME: str|None = 'uvicorn'
+
+    # AWS
+    AWS_ACCESS_KEY_ID: str = ""
+    AWS_SECRET_KEY: str = ""
+    AWS_REGION: str = ""
+    AWS_PARAMETER_PATH_PREFIX: str = ""
+    AWS_LOGGROUP_NAME: str = ""

fastapi_basic/base_factory.py

@@ -2,8 +2,16 @@ from abc import ABCMeta, abstractmethod
 from functools import lru_cache
 import os, dotenv
 
-from fastapi import FastAPI
+import watchtower
+from fastapi import FastAPI, HTTPException, Request
+from fastapi.responses import JSONResponse
+from fastapi.middleware.cors import CORSMiddleware
+from starlette.concurrency import iterate_in_threadpool
+import logging
 
+from .const import LOG_DEFAULT_LOGGER_NAME, LOG_FMT
+from .ext.aws import init_app as init_aws_app
+from .exception.base_exception import InternalBaseException
 from .utils import update_dict_with_cast
 
 class BaseFactory(metaclass=ABCMeta):
@@ -14,6 +22,32 @@ class BaseFactory(metaclass=ABCMeta):
         Each factory should define what config it wants.
         """
 
+    def __load_local_config(self):
+        dotenv.load_dotenv(dotenv_path='.env', override=True)
+        update_dict_with_cast(self.get_app_config(), os.environ)
+
+    def __setup_main_logger(self, app, logger_name=LOG_DEFAULT_LOGGER_NAME, level=logging.DEBUG):
+        logger = self.__setup_logger(app, logger_name, level)
+        app.logger = logger
+
+    def __setup_logger(self, app, logger_name, level=logging.INFO):
+        logger = logging.getLogger(logger_name)
+        logger.setLevel(level)
+
+        stream_handler = logging.StreamHandler()
+        stream_handler.setFormatter(logging.Formatter(LOG_FMT))
+        logger.addHandler(stream_handler)
+        return logger
+
+    def __setup_aws_cloud_log(self, app):
+        if app.state.aws_session and app.state.config.get("AWS_LOGGROUP_NAME"):
+            logs_client = app.state.aws_session.client("logs")
+            watchtower_handler = watchtower.CloudWatchLogHandler(
+                log_group_name=app.state.config.get("AWS_LOGGROUP_NAME"),
+                boto3_client=logs_client, create_log_group=True)
+            watchtower_handler.setFormatter(logging.Formatter(LOG_FMT))
+            app.logger.addHandler(watchtower_handler)
+
     def create_app(self):
         """
         Create an application instance.
@@ -22,8 +56,39 @@ class BaseFactory(metaclass=ABCMeta):
         app_config = self.get_app_config()
         app = FastAPI(docs_url=app_config.get('DOCS_URL'), redoc_url=app_config.get('REDOC_URL'), openapi_url=app_config.get('OPENAPI_URL'))
         app.state.config = app_config
-        return app
 
-    def __load_local_config(self):
-        dotenv.load_dotenv(override=True)
-        update_dict_with_cast(self.get_app_config(), os.environ)
+        app.add_middleware(
+            CORSMiddleware,
+            allow_origins=['*'],
+            allow_credentials=True,
+            allow_methods=['*'],
+            allow_headers=['*'],
+        )
+        self.__setup_main_logger(app, logger_name=app.state.config.get('LOGGER_NAME', LOG_DEFAULT_LOGGER_NAME), level=logging.DEBUG)
+        app.state.aws_session = init_aws_app(app)
+        self.__setup_aws_cloud_log(app)
+
+        @app.exception_handler(InternalBaseException)
+        async def http_exception_handler(request: Request, exc: InternalBaseException):
+            return JSONResponse(
+                status_code=exc.status_code,
+                content={
+                    "code": exc.detail["code"],
+                    "message": exc.detail["message"],
+                    "data": exc.detail["data"]
+                }
+            )
+
+        @app.middleware("http")
+        async def handle_request_headers(request: Request, call_next):
+            body = await request.body()
+            form = await request.form()
+            app.logger.info(f"request.url: {request.url}, method: {request.method}, headers: {request.headers}, body: {body}, form: {form}")
+            response = await call_next(request)
+            response_body = [section async for section in response.body_iterator]
+            response.body_iterator = iterate_in_threadpool(iter(response_body))
+            if response_body:
+                app.logger.info(f"response_body: {response_body[0].decode()}")
+            return response
+
+        return app

fastapi_basic/const.py

@@ -0,0 +1,2 @@
+LOG_DEFAULT_LOGGER_NAME = "uvicorn"
+LOG_FMT = '%(asctime)s %(filename)s %(levelname)s: %(message)s'

fastapi_basic/database/mongodb.py

@@ -0,0 +1,29 @@
+from beanie import init_beanie
+from motor.motor_asyncio import AsyncIOMotorClient
+
+class MongoDB:
+    def __init__(self, username: str, password: str, host: str, port: int, db_name: str, ssl: str=None, ssl_ca_certs: str=None):
+        self.username = username
+        self.password = password
+        self.host = host
+        self.port = port
+        self.db_name = db_name
+        self.ssl = ssl
+        self.ssl_ca_certs = ssl_ca_certs
+
+    async def connect(self, document_models: list):
+        db_settings = dict(
+            username=self.username,
+            password=self.password,
+            host=self.host,
+            port=self.port,
+            retryWrites=False
+        )
+        if self.ssl:
+            db_settings["ssl"] = self.ssl
+
+        if self.ssl_ca_certs and self.ssl_ca_certs != "":
+            db_settings["tlsCAFile"] = self.ssl_ca_certs
+
+        self.client = AsyncIOMotorClient(**db_settings)
+        await init_beanie(database=self.client[self.db_name], document_models=document_models)

fastapi_basic/exception/base_exception.py

@@ -0,0 +1,13 @@
+from fastapi import HTTPException
+from fastapi import status
+
+
+class InternalBaseException(HTTPException):
+    def __init__(self, status_code: int = status.HTTP_500_INTERNAL_SERVER_ERROR, code: str = "internal_server_error",
+                 message: str = "Internal server error", **kwargs):
+        detail = {
+            "code": code,
+            "message": message,
+            "data": kwargs,
+        }
+        super().__init__(status_code=status_code, detail=detail)

fastapi_basic/ext/aws/__init__.py

@@ -0,0 +1,24 @@
+# -*- coding: UTF-8 -*-
+import boto3
+
+from .const import AWS_CONF_KEY
+
+
+def init_app(app):
+    if not all([app.state.config.get(key) for key in AWS_CONF_KEY]):
+        # pylint: disable=no-member
+        app.logger.info("Lack AWS credential keys, ignore connect to AWS")
+        return None
+
+    aws_session = boto3.session.Session(
+        aws_access_key_id=app.state.config.AWS_ACCESS_KEY_ID,
+        aws_secret_access_key=app.state.config.AWS_SECRET_KEY,
+        region_name=app.state.config.AWS_REGION
+    )
+
+    # This should be logging when create Logging handlers,
+    # But we have too many CloudWatchLogHandler, only print once here.
+    if not getattr(app.state.config, "AWS_LOGGROUP_NAME"):
+        app.logger.info("Lack AWS configuration keys, ignore AWS CloudWatch log handlers")
+
+    return aws_session

fastapi_basic/ext/aws/const.py

@@ -0,0 +1 @@
+AWS_CONF_KEY = ["AWS_ACCESS_KEY_ID", "AWS_SECRET_KEY", "AWS_REGION"]

{fastapi_basic-0.0.999992.dist-info → fastapi_basic-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: fastapi_basic
-Version: 0.0.999992
+Version: 0.1.1
 Summary: A short description of your module
 Home-page: https://github.com/szx21023/fastapi-base
 Author: szx21023
@@ -12,6 +12,8 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 Requires-Dist: annotated-types==0.7.0
 Requires-Dist: anyio==4.9.0
+Requires-Dist: boto3==1.37.36
+Requires-Dist: botocore==1.37.36
 Requires-Dist: certifi==2025.1.31
 Requires-Dist: charset-normalizer==3.4.1
 Requires-Dist: click==8.1.8
@@ -19,16 +21,22 @@ Requires-Dist: dotenv==0.9.9
 Requires-Dist: fastapi==0.115.12
 Requires-Dist: h11==0.14.0
 Requires-Dist: idna==3.10
+Requires-Dist: jmespath==1.0.1
 Requires-Dist: pydantic==2.11.3
 Requires-Dist: pydantic_core==2.33.1
+Requires-Dist: python-dateutil==2.9.0.post0
 Requires-Dist: python-dotenv==1.1.0
+Requires-Dist: python-multipart==0.0.20
 Requires-Dist: requests==2.32.3
+Requires-Dist: s3transfer==0.11.5
+Requires-Dist: six==1.17.0
 Requires-Dist: sniffio==1.3.1
 Requires-Dist: starlette==0.46.1
 Requires-Dist: typing-inspection==0.4.0
 Requires-Dist: typing_extensions==4.13.1
 Requires-Dist: urllib3==2.3.0
 Requires-Dist: uvicorn==0.34.0
+Requires-Dist: watchtower==3.4.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

fastapi_basic-0.1.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+fastapi_basic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_basic/base_config.py,sha256=nimiiK5LRY9kmx3dBDbN7teO4R8E423-c2iyq9WMcCg,442
+fastapi_basic/base_factory.py,sha256=xrM4tbKjrhtqpzP2hupGJxiNeGsDnXfMYe8urOcq-ss,3801
+fastapi_basic/const.py,sha256=UA7-Eefu_dbWpbFn09Ei_BPb903SExnCgVbnm8_3ALE,99
+fastapi_basic/utils.py,sha256=8ympyQIXsKkxLILTI_7ug85vmKWYKqX0mpADjgHekgU,306
+fastapi_basic/database/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_basic/database/mongodb.py,sha256=XW7ApqYkR1Jf7LM1HaZ6jzYgajzuu1whKw5cpsjSO-M,1017
+fastapi_basic/exception/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_basic/exception/base_exception.py,sha256=xkpvAI8G96sqXqHgQC_rs2ZPL1liwKVXbXBIPF_8HPQ,473
+fastapi_basic/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fastapi_basic/ext/aws/__init__.py,sha256=N_cwnbv1N-F1SY6NenBOTZe20zGaKFu3UXAu17hFAXY,816
+fastapi_basic/ext/aws/const.py,sha256=Mmb6lo11aZZDAVy-nK-v_JxtVPPKYUo9GB4ihH7XYuM,68
+fastapi_basic-0.1.1.dist-info/METADATA,sha256=vopBHifYhaFjN8jw_Vm1sL2b7uiWfBpiVU0UAJGV3SY,1740
+fastapi_basic-0.1.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+fastapi_basic-0.1.1.dist-info/top_level.txt,sha256=Q9PdwWxaB4dy135MQHiroRYOqArdUSaIeEkzYinN6W0,14
+fastapi_basic-0.1.1.dist-info/RECORD,,

{fastapi_basic-0.0.999992.dist-info → fastapi_basic-0.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

fastapi_basic-0.0.999992.dist-info/RECORD

@@ -1,8 +0,0 @@
-fastapi_basic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastapi_basic/base_config.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fastapi_basic/base_factory.py,sha256=1FvDmK6tky7iqa5MmeZzaGbQR4pI4UPNJjNYkaDCezg,858
-fastapi_basic/utils.py,sha256=8ympyQIXsKkxLILTI_7ug85vmKWYKqX0mpADjgHekgU,306
-fastapi_basic-0.0.999992.dist-info/METADATA,sha256=hZfpyI6Ee5HYvERYNiMCK_5a7jN_eD2vUaB-1GyX7Xo,1473
-fastapi_basic-0.0.999992.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-fastapi_basic-0.0.999992.dist-info/top_level.txt,sha256=Q9PdwWxaB4dy135MQHiroRYOqArdUSaIeEkzYinN6W0,14
-fastapi_basic-0.0.999992.dist-info/RECORD,,