Skip to content

Document follow_imports_for_stubs usage #21829

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
nightcityblade wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −0
Open

Document follow_imports_for_stubs usage #21829

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions docs/source/config_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,18 @@ section of the command line docs.
to suppress the import of a module from ``typeshed``, replacing it
with ``Any``.

For example, suppose your code monkey-patches ``email.message`` with extra
members that are not declared in its ``typeshed`` stub. You can treat
imports from that module as ``Any`` with a per-module section:

.. code-block:: ini

[mypy]

[mypy-email.message]
follow_imports = skip
follow_imports_for_stubs = True

Used in conjunction with :confval:`follow_imports=error <follow_imports>`, this can be used
to make any use of a particular ``typeshed`` module an error.

Expand Down
Loading