Skip to content
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

⬆️ 🛠️(deps): update dependency ruff to ^0.8.0 #548

Merged
merged 1 commit into from
Nov 22, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 22, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
ruff (source, changelog) ^0.6.0 -> ^0.8.0 age adoption passing confidence

Release Notes

astral-sh/ruff (ruff)

v0.8.0

Compare Source

Check out the blog post for a migration guide and overview of the changes!

Breaking changes

See also, the "Remapped rules" section which may result in disabled rules.

  • Default to Python 3.9

    Ruff now defaults to Python 3.9 instead of 3.8 if no explicit Python version is configured using ruff.target-version or project.requires-python (#​13896)

  • Changed location of pydoclint diagnostics

    pydoclint diagnostics now point to the first-line of the problematic docstring. Previously, this was not the case.

    If you've opted into these preview rules but have them suppressed using
    noqa comments in
    some places, this change may mean that you need to move the noqa suppression
    comments. Most users should be unaffected by this change.

  • Use XDG (i.e. ~/.local/bin) instead of the Cargo home directory in the standalone installer

    Previously, Ruff's installer used $CARGO_HOME or ~/.cargo/bin for its target install directory. Now, Ruff will be installed into $XDG_BIN_HOME, $XDG_DATA_HOME/../bin, or ~/.local/bin (in that order).

    This change is only relevant to users of the standalone Ruff installer (using the shell or PowerShell script). If you installed Ruff using uv or pip, you should be unaffected.

  • Changes to the line width calculation

    Ruff now uses a new version of the unicode-width Rust crate to calculate the line width. In very rare cases, this may lead to lines containing Unicode characters being reformatted, or being considered too long when they were not before (E501).

Removed Rules

The following deprecated rules have been removed:

Remapped rules

The following rules have been remapped to new rule codes:

Stabilization

The following rules have been stabilized and are no longer in preview:

The following behaviors have been stabilized:

The following fixes have been stabilized:

Preview features
  • [flake8-datetimez] Exempt min.time() and max.time() (DTZ901) (#​14394)
  • [flake8-pie] Mark fix as unsafe if the following statement is a string literal (PIE790) (#​14393)
  • [flake8-pyi] New rule redundant-none-literal (PYI061) (#​14316)
  • [flake8-pyi] Add autofix for redundant-numeric-union (PYI041) (#​14273)
  • [ruff] New rule map-int-version-parsing (RUF048) (#​14373)
  • [ruff] New rule redundant-bool-literal (RUF038) (#​14319)
  • [ruff] New rule unraw-re-pattern (RUF039) (#​14446)
  • [pycodestyle] Exempt pytest.importorskip() calls (E402) (#​14474)
  • [pylint] Autofix suggests using sets when possible (PLR1714) (#​14372)
Rule changes
  • invalid-pyproject-toml (RUF200): Updated to reflect the provisionally accepted PEP 639.
  • [flake8-pyi] Avoid panic in unfixable case (PYI041) (#​14402)
  • [flake8-type-checking] Correctly handle quotes in subscript expression when generating an autofix (#​14371)
  • [pylint] Suggest correct autofix for __contains__ (PLC2801) (#​14424)
Configuration
  • Ruff now emits a warning instead of an error when a configuration ignores a rule that has been removed (#​14435)
  • Ruff now validates that lint.flake8-import-conventions.aliases only uses valid module names and aliases (#​14477)

v0.7.4

Compare Source

Preview features
  • [flake8-datetimez] Detect usages of datetime.max/datetime.min (DTZ901) (#​14288)
  • [flake8-logging] Implement root-logger-calls (LOG015) (#​14302)
  • [flake8-no-pep420] Detect empty implicit namespace packages (INP001) (#​14236)
  • [flake8-pyi] Add "replace with Self" fix (PYI019) (#​14238)
  • [perflint] Implement quick-fix for manual-list-comprehension (PERF401) (#​13919)
  • [pylint] Implement shallow-copy-environ (W1507) (#​14241)
  • [ruff] Implement none-not-at-end-of-union (RUF036) (#​14314)
  • [ruff] Implementation unsafe-markup-call from flake8-markupsafe plugin (RUF035) (#​14224)
  • [ruff] Report problems for attrs dataclasses (RUF008, RUF009) (#​14327)
Rule changes
  • [flake8-boolean-trap] Exclude dunder methods that define operators (FBT001) (#​14203)
  • [flake8-pyi] Add "replace with Self" fix (PYI034) (#​14217)
  • [flake8-pyi] Always autofix duplicate-union-members (PYI016) (#​14270)
  • [flake8-pyi] Improve autofix for nested and mixed type unions for unnecessary-type-union (PYI055) (#​14272)
  • [flake8-pyi] Mark fix as unsafe when type annotation contains comments for duplicate-literal-member (PYI062) (#​14268)
Server
  • Use the current working directory to resolve settings from ruff.configuration (#​14352)
Bug fixes
  • Avoid conflicts between PLC014 (useless-import-alias) and I002 (missing-required-import) by considering lint.isort.required-imports for PLC014 (#​14287)
  • [flake8-type-checking] Skip quoting annotation if it becomes invalid syntax (TCH001)
  • [flake8-pyi] Avoid using typing.Self in stub files pre-Python 3.11 (PYI034) (#​14230)
  • [flake8-pytest-style] Flag pytest.raises call with keyword argument expected_exception (PT011) (#​14298)
  • [flake8-simplify] Infer "unknown" truthiness for literal iterables whose items are all unpacks (SIM222) (#​14263)
  • [flake8-type-checking] Fix false positives for typing.Annotated (TCH001) (#​14311)
  • [pylint] Allow await at the top-level scope of a notebook (PLE1142) (#​14225)
  • [pylint] Fix miscellaneous issues in await-outside-async detection (PLE1142) (#​14218)
  • [pyupgrade] Avoid applying PEP 646 rewrites in invalid contexts (UP044) (#​14234)
  • [pyupgrade] Detect permutations in redundant open modes (UP015) (#​14255)
  • [refurb] Avoid triggering hardcoded-string-charset for reordered sets (FURB156) (#​14233)
  • [refurb] Further special cases added to verbose-decimal-constructor (FURB157) (#​14216)
  • [refurb] Use UserString instead of non-existent UserStr (FURB189) (#​14209)
  • [ruff] Avoid treating lowercase letters as # noqa codes (RUF100) (#​14229)
  • [ruff] Do not report when Optional has no type arguments (RUF013) (#​14181)
Documentation
  • Add "Notebook behavior" section for F704, PLE1142 (#​14266)
  • Document comment policy around fix safety (#​14300)

v0.7.3

Compare Source

Preview features
  • Formatter: Disallow single-line implicit concatenated strings (#​13928)
  • [flake8-pyi] Include all Python file types for PYI006 and PYI066 (#​14059)
  • [flake8-simplify] Implement split-of-static-string (SIM905) (#​14008)
  • [refurb] Implement subclass-builtin (FURB189) (#​14105)
  • [ruff] Improve diagnostic messages and docs (RUF031, RUF032, RUF034) (#​14068)
Rule changes
  • Detect items that hash to same value in duplicate sets (B033, PLC0208) (#​14064)
  • [eradicate] Better detection of IntelliJ language injection comments (ERA001) (#​14094)
  • [flake8-pyi] Add autofix for docstring-in-stub (PYI021) (#​14150)
  • [flake8-pyi] Update duplicate-literal-member (PYI062) to alawys provide an autofix (#​14188)
  • [pyflakes] Detect items that hash to same value in duplicate dictionaries (F601) (#​14065)
  • [ruff] Fix false positive for decorators (RUF028) (#​14061)
Bug fixes
  • Avoid parsing joint rule codes as distinct codes in # noqa (#​12809)
  • [eradicate] ignore # language= in commented-out-code rule (ERA001) (#​14069)
  • [flake8-bugbear] - do not run mutable-argument-default on stubs (B006) (#​14058)
  • [flake8-builtins] Skip lambda expressions in builtin-argument-shadowing (A002) (#​14144)
  • [flake8-comprehension] Also remove trailing comma while fixing C409 and C419 (#​14097)
  • [flake8-simplify] Allow open without context manager in return statement (SIM115) (#​14066)
  • [pylint] Respect hash-equivalent literals in iteration-over-set (PLC0208) (#​14063)
  • [pylint] Update known dunder methods for Python 3.13 (PLW3201) (#​14146)
  • [pyupgrade] - ignore kwarg unpacking for UP044 (#​14053)
  • [refurb] Parse more exotic decimal strings in verbose-decimal-constructor (FURB157) (#​14098)
Documentation
  • Add links to missing related options within rule documentations (#​13971)
  • Add rule short code to mkdocs tags to allow searching via rule codes (#​14040)

v0.7.2

Compare Source

Preview features
  • Fix formatting of single with-item with trailing comment (#​14005)
  • [pyupgrade] Add PEP 646 Unpack conversion to * with fix (UP044) (#​13988)
Rule changes
  • Regenerate known_stdlibs.rs with stdlibs 2024.10.25 (#​13963)
  • [flake8-no-pep420] Skip namespace package enforcement for PEP 723 scripts (INP001) (#​13974)
Server
  • Fix server panic when undoing an edit (#​14010)
Bug fixes
  • Fix issues in discovering ruff in pip build environments (#​13881)
  • [flake8-type-checking] Fix false positive for singledispatchmethod (TCH003) (#​13941)
  • [flake8-type-checking] Treat return type of singledispatch as runtime-required (TCH003) (#​13957)
Documentation
  • [flake8-simplify] Include caveats of enabling if-else-block-instead-of-if-exp (SIM108) (#​14019)

v0.7.1

Compare Source

Preview features
  • Fix E221 and E222 to flag missing or extra whitespace around == operator (#​13890)
  • Formatter: Alternate quotes for strings inside f-strings in preview (#​13860)
  • Formatter: Join implicit concatenated strings when they fit on a line (#​13663)
  • [pylint] Restrict iteration-over-set to only work on sets of literals (PLC0208) (#​13731)
Rule changes
  • [flake8-type-checking] Support auto-quoting when annotations contain quotes (#​11811)
Server
  • Avoid indexing the workspace for single-file mode (#​13770)
Bug fixes
  • Make ARG002 compatible with EM101 when raising NotImplementedError (#​13714)
Other changes
  • Introduce more Docker tags for Ruff (similar to uv) (#​13274)

v0.7.0

Compare Source

Check out the blog post for a migration guide and overview of the changes!

Breaking changes
  • The pytest rules PT001 and PT023 now default to omitting the decorator parentheses when there are no arguments
    (#​12838, #​13292).
    This was a change that we attempted to make in Ruff v0.6.0, but only partially made due to an error on our part.
    See the blog post for more details.
  • The useless-try-except rule (in our tryceratops category) has been recoded from TRY302 to
    TRY203 (#​13502). This ensures Ruff's code is consistent with
    the same rule in the tryceratops linter.
  • The lint.allow-unused-imports setting has been removed (#​13677). Use
    lint.pyflakes.allow-unused-imports
    instead.
Formatter preview style
  • Normalize implicit concatenated f-string quotes per part (#​13539)
Preview linter features
  • [refurb] implement hardcoded-string-charset (FURB156) (#​13530)
  • [refurb] Count codepoints not bytes for slice-to-remove-prefix-or-suffix (FURB188) (#​13631)
Rule changes
  • [pylint] Mark PLE1141 fix as unsafe (#​13629)
  • [flake8-async] Consider async generators to be "checkpoints" for cancel-scope-no-checkpoint (ASYNC100) (#​13639)
  • [flake8-bugbear] Do not suggest setting parameter strict= to False in B905 diagnostic message (#​13656)
  • [flake8-todos] Only flag the word "TODO", not words starting with "todo" (TD006) (#​13640)
  • [pycodestyle] Fix whitespace-related false positives and false negatives inside type-parameter lists (E231, E251) (#​13704)
  • [flake8-simplify] Stabilize preview behavior for SIM115 so that the rule can detect files
    being opened from a wider range of standard-library functions (#​12959).
CLI
  • Add explanation of fixable in --statistics command (#​13774)
Bug fixes
  • [pyflakes] Allow ipytest cell magic (F401) (#​13745)
  • [flake8-use-pathlib] Fix PTH123 false positive when open is passed a file descriptor (#​13616)
  • [flake8-bandit] Detect patterns from multi line SQL statements (S608) (#​13574)
  • [flake8-pyi] - Fix dropped expressions in PYI030 autofix (#​13727)

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

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.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Summary by Sourcery

Build:

  • Update the ruff dependency from version ^0.6.0 to ^0.8.0 in the pyproject.toml file.

Copy link

sourcery-ai bot commented Nov 22, 2024

Reviewer's Guide by Sourcery

This PR updates the Ruff linter dependency from version 0.6.0 to 0.8.0. The update includes breaking changes, new features, and bug fixes across multiple releases (0.7.0, 0.7.1, 0.7.2, 0.7.3, 0.7.4, and 0.8.0).

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Breaking changes in Ruff configuration and behavior
  • Default Python version changed to 3.9
  • Changed location of pydoclint diagnostics
  • Modified installer directory to use XDG instead of Cargo home
  • Updated line width calculation using new unicode-width crate
  • Removed several deprecated rules
  • Remapped flake8-type-checking rules from TCH to TC
pyproject.toml
New features and rule stabilization
  • Stabilized multiple rules including builtin-import-shadowing and mutable-contextvar-default
  • Added new preview rules for better code quality checks
  • Improved formatter behavior for string handling
  • Enhanced configuration validation
pyproject.toml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We have skipped reviewing this pull request. Here's why:

  • It seems to have been created by a bot (hey, renovate[bot]!). We assume it knows what it's doing!
  • We don't review packaging changes - Let us know if you'd like us to change this.

Copy link

@llamapreview llamapreview bot left a comment

Choose a reason for hiding this comment

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

Auto Pull Request Review from LlamaPReview

1. Change Overview

1.1 Core Changes

  • Primary purpose and scope: This pull request (PR) updates the dependency ruff from version ^0.6.0 to ^0.8.0.
  • Key components modified: The pyproject.toml file is modified to reflect the new version of the ruff dependency.
  • Cross-component impacts: Updating the ruff dependency may introduce new features, bug fixes, and breaking changes that could affect the overall system.
  • Business value alignment: The update aligns with maintaining up-to-date dependencies, ensuring compatibility, and leveraging new features and improvements.

1.2 Technical Architecture

  • System design modifications: No significant changes to the system design.
  • Component interaction changes: The update affects the linting and formatting rules applied by ruff, which could impact code quality and adherence to coding standards.
  • Integration points impact: The integration points with ruff may require adjustments to accommodate new features and breaking changes.
  • Dependency changes and implications: The update introduces new rules, removes deprecated rules, and changes default behaviors, which need to be considered in the codebase.

2. Deep Technical Analysis

2.1 Code Logic Analysis

pyproject.toml

  • Submitted PR Code:
    ---
    +++
    @@ -32,21 +32,21 @@
    easyoanda = {version ="1.0.19", python = ">=3.11,<4.0"}
    ib_insync = "0.9.86"
    # mt5linux = "0.1.9"
    mt5linux_updated = "0.0.1"
    # pyetrade = {version ="2.1.0"}
    
    [tool.poetry.group.dev.dependencies]
    python-semantic-release = ">=8.0.8"
    -ruff = "^0.6.0"
    +ruff = "^0.8.0"
    pre-commit = "^4.0.0"
  • Analysis:
    • The version update for ruff introduces several breaking changes and new features that need to be carefully reviewed.
    • The update removes deprecated rules and adds new rules, which may affect the existing codebase.
  • LlamaPReview Suggested Improvements:
    # No specific code improvement needed for the version update itself.
  • Improvement rationale:
    • Technical benefits: Ensuring compatibility with the latest version of ruff and leveraging new features and improvements.
    • Business value: Maintaining up-to-date dependencies helps in improving code quality and adherence to coding standards.
    • Risk assessment: The update introduces breaking changes that need to be carefully reviewed and tested to ensure they do not negatively impact the system.

2.2 Implementation Quality

  • Code Structure:

    • Organization and modularity: The update is well-contained within the pyproject.toml file.
    • Design pattern adherence: No changes to design patterns.
    • Reusability aspects: The update does not affect the reusability of the code.
    • Maintainability factors: Updating dependencies helps in maintaining the code and leveraging new features.
  • Error Handling:

    • Exception scenarios coverage: The update does not introduce new error handling scenarios.
    • Recovery mechanisms: No changes to recovery mechanisms.
    • Logging and monitoring: No changes to logging and monitoring.
    • User experience impact: The update may affect the linting and formatting rules, which could impact the user experience during development.
  • Performance Considerations:

    • Resource utilization: The update does not introduce significant changes to resource utilization.
    • Scalability aspects: No changes to scalability.
    • Bottleneck analysis: No new bottlenecks introduced.
    • Optimization opportunities: The update leverages new features and improvements in ruff, which may offer optimization opportunities.

3. Risk Assessment

3.1 Critical Issues

🔴 P0 (Must Fix):

  • Issue:
    • Breaking changes introduced in ruff version ^0.8.0 may affect the existing codebase.
  • Impact:
    • Technical implications: May result in linting and formatting issues in the codebase.
    • Business consequences: May require additional development effort to address the breaking changes.
    • User experience effects: May affect the user experience during development due to changes in linting and formatting rules.
  • Resolution:
    • Specific code changes: Review the breaking changes and update the codebase accordingly.
    • Configuration updates: Update the ruff configuration to accommodate new rules and changes.
    • Testing requirements: Conduct thorough testing to ensure the update does not introduce new issues.

3.2 Important Improvements

🟡 P1 (Should Fix):

  • Issue:
    • Ensure compatibility with the latest version of ruff.
  • Current Impact:
    • Performance implications: No significant performance implications.
    • Maintenance overhead: Updating dependencies helps in maintaining the code and leveraging new features.
    • Future scalability: No changes to scalability.
  • Suggested Solution:
    • Implementation approach: Review the release notes and update the codebase to accommodate new features and breaking changes.
    • Migration strategy: Plan a phased migration to address breaking changes and leverage new features.
    • Testing considerations: Conduct thorough testing to ensure the update does not introduce new issues.

3.3 Minor Suggestions

🟢 P2 (Consider):

  • Area: Documentation updates
  • Improvement Opportunity:
    • Code quality enhancement: Update the documentation to reflect the changes introduced in ruff version ^0.8.0.
    • Best practice alignment: Ensure the documentation aligns with the latest coding standards and best practices.
    • Documentation updates: Include detailed information on the breaking changes and new features introduced in the update.

4. Requirements Analysis

4.1 Functional Coverage

  • Requirements mapping:
    • Implemented features: The update introduces new features and improvements in ruff.
    • Missing elements: No missing elements identified.
    • Edge cases handling: Ensure that the breaking changes and new features are thoroughly tested for edge cases.
  • Business Logic:
    • Use case coverage: The update aligns with maintaining up-to-date dependencies and leveraging new features.
    • Business rule implementation: No changes to business rules.
    • Data flow correctness: No changes to data flow.

4.2 Non-functional Aspects

  • Performance metrics: No significant changes to performance metrics.
  • Security considerations: No new security considerations introduced.
  • Scalability factors: No changes to scalability.
  • Maintainability aspects: Updating dependencies helps in maintaining the code and leveraging new features.

5. Testing Strategy

  • Test Coverage:
    • Unit test requirements: Ensure unit tests cover the new features and changes introduced in ruff version ^0.8.0.
    • Integration test scenarios: Conduct integration tests to ensure compatibility with the updated version of ruff.
    • Edge case validation: Thoroughly test edge cases related to the breaking changes and new features.
  • Quality Metrics:
    • Current coverage: Ensure high test coverage for the updated codebase.
    • Critical paths: Test critical paths to ensure the update does not introduce new issues.
    • Performance benchmarks: No new performance benchmarks required.

6. Final Assessment

6.1 Key Action Items

  1. Critical Changes (P0):

    • Review the breaking changes introduced in ruff version ^0.8.0 and update the codebase accordingly.
    • Update the ruff configuration to accommodate new rules and changes.
    • Conduct thorough testing to ensure the update does not introduce new issues.
  2. Important Improvements (P1):

    • Ensure compatibility with the latest version of ruff.
    • Review the release notes and update the codebase to accommodate new features and breaking changes.
    • Plan a phased migration to address breaking changes and leverage new features.
    • Conduct thorough testing to ensure the update does not introduce new issues.
  3. Suggested Enhancements (P2):

    • Update the documentation to reflect the changes introduced in ruff version ^0.8.0.
    • Ensure the documentation aligns with the latest coding standards and best practices.
    • Include detailed information on the breaking changes and new features introduced in the update.

6.2 Overall Evaluation

  • Technical assessment: The update introduces new features and improvements, but also includes breaking changes that need to be carefully reviewed and tested.
  • Business impact: Maintaining up-to-date dependencies helps in improving code quality and adherence to coding standards.
  • Risk evaluation: The update introduces breaking changes that need to be carefully reviewed and tested to ensure they do not negatively impact the system.
  • Implementation quality: The update is well-contained within the pyproject.toml file and helps in maintaining the code and leveraging new features.

💡 LlamaPReview Community
Have feedback on this AI Code review tool? Join our GitHub Discussions to share your thoughts and help shape the future of LlamaPReview.

@github-actions github-actions bot merged commit 859129a into dev Nov 22, 2024
7 of 8 checks passed
@github-actions github-actions bot deleted the renovate/ruff-0.x branch November 22, 2024 11:25
Copy link

codecov bot commented Nov 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.56%. Comparing base (2a115d6) to head (8cf1fce).
Report is 2 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #548      +/-   ##
==========================================
- Coverage   65.43%   64.56%   -0.88%     
==========================================
  Files          10       10              
  Lines         570      570              
==========================================
- Hits          373      368       -5     
- Misses        197      202       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants