Skip to content

Add test and docs for top level mypy: disable-error-code comment #14810

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
hauntsaninja merged 3 commits into from
Mar 1, 2023
Merged

Add test and docs for top level mypy: disable-error-code comment #14810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0c2c1e
Add test and docs for top level `mypy: disable-error-code` comment
sobolevn Mar 1, 2023
79ac7af
Address review
sobolevn Mar 1, 2023
ffc91ca
No walrus!
sobolevn Mar 1, 2023
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
2 changes: 1 addition & 1 deletion docs/source/common_issues.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Ignoring a whole file

* To only ignore errors, use a top-level ``# mypy: ignore-errors`` comment instead.
* To only ignore errors with a specific error code, use a top-level
``# mypy: disable-error-code=...`` comment.
``# mypy: disable-error-code="..."`` comment. Example: ``# mypy: disable-error-code="truthy-bool, ignore-without-code"``
* To replace the contents of a module with ``Any``, use a per-module ``follow_imports = skip``.
See :ref:`Following imports <follow-imports>` for details.

Expand Down
6 changes: 4 additions & 2 deletions mypy/fastparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,11 +487,13 @@ def translate_stmt_list(
and self.type_ignores
and min(self.type_ignores) < self.get_lineno(stmts[0])
):
if self.type_ignores[min(self.type_ignores)]:
Copy link
Copy Markdown
Collaborator

@hauntsaninja hauntsaninja Mar 1, 2023

Choose a reason for hiding this comment

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

We can't use walrus just yet; we still support 3.7

Copy link
Copy Markdown
Member Author

@sobolevn sobolevn Mar 1, 2023

Choose a reason for hiding this comment

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

This is the first time I've used walrus in real code :)
Probably, the last time.

ignores = self.type_ignores[min(self.type_ignores)]
if ignores:
joined_ignores = ", ".join(ignores)
self.fail(
(
"type ignore with error code is not supported for modules; "
"use `# mypy: disable-error-code=...`"
f'use `# mypy: disable-error-code="{joined_ignores}"`'
),
line=min(self.type_ignores),
column=0,
Expand Down
6 changes: 5 additions & 1 deletion test-data/unit/check-errorcodes.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -960,7 +960,11 @@ def f(d: D, s: str) -> None:
[typing fixtures/typing-typeddict.pyi]

[case testRecommendErrorCode]
# type: ignore[whatever] # E: type ignore with error code is not supported for modules; use `# mypy: disable-error-code=...` [syntax]
# type: ignore[whatever] # E: type ignore with error code is not supported for modules; use `# mypy: disable-error-code="whatever"` [syntax]
1 + "asdf"

[case testRecommendErrorCode2]
# type: ignore[whatever, other] # E: type ignore with error code is not supported for modules; use `# mypy: disable-error-code="whatever, other"` [syntax]
1 + "asdf"

[case testShowErrorCodesInConfig]
Expand Down
9 changes: 9 additions & 0 deletions test-data/unit/check-inline-config.test
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,3 +210,12 @@ enable_error_code = ignore-without-code, truthy-bool

\[mypy-tests.*]
disable_error_code = ignore-without-code

[case testInlineErrorCodesMultipleCodes]
# mypy: disable-error-code="truthy-bool, ignore-without-code"
class Foo:
pass

foo = Foo()
if foo: ...
42 + "no" # type: ignore
⚡