changed the way how errors are handled (different response structure: see HISTORY.rst); added back 3.6 support + added newer 3.8

Author: Lev Rubel

.github/workflows/pythonpackage.yml

@@ -9,7 +9,7 @@ jobs:
  strategy:
  max-parallel: 4
  matrix:
- python-version: [3.7, 3.8]
+ python-version: [3.6, 3.7, 3.8]
 
  steps:
  - uses: actions/checkout@v1

.travis.yml

@@ -2,11 +2,13 @@ language: python
 python:
 - 3.8
 - 3.7
+- 3.6
 install: pip install -U tox-travis
 script: tox
 deploy:
  provider: pypi
  distributions: sdist bdist_wheel
+ skip_existing: true
  user: identixone
  password:
  secure: LW3LxTFsfGqnJKyJmu+fOiDT5bJfBuhkrYjXPWnXY18uCnn/gWnivHtsQNcXK8x6PeRMjHZweFbqJ/xnlPLpqdp4xSWmMhrDX0yP0gsC/6P2dssicvfjuQlN2V1+NEcBYOaAvSoafxQ6b5uPmLuFjNbNQGvLmupsvvXVBgAUnoAS9bC4av7nNmCS8YFDP0kxNd4aP0VNzOxgIxLxdcJtRQgFyGjun7DH2Oj851YxRS5/AOES4zZcjuhNUyJX0zpry5HIPN/uheJKquaBz9tRkSREY88TA+kMAiEflZooY68YsVfNJWl7RRxdQh9jKEz3VqSpObNxT3nl1dKMzrv8Opm0WCst9hHn735ZQcE2Od3uUjH7mTgtJv7x+UHcHkdT9p7hMmSJfxog8kY9Ys0P1gsUyXp5/Ol+xEKuSVSAvyxGRSnryoANsTAlyRKmKlr3CT1xdzPb5f7yrd3+MceuwDCHilSI7TVWVslnYRiDZWWBhefKmxddAMu1xSKe3NDaF/5W0s3vuwy9vEQF2cjLn6oiNhzQFL+BWV4UGgRP0GBHobI/oWCZVUE1aCEfIhGIYoWYggHddYuH4Rh/qQMs22OxND5WnX30mYtHLCB8TP+VkEwY7IpQ++r0P8dFxofiuamFhl503CRXEUs/K1oExOS5PETD7cyjdDbJ+JAZwIk=

AUTHORS.rst

@@ -11,3 +11,5 @@ Contributors
 ------------
 
 * Yaroslav Ulanovich <yul@datacorp.ee>
+* BumagniyPacket <rly@datacorp.ee>
+* aCLr <a.ch.clr@gmail.com>

CONTRIBUTING.rst

@@ -102,7 +102,7 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
  your new functionality into a function with a docstring, and add the
  feature to the list in README.rst.
-3. The pull request should work for Python 3.7. Check
+3. The pull request should work for Python 3.6, 3.7, 3.8. Check
  https://travis-ci.org/identixone/fastapi_contrib/pull_requests
  and make sure that the tests pass for all supported Python versions.
 

HISTORY.rst

@@ -1,3 +1,35 @@
 =======
 History
 =======
+
+0.2.0
+--------
+
+General changes:
+
+* Added support for Python 3.8
+
+Breaking changes:
+
+* Changed the way of how the error structure look like
+
+.. code-block:: json
+
+ [
+ {
+ "error_codes": [400, 401],
+ "message": "Validation error.",
+ "fields": [
+ {
+ "name": "field1",
+ "message": "Field is required",
+ "error_code": 400
+ },
+ {
+ "name": "field2",
+ "message": "Invalid value",
+ "error_code": 401
+ }
+ ]
+ }
+ ]

README.rst

@@ -41,6 +41,11 @@ Features
 * Opentracing middleware & setup utility with Jaeger tracer + root span available in every Request's state
 * StateRequestIDMiddleware: receives configurable header and saves it in request state
 
+History
+--------
+
+See `HISTORY.rst <https://github.com/identixone/fastapi_contrib/blob/master/HISTORY.rst>`_.
+
 Roadmap
 --------
 

fastapi_contrib/exception_handlers.py

@@ -19,15 +19,23 @@ def parse_error(
  :param raw: Whether this is a raw error or wrapped pydantic error
  :return: dict with name of the field (or "__all__") and actual message
  """
+ print(err.type_, err.loc, raw)
  if err.type_ == "value_error.str.regex":
  message = "Provided value doesn't match valid format."
  elif err.type_ == "type_error.enum":
  message = "One or more values provided are not valid."
  else:
  message = err.msg or ""
+
+ if err.type_.startswith("value_error.error_code"):
+ error_code = int(err.type_.split(".")[-1])
+ else:
+ # default error code for non-custom errors is 400
+ error_code = 400
+
  if not raw:
  if len(err.loc) == 2:
- if str(err.loc[0]) == "body":
+ if str(err.loc[0]) in ["body", "query"]:
  name = err.loc[1]
  else:
  name = err.loc[0]
@@ -41,7 +49,7 @@ def parse_error(
  else:
  if len(err.loc) == 2:
  name = str(err.loc[0])
- message = f"{str(err.loc[1]).lower()}: {message}"
+ # message = f"{str(err.loc[1]).lower()}: {message}"
  elif len(err.loc) == 1:
  name = str(err.loc[0])
  else:
@@ -50,7 +58,11 @@ def parse_error(
  if name in field_names:
  return None
 
- return {"name": name, "message": message.capitalize()}
+ return {
+ "name": name,
+ "message": message.capitalize(),
+ "error_code": error_code,
+ }
 
 
 def raw_errors_to_fields(raw_errors: List) -> List[dict]:
@@ -60,23 +72,22 @@ def raw_errors_to_fields(raw_errors: List) -> List[dict]:
  :param raw_errors: List with instances of raw error
  :return: List of dicts (1 dict for every raw error)
  """
- # import pdb;pdb.set_trace()
  fields = []
  for top_err in raw_errors:
  if hasattr(top_err.exc, "raw_errors"):
  for err in top_err.exc.raw_errors:
  field_err = parse_error(
  err,
  field_names=list(map(lambda x: x["name"], fields)),
- raw=True
+ raw=True,
  )
  if field_err is not None:
  fields.append(field_err)
  else:
  field_err = parse_error(
  top_err,
  field_names=list(map(lambda x: x["name"], fields)),
- raw=False
+ raw=False,
  )
  if field_err is not None:
  fields.append(field_err)
@@ -98,8 +109,8 @@ async def http_exception_handler(
  """
  fields = getattr(exc, "fields", [])
  data = {
- "code": getattr(exc, "error_code", exc.status_code),
- "detail": getattr(exc, "message", exc.detail),
+ "error_codes": [getattr(exc, "error_code", exc.status_code)],
+ "message": getattr(exc, "detail", "Validation error."),
  "fields": fields,
  }
  return UJSONResponse(data, status_code=exc.status_code)
@@ -118,35 +129,30 @@ async def validation_exception_handler(
  :param exc: StarletteHTTPException instance
  :return: UJSONResponse with newly formatted error data
  """
- fields = raw_errors_to_fields(exc.raw_errors)
  status_code = getattr(exc, "status_code", 400)
+ fields = raw_errors_to_fields(exc.raw_errors)
+
+ if fields:
+ error_codes = set(list(map(lambda x: x["error_code"], fields)))
+ else:
+ error_codes = [getattr(exc, "error_code", status_code)]
+
  data = {
- "code": getattr(exc, "error_code", status_code),
- "detail": getattr(exc, "message", "Validation error"),
+ "error_codes": error_codes,
+ "message": getattr(exc, "message", "Validation error."),
  "fields": fields,
  }
  return UJSONResponse(data, status_code=status_code)
 
 
-async def internal_server_error_handler(
- request: Request, exc: RequestValidationError
-) -> UJSONResponse:
- code = exc.error_code if hasattr(exc, "error_code") else 500
- detail = exc.detail if hasattr(exc, "detail") else "Internal Server Error."
- fields = exc.fields if hasattr(exc, "fields") else []
- status_code = exc.status_code if hasattr(exc, "status_code") else 500
- data = {"code": code, "detail": detail, "fields": fields}
- return UJSONResponse(data, status_code=status_code)
-
-
 async def not_found_error_handler(
  request: Request, exc: RequestValidationError
 ) -> UJSONResponse:
- code = exc.error_code if hasattr(exc, "error_code") else 404
- detail = exc.detail if hasattr(exc, "detail") else "Not found."
- fields = exc.fields if hasattr(exc, "fields") else []
- status_code = exc.status_code if hasattr(exc, "status_code") else 404
- data = {"code": code, "detail": detail, "fields": fields}
+ code = getattr(exc, "error_code", 404)
+ detail = getattr(exc, "detail", "Not found.")
+ fields = getattr(exc, "fields", [])
+ status_code = getattr(exc, "status_code", 404)
+ data = {"error_codes": [code], "message": detail, "fields": fields}
  return UJSONResponse(data, status_code=status_code)
 
 
@@ -171,4 +177,3 @@ async def startup():
  RequestValidationError, validation_exception_handler
  )
  app.add_exception_handler(404, not_found_error_handler)
- app.add_exception_handler(500, internal_server_error_handler)

fastapi_contrib/exceptions.py

@@ -103,3 +103,24 @@ def __init__(
  detail=detail,
  fields=fields,
  )
+
+
+class InternalServerError(HTTPException):
+ def __init__(
+ self,
+ error_code: int = 500,
+ detail: Any = "Internal Server Error.",
+ fields: List[Dict] = None,
+ ):
+ """
+ Generic Internal Server Error with support for custom error code.
+
+ :param error_code: Custom error code, unique throughout the app
+ :param detail: detailed message of the error
+ """
+ super().__init__(
+ error_code=error_code,
+ status_code=500,
+ detail=detail,
+ fields=fields,
+ )

setup.py

@@ -11,7 +11,10 @@
 with open("HISTORY.rst") as history_file:
  history = history_file.read()
 
-requirements = ["fastapi==0.42.0"]
+requirements = [
+ 'fastapi==0.42.0',
+ 'contextvars;python_version<"3.7"'
+]
 
 setup_requirements = ["pytest-runner"]
 
@@ -26,7 +29,9 @@
  "License :: OSI Approved :: MIT License",
  "Natural Language :: English",
  "Programming Language :: Python :: 3",
+ "Programming Language :: Python :: 3.6",
  "Programming Language :: Python :: 3.7",
+ "Programming Language :: Python :: 3.8",
  ],
  description="Opinionated set of utilities on top of FastAPI",
  install_requires=requirements,

tests/auth/test_permissions.py

@@ -68,7 +68,7 @@ def test_doesnt_have_auth_permission():
  assert response.status_code == 401
  response = response.json()
  assert response == {
- "code": 401,
- "detail": "Not authenticated.",
+ "error_codes": [401],
+ "message": "Not authenticated.",
  "fields": [],
  }