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
Allow # ruff:
prefix for isort action comments
#3493
Conversation
✅ 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.
I find the "double" colons a bit confusing but it makes sense to use the same format since we already have precedence.
Rome uses the rome linter:
format to avoid having two colons docs which I find nice (also supports rome linter/rule-name).
@@ -107,15 +107,19 @@ pub fn extract_isort_directives(lxr: &[LexResult]) -> IsortDirectives { | |||
// omit a space after the colon. The remaining action comments are | |||
// required to include the space, and must appear on their own lines. | |||
let comment_text = comment_text.trim_end(); |
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.
It could help performance if you first test if the comment starts with either # isort
or ruff: isort
and, if not, bail out early. That ensures that we short-circuit for the majority of comments.
We could even go as far as doing, to reduce the casing necessary
if let Some(isort_comment) = comment_text.split_once(["# isort:", "# ruff: isort:"]) {
match isort_comment.trim_start() {
"split" => {},
"skip_file" => {}
}
}
e8d00e8
to
3c34dfd
Compare
Co-authored-by: Micha Reiser <micha@reiser.io>
Co-authored-by: Micha Reiser <micha@reiser.io>
3c34dfd
to
bdae9fc
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>
This PR lets users write
# ruff: isort: skip_file
in lieu of# isort: skip_file
-- similar to how we support# ruff: noqa: F401
in lieu of# flake8: noqa: F401
.This option is admittedly more verbose, but it's clearer that they're intended for Ruff, that the project is using Ruff, etc.
Closes #3450.