Repository navigation
feat(ignore): add invalid-ignore-comment and ignore-without-code rules - #3832
mikeleppane wants to merge 1 commit into
Conversation
Malformed ignore comments were silently discarded: a typo'd directive (`# pyrefly: ignoree`), an unterminated `[`, or an empty `[]` produced neither a suppression nor any warning, so a developer never learned the comment was wrong. Separately, a bare `# pyrefly: ignore` suppresses any error on its line, which can silently swallow a later, unrelated error. Turn the ignore-comment parser into a single recognizer with three disjoint outcomes (valid / malformed / not-a-directive) so exactly one fires and a non-directive such as `# type: list[int]`, which never reaches the `ignore` stem, can never be flagged. A malformed result still carries the suppression it produced before, so the new invalid-ignore-comment diagnostic (default `warn`) is purely additive and no existing suppression behavior changes. ignore-without-code is opt-in (default off) and scoped to the Pyrefly tool, the only one whose per-line codes Pyrefly honors. Both kinds are unsuppressable, enforced centrally so an ignore comment cannot silence the lint about itself. Refs: pyrefly-org#3752, pyrefly-org#3450
Summary: - Support `# pyrefly: ignore-errors[code]` as a file-level suppression for selected Pyrefly error codes. - Reuse the existing `Suppression` representation for file-level directives so whole-file and line-level Pyrefly code matching share the same semantics, including parent suppression names. - Keep non-Pyrefly `ignore-errors` directives as blanket-only and document the new Pyrefly form. Fixes #3723 Import note (maintainer changes on top of the PR, addressing Devmate review nits): - Dedupe the `[code, code]` parse into a shared `parse_error_codes` helper used by both the line-level and file-level parsers. - Reject malformed file-level directives with a missing closing `]` (previously silently accepted as valid). - Drop empty entries so `# pyrefly: ignore-errors[]` (and trailing commas) act as a blanket ignore rather than a directive matching nothing. - Update the `parse_ignore_all` docstring to reflect its `Vec<Suppression>` return shape. ## Notes This is scoped to file-level code filtering for `pyrefly: ignore-errors`. Related suppression lint/reporting PRs (#3832 and #3797) address separate diagnostics and unused-ignore behavior. Pull Request resolved: #3944 Test Plan: buck test pyrefly:pyrefly_library -- test_pyrefly_top_level_ignore (6 pass); buck test pyrefly_python -- test_parse_ignore (4 pass, incl. empty-bracket + missing-bracket cases). Reviewed By: kinto0 Differential Revision: D110063592 Pulled By: NathanTempest fbshipit-source-id: 734d71d546e8d39f696b31af3eaeb0a53d6f094f
|
It would be better to fix these separately since that's easier to review, but since it's done already I'll try to review it all together |
|
@yangdanny97 has imported this pull request. If you are a Meta employee, you can view this in D113082971. |
|
This pull request has been automatically marked as stale because it has not had recent activity for more than 2 weeks. If you are still working on this this pull request, please add a comment or push new commits to keep it active. Otherwise, please unassign yourself and allow someone else to take over. Thank you for your contributions! |
Summary: - Support `# pyrefly: ignore-errors[code]` as a file-level suppression for selected Pyrefly error codes. - Reuse the existing `Suppression` representation for file-level directives so whole-file and line-level Pyrefly code matching share the same semantics, including parent suppression names. - Keep non-Pyrefly `ignore-errors` directives as blanket-only and document the new Pyrefly form. Fixes pyrefly-org#3723 Import note (maintainer changes on top of the PR, addressing Devmate review nits): - Dedupe the `[code, code]` parse into a shared `parse_error_codes` helper used by both the line-level and file-level parsers. - Reject malformed file-level directives with a missing closing `]` (previously silently accepted as valid). - Drop empty entries so `# pyrefly: ignore-errors[]` (and trailing commas) act as a blanket ignore rather than a directive matching nothing. - Update the `parse_ignore_all` docstring to reflect its `Vec<Suppression>` return shape. ## Notes This is scoped to file-level code filtering for `pyrefly: ignore-errors`. Related suppression lint/reporting PRs (pyrefly-org#3832 and pyrefly-org#3797) address separate diagnostics and unused-ignore behavior. Pull Request resolved: pyrefly-org#3944 Test Plan: buck test pyrefly:pyrefly_library -- test_pyrefly_top_level_ignore (6 pass); buck test pyrefly_python -- test_parse_ignore (4 pass, incl. empty-bracket + missing-bracket cases). Reviewed By: kinto0 Differential Revision: D110063592 Pulled By: NathanTempest fbshipit-source-id: 734d71d546e8d39f696b31af3eaeb0a53d6f094f
|
Hey @mikeleppane! I'm hoping to get this merged in soon, so will be ready to review soon. It looks like there are some merge conflicts (totally understandable without attention from us, we've been swamped with PR reviews). If you're still interested in working on this, would you be able to let me know, then rebase and resolve those issues? If I don't hear anything back by next week, I'll assume you've moved on and will close this PR so others can work on it. Just a hello and quick status update is all I need, and then we can finish this up! Also, like @yangdanny97 requested, could we split this into two separate PRs, one for each new error you're adding? Thanks! |
|
Closing due to inactivity |
Closes /#3752
Closes /#3450
Two new ignore-comment lint rules, mirroring ty's
invalid-ignore-commentand basedpyright's
reportIgnoreCommentWithoutRule.What & why
invalid-ignore-comment(defaultwarn). A comment that looks like anignore directive but is malformed used to be silently discarded: it produced
neither a suppression nor any warning, so you never learned it was wrong. Three
shapes are now flagged:
ignore-without-code(defaultignore, opt-in). A bare# pyrefly: ignoresuppresses any error on its line, so it can silently swallow a later, unrelated
error. Enable the rule to require an explicit code:
Key design property: purely additive
invalid-ignore-commentchanges no suppression behavior. The ignore-commentparser now returns a single recognizer result with three disjoint outcomes
(
Valid,Malformed { suppression, .. },NotADirective), so exactly one firesper comment, and a non-directive such as
# type: list[int](which never reachesthe
ignorestem) can never be flagged. AMalformedresult still carriesthe exact suppression it produced before, so the diagnostic is layered on top:
[: keeps the lenient parse, still suppresses[]: still suppresses for tools whose codes aren't checked(
# type: ignore[]remains a blanket suppression), a no-op for PyreflyHow
crates/pyrefly_python/src/ignore.rs:parse_ignore_commentreturns thenew
ParsedIgnoreenum;Ignorerecords aVec<MalformedIgnore>alongsideits suppression map.
ignore-errors/ignore-all-errorsare excluded via aword-boundary check so genuine file-level directives aren't flagged.
crates/pyrefly_config/src/error_kind.rs: two newErrorKinds inlexicographic position (
InvalidIgnoreComment=warn,IgnoreWithoutCode=ignore) plusErrorKind::is_unsuppressable(), the shared predicate for thethree ignore-comment diagnostics.
pyrefly/lib/state/errors.rs:collect_ignore_comment_lint_errors()emits both diagnostics (gated on the tool being enabled), folded into the
ignore-diagnostics display path so configured severity is respected.
error/collector.rsso theignore-all, per-line, and f-string paths are covered uniformly; also excluded
from
--suppress-errorsso it can't write a comment that could never takeeffect.
website/docs/error-kinds.mdxgains both rule sections.Presets are unchanged:
allpromotes both automatically;strictis left as-isto keep
ignore-without-codeopt-in.Test plan
ignore::tests::test_parse_ignore_commentignore::tests::test_malformed_ignores_are_additivestate::errors::tests::test_invalid_ignore_comment_{emitted,variants}state::errors::tests::test_empty_bracket_ignore_is_additive# type: ignore[]still suppresses (no regression for non-Pyrefly tools)state::errors::tests::test_ignore_without_code_{emitted,scoped_to_pyrefly}# type: ignorenot (Pyrefly-scoped)test/ignores.md(scrut)pyrefly_config219;clippyandfmtclean.mypy_primerover 56 real-world projects (mypy, sphinx, scrapy, pydantic,cryptography, and more): zero diagnostic diff, confirming no existing
diagnostic changes on real code.