Merge branch 'master' into any-of

Author: sisp

.github/workflows/python-test.yml

@@ -10,6 +10,7 @@ on:
 
 jobs:
   test:
+    name: "Tests"
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -31,3 +32,16 @@ jobs:
       run: python setup.py test
     - name: Upload coverage
       uses: codecov/codecov-action@v1
+
+  static-checks:
+    name: "Static checks"
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )"
+        uses: actions/checkout@v2
+      - name: "Setup Python"
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: "Run static checks"
+        uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+---
+default_stages: [commit, push]
+default_language_version:
+  # force all unspecified python hooks to run python3
+  python: python3
+minimum_pre_commit_version: "1.20.0"
+repos:
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.19.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py36-plus"]
+  - repo: local
+    hooks:
+      - id: flynt
+        name: Convert to f-strings with flynt
+        entry: flynt
+        language: python
+        additional_dependencies: ['flynt==0.64']

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+
+Contributor Guide
+=================
+
+# Static checks
+
+The project uses static checks using fantastic [pre-commit](https://pre-commit.com/). Every change is checked on CI and if it does not pass the tests it cannot be accepted. If you want to check locally then run following command to install pre-commit:
+
+```bash
+pip install -r requiremenets_dev.txt
+```
+
+To turn on pre-commit checks for commit operations in git, enter:
+```bash
+pre-commit install
+```
+
+To run all checks on your staged files, enter:
+```bash
+pre-commit run
+```
+
+To run all checks on all files, enter:
+```bash
+pre-commit run --all-files
+```
+
+Pre-commit check results are also attached to your PR through integration with Github Action.

docs/integrations.rst

@@ -4,15 +4,55 @@ Integrations
 Bottle
 ------
 
-See `bottle-openapi-3  <https://github.com/cope-systems/bottle-openapi-3>`_ project.
+See `bottle-openapi-3 <https://github.com/cope-systems/bottle-openapi-3>`_ project.
 
 
 Django
 ------
 
 This section describes integration with `Django <https://www.djangoproject.com>`__ web framework.
+The integration supports Django from version 3.0 and above.
 
-For Django 2.2 you can use DjangoOpenAPIRequest a Django request factory:
+Middleware
+~~~~~~~~~~
+
+Django can be integrated by middleware. Add `DjangoOpenAPIMiddleware` to your `MIDDLEWARE` list and define `OPENAPI_SPEC`.
+
+.. code-block:: python
+
+   # settings.py
+   from openapi_core import create_spec
+
+   MIDDLEWARE = [
+       # ...
+       'openapi_core.contrib.django.middlewares.DjangoOpenAPIMiddleware',
+   ]
+
+   OPENAPI_SPEC = create_spec(spec_dict)
+
+After that you have access to validation result object with all validated request data from Django view through request object.
+
+.. code-block:: python
+
+   from django.views import View
+
+   class MyView(View):
+       def get(self, req):
+           # get parameters object with path, query, cookies and headers parameters
+           validated_params = req.openapi.parameters
+           # or specific location parameters
+           validated_path_params = req.openapi.parameters.path
+
+           # get body
+           validated_body = req.openapi.body
+
+           # get security data
+           validated_security = req.openapi.security
+
+Low level
+~~~~~~~~~
+
+You can use `DjangoOpenAPIRequest` as a Django request factory:
 
 .. code-block:: python
 
@@ -23,7 +63,7 @@ For Django 2.2 you can use DjangoOpenAPIRequest a Django request factory:
    validator = RequestValidator(spec)
    result = validator.validate(openapi_request)
 
-You can use DjangoOpenAPIResponse as a Django response factory:
+You can use `DjangoOpenAPIResponse` as a Django response factory:
 
 .. code-block:: python
 
@@ -39,41 +79,59 @@ Falcon
 ------
 
 This section describes integration with `Falcon <https://falconframework.org>`__ web framework.
+The integration supports Falcon from version 3.0 and above.
 
 Middleware
 ~~~~~~~~~~
 
-Falcon API can be integrated by `FalconOpenAPIMiddleware` middleware.
+The Falcon API can be integrated by `FalconOpenAPIMiddleware` middleware.
 
 .. code-block:: python
 
    from openapi_core.contrib.falcon.middlewares import FalconOpenAPIMiddleware
 
    openapi_middleware = FalconOpenAPIMiddleware.from_spec(spec)
-   api = falcon.API(middleware=[openapi_middleware])
+   app = falcon.App(middleware=[openapi_middleware])
+
+After that you will have access to validation result object with all validated request data from Falcon view through request context.
+
+.. code-block:: python
+
+   class ThingsResource:
+       def on_get(self, req, resp):
+           # get parameters object with path, query, cookies and headers parameters
+           validated_params = req.context.openapi.parameters
+           # or specific location parameters
+           validated_path_params = req.context.openapi.parameters.path
+
+           # get body
+           validated_body = req.context.openapi.body
+
+           # get security data
+           validated_security = req.context.openapi.security
 
 Low level
 ~~~~~~~~~
 
-For Falcon you can use FalconOpenAPIRequest a Falcon request factory:
+You can use `FalconOpenAPIRequest` as a Falcon request factory:
 
 .. code-block:: python
 
    from openapi_core.validation.request.validators import RequestValidator
    from openapi_core.contrib.falcon import FalconOpenAPIRequestFactory
 
-   openapi_request = FalconOpenAPIRequestFactory.create(falcon_request)
+   openapi_request = FalconOpenAPIRequestFactory().create(falcon_request)
    validator = RequestValidator(spec)
    result = validator.validate(openapi_request)
 
-You can use FalconOpenAPIResponse as a Falcon response factory:
+You can use `FalconOpenAPIResponse` as a Falcon response factory:
 
 .. code-block:: python
 
    from openapi_core.validation.response.validators import ResponseValidator
    from openapi_core.contrib.falcon import FalconOpenAPIResponseFactory
 
-   openapi_response = FalconOpenAPIResponseFactory.create(falcon_response)
+   openapi_response = FalconOpenAPIResponseFactory().create(falcon_response)
    validator = ResponseValidator(spec)
    result = validator.validate(openapi_request, openapi_response)
 
@@ -109,7 +167,7 @@ If you want to decorate class based view you can use the decorators attribute:
 View
 ~~~~
 
-As an alternative to the decorator-based integration, Flask method based views can be integrated by inheritance from `FlaskOpenAPIView` class.
+As an alternative to the decorator-based integration, a Flask method based views can be integrated by inheritance from `FlaskOpenAPIView` class.
 
 .. code-block:: python
 
@@ -123,7 +181,7 @@ As an alternative to the decorator-based integration, Flask method based views c
 Request parameters
 ~~~~~~~~~~~~~~~~~~
 
-In Flask, all unmarshalled request data are provided as Flask request object's openapi.parameters attribute
+In Flask, all unmarshalled request data are provided as Flask request object's `openapi.parameters` attribute
 
 .. code-block:: python
 
@@ -138,7 +196,7 @@ In Flask, all unmarshalled request data are provided as Flask request object's o
 Low level
 ~~~~~~~~~
 
-You can use FlaskOpenAPIRequest a Flask/Werkzeug request factory:
+You can use `FlaskOpenAPIRequest` as a Flask/Werkzeug request factory:
 
 .. code-block:: python
 
@@ -149,7 +207,7 @@ You can use FlaskOpenAPIRequest a Flask/Werkzeug request factory:
    validator = RequestValidator(spec)
    result = validator.validate(openapi_request)
 
-You can use FlaskOpenAPIResponse as a Flask/Werkzeug response factory:
+You can use `FlaskOpenAPIResponse` as a Flask/Werkzeug response factory:
 
 .. code-block:: python
 
@@ -164,7 +222,7 @@ You can use FlaskOpenAPIResponse as a Flask/Werkzeug response factory:
 Pyramid
 -------
 
-See `pyramid_openapi3  <https://github.com/niteoweb/pyramid_openapi3>`_ project.
+See `pyramid_openapi3 <https://github.com/niteoweb/pyramid_openapi3>`_ project.
 
 
 Requests
@@ -175,7 +233,7 @@ This section describes integration with `Requests <https://requests.readthedocs.
 Low level
 ~~~~~~~~~
 
-For Requests you can use RequestsOpenAPIRequest a Requests request factory:
+You can use `RequestsOpenAPIRequest` as a Requests request factory:
 
 .. code-block:: python
 
@@ -186,7 +244,7 @@ For Requests you can use RequestsOpenAPIRequest a Requests request factory:
    validator = RequestValidator(spec)
    result = validator.validate(openapi_request)
 
-You can use RequestsOpenAPIResponse as a Requests response factory:
+You can use `RequestsOpenAPIResponse` as a Requests response factory:
 
 .. code-block:: python
 
@@ -200,4 +258,4 @@ You can use RequestsOpenAPIResponse as a Requests response factory:
 Tornado
 -------
 
-See `tornado-openapi3  <https://github.com/correl/tornado-openapi3>`_ project.
+See `tornado-openapi3 <https://github.com/correl/tornado-openapi3>`_ project.

docs/usage.rst

@@ -38,7 +38,7 @@ and unmarshal request data from validation result
 
    # get parameters object with path, query, cookies and headers parameters
    validated_params = result.parameters
-   # or specific parameters
+   # or specific location parameters
    validated_path_params = result.parameters.path
 
    # get body

openapi_core/__init__.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """OpenAPI core module"""
 from openapi_core.shortcuts import (
     create_spec, validate_request, validate_response,

openapi_core/casting/schemas/exceptions.py

@@ -10,5 +10,4 @@ class CastError(OpenAPIError):
     type: str
 
     def __str__(self):
-        return "Failed to cast value to {type} type: {value}".format(
-            type=self.type, value=self.value)
+        return f"Failed to cast value to {self.type} type: {self.value}"

openapi_core/contrib/django/__init__.py

@@ -1,9 +1,9 @@
+"""OpenAPI core contrib django module"""
 from openapi_core.contrib.django.requests import DjangoOpenAPIRequestFactory
 from openapi_core.contrib.django.responses import DjangoOpenAPIResponseFactory
 
-# backward compatibility
-DjangoOpenAPIRequest = DjangoOpenAPIRequestFactory.create
-DjangoOpenAPIResponse = DjangoOpenAPIResponseFactory.create
+DjangoOpenAPIRequest = DjangoOpenAPIRequestFactory().create
+DjangoOpenAPIResponse = DjangoOpenAPIResponseFactory().create
 
 __all__ = [
     'DjangoOpenAPIRequestFactory', 'DjangoOpenAPIResponseFactory',