fix: Ignore mypy error when returning None

robertschweizer · robertschweizer · commit b666c4cf279e · 2023-03-27T10:50:38.000+02:00
This was introduced in "fix: Make empty response a `NoneProperty`",
but is easier to fix now with the refactored endpoint_module.py.jinja.
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/default/get_common_parameters.py b/end_to_end_tests/golden-record/my_test_api_client/api/default/get_common_parameters.py
@@ -48,7 +48,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/default/post_common_parameters.py b/end_to_end_tests/golden-record/my_test_api_client/api/default/post_common_parameters.py
@@ -48,7 +48,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/location/get_location_header_types.py b/end_to_end_tests/golden-record/my_test_api_client/api/location/get_location_header_types.py
@@ -67,7 +67,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/location/get_location_query_optionality.py b/end_to_end_tests/golden-record/my_test_api_client/api/location/get_location_query_optionality.py
@@ -72,7 +72,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/get_parameter_references_path_param.py b/end_to_end_tests/golden-record/my_test_api_client/api/parameter_references/get_parameter_references_path_param.py
@@ -60,7 +60,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/parameters/delete_common_parameters_overriding_param.py b/end_to_end_tests/golden-record/my_test_api_client/api/parameters/delete_common_parameters_overriding_param.py
@@ -49,7 +49,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/parameters/get_common_parameters_overriding_param.py b/end_to_end_tests/golden-record/my_test_api_client/api/parameters/get_common_parameters_overriding_param.py
@@ -49,7 +49,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/parameters/get_same_name_multiple_locations_param.py b/end_to_end_tests/golden-record/my_test_api_client/api/parameters/get_same_name_multiple_locations_param.py
@@ -57,7 +57,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/parameters/multiple_path_parameters.py b/end_to_end_tests/golden-record/my_test_api_client/api/parameters/multiple_path_parameters.py
@@ -47,7 +47,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tag1/get_tag_with_number.py b/end_to_end_tests/golden-record/my_test_api_client/api/tag1/get_tag_with_number.py
@@ -41,7 +41,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/description_with_backslash.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/description_with_backslash.py
@@ -41,7 +41,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/no_response_tests_no_response_get.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/no_response_tests_no_response_get.py
@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, cast
+from typing import Any, Dict, Optional
 
 import httpx
 
@@ -29,7 +29,7 @@ def _get_kwargs(
 
 def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any]:
     if response.status_code == HTTPStatus.OK:
-        response_200 = cast(Any, response.json())
+        response_200 = response.json()
         return response_200
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/post_form_data.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/post_form_data.py
@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, cast
+from typing import Any, Dict, Optional
 
 import httpx
 
@@ -32,7 +32,7 @@ def _get_kwargs(
 
 def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any]:
     if response.status_code == HTTPStatus.OK:
-        response_200 = cast(Any, response.json())
+        response_200 = response.json()
         return response_200
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/post_form_data_inline.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/post_form_data_inline.py
@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, cast
+from typing import Any, Dict, Optional
 
 import httpx
 
@@ -32,7 +32,7 @@ def _get_kwargs(
 
 def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any]:
     if response.status_code == HTTPStatus.OK:
-        response_200 = cast(Any, response.json())
+        response_200 = response.json()
         return response_200
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/tests/unsupported_content_tests_unsupported_content_get.py b/end_to_end_tests/golden-record/my_test_api_client/api/tests/unsupported_content_tests_unsupported_content_get.py
@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import Any, Dict, Optional, cast
+from typing import Any, Dict, Optional
 
 import httpx
 
@@ -29,7 +29,7 @@ def _get_kwargs(
 
 def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Any]:
     if response.status_code == HTTPStatus.OK:
-        response_200 = cast(Any, response.json())
+        response_200 = response.json()
         return response_200
     if client.raise_on_unexpected_status:
         raise errors.UnexpectedStatus(response.status_code, response.content)
diff --git a/end_to_end_tests/golden-record/my_test_api_client/api/true_/false_.py b/end_to_end_tests/golden-record/my_test_api_client/api/true_/false_.py
@@ -48,7 +48,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
-        parsed=_parse_response(client=client, response=response),
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
     )
 
 
diff --git a/openapi_python_client/templates/endpoint_module.py.jinja b/openapi_python_client/templates/endpoint_module.py.jinja
@@ -85,7 +85,12 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[{{
         status_code=HTTPStatus(response.status_code),
         content=response.content,
         headers=response.headers,
+        {% if parsed_responses %}
         parsed=_parse_response(client=client, response=response),
+        {% else %}
+        {# If _parse_response() returns None, mypy complains: https://github.com/python/mypy/issues/6549 #}
+        parsed=_parse_response(client=client, response=response),  # type: ignore[func-returns-value]
+        {% endif %}
     )
 
 

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non`
`48`	`48`	`status_code=HTTPStatus(response.status_code),`
`49`	`49`	`content=response.content,`
`50`	`50`	`headers=response.headers,`
`51`		`- parsed=_parse_response(client=client, response=response),`
	`51`	`+ parsed=_parse_response(client=client, response=response), # type: ignore[func-returns-value]`
`52`	`52`	`)`
`53`	`53`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non`
`67`	`67`	`status_code=HTTPStatus(response.status_code),`
`68`	`68`	`content=response.content,`
`69`	`69`	`headers=response.headers,`
`70`		`- parsed=_parse_response(client=client, response=response),`
	`70`	`+ parsed=_parse_response(client=client, response=response), # type: ignore[func-returns-value]`
`71`	`71`	`)`
`72`	`72`
`73`	`73`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non`
`72`	`72`	`status_code=HTTPStatus(response.status_code),`
`73`	`73`	`content=response.content,`
`74`	`74`	`headers=response.headers,`
`75`		`- parsed=_parse_response(client=client, response=response),`
	`75`	`+ parsed=_parse_response(client=client, response=response), # type: ignore[func-returns-value]`
`76`	`76`	`)`
`77`	`77`
`78`	`78`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non`
`60`	`60`	`status_code=HTTPStatus(response.status_code),`
`61`	`61`	`content=response.content,`
`62`	`62`	`headers=response.headers,`
`63`		`- parsed=_parse_response(client=client, response=response),`
	`63`	`+ parsed=_parse_response(client=client, response=response), # type: ignore[func-returns-value]`
`64`	`64`	`)`
`65`	`65`
`66`	`66`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non`
`49`	`49`	`status_code=HTTPStatus(response.status_code),`
`50`	`50`	`content=response.content,`
`51`	`51`	`headers=response.headers,`
`52`		`- parsed=_parse_response(client=client, response=response),`
	`52`	`+ parsed=_parse_response(client=client, response=response), # type: ignore[func-returns-value]`
`53`	`53`	`)`
`54`	`54`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non`
`57`	`57`	`status_code=HTTPStatus(response.status_code),`
`58`	`58`	`content=response.content,`
`59`	`59`	`headers=response.headers,`
`60`		`- parsed=_parse_response(client=client, response=response),`
	`60`	`+ parsed=_parse_response(client=client, response=response), # type: ignore[func-returns-value]`
`61`	`61`	`)`
`62`	`62`
`63`	`63`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non`
`47`	`47`	`status_code=HTTPStatus(response.status_code),`
`48`	`48`	`content=response.content,`
`49`	`49`	`headers=response.headers,`
`50`		`- parsed=_parse_response(client=client, response=response),`
	`50`	`+ parsed=_parse_response(client=client, response=response), # type: ignore[func-returns-value]`
`51`	`51`	`)`
`52`	`52`
`53`	`53`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ def _build_response(*, client: Client, response: httpx.Response) -> Response[Non`
`41`	`41`	`status_code=HTTPStatus(response.status_code),`
`42`	`42`	`content=response.content,`
`43`	`43`	`headers=response.headers,`
`44`		`- parsed=_parse_response(client=client, response=response),`
	`44`	`+ parsed=_parse_response(client=client, response=response), # type: ignore[func-returns-value]`
`45`	`45`	`)`
`46`	`46`
`47`	`47`