8000 Read-only `src_dict` dictionary in `from_dict` methods should be typed as `Mapping[str, Any]` · Issue #1203 · openapi-generators/openapi-python-client · GitHub
[go: up one dir, main page]
Skip to content

Read-only src_dict dictionary in from_dict methods should be typed as Mapping[str, Any] #1203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
edgarrmondragon opened this issue Feb 8, 2025 · 0 comments · Fixed by #1211
Closed

Read-only src_dict dictionary in from_dict methods should be typed as Mapping[str, Any] #1203

edgarrmondragon opened this issue Feb 8, 2025 · 0 comments · Fixed by #1211

Comments

@edgarrmondragon
Copy link
Contributor
edgarrmondragon commented Feb 8, 2025 •
edited
Loading

Describe the bug

Generated classmethod from_dict

openapi-python-client/openapi_python_client/templates/model.py.jinja

Lines 131 to 132 in 5cfe4e1

@classmethod
def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:

should probably be annotated as

    @classmethod
    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:

i.e. using typing.Mapping.

This marks the input dictionary as immutable and thus mypy is OK if you pass it a TypedDict. Otherwise, it correctly complains about type-incompatibility because the method could be removing or adding keys from the dictionary.

OpenAPI Spec File

NA.

Additional context
@edgarrmondragon edgarrmondragon mentioned this issue Mar 3, 2025
Merged
github-merge-queue bot pushed a commit that referenced this issue Mar 15, 2025
@edgarrmondragon @dbanty
feat: Allow any Mapping in generated from_dict functions (#1211)
b8fbea9 
Closes
#1203

---------

Co-authored-by: Dylan Anthony <43723790+dbanty@users.noreply.github.com>
micha91 pushed a commit to micha91/openapi-python-client that referenced this issue May 13, 2025
@edgarrmondragon @dbanty @micha91
feat: Allow any Mapping in generated from_dict functions (openapi…
7577edd 
…-generators#1211)

Closes
openapi-generators#1203

---------

Co-authored-by: Dylan Anthony <43723790+dbanty@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Allow any Mapping in generated from_dict functions edgarrmondragon/openapi-python-client
1 participant
@edgarrmondragon
0