Skip to content

[docs] Update common_issues.rst: mention orjson in the Mypy slow section #19058

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

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

[docs] Update common_issues.rst: mention orjson in the Mypy slow section #19058

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d23b031
Update common_issues.rst: mention orjson in the Mypy slow section
wyattscarpenter May 8, 2025
6cf1a42
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 8, 2025
08d45c5
Update common_issues.rst: finish formatting for rst
wyattscarpenter May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/source/common_issues.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,14 @@ daemon <mypy_daemon>`, which can speed up incremental mypy runtimes by
a factor of 10 or more. :ref:`Remote caching <remote-cache>` can
make cold mypy runs several times faster.

Furthermore: as of `mypy 1.13 <https://mypy-lang.blogspot.com/2024/10/mypy-113-released.html>`_,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is all history, are you sure that the changelog link and the specific version reference are relevant here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My instinct is, we might as well include it for people locked into Mypy version X who Google "Mypy slow" to see what they get. It can always be removed from the Mypy documentation later.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They'll try pip install mypy[fast-cache], get a helpful message that such extra does not exist and, hopefully, figure out that using a version more than a year old has some drawbacks... But this is more a nitpick, I agree documentation should mention this extra and have no other objections:)

mypy allows use of the orjson library for handling the cache instead of the stdlib json, for
improved performance. You can ensure the presence of orjson using the faster-cache extra:

python3 -m pip install -U mypy[faster-cache]

Mypy may depend on orjson by default in the future.

Types of empty collections
--------------------------

Expand Down