Skip to content
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.

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

Give type annotation suggestion for incompatible **kwargs error #17186

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

andyxzhu
Copy link

Fixes #8874 .

When raising an error involving passing **kwargs, this PR adds a note informing the user of a potential fix based on @JukkaL's suggestion. For example,

main:3: error: Argument 2 to "dumps" has incompatible type "**Dict[str, int]"; expected "bool"
main:3: note: Consider using a TypedDict type or "Dict[str, any]" for the ** argument

Modified testing suite for compatibility with added note. Also created two new test cases based on JSON and Python classes .

Copy link
Contributor

Diff from mypy_primer, showing the effect of this PR on open source code:

pyppeteer (https://github.com/pyppeteer/pyppeteer)
+ pyppeteer/launcher.py:149: note: Consider using a TypedDict type or "Dict[str, any]" for the ** argument

discord.py (https://github.com/Rapptz/discord.py)
+ discord/http.py:544: note: Consider using a TypedDict type or "Dict[str, any]" for the ** argument
+ discord/client.py:658: note: Consider using a TypedDict type or "Dict[str, any]" for the ** argument

ibis (https://github.com/ibis-project/ibis)
+ ibis/expr/types/temporal.py:659: note: Consider using a TypedDict type or "Dict[str, any]" for the ** argument

hydra-zen (https://github.com/mit-ll-responsible-ai/hydra-zen)
+ src/hydra_zen/structured_configs/_implementations.py:1129: note: Consider using a TypedDict type or "Dict[str, any]" for the ** argument
+ src/hydra_zen/wrapper/_implementations.py:454: note: Consider using a TypedDict type or "Dict[str, any]" for the ** argument

@153957
Copy link

153957 commented Oct 15, 2024

Shouldn't the suggestion be to annotate the ** argument with Any instead of Dict[str, any]? Though technically both are correct, but from a users perspective it may be clearer to note the actual annotation they'd need to add.
( Related PEP; https://peps.python.org/pep-0484/#arbitrary-argument-lists-and-default-argument-values )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate better error message for incompatible **kwargs
3 participants