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

build(deps): add pydoclint #228

Merged
merged 2 commits into from
Jan 28, 2025
Merged

build(deps): add pydoclint #228

merged 2 commits into from
Jan 28, 2025

Conversation

cesarcoatl
Copy link
Member

@cesarcoatl cesarcoatl commented Jan 28, 2025

Summary by Sourcery

Add pydoclint to the pre-commit hooks and update isort.

Build:

  • Update Makefile targets to use a single hyphen between words.

CI:

  • Add pydoclint to pre-commit configuration and update isort to v6.0.0.

Copy link
Contributor

sourcery-ai bot commented Jan 28, 2025

Reviewer's Guide by Sourcery

This pull request introduces pydoclint to the pre-commit hooks and updates isort to version 6.0.0. Additionally, it renames some of the make commands to be more descriptive and adds a return to the enter method of the DisposableConnection class.

Class diagram showing updated DisposableConnection class

classDiagram
    class DisposableConnection {
        -_database
        +__enter__() DisposableConnection
    }
    note for DisposableConnection "Added return type annotation for __enter__ method"
Loading

File-Level Changes

Change Details Files
Added pydoclint to pre-commit hooks.
  • Added pydoclint to the pre-commit configuration.
  • Added pydoclint-flake8 hook.
.pre-commit-config.yaml
Updated isort version.
  • Updated isort version from 5.13.2 to 6.0.0.
.pre-commit-config.yaml
Renamed make commands.
  • Renamed install-clean to cleaninstall.
  • Renamed install-force to forceinstall.
  • Renamed install-nocache to nocacheinstall.
  • Renamed install-nodeps to nodepsinstall.
Makefile
Added a return to the enter method of the DisposableConnection class.
  • Added a return statement to the enter method.
src/incendium/db.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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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
Contributor

@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 @cesarcoatl - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The removal of files: ^src/ from the pylint hook will cause it to run on all Python files in the repository. Was this intentional? Consider keeping the src/ restriction if other Python files (like scripts or tests) don't need to be linted.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues 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.

Comment on lines 44 to 45
language: system
files: ^src/
types: [python]
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion (performance): Removing the src/ directory constraint for pylint might impact pre-commit hook performance

Consider keeping the files constraint to limit pylint to only the relevant source files

Suggested implementation:

        name: pylint
        entry: pylint
        language: system
        files: ^src/
        types: [python]

Note: If your source code is not in a src/ directory, you should adjust the files pattern to match your project's structure (e.g., ^your_package/ or similar).

src/incendium/db.py Outdated Show resolved Hide resolved
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@cesarcoatl cesarcoatl merged commit 5439749 into main Jan 28, 2025
4 checks passed
@cesarcoatl cesarcoatl deleted the build/deps/pydoclint branch January 28, 2025 19:38
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