Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork1.9k
feat:json.dumps,json.dump accuracy improvements#13960
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
max-muoto wants to merge18 commits intopython:mainChoose a base branch
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
json.dumps,json.dump typingjson.dumps,json.dump accuracy improvements This comment has been minimized.
This comment has been minimized.
ContributorAuthor
max-muoto commentedMay 9, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
CC:@srittau if you're interested in reviewing. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
3ca5208 toa05d94aCompare This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Diff frommypy_primer, showing the effect of this PR on open source code: spark (https://github.com/apache/spark)+ python/pyspark/pandas/config.py:409: error: Argument 1 to "dumps" has incompatible type "Any | _NoValueType"; expected "_JSON" [arg-type]pandas (https://github.com/pandas-dev/pandas)+ pandas/io/parquet.py:191: error: Argument 1 to "dumps" has incompatible type "dict[Hashable, Any]"; expected "_JSON" [arg-type]pytest (https://github.com/pytest-dev/pytest)+ src/_pytest/cacheprovider.py:191: error: No overload variant of "dumps" matches argument types "object", "bool", "int" [call-overload]+ src/_pytest/cacheprovider.py:191: note: Possible overload variants:+ src/_pytest/cacheprovider.py:191: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: Union[int, str, None] = ..., separators: Optional[tuple[str, str]] = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ src/_pytest/cacheprovider.py:191: note: def [_T] dumps(obj: Union[_JSON, _T], *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: Union[int, str, None] = ..., separators: Optional[tuple[str, str]] = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ src/_pytest/cacheprovider.py:191: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: Union[int, str, None] = ..., separators: Optional[tuple[str, str]] = ..., default: Optional[Callable[[Any], Any]] = ..., sort_keys: bool = ..., **kwds: Any) -> strspack (https://github.com/spack/spack)+ lib/spack/spack/util/spack_json.py:26: error: Unused "type: ignore" comment [unused-ignore]+ lib/spack/spack/util/spack_json.py:26: error: No overload variant of "dumps" matches argument types "dict[Any, Any]", "dict[str, tuple[str, str] | None]" [call-overload]+ lib/spack/spack/util/spack_json.py:26: note: Error code "call-overload" not covered by "type: ignore" comment+ lib/spack/spack/util/spack_json.py:26: note: Possible overload variants:+ lib/spack/spack/util/spack_json.py:26: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ lib/spack/spack/util/spack_json.py:26: note: def [_T] dumps(obj: _JSON | _T, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ lib/spack/spack/util/spack_json.py:26: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[Any], Any] | None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ lib/spack/spack/util/spack_json.py:27: error: Unused "type: ignore" comment [unused-ignore]+ lib/spack/spack/util/spack_json.py:27: error: No overload variant of "dump" matches argument types "dict[Any, Any]", "Any", "dict[str, tuple[str, str] | None]" [call-overload]+ lib/spack/spack/util/spack_json.py:27: note: Error code "call-overload" not covered by "type: ignore" comment+ lib/spack/spack/util/spack_json.py:27: note: Possible overload variants:+ lib/spack/spack/util/spack_json.py:27: note: def dump(obj: _JSON, fp: SupportsWrite[str], *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> None+ lib/spack/spack/util/spack_json.py:27: note: def [_T] dump(obj: _JSON | _T, fp: SupportsWrite[str], *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder] | None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> None+ lib/spack/spack/util/spack_json.py:27: note: def dump(obj: object, fp: SupportsWrite[str], *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[Any], Any] | None = ..., sort_keys: bool = ..., **kwds: Any) -> Nonestrawberry (https://github.com/strawberry-graphql/strawberry)+ strawberry/http/base.py:51: error: No overload variant of "dumps" matches argument type "object" [call-overload]+ strawberry/http/base.py:51: note: Possible overload variants:+ strawberry/http/base.py:51: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ strawberry/http/base.py:51: note: def [_T] dumps(obj: _JSON | _T, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ strawberry/http/base.py:51: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[Any], Any] | None = ..., sort_keys: bool = ..., **kwds: Any) -> strscrapy (https://github.com/scrapy/scrapy)+ scrapy/commands/settings.py:54: error: Argument 1 to "dumps" has incompatible type "dict[bool | float | int | str | None, Any]"; expected "_JSON" [arg-type]cki-lib (https://gitlab.com/cki-project/cki-lib)+ cki_lib/owners.py:249: error: Argument "key" to "sorted" has incompatible type "Callable[[Mapping[str, object] | Sequence[_JSON] | float | bool | None], object | Any]"; expected "Callable[[Mapping[str, object] | Sequence[_JSON] | float | bool | None], SupportsDunderLT[Any] | SupportsDunderGT[Any]]" [arg-type]+ cki_lib/owners.py:249: error: No overload variant of "__getitem__" of "Sequence" matches argument type "str" [call-overload]+ cki_lib/owners.py:249: note: Possible overload variants:+ cki_lib/owners.py:249: note: def __getitem__(self, int, /) -> _JSON+ cki_lib/owners.py:249: note: def __getitem__(self, slice[Any, Any, Any], /) -> Sequence[_JSON]+ cki_lib/owners.py:249: error: Value of type "Mapping[str, object] | Sequence[_JSON] | float | bool | None" is not indexable [index]+ cki_lib/owners.py:249: error: Incompatible return value type (got "object | Any", expected "SupportsDunderLT[Any] | SupportsDunderGT[Any]") [return-value]poetry (https://github.com/python-poetry/poetry)+ src/poetry/utils/cache.py:181: error: No overload variant of "dumps" matches argument type "T" [call-overload]+ src/poetry/utils/cache.py:181: note: Possible overload variants:+ src/poetry/utils/cache.py:181: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ src/poetry/utils/cache.py:181: note: def [_T] dumps(obj: _JSON | _T, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ src/poetry/utils/cache.py:181: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[Any], Any] | None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ src/poetry/utils/cache.py:211: error: No overload variant of "dumps" matches argument types "object", "bool", "tuple[str, str]", "bool" [call-overload]+ src/poetry/utils/cache.py:211: note: Possible overload variants:+ src/poetry/utils/cache.py:211: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ src/poetry/utils/cache.py:211: note: def [_T] dumps(obj: _JSON | _T, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ src/poetry/utils/cache.py:211: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[Any], Any] | None = ..., sort_keys: bool = ..., **kwds: Any) -> strmypy (https://github.com/python/mypy)+ mypy/util.py:935: error: Returning Any from function declared to return "bytes" [no-any-return]+ mypy/util.py:935: note: See https://mypy.rtfd.io/en/stable/_refs.html#code-no-any-return for more info+ mypy/util.py:935: error: No overload variant of "dumps" matches argument types "object", "int", "bool" [call-overload]+ mypy/util.py:935: note: Possible overload variants:+ mypy/util.py:935: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: Union[int, str, None] = ..., separators: Optional[tuple[str, str]] = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ mypy/util.py:935: note: def [_T] dumps(obj: Union[_JSON, _T], *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: Union[int, str, None] = ..., separators: Optional[tuple[str, str]] = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ mypy/util.py:935: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: Union[int, str, None] = ..., separators: Optional[tuple[str, str]] = ..., default: Optional[Callable[[Any], Any]] = ..., sort_keys: bool = ..., **kwds: Any) -> str+ mypy/util.py:935: note: See https://mypy.rtfd.io/en/stable/_refs.html#code-call-overload for more info+ mypy/util.py:938: error: Returning Any from function declared to return "bytes" [no-any-return]+ mypy/util.py:938: error: No overload variant of "dumps" matches argument types "object", "bool", "tuple[str, str]" [call-overload]+ mypy/util.py:938: note: Possible overload variants:+ mypy/util.py:938: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: Union[int, str, None] = ..., separators: Optional[tuple[str, str]] = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ mypy/util.py:938: note: def [_T] dumps(obj: Union[_JSON, _T], *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: Union[int, str, None] = ..., separators: Optional[tuple[str, str]] = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ mypy/util.py:938: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: Union[int, str, None] = ..., separators: Optional[tuple[str, str]] = ..., default: Optional[Callable[[Any], Any]] = ..., sort_keys: bool = ..., **kwds: Any) -> strzulip (https://github.com/zulip/zulip)+ zerver/lib/markdown/api_arguments_table_generator.py:170: error: No overload variant of "dumps" matches argument type "object" [call-overload]+ zerver/lib/markdown/api_arguments_table_generator.py:170: note: Possible overload variants:+ zerver/lib/markdown/api_arguments_table_generator.py:170: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ zerver/lib/markdown/api_arguments_table_generator.py:170: note: def [_T] dumps(obj: _JSON | _T, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ zerver/lib/markdown/api_arguments_table_generator.py:170: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[Any], Any] | None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ zerver/openapi/markdown_extension.py:243: error: No overload variant of "dumps" matches argument types "object", "bool" [call-overload]+ zerver/openapi/markdown_extension.py:243: note: Possible overload variants:+ zerver/openapi/markdown_extension.py:243: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ zerver/openapi/markdown_extension.py:243: note: def [_T] dumps(obj: _JSON | _T, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ zerver/openapi/markdown_extension.py:243: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[Any], Any] | None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ zerver/openapi/markdown_extension.py:258: error: No overload variant of "dumps" matches argument type "object" [call-overload]+ zerver/openapi/markdown_extension.py:258: note: Possible overload variants:+ zerver/openapi/markdown_extension.py:258: note: def dumps(obj: _JSON, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ zerver/openapi/markdown_extension.py:258: note: def [_T] dumps(obj: _JSON | _T, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: None = ..., indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[_T], _JSON], sort_keys: bool = ..., **kwds: Any) -> str+ zerver/openapi/markdown_extension.py:258: note: def dumps(obj: object, *, skipkeys: bool = ..., ensure_ascii: bool = ..., check_circular: bool = ..., allow_nan: bool = ..., cls: type[JSONEncoder], indent: int | str | None = ..., separators: tuple[str, str] | None = ..., default: Callable[[Any], Any] | None = ..., sort_keys: bool = ..., **kwds: Any) -> str+ zerver/openapi/markdown_extension.py:264: error: Incompatible return value type (got "object", expected "str") [return-value]+ zerver/lib/bot_lib.py:47: error: Incompatible types in assignment (expression has type overloaded function, variable has type "Callable[[object], str]") [assignment] |
I don't think we can do this, it will lead to too many false positives. |
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading.Please reload this page.
This PR addresses#13781 by making
json.dumpsandjson.dumpmore accurate:defaultisn't provided, only JSON serializable types are supported (as accurate we can get, we'll go through trade-offs)defaultis provided, the type must match that of the first call argument fordefaultor what we consider JSON-serializable .Trade-offs:
SequenceandMappingtyping is needed to support nested types properly but this will obviously still be a big improvement overAny.TypedDicts are only compatible withMapping[str, object]would it would be far preferable to useMapping[str, _JSON]closing off typed dictionaries is going to lead to a noticeable number of false positives.JSONEncoder(defaulting to our custom JSON type as the default) however it would be impractical for users to supply said generic param considering it doesn't exist at runtime. As a result an overload exists to acceptobjectin the case that any customJSONEncoderis provided.