fastapi-custom-responses 0.0.0__tar.gz

fastapi_custom_responses-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 KRYSTAL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_custom_responses-0.0.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.3
+Name: fastapi-custom-responses
+Version: 0.0.0
+Summary: FastAPI Custom Responses
+Author: Julien Kmec
+Author-email: me@julien.dev
+Requires-Python: >=3.11.0,<3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: dev
+Requires-Dist: black (>=24.3.0,<25.0.0) ; extra == "dev"
+Requires-Dist: fastapi[standard] (>=0.115.14)
+Requires-Dist: isort (>=5.12.0,<6.0.0) ; extra == "dev"
+Requires-Dist: pydantic (>=2.10.6)
+Requires-Dist: pydantic-super-model (>=1.0.3,<2.0.0)
+Requires-Dist: pylint (>=3.0.1,<4.0.0) ; extra == "dev"
+Description-Content-Type: text/markdown
+
+

fastapi_custom_responses-0.0.0/fastapi_custom_responses/__init__.py

@@ -0,0 +1,2 @@
+from .errors import setup_error_handlers, ErrorResponse
+from .responses import Response, PaginatedResponse

fastapi_custom_responses-0.0.0/fastapi_custom_responses/errors.py

@@ -0,0 +1,95 @@
+from http import HTTPStatus
+import logging
+from fastapi import FastAPI, Request, status
+from fastapi.exceptions import RequestValidationError
+from fastapi.responses import JSONResponse
+from fastapi_responses.responses import Response
+
+logger = logging.getLogger(__name__)
+
+ERROR_MESSAGES: dict[int, str] = {
+    401: "Authentication required",
+    403: "You don't have permission to perform this action",
+    404: "Resource not found",
+    400: "Invalid request",
+    422: "Invalid request data",
+    500: "An unexpected error occurred",
+}
+
+
+class ErrorResponse(Exception):
+    """Standard error response that includes error message."""
+
+    def __init__(self, error: str, status_code: int = HTTPStatus.BAD_REQUEST) -> None:
+        """Initialize error response with message and status code.
+
+        Args:
+            error: Error message to return
+            status_code: HTTP status code for the response
+        """
+
+        self.error = error
+        self.status_code = status_code
+
+        super().__init__(error)
+
+    @classmethod
+    def from_status_code(cls, status_code: int) -> "ErrorResponse":
+        """Create an error response from a status code.
+
+        Args:
+            status_code: HTTP status code to get error message for
+
+        Returns:
+            ErrorResponse with the appropriate error message for the status code
+        """
+
+        return cls(
+            error=ERROR_MESSAGES.get(status_code, ERROR_MESSAGES[500]),
+            status_code=status_code,
+        )
+
+
+def setup_error_handlers(app: FastAPI) -> None:
+    """Set up global error handlers for the application."""
+
+    @app.exception_handler(RequestValidationError)
+    async def validation_exception_handler(
+        _: Request, exc: RequestValidationError
+    ) -> JSONResponse:
+        """Handle validation errors from pydantic models."""
+
+        logger.exception(exc)
+
+        response = Response(success=False, error=ERROR_MESSAGES[422])
+
+        return JSONResponse(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            content=response.model_dump(mode="json"),
+        )
+
+    @app.exception_handler(ErrorResponse)
+    async def error_response_handler(_: Request, exc: ErrorResponse) -> JSONResponse:
+        """Convert ErrorResponse exceptions to proper JSONResponse objects."""
+
+        logger.info("ErrorResponse: %s - %s", exc.status_code, exc.error)
+
+        response = Response(success=False, error=exc.error)
+
+        return JSONResponse(
+            status_code=exc.status_code,
+            content=response.model_dump(mode="json"),
+        )
+
+    @app.exception_handler(Exception)
+    async def general_exception_handler(_: Request, exc: Exception) -> JSONResponse:
+        """Handle all unhandled exceptions."""
+
+        logger.exception(exc)
+
+        response = Response(success=False, error=ERROR_MESSAGES[500])
+
+        return JSONResponse(
+            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            content=response.model_dump(mode="json"),
+        )

fastapi_custom_responses-0.0.0/fastapi_custom_responses/responses.py

@@ -0,0 +1,24 @@
+from typing import Any
+from pydantic_super_model import SuperModel
+
+
+class Response[T](SuperModel):
+    """Response model."""
+
+    success: bool
+    data: T | None = None
+    error: str | None = None
+
+
+class PaginationMeta(SuperModel):
+    """Pagination metadata model."""
+
+    offset: int
+    limit: int
+    count: int
+
+
+class PaginatedResponse[T: Any](Response[list[T]]):
+    """Paginated response model."""
+
+    meta: PaginationMeta

fastapi_custom_responses-0.0.0/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "fastapi-custom-responses"
+version = "0.0.0"
+description = "FastAPI Custom Responses"
+authors = [
+    { name = "Julien Kmec", email = "me@julien.dev" },
+]
+readme = "README.md"
+homepage = "https://github.com/julien777z/fastapi-custom-responses"
+packages = [{include = "fastapi_custom_responses"}]
+requires-python = ">=3.11.0,<3.14"
+dependencies = [
+    "pydantic>=2.10.6",
+    "fastapi[standard]>=0.115.14",
+    "pydantic-super-model (>=1.0.3,<2.0.0)",
+]
+
+[tool.black]
+line-length = 110
+target-version = ["py312"]
+
+[tool.isort]
+profile = "black"
+line_length = 110
+
+[project.optional-dependencies]
+dev = [
+    "black (>=24.3.0,<25.0.0)",
+    "isort (>=5.12.0,<6.0.0)",
+    "pylint (>=3.0.1,<4.0.0)",
+]
+
+[build-system]
+requires = ["poetry-core", "setuptools"]
+build-backend = "poetry.core.masonry.api"