spakky-fastapi 0.7.19__tar.gz → 0.10.0__tar.gz

{spakky_fastapi-0.7.19 → spakky_fastapi-0.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: spakky-fastapi
-Version: 0.7.19
+Version: 0.10.0
 Summary: Highly abstracted Framework core to use DDD & DI/IoC & AOP & Etc...
 Author: Spakky
 Author-email: sejong418@icloud.com
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: fastapi (>=0.109.2,<0.110.0)
 Requires-Dist: orjson (>=3.9.15,<4.0.0)
-Requires-Dist: spakky-core (>=0.7.14)
+Requires-Dist: spakky-core (>=0.12,<0.13)
 Requires-Dist: websockets (>=12.0,<13.0)
 Description-Content-Type: text/markdown
 

{spakky_fastapi-0.7.19 → spakky_fastapi-0.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "spakky-fastapi"
-version = "0.7.19"
+version = "0.10.0"
 description = "Highly abstracted Framework core to use DDD & DI/IoC & AOP & Etc..."
 authors = ["Spakky <sejong418@icloud.com>"]
 readme = "README.md"
@@ -12,7 +12,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry.dependencies]
 python = ">=3.10"
 fastapi = "^0.109.2"
-spakky-core = ">=0.7.14"
+spakky-core = "^0.12"
 websockets = "^12.0"
 orjson = "^3.9.15"
 
@@ -33,21 +33,21 @@ pytest-asyncio = "^0.21.1"
 
 [tool.black]
 line-length = 90
-target-version = ["py310"]
+target-version = ["py312"]
 include = '\.pyi?$'
 
 [tool.isort]
 py_version = 311
-src_paths = ["spakky", "tests"]
-skip = [".gitignore", ".dockerignore"]
+src_paths = ["spakky_fastapi", "tests"]
+skip = [".venv", ".gitignore", ".dockerignore"]
 extend_skip = [".md", ".json", ".txt"]
 profile = "black"
 combine_as_imports = true
 remove_redundant_aliases = true
 length_sort_sections = ["future", "stdlib"]
 
-[tool.pylint.MASTER]
-ignore-patterns = "test_.*?py"
+[tool.pylint]
+ignore-paths = [".venv", "tests"]
 
 [tool.pylint.'MESSAGES CONTROL']
 max-line-length = 90
@@ -63,7 +63,10 @@ disable = """
     too-few-public-methods,
     unnecessary-ellipsis,
     redefined-builtin,
-    too-many-locals
+    too-many-locals,
+    multiple-statements,
+    consider-using-f-string,
+    duplicate-code,
 """
 
 [tool.pytest.ini_options]

{spakky_fastapi-0.7.19/spakky_fastapi → spakky_fastapi-0.10.0/spakky_fastapi/aspects}/jwt_auth.py

@@ -1,20 +1,21 @@
 from typing import Any, TypeVar, Callable, Annotated, Awaitable, TypeAlias, Concatenate
+from inspect import iscoroutinefunction
 from logging import Logger
 from dataclasses import InitVar, field, dataclass
 
 from fastapi import Depends
 from fastapi.security import OAuth2PasswordBearer
 from spakky.aop.advice import Around
-from spakky.aop.advisor import IAsyncAdvisor
-from spakky.aop.aspect import AsyncAspect
+from spakky.aop.advisor import IAdvisor, IAsyncAdvisor
+from spakky.aop.aspect import Aspect, AsyncAspect
 from spakky.aop.error import SpakkyAOPError
 from spakky.aop.order import Order
-from spakky.bean.autowired import autowired
 from spakky.core.annotation import FunctionAnnotation
-from spakky.core.types import AsyncFunc, P
+from spakky.core.types import AsyncFunc, Func, P
 from spakky.cryptography.error import InvalidJWTFormatError, JWTDecodingError
 from spakky.cryptography.jwt import JWT
 from spakky.cryptography.key import Key
+
 from spakky_fastapi.error import Unauthorized
 
 R_co = TypeVar("R_co", covariant=True)
@@ -24,7 +25,10 @@ class AuthenticationFailedError(SpakkyAOPError):
     message = "사용자 인증에 실패했습니다."
 
 
-IAuthenticatedFunction: TypeAlias = Callable[Concatenate[Any, JWT, P], Awaitable[R_co]]
+IAuthenticatedFunction: TypeAlias = (
+    Callable[Concatenate[Any, JWT, P], R_co]
+    | Callable[Concatenate[Any, JWT, P], Awaitable[R_co]]
+)
 
 
 @dataclass
@@ -46,19 +50,47 @@ class JWTAuth(FunctionAnnotation):
         return super().__call__(obj)
 
 
+@Order(1)
+@Aspect()
+class JWTAuthAdvisor(IAdvisor):
+    __logger: Logger
+    __key: Key
+
+    def __init__(self, logger: Logger, key: Key) -> None:
+        super().__init__()
+        self.__logger = logger
+        self.__key = key
+
+    @Around(lambda x: JWTAuth.contains(x) and not iscoroutinefunction(x))
+    def around(self, joinpoint: Func, *args: Any, **kwargs: Any) -> Any:
+        annotation: JWTAuth = JWTAuth.single(joinpoint)
+        for keyword in annotation.token_keywords:
+            token: str = kwargs[keyword]
+            try:
+                jwt: JWT = JWT(token=token)
+            except (InvalidJWTFormatError, JWTDecodingError) as e:
+                raise Unauthorized(AuthenticationFailedError()) from e
+            if jwt.is_expired:
+                raise Unauthorized(AuthenticationFailedError())
+            if jwt.verify(self.__key) is False:
+                raise Unauthorized(AuthenticationFailedError())
+            self.__logger.info(f"[{type(self).__name__}] {jwt.payload!r}")
+            kwargs[keyword] = jwt
+        return joinpoint(*args, **kwargs)
+
+
 @Order(1)
 @AsyncAspect()
 class AsyncJWTAuthAdvisor(IAsyncAdvisor):
     __logger: Logger
     __key: Key
 
-    @autowired
     def __init__(self, logger: Logger, key: Key) -> None:
         super().__init__()
         self.__logger = logger
         self.__key = key
 
-    @Around(JWTAuth.contains)
+    @Around(lambda x: JWTAuth.contains(x) and iscoroutinefunction(x))
     async def around_async(self, joinpoint: AsyncFunc, *args: Any, **kwargs: Any) -> Any:
         annotation: JWTAuth = JWTAuth.single(joinpoint)
         for keyword in annotation.token_keywords:

{spakky_fastapi-0.7.19 → spakky_fastapi-0.10.0}/spakky_fastapi/middlewares/error_handling.py

@@ -3,9 +3,11 @@ from typing import Callable, Awaitable, TypeAlias
 from fastapi import Request
 from fastapi.responses import ORJSONResponse
 from pydantic import BaseModel
-from spakky_fastapi.error import InternalServerError, SpakkyFastAPIError
-from starlette.middleware.base import BaseHTTPMiddleware
+from starlette.middleware.base import BaseHTTPMiddleware, DispatchFunction
 from starlette.responses import Response
+from starlette.types import ASGIApp
+
+from spakky_fastapi.error import InternalServerError, SpakkyFastAPIError
 
 Next: TypeAlias = Callable[[Request], Awaitable[Response]]
 
@@ -13,9 +15,21 @@ Next: TypeAlias = Callable[[Request], Awaitable[Response]]
 class ErrorResponse(BaseModel):
     message: str
     args: list[str]
+    traceback: str = ""
 
 
 class ErrorHandlingMiddleware(BaseHTTPMiddleware):
+    __debug: bool
+
+    def __init__(
+        self,
+        app: ASGIApp,
+        dispatch: DispatchFunction | None = None,
+        debug: bool = False,
+    ) -> None:
+        super().__init__(app, dispatch)
+        self.__debug = debug
+
     async def dispatch(self, request: Request, call_next: Next) -> Response:
         try:
             return await call_next(request)
@@ -34,6 +48,7 @@ class ErrorHandlingMiddleware(BaseHTTPMiddleware):
                 content=ErrorResponse(
                     message=error.message,
                     args=[str(x) for x in error.args],
+                    traceback=error.traceback if self.__debug else "",
                 ).model_dump(),
                 status_code=error.status_code,
             )

spakky_fastapi-0.10.0/spakky_fastapi/plugins/fast_api.py

@@ -0,0 +1,24 @@
+from logging import Logger
+
+from fastapi import FastAPI
+from spakky.application.interfaces.pluggable import IPluggable
+from spakky.application.interfaces.registry import IRegistry
+
+from spakky_fastapi.post_processor import FastAPIBeanPostProcessor
+
+
+class FastAPIPlugin(IPluggable):
+    app: FastAPI
+    logger: Logger
+
+    def __init__(self, app: FastAPI, logger: Logger) -> None:
+        self.app = app
+        self.logger = logger
+
+    def register(self, registry: IRegistry) -> None:
+        registry.register_bean_post_processor(
+            FastAPIBeanPostProcessor(
+                self.app,
+                self.logger,
+            )
+        )

spakky_fastapi-0.10.0/spakky_fastapi/plugins/jwt_auth.py

@@ -0,0 +1,10 @@
+from spakky.application.interfaces.pluggable import IPluggable
+from spakky.application.interfaces.registry import IRegistry
+
+from spakky_fastapi.aspects.jwt_auth import AsyncJWTAuthAdvisor, JWTAuthAdvisor
+
+
+class JWTAuthPlugin(IPluggable):
+    def register(self, registry: IRegistry) -> None:
+        registry.register_bean(JWTAuthAdvisor)
+        registry.register_bean(AsyncJWTAuthAdvisor)

{spakky_fastapi-0.7.19 → spakky_fastapi-0.10.0}/spakky_fastapi/post_processor.py

@@ -6,10 +6,14 @@ from dataclasses import asdict
 from fastapi import APIRouter, FastAPI
 from fastapi.exceptions import FastAPIError
 from fastapi.utils import create_response_field  # type: ignore
-from spakky.bean.interfaces.bean_container import IBeanContainer
-from spakky.bean.interfaces.bean_processor import IBeanPostProcessor
-from spakky_fastapi.routing import Route, WebSocketRoute
-from spakky_fastapi.stereotypes.api_controller import ApiController
+from spakky.application.interfaces.bean_container import IBeanContainer
+from spakky.application.interfaces.bean_processor import IBeanPostProcessor
+
+from spakky_fastapi.stereotypes.api_controller import (
+    ApiController,
+    Route,
+    WebSocketRoute,
+)
 
 
 class FastAPIBeanPostProcessor(IBeanPostProcessor):
@@ -32,6 +36,7 @@ class FastAPIBeanPostProcessor(IBeanPostProcessor):
             if route is None and websocket_route is None:
                 continue
             if route is not None:
+                # pylint: disable=line-too-long
                 self.__logger.info(
                     f"[{type(self).__name__}] {route.methods!r} {controller.prefix}{route.path} -> {method.__qualname__}"
                 )
@@ -50,6 +55,7 @@ class FastAPIBeanPostProcessor(IBeanPostProcessor):
                             route.response_model = return_annotation
                 router.add_api_route(endpoint=method, **asdict(route))
             if websocket_route is not None:
+                # pylint: disable=line-too-long
                 self.__logger.info(
                     f"[{type(self).__name__}] [WebSocket] {controller.prefix}{websocket_route.path} -> {method.__qualname__}"
                 )

spakky_fastapi-0.7.19/spakky_fastapi/routing.py → spakky_fastapi-0.10.0/spakky_fastapi/stereotypes/api_controller.py

@@ -7,6 +7,7 @@ from fastapi.responses import JSONResponse
 from fastapi.routing import APIRoute
 from spakky.core.annotation import FunctionAnnotation
 from spakky.core.types import FuncT
+from spakky.stereotype.controller import Controller
 from starlette.routing import Route as StarletteRoute
 
 SetIntStr: TypeAlias = set[int | str]
@@ -500,3 +501,8 @@ def websocket(
         name=name,
         dependencies=dependencies,
     )
+
+
+@dataclass
+class ApiController(Controller):
+    tags: list[str | Enum] | None = None

spakky_fastapi-0.7.19/spakky_fastapi/stereotypes/api_controller.py

@@ -1,9 +0,0 @@
-from enum import Enum
-from dataclasses import dataclass
-
-from spakky.stereotype.controller import Controller
-
-
-@dataclass
-class ApiController(Controller):
-    tags: list[str | Enum] | None = None