fastapi-basic 0.0.9__tar.gz → 0.0.11__tar.gz

{fastapi_basic-0.0.9 → fastapi_basic-0.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi_basic
-Version: 0.0.9
+Version: 0.0.11
 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,17 +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.0.9 → fastapi_basic-0.0.11}/fastapi_basic/base_config.py

@@ -7,4 +7,11 @@ class BaseConfig(BaseSettings):
     OPENAPI_URL: str|None = '/openapi.json'
 
     # Logging config
-    LOGGER_NAME: str|None = 'uvicorn'
+    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-0.0.9 → fastapi_basic-0.0.11}/fastapi_basic/base_factory.py

@@ -2,12 +2,16 @@ from abc import ABCMeta, abstractmethod
 from functools import lru_cache
 import os, dotenv
 
-from fastapi import FastAPI, Request
+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):
@@ -35,6 +39,15 @@ class BaseFactory(metaclass=ABCMeta):
         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.
@@ -52,6 +65,19 @@ class BaseFactory(metaclass=ABCMeta):
             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):

fastapi_basic-0.0.11/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-0.0.11/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-0.0.11/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.9 → fastapi_basic-0.0.11}/fastapi_basic.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi_basic
-Version: 0.0.9
+Version: 0.0.11
 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,17 +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.0.9 → fastapi_basic-0.0.11}/fastapi_basic.egg-info/SOURCES.txt

@@ -9,4 +9,9 @@ fastapi_basic.egg-info/PKG-INFO
 fastapi_basic.egg-info/SOURCES.txt
 fastapi_basic.egg-info/dependency_links.txt
 fastapi_basic.egg-info/requires.txt
-fastapi_basic.egg-info/top_level.txt
+fastapi_basic.egg-info/top_level.txt
+fastapi_basic/exception/__init__.py
+fastapi_basic/exception/base_exception.py
+fastapi_basic/ext/__init__.py
+fastapi_basic/ext/aws/__init__.py
+fastapi_basic/ext/aws/const.py

{fastapi_basic-0.0.9 → fastapi_basic-0.0.11}/fastapi_basic.egg-info/requires.txt

@@ -1,5 +1,7 @@
 annotated-types==0.7.0
 anyio==4.9.0
+boto3==1.37.36
+botocore==1.37.36
 certifi==2025.1.31
 charset-normalizer==3.4.1
 click==8.1.8
@@ -7,14 +9,19 @@ dotenv==0.9.9
 fastapi==0.115.12
 h11==0.14.0
 idna==3.10
+jmespath==1.0.1
 pydantic==2.11.3
 pydantic_core==2.33.1
+python-dateutil==2.9.0.post0
 python-dotenv==1.1.0
 python-multipart==0.0.20
 requests==2.32.3
+s3transfer==0.11.5
+six==1.17.0
 sniffio==1.3.1
 starlette==0.46.1
 typing-inspection==0.4.0
 typing_extensions==4.13.1
 urllib3==2.3.0
 uvicorn==0.34.0
+watchtower==3.4.0

{fastapi_basic-0.0.9 → fastapi_basic-0.0.11}/setup.py

@@ -5,7 +5,7 @@ with open('requirements.txt', 'r') as f:
 
 setup(
     name='fastapi_basic', # 模組名稱
-    version='0.0.9', # 版號版號
+    version='0.0.11', # 版號版號
     description='A short description of your module', # 模塊描述
     long_description=open('README.md').read(), # 詳細描述，通常是 README 文件的内容
     long_description_content_type='text/markdown', # markdown 格式