mirror of
https://github.com/fastapi-practices/fastapi_best_architecture.git
synced 2025-08-15 12:03:28 +08:00
5e438c685d
* define the basic architecture * Update script and deployment file locations * Update the route registration * Fix CI download dependencies * Updated ruff to 0.3.3 * Update app subdirectory naming * Update the model import * fix pre-commit pdm lock * Update the service directory naming * Add CRUD method documents * Fix the issue of circular import * Update the README document * Update the SQL statement for create tables * Update docker scripts and documentation * Fix docker scripts * Update the backend README.md * Add the security folder and move the redis client * Update the configuration item * Fix environment configuration reads * Update the default configuration * Updated README description * Updated the user registration API * Fix test cases * Update the celery configuration * Update and fix celery configuration * Updated the celery structure * Update celery tasks and api * Add celery flower * Update the import style * Update contributors
88 lines
3.2 KiB
Python
88 lines
3.2 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
"""
|
|
全局业务异常类
|
|
|
|
业务代码执行异常时，可以使用 raise xxxError 触发内部错误，它尽可能实现带有后台任务的异常，但它不适用于**自定义响应状态码**
|
|
如果要求使用**自定义响应状态码**，则可以通过 return await response_base.fail(res=CustomResponseCode.xxx) 直接返回
|
|
""" # noqa: E501
|
|
|
|
from typing import Any
|
|
|
|
from fastapi import HTTPException
|
|
from starlette.background import BackgroundTask
|
|
|
|
from backend.common.response.response_code import CustomErrorCode, StandardResponseCode
|
|
|
|
|
|
class BaseExceptionMixin(Exception):
|
|
code: int
|
|
|
|
def __init__(self, *, msg: str = None, data: Any = None, background: BackgroundTask | None = None):
|
|
self.msg = msg
|
|
self.data = data
|
|
# The original background task: https://www.starlette.io/background/
|
|
self.background = background
|
|
|
|
|
|
class HTTPError(HTTPException):
|
|
def __init__(self, *, code: int, msg: Any = None, headers: dict[str, Any] | None = None):
|
|
super().__init__(status_code=code, detail=msg, headers=headers)
|
|
|
|
|
|
class CustomError(BaseExceptionMixin):
|
|
def __init__(self, *, error: CustomErrorCode, data: Any = None, background: BackgroundTask | None = None):
|
|
self.code = error.code
|
|
super().__init__(msg=error.msg, data=data, background=background)
|
|
|
|
|
|
class RequestError(BaseExceptionMixin):
|
|
code = StandardResponseCode.HTTP_400
|
|
|
|
def __init__(self, *, msg: str = 'Bad Request', data: Any = None, background: BackgroundTask | None = None):
|
|
super().__init__(msg=msg, data=data, background=background)
|
|
|
|
|
|
class ForbiddenError(BaseExceptionMixin):
|
|
code = StandardResponseCode.HTTP_403
|
|
|
|
def __init__(self, *, msg: str = 'Forbidden', data: Any = None, background: BackgroundTask | None = None):
|
|
super().__init__(msg=msg, data=data, background=background)
|
|
|
|
|
|
class NotFoundError(BaseExceptionMixin):
|
|
code = StandardResponseCode.HTTP_404
|
|
|
|
def __init__(self, *, msg: str = 'Not Found', data: Any = None, background: BackgroundTask | None = None):
|
|
super().__init__(msg=msg, data=data, background=background)
|
|
|
|
|
|
class ServerError(BaseExceptionMixin):
|
|
code = StandardResponseCode.HTTP_500
|
|
|
|
def __init__(
|
|
self, *, msg: str = 'Internal Server Error', data: Any = None, background: BackgroundTask | None = None
|
|
):
|
|
super().__init__(msg=msg, data=data, background=background)
|
|
|
|
|
|
class GatewayError(BaseExceptionMixin):
|
|
code = StandardResponseCode.HTTP_502
|
|
|
|
def __init__(self, *, msg: str = 'Bad Gateway', data: Any = None, background: BackgroundTask | None = None):
|
|
super().__init__(msg=msg, data=data, background=background)
|
|
|
|
|
|
class AuthorizationError(BaseExceptionMixin):
|
|
code = StandardResponseCode.HTTP_401
|
|
|
|
def __init__(self, *, msg: str = 'Permission Denied', data: Any = None, background: BackgroundTask | None = None):
|
|
super().__init__(msg=msg, data=data, background=background)
|
|
|
|
|
|
class TokenError(HTTPError):
|
|
code = StandardResponseCode.HTTP_401
|
|
|
|
def __init__(self, *, msg: str = 'Not Authenticated', headers: dict[str, Any] | None = None):
|
|
super().__init__(code=self.code, msg=msg, headers=headers or {'WWW-Authenticate': 'Bearer'})
|