From 9dbf25bb625d608e957af9159dcebc6bd9f6a374 Mon Sep 17 00:00:00 2001 From: Dylan Tack Date: Mon, 1 Dec 2025 14:00:27 -0800 Subject: [PATCH 1/3] accomodate type changes in werkzeug 3.1.4 --- openapi_core/datatypes.py | 6 +++++- openapi_core/protocols.py | 8 +++++++- openapi_core/validation/response/validators.py | 7 ++++--- poetry.lock | 14 +++++++------- pyproject.toml | 4 +--- 5 files changed, 24 insertions(+), 15 deletions(-) diff --git a/openapi_core/datatypes.py b/openapi_core/datatypes.py index 38746aff..12ffcbba 100644 --- a/openapi_core/datatypes.py +++ b/openapi_core/datatypes.py @@ -6,10 +6,14 @@ from dataclasses import field from typing import Any from typing import Mapping +from typing import Union from werkzeug.datastructures import Headers from werkzeug.datastructures import ImmutableMultiDict +# Type alias for headers that accepts both Mapping and werkzeug Headers +HeadersType = Union[Mapping[str, Any], Headers] + @dataclass class RequestParameters: @@ -27,7 +31,7 @@ class RequestParameters: """ query: Mapping[str, Any] = field(default_factory=ImmutableMultiDict) - header: Mapping[str, Any] = field(default_factory=Headers) + header: HeadersType = field(default_factory=Headers) cookie: Mapping[str, Any] = field(default_factory=ImmutableMultiDict) path: Mapping[str, Any] = field(default_factory=dict) diff --git a/openapi_core/protocols.py b/openapi_core/protocols.py index 160354f3..0397956d 100644 --- a/openapi_core/protocols.py +++ b/openapi_core/protocols.py @@ -4,10 +4,16 @@ from typing import Mapping from typing import Optional from typing import Protocol +from typing import Union from typing import runtime_checkable +from werkzeug.datastructures import Headers + from openapi_core.datatypes import RequestParameters +# Type alias for headers that accepts both Mapping and werkzeug Headers +HeadersType = Union[Mapping[str, Any], Headers] + @runtime_checkable class BaseRequest(Protocol): @@ -109,7 +115,7 @@ def content_type(self) -> str: """The content type with parameters and always lowercase.""" @property - def headers(self) -> Mapping[str, Any]: + def headers(self) -> HeadersType: """Response headers as Headers.""" @property diff --git a/openapi_core/validation/response/validators.py b/openapi_core/validation/response/validators.py index cd4d4350..b600d996 100644 --- a/openapi_core/validation/response/validators.py +++ b/openapi_core/validation/response/validators.py @@ -15,6 +15,7 @@ from openapi_core.casting.schemas import oas30_read_schema_casters_factory from openapi_core.casting.schemas import oas31_schema_casters_factory from openapi_core.exceptions import OpenAPIError +from openapi_core.protocols import HeadersType from openapi_core.protocols import Request from openapi_core.protocols import Response from openapi_core.protocols import WebhookRequest @@ -44,7 +45,7 @@ def _iter_errors( self, status_code: int, data: Optional[bytes], - headers: Mapping[str, Any], + headers: HeadersType, mimetype: str, operation: SchemaPath, ) -> Iterator[Exception]: @@ -91,7 +92,7 @@ def _iter_data_errors( def _iter_headers_errors( self, status_code: int, - headers: Mapping[str, Any], + headers: HeadersType, operation: SchemaPath, ) -> Iterator[Exception]: try: @@ -141,7 +142,7 @@ def _get_data_value(self, data: Optional[bytes]) -> bytes: return data def _get_headers( - self, headers: Mapping[str, Any], operation_response: SchemaPath + self, headers: HeadersType, operation_response: SchemaPath ) -> Dict[str, Any]: if "headers" not in operation_response: return {} diff --git a/poetry.lock b/poetry.lock index 3c42f013..821d0408 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 2.1.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 2.2.1 and should not be changed by hand. [[package]] name = "aiohappyeyeballs" @@ -2730,18 +2730,18 @@ testing = ["coverage", "pytest (>=3.1.0)", "pytest-cov", "pytest-xdist"] [[package]] name = "werkzeug" -version = "3.0.6" +version = "3.1.4" description = "The comprehensive WSGI web application library." optional = false -python-versions = ">=3.8" +python-versions = ">=3.9" groups = ["main", "dev"] files = [ - {file = "werkzeug-3.0.6-py3-none-any.whl", hash = "sha256:1bc0c2310d2fbb07b1dd1105eba2f7af72f322e1e455f2f93c993bee8c8a5f17"}, - {file = "werkzeug-3.0.6.tar.gz", hash = "sha256:a8dd59d4de28ca70471a34cba79bed5f7ef2e036a76b3ab0835474246eb41f8d"}, + {file = "werkzeug-3.1.4-py3-none-any.whl", hash = "sha256:2ad50fb9ed09cc3af22c54698351027ace879a0b60a3b5edf5730b2f7d876905"}, + {file = "werkzeug-3.1.4.tar.gz", hash = "sha256:cd3cd98b1b92dc3b7b3995038826c68097dcb16f9baa63abe35f20eafeb9fe5e"}, ] [package.dependencies] -MarkupSafe = ">=2.1.1" +markupsafe = ">=2.1.1" [package.extras] watchdog = ["watchdog (>=2.3)"] @@ -2872,4 +2872,4 @@ starlette = ["aioitertools", "starlette"] [metadata] lock-version = "2.1" python-versions = "^3.9.0" -content-hash = "e65afc8fd5e0b210f7ad24da23b3321d7c9cd76cc8a81d7672d336668fbead0c" +content-hash = "85d4f608bc5c8d49dba112249b81e33f17527ca02389d331cee92bbe8d00188d" diff --git a/pyproject.toml b/pyproject.toml index 4621aaa7..9e5ecb3a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -71,9 +71,7 @@ parse = "*" openapi-schema-validator = "^0.6.0" openapi-spec-validator = "^0.7.1" requests = {version = "*", optional = true} -# werkzeug 3.1.2 changed the definition of Headers -# See https://github.com/python-openapi/openapi-core/issues/938 -werkzeug = "<3.1.2" +werkzeug = ">=2.1.0" jsonschema-path = "^0.3.4" jsonschema = "^4.23.0" multidict = {version = "^6.0.4", optional = true} From 97d5e0fb2767b31d82472991bac393b13405ac77 Mon Sep 17 00:00:00 2001 From: p1c2u Date: Fri, 12 Dec 2025 11:21:31 +0000 Subject: [PATCH 2/3] Update poetry in workflows --- .github/workflows/build-docs.yml | 2 +- .github/workflows/python-publish.yml | 2 +- .github/workflows/python-test.yml | 2 +- .readthedocs.yaml | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 86f82d36..4626df45 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -23,7 +23,7 @@ jobs: - name: Set up poetry uses: Gr1N/setup-poetry@v9 with: - poetry-version: "2.1.1" + poetry-version: "2.2.1" - name: Configure poetry run: poetry config virtualenvs.in-project true diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index c93d2ab7..89ccd979 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -25,7 +25,7 @@ jobs: - name: Set up poetry uses: Gr1N/setup-poetry@v9 with: - poetry-version: "2.1.1" + poetry-version: "2.2.1" - name: Build run: poetry build diff --git a/.github/workflows/python-test.yml b/.github/workflows/python-test.yml index a0d7a0db..e84287a2 100644 --- a/.github/workflows/python-test.yml +++ b/.github/workflows/python-test.yml @@ -31,7 +31,7 @@ jobs: - name: Set up poetry uses: Gr1N/setup-poetry@v9 with: - poetry-version: "2.1.1" + poetry-version: "2.2.1" - name: Configure poetry run: poetry config virtualenvs.in-project true diff --git a/.readthedocs.yaml b/.readthedocs.yaml index bde1686a..fe7c6754 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -16,7 +16,7 @@ build: jobs: post_system_dependencies: - asdf plugin-add poetry - - asdf install poetry 2.1.1 - - asdf global poetry 2.1.1 + - asdf install poetry 2.2.1 + - asdf global poetry 2.2.1 post_install: - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --no-interaction --with docs From 558b8f4f18fe631e4a9e5d74bc84f0d6994b34d1 Mon Sep 17 00:00:00 2001 From: p1c2u Date: Fri, 12 Dec 2025 11:23:41 +0000 Subject: [PATCH 3/3] Update poetry lock --- poetry.lock | 23 +---------------------- 1 file changed, 1 insertion(+), 22 deletions(-) diff --git a/poetry.lock b/poetry.lock index 821d0408..14431776 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1278,16 +1278,6 @@ files = [ {file = "MarkupSafe-2.1.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:5bbe06f8eeafd38e5d0a4894ffec89378b6c6a625ff57e3028921f8ff59318ac"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win32.whl", hash = "sha256:dd15ff04ffd7e05ffcb7fe79f1b98041b8ea30ae9234aed2a9168b5797c3effb"}, {file = "MarkupSafe-2.1.3-cp311-cp311-win_amd64.whl", hash = "sha256:134da1eca9ec0ae528110ccc9e48041e0828d79f24121a1a146161103c76e686"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:f698de3fd0c4e6972b92290a45bd9b1536bffe8c6759c62471efaa8acb4c37bc"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:aa57bd9cf8ae831a362185ee444e15a93ecb2e344c8e52e4d721ea3ab6ef1823"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ffcc3f7c66b5f5b7931a5aa68fc9cecc51e685ef90282f4a82f0f5e9b704ad11"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47d4f1c5f80fc62fdd7777d0d40a2e9dda0a05883ab11374334f6c4de38adffd"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1f67c7038d560d92149c060157d623c542173016c4babc0c1913cca0564b9939"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:9aad3c1755095ce347e26488214ef77e0485a3c34a50c5a5e2471dff60b9dd9c"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:14ff806850827afd6b07a5f32bd917fb7f45b046ba40c57abdb636674a8b559c"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8f9293864fe09b8149f0cc42ce56e3f0e54de883a9de90cd427f191c346eb2e1"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-win32.whl", hash = "sha256:715d3562f79d540f251b99ebd6d8baa547118974341db04f5ad06d5ea3eb8007"}, - {file = "MarkupSafe-2.1.3-cp312-cp312-win_amd64.whl", hash = "sha256:1b8dd8c3fd14349433c79fa8abeb573a55fc0fdd769133baac1f5e07abf54aeb"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8e254ae696c88d98da6555f5ace2279cf7cd5b3f52be2b5cf97feafe883b58d2"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cb0932dc158471523c9637e807d9bfb93e06a95cbf010f1a38b98623b929ef2b"}, {file = "MarkupSafe-2.1.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9402b03f1a1b4dc4c19845e5c749e3ab82d5078d16a2a4c2cd2df62d57bb0707"}, @@ -2232,7 +2222,6 @@ files = [ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, - {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, @@ -2240,16 +2229,8 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, - {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, - {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, - {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, - {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, - {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, @@ -2266,7 +2247,6 @@ files = [ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, - {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, @@ -2274,7 +2254,6 @@ files = [ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, - {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, @@ -2872,4 +2851,4 @@ starlette = ["aioitertools", "starlette"] [metadata] lock-version = "2.1" python-versions = "^3.9.0" -content-hash = "85d4f608bc5c8d49dba112249b81e33f17527ca02389d331cee92bbe8d00188d" +content-hash = "e32bb63ea7f2330067585834d57d706df2e54ebde1040c59bd510828b6d4ea39"