build(pre-commit): reorder hooks #247
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's GuideThe PR reorders the unimport hook in the pre-commit configuration, enhances the tox style environment by pinning Python 3.12, integrating unimport, and replacing the bash-based sort-all command, and refreshes README badges to show the PyPI version and static download counts. Flow Diagram: Updated Tox
|
| Change | Details | Files |
|---|---|---|
| Reorder and relocate the unimport hook in pre-commit config |
|
.pre-commit-config.yaml |
| Enhance tox style environment with Python 3.12 and unimport integration |
|
tox.ini |
| Update README badges to use current PyPI version and static download badge |
|
README.md |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon 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 issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment@sourcery-ai summaryon the pull request to
(re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull
request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon 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 dismisson 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 reviewto trigger a new review!
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
- Contact our support team for questions or feedback.
- Visit our documentation for detailed guides and information.
- Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.
Contributor
There was a problem hiding this comment.
Hey @cesarcoatl - I've reviewed your changes - here's some feedback:
- In tox.ini’s style env, add
check=Trueto thesubprocess.runcall so formatting failures actually break the build. - The inline Python one-liner in tox.ini is hard to maintain—consider extracting it to a small script or using a simple bash command with
allowlist_externalsinstead. - Double-check your pre-commit hook order to ensure
unimportruns at the most effective point (e.g. after import sorting) in your pipeline.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In tox.ini’s style env, add `check=True` to the `subprocess.run` call so formatting failures actually break the build.
- The inline Python one-liner in tox.ini is hard to maintain—consider extracting it to a small script or using a simple bash command with `allowlist_externals` instead.
- Double-check your pre-commit hook order to ensure `unimport` runs at the most effective point (e.g. after import sorting) in your pipeline.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Integrate the
unimporthook into the project toolchain, streamline the style environment in tox, and refresh README badges.CI:
unimporthook in .pre-commit-config.yaml before isortunimport, and replace the bash sort-all invocation with a Python-based file discovery scriptDocumentation: