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

TST: update ruff and codespell versions #113

Merged
merged 2 commits into from
Dec 16, 2024
Merged

TST: update ruff and codespell versions #113

merged 2 commits into from
Dec 16, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Dec 16, 2024

Update ruff and codespell pre-commits to the versions we now use in other packages.

Summary by Sourcery

Update pre-commit hooks for ruff and codespell to newer versions and fix type comparison issues in the codebase.

Bug Fixes:

  • Fix type comparison in audobject/core/parameter.py by using isinstance for boolean type check.
  • Correct object comparison in tests/test_object.py by using isinstance.

Enhancements:

  • Update ruff pre-commit hook to version 0.7.0.
  • Update codespell pre-commit hook to version 2.3.0.

Copy link

sourcery-ai bot commented Dec 16, 2024

Reviewer's Guide by Sourcery

This PR updates the versions of two pre-commit hooks (ruff and codespell) and fixes type checking issues in the codebase. The ruff version is updated from v0.1.8 to v0.7.0, and codespell is updated from v2.2.4 to v2.3.0. Additionally, two type-related comparisons are modified to use more appropriate comparison methods.

Class diagram for updated type checking in parameter.py

classDiagram
    class Parameter {
        - description: String
        - value_type: Any
    }
    class CommandLineParser {
        + add_argument(name: String, action: String)
    }
    Parameter --> CommandLineParser : uses
    note for Parameter "Updated type check for value_type to use isinstance"
Loading

File-Level Changes

Change Details Files
Update pre-commit hook versions
  • Update ruff from v0.1.8 to v0.7.0
  • Update codespell from v2.2.4 to v2.3.0
.pre-commit-config.yaml
Fix type checking and comparison operations
  • Replace direct boolean type comparison with isinstance() check
  • Replace equality comparison with type to isinstance() check
audobject/core/parameter.py
tests/test_object.py

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.

Hey @hagenw - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

audobject/core/parameter.py Outdated Show resolved Hide resolved
@hagenw hagenw merged commit c77df85 into main Dec 16, 2024
17 checks passed
@hagenw hagenw deleted the update-pre-commit branch December 16, 2024 15:38
Copy link

codecov bot commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.0%. Comparing base (2e9e40f) to head (681e18b).
Report is 1 commits behind head on main.

Additional details and impacted files
Files with missing lines Coverage Δ
audobject/core/parameter.py 100.0% <100.0%> (ø)
audobject/resolver/__init__.py 100.0% <ø> (ø)

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

Successfully merging this pull request may close these issues.

1 participant