feat(core): Add common schemas

This commit is contained in:
Fangyin Cheng
2024-03-21 11:23:24 +08:00
parent ab3e8e54a1
commit b4b810d68f
18 changed files with 188 additions and 123 deletions

View File

@@ -1,12 +1,12 @@
import logging
import sys
from typing import TYPE_CHECKING, Any, Generic, Optional, TypeVar
from typing import TYPE_CHECKING
from fastapi import HTTPException, Request
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse
from dbgpt._private.pydantic import BaseModel, Field
from dbgpt.core.schema.api import Result
if sys.version_info < (3, 11):
try:
@@ -18,40 +18,6 @@ if TYPE_CHECKING:
from fastapi import FastAPI
logger = logging.getLogger(__name__)
T = TypeVar("T")
class Result(BaseModel, Generic[T]):
"""Common result entity class"""
success: bool = Field(
..., description="Whether it is successful, True: success, False: failure"
)
err_code: str | None = Field(None, description="Error code")
err_msg: str | None = Field(None, description="Error message")
data: T | None = Field(None, description="Return data")
@staticmethod
def succ(data: T) -> "Result[T]":
"""Build a successful result entity
Args:
data (T): Return data
Returns:
Result[T]: Result entity
"""
return Result(success=True, err_code=None, err_msg=None, data=data)
@staticmethod
def failed(msg: str, err_code: Optional[str] = "E000X") -> "Result[Any]":
"""Build a failed result entity
Args:
msg (str): Error message
err_code (Optional[str], optional): Error code. Defaults to "E000X".
"""
return Result(success=False, err_code=err_code, err_msg=msg, data=None)
async def validation_exception_handler(