feat: add description to parameters; bump: libs and tests; bump: 2.0.3

.gitlab-ci.yml

@@ -3,7 +3,7 @@ stages:
 
 publish-pypi:
   stage: package
-  image: python:3.10
+  image: python:3.11
   script:
     - sed -i -e "s/1.12.1/${CI_COMMIT_TAG:1}/g" aiohttp_pydantic/__init__.py
     - pip install -U setuptools wheel pip; pip install invoke

aiohttp_pydantic/injectors.py

@@ -68,7 +68,7 @@ class BodyGetter(AbstractInjector):
 
     def __init__(self, args_spec: dict, default_values: dict):
         self.arg_name, self.model = next(iter(args_spec.items()))
-        schema = self.model.schema()
+        schema = self.model.model_json_schema()
         if "type" not in schema:
             schema["type"] = "object"
         self._expect_object = schema["type"] == "object"

aiohttp_pydantic/oas/view.py

@@ -128,6 +128,9 @@ def _add_http_method_to_oas(
                 ref_template="#/components/schemas/{model}"
             )
 
+            if 'description' in oas_operation.parameters[i].schema:
+                oas_operation.parameters[i].description = oas_operation.parameters[i].schema['description']
+
             # move definitions
             if def_sub_schemas := oas_operation.parameters[i].schema.pop("$defs", None):
                 oas.components.schemas.update(def_sub_schemas)

requirements/ci.txt

@@ -1,11 +1,11 @@
-aiohttp==3.8.4
-pydantic==2.0.2
+aiohttp==3.8.6
+pydantic==2.4.2
 jinja2==3.1.2
 swagger-4-ui-bundle==0.0.4
-pytest==7.4.0
-pytest-aiohttp==1.0.4
+pytest==7.4.3
+pytest-aiohttp==1.0.5
 pytest-asyncio==0.21.1
 pytest-cov==4.1.0
-readme-renderer==40.0
+readme-renderer==42.0
 codecov==2.1.13
 twine==4.0.2

requirements/test.txt

@@ -1,9 +1,9 @@
-aiohttp==3.8.4
-pydantic==2.0.2
+aiohttp==3.8.6
+pydantic==2.4.2
 jinja2==3.1.2
 swagger-4-ui-bundle==0.0.4
-pytest==7.4.0
-pytest-aiohttp==1.0.4
+pytest==7.4.3
+pytest-aiohttp==1.0.5
 pytest-asyncio==0.21.1
 pytest-cov==4.1.0
-readme-renderer==40.0
+readme-renderer==42.0

setup.cfg

@@ -31,15 +31,15 @@ packages = find:
 python_requires = >=3.10
 install_requires =
     aiohttp
-    pydantic>=2.0.0
+    pydantic>=2.4.2
     swagger-4-ui-bundle
 
 [options.extras_require]
 test =
     pytest==7.4.0
-    pytest-aiohttp==1.0.4
+    pytest-aiohttp==1.0.5
     pytest-cov==4.1.0
-    readme-renderer==40.0
+    readme-renderer==42.0
 ci =
     %(test)s
     codecov==2.1.13

tests/test_hook_to_custom_response.py

@@ -54,6 +54,6 @@ async def test_post_an_article_with_wrong_type_field_should_return_an_error_mess
             'loc': ['nb_page'],
             'msg': 'Input should be a valid integer, unable to parse string as an integer',
             'type': 'int_parsing',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/int_parsing'
+            'url': 'https://errors.pydantic.dev/2.4/v/int_parsing'
         }
     ]

tests/test_oas/test_view.py

@@ -55,7 +55,8 @@ class Dog(BaseModel):
     barks: float
 
 
-Animal = RootModel[Annotated[Union[Cat, Dog], Field(discriminator='pet_type')]]
+class Animal(RootModel):
+    root: Annotated[Union[Cat, Dog], Field(discriminator='pet_type')]
 
 
 class PetCollectionView(PydanticView):

tests/test_validation_body.py

@@ -46,7 +46,7 @@ async def test_post_an_article_without_required_field_should_return_an_error_mes
             'loc_in': 'body',
             'msg': 'Field required',
             'type': 'missing',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/missing'
+            'url': 'https://errors.pydantic.dev/2.4/v/missing'
         }
     ]
 
@@ -68,7 +68,7 @@ async def test_post_an_article_with_wrong_type_field_should_return_an_error_mess
             'loc_in': 'body',
             'msg': 'Input should be a valid integer, unable to parse string as an integer',
             'type': 'int_parsing',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/int_parsing'
+            'url': 'https://errors.pydantic.dev/2.4/v/int_parsing'
         }
     ]
 
@@ -123,7 +123,7 @@ async def test_post_an_object_json_to_a_list_model_should_return_an_error(
             'loc_in': 'body',
             'msg': 'Input should be a valid list',
             'type': 'list_type',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/list_type'
+            'url': 'https://errors.pydantic.dev/2.4/v/list_type'
         }
     ]
 

tests/test_validation_header.py

@@ -80,7 +80,7 @@ async def test_get_article_without_required_header_should_return_an_error_messag
             'type': 'missing',
             'loc': ['signature_expired'],
             'msg': 'Field required',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/missing',
+            'url': 'https://errors.pydantic.dev/2.4/v/missing',
             'loc_in': 'headers'
         }
     ]
@@ -104,7 +104,7 @@ async def test_get_article_with_wrong_header_type_should_return_an_error_message
             'msg': 'Input should be a valid datetime, input is too short',
             'input': 'foo',
             'ctx': {'error': 'input is too short'},
-            'url': 'https://errors.pydantic.dev/2.1.2/v/datetime_parsing',
+            'url': 'https://errors.pydantic.dev/2.4/v/datetime_parsing',
             'loc_in': 'headers'
         }
     ]

tests/test_validation_path.py

@@ -41,6 +41,6 @@ async def test_get_article_with_wrong_path_parameters_should_return_error(
             'loc_in': 'path',
             'msg': 'Input should be a valid integer, unable to parse string as an integer',
             'type': 'int_parsing',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/int_parsing'
+            'url': 'https://errors.pydantic.dev/2.4/v/int_parsing'
         }
     ]

tests/test_validation_query_string.py

@@ -87,7 +87,7 @@ async def test_get_article_without_required_qs_should_return_an_error_message(
             'loc_in': 'query string',
             'msg': 'Field required',
             'type': 'missing',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/missing'
+            'url': 'https://errors.pydantic.dev/2.4/v/missing'
         }
     ]
 
@@ -109,7 +109,7 @@ async def test_get_article_with_wrong_qs_type_should_return_an_error_message(
             'loc_in': 'query string',
             'msg': 'Input should be a valid boolean, unable to interpret input',
             'type': 'bool_parsing',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/bool_parsing'
+            'url': 'https://errors.pydantic.dev/2.4/v/bool_parsing'
         }
     ]
 
@@ -168,7 +168,7 @@ async def test_get_article_with_multiple_value_for_qs_age_must_failed(
             'loc_in': 'query string',
             'msg': 'Input should be a valid integer',
             'type': 'int_type',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/int_type'
+            'url': 'https://errors.pydantic.dev/2.4/v/int_type'
         }
     ]
     assert resp.status == 400
@@ -227,7 +227,7 @@ async def test_get_article_without_required_field_page(aiohttp_client, event_loo
             'loc_in': 'query string',
             'msg': 'Field required',
             'type': 'missing',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/missing'
+            'url': 'https://errors.pydantic.dev/2.4/v/missing'
         }
     ]
     assert resp.status == 400
@@ -291,7 +291,7 @@ async def test_get_article_with_page_and_wrong_page_size(aiohttp_client, event_l
             'msg': 'Input should be a valid integer, unable to parse string as an '
                    'integer',
             'type': 'int_parsing',
-            'url': 'https://errors.pydantic.dev/2.1.2/v/int_parsing'
+            'url': 'https://errors.pydantic.dev/2.4/v/int_parsing'
         }
     ]
     assert resp.status == 400