[REQ][python] get user's mypy check passing with warn_redundant_casts turned on

[nponsard]

Is your feature request related to a problem? Please describe.

I tried to run mypy on code generated by this project and got around 30 errors. The same happens when running mypy on the provided samples. There was an issue about that one year ago #1, is this a regression ?

Some errors I get on my project :

nethsm/client/components/schema/provision_request_data.py:76: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/provision_request_data.py:83: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/paths/keys_generate/post/responses/response_201/__init__.py:19: error: Attributes without a default cannot follow attributes with one  [misc]
nethsm/client/paths/keys/post/responses/response_201/__init__.py:19: error: Attributes without a default cannot follow attributes with one  [misc]
nethsm/client/components/schema/public_key.py:78: error: Incompatible types in assignment (expression has type "str", variable has type "Union[Mapping[str, Union[dict[Any, Any], immutabledict[Any, Any], Mapping[str, object], list[Any], tuple[Any, ...], float, int, str, date, datetime, UUID, bool, None, bytes, io.FileIO, BufferedReader, nethsm.client.schemas.schema.FileIO]], KeyPublicDataDict, Unset]")  [assignment]

Describe the solution you'd like

That the generated code doesn't emit any type error with mypy.

Describe alternatives you've considered

I disabled type checking for the folder containing the generated code in my pyproject.toml :

[[tool.mypy.overrides]]
module = "nethsm.client.*"
ignore_errors = true

[spacether]

Can you please provide your openapi document and the 30 errors? Mypy is successfully passing on the petstore sample in CI.

[jans23]

The OpenAPI is here.

[spacether]

What are the 30 errors you get on your project? I only get 6.
How are you invoking mypy?

python3 -m venv venv
source venv/bin/activate
python -m pip install .
pip install mypy
# I passed in --additional-properties packageName=some_api
mypy src/some_api

-->

src/some_api/paths/keys_generate/post/responses/response_201/__init__.py:19: error: Attributes without a default cannot follow attributes with one  [misc]
src/some_api/paths/keys/post/responses/response_201/__init__.py:19: error: Attributes without a default cannot follow attributes with one  [misc]
src/some_api/components/schema/public_key.py:78: error: Incompatible types in assignment (expression has type "str", variable has type "Union[Mapping[str, Union[Dict[Any, Any], immutabledict[Any, Any], Mapping[str, object], List[Any], Tuple[Any, ...], float, int, str, date, datetime, UUID, bool, None, bytes, io.FileIO, BufferedReader, some_api.schemas.schema.FileIO]], KeyPublicDataDict, Unset]")  [assignment]
src/some_api/components/schema/public_key.py:83: error: Invalid index type "Union[Mapping[str, Union[Dict[Any, Any], immutabledict[Any, Any], Mapping[str, object], List[Any], Tuple[Any, ...], float, int, str, date, datetime, UUID, bool, None, bytes, io.FileIO, BufferedReader, some_api.schemas.schema.FileIO]], KeyPublicDataDict, Unset]" for "Dict[str, Any]"; expected type "str"  [index]
src/some_api/components/schema/private_key.py:73: error: Incompatible types in assignment (expression has type "str", variable has type "Union[Mapping[str, Union[Dict[Any, Any], immutabledict[Any, Any], Mapping[str, object], List[Any], Tuple[Any, ...], float, int, str, date, datetime, UUID, bool, None, bytes, io.FileIO, BufferedReader, some_api.schemas.schema.FileIO]], KeyPrivateDataDict]")  [assignment]
src/some_api/components/schema/private_key.py:78: error: Invalid index type "Union[Mapping[str, Union[Dict[Any, Any], immutabledict[Any, Any], Mapping[str, object], List[Any], Tuple[Any, ...], float, int, str, date, datetime, UUID, bool, None, bytes, io.FileIO, BufferedReader, some_api.schemas.schema.FileIO]], KeyPrivateDataDict]" for "Dict[str, Any]"; expected type "str"  [index]
Found 6 errors in 4 files (checked 1004 source files)

[spacether]

@nponsard my merged PR should resolve this issue. Can you please verify that?
Local verification with your client passed. Petstore with added component response and schema with the same root causes as yours passsed mypy check in CI.

[nponsard]

I still have some errors :

nethsm/client/servers/server_0.py:74: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/servers/server_0.py:81: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/time_config.py:59: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/system_update_data.py:56: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/random_request_data.py:67: error: Redundant cast to "int"  [redundant-cast]
nethsm/client/components/schema/network_config.py:66: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/network_config.py:73: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/network_config.py:80: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/info_data.py:61: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/info_data.py:68: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/distinguished_name.py:109: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/distinguished_name.py:119: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/distinguished_name.py:129: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/distinguished_name.py:139: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/distinguished_name.py:149: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/distinguished_name.py:159: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/distinguished_name.py:169: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/tls_key_generate_request_data.py:98: error: Redundant cast to "int"  [redundant-cast]
nethsm/client/components/schema/provision_request_data.py:69: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/provision_request_data.py:76: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/provision_request_data.py:83: error: Redundant cast to "str"  [redundant-cast]
nethsm/client/components/schema/public_key.py:107: error: Redundant cast to "int"  [redundant-cast]

It's weird that you don't have these ones reported.

[spacether]

Please provide the steps to reproduce your output.
Also, what python version are you using?
My steps in the root of the generated client are:

python3 -m venv venv
source venv/bin/activate
python -m pip install .
pip install mypy
# I passed in --additional-properties packageName=some_api
mypy src/some_api

[nponsard]

Here's what I've done

git clone git@github.com:Nitrokey/nethsm-sdk-py.git
cd nethsm-sdk-py
make init
source venv/bin/activate
#regenerate the client
make nethsm-client
mypy nethsm

[spacether]

This is happening because you have:

[tool.mypy]
warn_redundant_casts = true

turned on in your pyproject.toml which is defaulted to false if unset
and I am able to reproduce warnings by turning it on
If you remove that line mypy checks will succeed