docs code highlight improvement

Author: p1c2u

docs/customizations.rst

@@ -9,17 +9,22 @@ By default, the provided specification is validated on ``Spec`` object creation
 If you know you have a valid specification already, disabling the validator can improve the performance.
 
 .. code-block:: python
+  :emphasize-lines: 5
 
    from openapi_core import Spec
 
-   spec = Spec.from_dict(spec_dict, validator=None)
+   spec = Spec.from_dict(
+       spec_dict,
+       validator=None,
+   )
 
 Media type deserializers
 ------------------------
 
 Pass custom defined media type deserializers dictionary with supported mimetypes as a key to `unmarshal_response` function:
 
 .. code-block:: python
+  :emphasize-lines: 13
 
    def protobuf_deserializer(message):
        feature = route_guide_pb2.Feature()
@@ -46,6 +51,7 @@ OpenAPI comes with a set of built-in format validators, but it's also possible t
 Here's how you could add support for a ``usdate`` format that handles dates of the form MM/DD/YYYY:
 
 .. code-block:: python
+  :emphasize-lines: 13
 
    import re
 
@@ -72,6 +78,7 @@ Openapi-core comes with a set of built-in format unmarshallers, but it's also po
 Here's an example with the ``usdate`` format that converts a value to date object:
 
 .. code-block:: python
+  :emphasize-lines: 13
 
    from datetime import datetime
 

docs/extensions.rst

@@ -4,9 +4,10 @@ Extensions
 x-model
 -------
 
-By default, objects are unmarshalled to dictionaries. You can use dynamically created dataclasses.
+By default, objects are unmarshalled to dictionaries. You can use dynamically created dataclasses by providing ``x-model-path`` property inside schema definition with name of the model.
 
 .. code-block:: yaml
+  :emphasize-lines: 5
 
    ...
    components:
@@ -23,10 +24,16 @@ By default, objects are unmarshalled to dictionaries. You can use dynamically cr
            lon:
              type: number
 
+As a result of unmarshalling process, you will get ``Coordinates`` class instance with ``lat`` and ``lon`` attributes.
+
+
+x-model-path
+------------
 
 You can use your own dataclasses, pydantic models or models generated by third party generators (i.e. `datamodel-code-generator <https://github.com/koxudaxi/datamodel-code-generator>`__) by providing ``x-model-path`` property inside schema definition with location of your class.
 
 .. code-block:: yaml
+  :emphasize-lines: 5
 
    ...
    components:
@@ -52,3 +59,5 @@ You can use your own dataclasses, pydantic models or models generated by third p
    class Coordinates:
        lat: float
        lon: float
+
+As a result of unmarshalling process, you will get instance of your own dataclasses or model.

docs/integrations.rst

@@ -21,6 +21,7 @@ Middleware
 Django can be integrated by middleware. Add ``DjangoOpenAPIMiddleware`` to your ``MIDDLEWARE`` list and define ``OPENAPI_SPEC``.
 
 .. code-block:: python
+  :emphasize-lines: 6,9
 
    # settings.py
    from openapi_core import Spec
@@ -87,11 +88,16 @@ Middleware
 The Falcon API can be integrated by ``FalconOpenAPIMiddleware`` middleware.
 
 .. code-block:: python
+  :emphasize-lines: 1,3,7
 
    from openapi_core.contrib.falcon.middlewares import FalconOpenAPIMiddleware
 
    openapi_middleware = FalconOpenAPIMiddleware.from_spec(spec)
-   app = falcon.App(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.
 
@@ -145,6 +151,7 @@ Decorator
 Flask views can be integrated by ``FlaskOpenAPIViewDecorator`` decorator.
 
 .. code-block:: python
+  :emphasize-lines: 1,3,6
 
    from openapi_core.contrib.flask.decorators import FlaskOpenAPIViewDecorator
 
@@ -153,44 +160,58 @@ Flask views can be integrated by ``FlaskOpenAPIViewDecorator`` decorator.
    @app.route('/home')
    @openapi
    def home():
-       pass
+       return "Welcome home"
 
 If you want to decorate class based view you can use the decorators attribute:
 
 .. code-block:: python
+  :emphasize-lines: 2
 
    class MyView(View):
        decorators = [openapi]
 
+       def dispatch_request(self):
+           return "Welcome home"
+
+   app.add_url_rule('/home', view_func=MyView.as_view('home'))
+
 View
 ~~~~
 
 As an alternative to the decorator-based integration, a Flask method based views can be integrated by inheritance from ``FlaskOpenAPIView`` class.
 
 .. code-block:: python
+  :emphasize-lines: 1,3,8
 
    from openapi_core.contrib.flask.views import FlaskOpenAPIView
 
    class MyView(FlaskOpenAPIView):
-       pass
+       def get(self):
+           return "Welcome home"
 
-   app.add_url_rule('/home', view_func=MyView.as_view('home', spec))
+   app.add_url_rule(
+       '/home',
+       view_func=MyView.as_view('home', spec),
+   )
 
 Request parameters
 ~~~~~~~~~~~~~~~~~~
 
 In Flask, all unmarshalled request data are provided as Flask request object's ``openapi.parameters`` attribute
 
 .. code-block:: python
+  :emphasize-lines: 6,7
 
    from flask.globals import request
 
    @app.route('/browse/<id>/')
    @openapi
-   def home():
+   def browse(id):
        browse_id = request.openapi.parameters.path['id']
        page = request.openapi.parameters.query.get('page', 1)
 
+       return f"Browse {browse_id}, page {page}"
+
 Low level
 ~~~~~~~~~
 

docs/unmarshalling.rst

@@ -61,11 +61,16 @@ In order to explicitly validate and unmarshal a:
 * OpenAPI 3.0 spec, import ``V30RequestUnmarshaller``
 * OpenAPI 3.1 spec, import ``V31RequestUnmarshaller`` or ``V31WebhookRequestUnmarshaller``
 
-.. code:: python
+.. code-block:: python
+  :emphasize-lines: 1,6
 
    from openapi_core import V31RequestUnmarshaller
 
-   result = unmarshal_request(request, response, spec=spec, cls=V31RequestUnmarshaller)
+   result = unmarshal_request(
+       request, response,
+       spec=spec,
+       cls=V31RequestUnmarshaller,
+   )
 
 You can also explicitly import ``V3RequestUnmarshaller`` which is a shortcut to the latest OpenAPI v3 version.
 
@@ -108,10 +113,15 @@ In order to explicitly validate and unmarshal a:
 * OpenAPI 3.0 spec, import ``V30ResponseUnmarshaller`` 
 * OpenAPI 3.1 spec, import ``V31ResponseUnmarshaller`` or ``V31WebhookResponseUnmarshaller`` 
 
-.. code:: python
+.. code-block:: python
+  :emphasize-lines: 1,6
 
    from openapi_core import V31ResponseUnmarshaller
 
-   result = unmarshal_response(request, response, spec=spec, cls=V31ResponseUnmarshaller)
+   result = unmarshal_response(
+       request, response,
+       spec=spec,
+       cls=V31ResponseUnmarshaller,
+   )
 
 You can also explicitly import ``V3ResponseUnmarshaller``  which is a shortcut to the latest OpenAPI v3 version.

docs/validation.rst

@@ -43,11 +43,16 @@ In order to explicitly validate and unmarshal a:
 * OpenAPI 3.0 spec, import ``V30RequestValidator``
 * OpenAPI 3.1 spec, import ``V31RequestValidator`` or ``V31WebhookRequestValidator``
 
-.. code:: python
+.. code-block:: python
+  :emphasize-lines: 1,6
 
    from openapi_core import V31RequestValidator
 
-   validate_request(request, response, spec=spec, cls=V31RequestValidator)
+   validate_request(
+       request, response,
+       spec=spec,
+       cls=V31RequestValidator,
+   )
 
 You can also explicitly import ``V3RequestValidator`` which is a shortcut to the latest OpenAPI v3 version.
 
@@ -81,10 +86,15 @@ In order to explicitly validate a:
 * OpenAPI 3.0 spec, import ``V30ResponseValidator`` 
 * OpenAPI 3.1 spec, import ``V31ResponseValidator`` or ``V31WebhookResponseValidator`` 
 
-.. code:: python
+.. code-block:: python
+  :emphasize-lines: 1,6
 
    from openapi_core import V31ResponseValidator
 
-   validate_response(request, response, spec=spec, cls=V31ResponseValidator)
+   validate_response(
+       request, response,
+       spec=spec,
+       cls=V31ResponseValidator,
+   )
 
 You can also explicitly import ``V3ResponseValidator``  which is a shortcut to the latest OpenAPI v3 version.