pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-04 20:26:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add ability to disable qa for blocks of code

Browse source 
An ignore block can be defined with `# noqa: on` and `# noqa: off`
comments. Ignore block behaviour should be the same as inline ignore.
This commit is contained in:
Tom 2025-03-25 13:32:35 -04:00
parent e492aeb385
commit 6051897a91
4 changed files with 174 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

61
tests/unit/test_violation.py
View file

@ -51,3 +51,64 @@ def test_disable_is_inline_ignored():
assert error.is_inline_ignored(True) is False
assert getline.called is False
def _bi_tc(error_code, physical_line, block_start, filename, expected_result):
if block_start is None:
physical_lines = [physical_line]
line_no = 1
else:
block_end = "# noqa: off"
physical_lines = [block_start, physical_line, block_end]
line_no = 2
return (error_code, filename, physical_lines, line_no, expected_result)
@pytest.mark.parametrize(
"error_code,filename,physical_lines,line_no,expected_result",
[
_bi_tc("E111", "a = 1", None, "filename-1.py", False),
_bi_tc("E121", "a = 1", "# noqa: on E111", "filename-2.py", False),
_bi_tc("E121", "a = 1", "# noqa: on E111,W123,F821", "filename-3.py", False),
_bi_tc("E111", "a = 1", "# noqa: on E111,W123,F821", "filename-4.py", True),
_bi_tc("W123", "a = 1", "# noqa: on E111,W123,F821", "filename-5.py", True),
_bi_tc("W123", "a = 1", "# noqa: on E111, W123,F821", "filename-6.py", True),
_bi_tc("E111", "a = 1", "# noqa: on E11,W123,F821", "filename-7.py", True),
_bi_tc("E121", "a = 1", "# noqa:on E111,W123,F821", "filename-8.py", False),
_bi_tc("E111", "a = 1", "# noqa:on E111,W123,F821", "filename-9.py", True),
_bi_tc("W123", "a = 1", "# noqa:on E111,W123,F821", "filename-10.py", True),
_bi_tc("W123", "a = 1", "# noqa:on E111, W123,F821", "filename-11.py", True),
_bi_tc("E111", "a = 1", "# noqa:on E11,W123,F821", "filename-12.py", True),
_bi_tc("E111", "a = 1", "# noqa: on - We do not care", "filename-13.py", True),
_bi_tc("E111", "a = 1", "# noqa: on We do not care", "filename-14.py", True),
_bi_tc("E111", "a = 1", "# noqa:On We do not care", "filename-15.py", True),
_bi_tc("ABC123", "a = 1", "# noqa: on ABC123", "filename-16.py", True),
_bi_tc("E111", "a = 1", "# noqa: on ABC123", "filename-17.py", False),
_bi_tc("ABC123", "a = 1", "# noqa: on ABC124", "filename-18.py", False),
_bi_tc("ABC123", "a = 1", "# noqa: ABC124", "filename-19.py", False),
_bi_tc("ABC123", "a = 1", "# noqa: off ABC124", "filename-19.py", False),
],
)
def test_is_block_ignored(
error_code,
filename,
physical_lines,
line_no,
expected_result,
):
"""Verify that we detect block usage of ``# noqa: off/on``."""
error = Violation(error_code, filename, line_no, 1, "error text", None)
with mock.patch("linecache.getlines", return_value=physical_lines):
assert error.is_block_ignored(False) is expected_result
def test_disable_is_block_ignored():
"""Verify that is_block_ignored exits immediately if disabling NoQA."""
error = Violation("E121", "filename.py", 1, 1, "error text", "line")
with mock.patch("linecache.getlines") as getlines:
assert error.is_block_ignored(True) is False
assert getlines.called is False