Skip to content

Warn about --follow-untyped-imports #18249

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

Merged
merged 5 commits into from
Dec 7, 2024
Merged

Warn about --follow-untyped-imports #18249

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ea07ddb
Warn about --follow-untyped-imports
hauntsaninja Dec 5, 2024
b02602f
Update docs/source/config_file.rst
hauntsaninja Dec 5, 2024
c1f54f1
more warning
hauntsaninja Dec 6, 2024
ce7bbad
Apply suggestions from code review
hauntsaninja Dec 7, 2024
f65a3f6
more feedback
hauntsaninja Dec 7, 2024
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
6 changes: 5 additions & 1 deletion docs/source/command_line.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,11 @@ imports.

.. option:: --follow-untyped-imports

This flag makes mypy analyze imports without stubs or a py.typed marker.
This flag makes mypy analyze imports even if missing a py.typed marker or stubs.

Note that analyzing all unannotated modules might result in issues
when analyzing code not designed to be type checked and may significantly
increase how long mypy takes to run.

.. option:: --follow-imports {normal,silent,skip,error}

Expand Down
9 changes: 6 additions & 3 deletions docs/source/config_file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,12 +320,15 @@ section of the command line docs.
:type: boolean
:default: False

Typechecks imports from modules that do not have stubs or a py.typed marker.
Makes mypy analyze imports even if missing a py.typed marker or stubs.

Note that analyzing all unannotated modules might result in issues
when analyzing code not designed to be type checked and may significantly
increase how long mypy takes to run.

If this option is used in a per-module section, the module name should
match the name of the *imported* module, not the module containing the
import statement. Note that scanning all unannotated modules might
significantly increase the runtime of your mypy calls.
import statement

.. confval:: follow_imports

Expand Down
Loading