-
Notifications
You must be signed in to change notification settings - Fork 1k
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.
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
Ensure that redirect warnings appear exactly once per code #3500
Conversation
c056d37
to
8d52525
Compare
✅ ecosystem check detected no changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you extend the PR with a test plan.
crates/ruff/src/logging.rs
Outdated
use once_cell::sync::Lazy; | ||
use rustc_hash::FxHashSet; | ||
|
||
pub(crate) static WARNINGS: Lazy<Mutex<FxHashSet<String>>> = Lazy::new(Mutex::default); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using a String
as the key has the potential risk that two keys end up with the same name.
We can use TypeId
to avoid this. I've done this before for the Label
struct in the formatter.
#[derive(Eq, PartialEq, Copy, Clone, Debug)]
pub struct WarningId {
id: TypeId,
// Pretty name for debugging
#[cfg(debug_assertions)]
label: &'static str,
}
impl WarningId {
pub fn of<T: ?Sized + 'static>() -> Self {
Self {
id: TypeId::of::<T>(),
#[cfg(debug_assertions)]
label: type_name::<T>(),
}
}
}
Usage:
struct MyWarning;
let id = WarningId::of::<MyWarning>("Some name");
Using TypeId
further has the advantage that using a simple Vec
and scanning it is probably cheaper (this is based on the assumption that users will have few warnings, let's say less than 16).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, okay, you indeed want to match on a string here. The above approach could still work but may be more complicated.
I would still argue that using a Vec
instead of a FxHashMap
is probably cheaper since the lookups are rare and the table only contains few entries.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's also https://github.com/Luthaf/log-once which might be relevant
foo.py
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
huh?
Unrelated to the fix but related to our We should refactor our code in the long term to avoid writing to stdout/stderr during analysis because they, at best, get printed to stdout when running in WebAssembly and are inaccessible to other APIs. That's why we should only rely on Diagnostics to communicate output to the users. Relying on global-state is related. WebAssembly or other APIs can call the linter multiple times, and calling |
Wow I hadn't thought about that (RE WebAssembly, APIs, etc.). |
Wondering whether to refactor to use |
Our code looks simple enough and this is a pattern that we, ideally, shouldn't encourage. That's why I would prefer our code over having another dependency (dependencies have a maintenance cost too) |
8d52525
to
03a541a
Compare
03a541a
to
f1595fe
Compare
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://togithub.com/charliermarsh/ruff) | `^0.0.255` -> `^0.0.256` | [![age](https://badges.renovateapi.com/packages/pypi/ruff/0.0.256/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/pypi/ruff/0.0.256/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/pypi/ruff/0.0.256/compatibility-slim/0.0.255)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/pypi/ruff/0.0.256/confidence-slim/0.0.255)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charliermarsh/ruff</summary> ### [`v0.0.256`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.256) [Compare Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.255...v0.0.256) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Bug Fixes - PYI011: allow `math` constants in defaults by [@​XuehaiPan](https://togithub.com/XuehaiPan) in [astral-sh/ruff#3484 - Remove erroneous C4-to-C40 redirect by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3488 - fix lack of `not` in error message by [@​Czaki](https://togithub.com/Czaki) in [astral-sh/ruff#3497 - Ensure that redirect warnings appear exactly once per code by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3500 - Allow f-strings and concatenations in os.getenv by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3516 - Allow string percent formatting in os.getenv by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3518 - Refine complexity rules for try-except-else-finally by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3519 - Replicate inline comments when splitting single-line imports by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3521 - Avoid PEP 604 isinstance errors for starred tuples by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3527 - Avoid tracking as-imports separately with force-single-line by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3530 - Fix PYI011 and add auto-fix by [@​JonathanPlasse](https://togithub.com/JonathanPlasse) in [astral-sh/ruff#3492 - Avoid PEP 604 panic with empty tuple by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3526 - Add last remaining deprecated typing imports by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3529 - Avoid unused argument violations in .pyi files by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3533 ##### Other Changes - Include individual path checks in --verbose logging by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3489 - Allow `# ruff:` prefix for isort action comments by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3493 **Full Changelog**: astral-sh/ruff@v0.0.255...v0.0.256 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/ixm-one/pytest-cmake-presets). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNjAuMCIsInVwZGF0ZWRJblZlciI6IjM0LjE2MC4wIn0=--> Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://togithub.com/charliermarsh/ruff) | `==0.0.254` -> `==0.0.256` | [![age](https://badges.renovateapi.com/packages/pypi/ruff/0.0.256/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/pypi/ruff/0.0.256/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/pypi/ruff/0.0.256/compatibility-slim/0.0.254)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/pypi/ruff/0.0.256/confidence-slim/0.0.254)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charliermarsh/ruff</summary> ### [`v0.0.256`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.256) [Compare Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.255...v0.0.256) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Bug Fixes - PYI011: allow `math` constants in defaults by [@​XuehaiPan](https://togithub.com/XuehaiPan) in [astral-sh/ruff#3484 - Remove erroneous C4-to-C40 redirect by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3488 - fix lack of `not` in error message by [@​Czaki](https://togithub.com/Czaki) in [astral-sh/ruff#3497 - Ensure that redirect warnings appear exactly once per code by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3500 - Allow f-strings and concatenations in os.getenv by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3516 - Allow string percent formatting in os.getenv by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3518 - Refine complexity rules for try-except-else-finally by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3519 - Replicate inline comments when splitting single-line imports by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3521 - Avoid PEP 604 isinstance errors for starred tuples by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3527 - Avoid tracking as-imports separately with force-single-line by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3530 - Fix PYI011 and add auto-fix by [@​JonathanPlasse](https://togithub.com/JonathanPlasse) in [astral-sh/ruff#3492 - Avoid PEP 604 panic with empty tuple by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3526 - Add last remaining deprecated typing imports by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3529 - Avoid unused argument violations in .pyi files by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3533 ##### Other Changes - Include individual path checks in --verbose logging by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3489 - Allow `# ruff:` prefix for isort action comments by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3493 **Full Changelog**: astral-sh/ruff@v0.0.255...v0.0.256 ### [`v0.0.255`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.255) [Compare Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.254...v0.0.255) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Rules - \[`flake8-pie`] Fix PIE802 broken auto-fix with trailing comma by [@​JonathanPlasse](https://togithub.com/JonathanPlasse) in [astral-sh/ruff#3402 - \[`flake8-pie`] Implement autofix for PIE810 by [@​kyoto7250](https://togithub.com/kyoto7250) in [astral-sh/ruff#3411 - \[`flake8-bugbear`] Add `flake8-bugbear`'s B030 rule by [@​aacunningham](https://togithub.com/aacunningham) in [astral-sh/ruff#3400 - \[`pycodestyle`] Add E231 by [@​carlosmiei](https://togithub.com/carlosmiei) in [astral-sh/ruff#3344 - \[`pyupgrade`] Flag deprecated (but renamed) imports in UP035 by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3448 - \[`pyupgrade`] Remap ChainMap, Counter, and OrderedDict imports to collections by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3392 - \[`pylint`] C1901: compare-to-empty-string by [@​AreamanM](https://togithub.com/AreamanM) in [astral-sh/ruff#3405 - \[`pylint`] Implement W1508 invalid-envvar-default by [@​latonis](https://togithub.com/latonis) in [astral-sh/ruff#3449 - \[`pylint`] Implement E1507 invalid-envvar-value by [@​latonis](https://togithub.com/latonis) in [astral-sh/ruff#3467 ##### Settings - Infer `target-version` from project metadata by [@​JonathanPlasse](https://togithub.com/JonathanPlasse) in [astral-sh/ruff#3470 - Implement configuration options `runtime-evaluated-decorators` and `runtime-evaluated-base-classes` for `flake8-type-checking` by [@​sasanjac](https://togithub.com/sasanjac) in [astral-sh/ruff#3292 - Add Azure DevOps as a `--format` option. by [@​StefanBRas](https://togithub.com/StefanBRas) in [astral-sh/ruff#3335 ##### Bug Fixes - Re-enable the T and C linter prefix selectors by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3452 - Treat unary operations on constants as constant-like by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3348 - Skip byte-order-mark at start of file by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3343 - Don't enforce typing-import rules in .pyi files by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3362 - Include entire prefix when reporting rule selector errors by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3375 - Handle multi-line fixes for byte-string prefixing by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3391 - Catch RET504 usages via decorators by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3395 - Ignore multiply-assigned variables in RET504 by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3393 - \[FIX] PYI011: recognize `Bool` / `Float` / `Complex` numbers as simple defaults by [@​XuehaiPan](https://togithub.com/XuehaiPan) in [astral-sh/ruff#3459 - Respect ignores for runtime-import-in-type-checking-block (TCH004) by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3474 - Avoid panicking in invalid_escape_sequence by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3338 - fix: Emit a more useful error if an `extend` points at a non-existent ruff.toml file. by [@​DanCardin](https://togithub.com/DanCardin) in [astral-sh/ruff#3417 - Respect `--show-fixes` with `--fix-only` by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3426 - When "Args" and "Parameters" are present, prefer NumPy style by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3430 - Remove empty line after RUF100 auto-fix by [@​JonathanPlasse](https://togithub.com/JonathanPlasse) in [astral-sh/ruff#3414 - Avoid removing un-aliased exceptions in `OSError`-aliased handlers by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3451 - Use a hash to fingerprint GitLab CI output by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3456 - Avoid respecting noqa directives when RUF100 is enabled by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3469 - Output GitLab paths relative to `CI_PROJECT_DIR` by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3475 - Implement an iterator for universal newlines by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#3454 #### New Contributors - [@​sasanjac](https://togithub.com/sasanjac) made their first contribution in [astral-sh/ruff#3292 - [@​aacunningham](https://togithub.com/aacunningham) made their first contribution in [astral-sh/ruff#3380 - [@​orf](https://togithub.com/orf) made their first contribution in [astral-sh/ruff#3389 - [@​DanCardin](https://togithub.com/DanCardin) made their first contribution in [astral-sh/ruff#3417 - [@​AreamanM](https://togithub.com/AreamanM) made their first contribution in [astral-sh/ruff#3405 - [@​kyoto7250](https://togithub.com/kyoto7250) made their first contribution in [astral-sh/ruff#3411 - [@​latonis](https://togithub.com/latonis) made their first contribution in [astral-sh/ruff#3449 - [@​XuehaiPan](https://togithub.com/XuehaiPan) made their first contribution in [astral-sh/ruff#3459 - [@​CalumY](https://togithub.com/CalumY) made their first contribution in [astral-sh/ruff#3461 - [@​YDX-2147483647](https://togithub.com/YDX-2147483647) made their first contribution in [astral-sh/ruff#3473 **Full Changelog**: astral-sh/ruff@v0.0.254...v0.0.255 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/allenporter/flux-local). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNjAuMCIsInVwZGF0ZWRJblZlciI6IjM0LjE2MC4wIn0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Summary
We often have warnings that we want to show users -- but we only want to show those warnings once, no matter how many times the triggering codepath executes, since it's not useful to show the same warning multiple times.
Case in point: when the user lists a rule code that has been deprecated and redirected to a new rule code (e.g.,
RUF004
was moved toB026
), that redirect could happen multiple times in a single invocation -- the out-dated rule could appear in multiple parts of the configuration file, it could be provided on the command-line in addition to the configuration file, and so on.Historically, to show one-time warnings, we used this
warn_user_once!
macro, which relies on anAtomicBool
. This macro does warn once, but is dependent on the code path. That is: it doesn't support dynamic warnings, since the "state" gets inlined into the call-site.For the redirect case described above, we currently print that warning multiple times, since we can't use our
warn_user_once!
macro. This PR thus introduces awarn_user_once_by_id
variant that stores the warnings in a global "registry" with arbitrary keys. By registering each redirect warning based on the redirection code, we avoid repeated warnings even for codes that are redirected multiple times.Closes #3431.
Test Plan
Add the following to a
pyproject.toml
:Over an arbitrary file, run:
cargo run -p ruff_cli -- foo.py --select PDV010 -n
.Verify that exactly one warning appears:
warning: `PDV010` has been remapped to `PD010`.