fastapi-enum-errors/example.py at master · barabum0/fastapi-enum-errors · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
from enum import auto

from pydantic import Field

from fastapi_enum_errors import ErrorEnum, ErrorResponse


class NotSoImportantErrorDetails(ErrorResponse):
    some_ids: list[int] = Field(examples=[[123, 456, 789]])


class SomeErrors(ErrorEnum):
    SOME_VERY_IMPORTANT_ERROR = (auto(), 404)
    """THIS ERROR IS VERY VERY IMPORTANT"""

    NOT_SO_IMPORTANT_ERROR = (auto(), 500)
    """This error is not very important, but it has some additional details."""

    @classmethod
    def error_response_models(cls) -> dict:
        return {
            cls.NOT_SO_IMPORTANT_ERROR: NotSoImportantErrorDetails,
        }


print(SomeErrors.__members__)  # noqa: T201
# {'SOME_VERY_IMPORTANT_ERROR': <SomeErrors.SOME_VERY_IMPORTANT_ERROR: error='some_very_important_error', code=404>}

print(SomeErrors.build_md_table_for_all_errors())  # noqa: T201
# | Error Code                  | Description                                                           | Status code                   |
# |-----------------------------|-----------------------------------------------------------------------|-------------------------------|
# | `some_very_important_error` | THIS ERROR IS VERY VERY IMPORTANT                                     | **404** Not Found             |
# | `not_so_important_error`    | This error is not very important, but it has some additional details. | **500** Internal Server Error |

print(SomeErrors.build_responses(SomeErrors.SOME_VERY_IMPORTANT_ERROR))  # noqa: T201
# {
#    "404":{
#       "description":"Not Found\n- THIS ERROR IS VERY VERY IMPORTANT",
#       "content":{
#          "application/json":{
#             "schema":{
#                "type":"object",
#                "properties":{
#                   "detail":{
#                      "type":"string",
#                      "enum":[
#                         "THIS ERROR IS VERY VERY IMPORTANT"
#                      ]
#                   },
#                   "status_code":{
#                      "type":"integer",
#                      "enum":[
#                         404
#                      ]
#                   },
#                   "error_code":{
#                      "type":"string",
#                      "enum":[
#                         "some_very_important_error"
#                      ]
#                   }
#                },
#                "required":[
#                   "detail",
#                   "status_code",
#                   "error_code"
#                ]
#             },
#             "examples":{
#                "SOME_VERY_IMPORTANT_ERROR":{
#                   "value":{
#                      "detail":"THIS ERROR IS VERY VERY IMPORTANT",
#                      "status_code":404,
#                      "error_code":"some_very_important_error"
#                   },
#                   "summary":"THIS ERROR IS VERY VERY IMPORTANT"
#                }
#             }
#          }
#       }
#    }
# }

print(SomeErrors.from_str("some_very_important_error"))
# SomeErrors.SOME_VERY_IMPORTANT_ERROR