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

Use ruff for pre-commits #515

Merged
merged 4 commits into from
Jan 16, 2024
Merged

Use ruff for pre-commits #515

merged 4 commits into from
Jan 16, 2024

Conversation

lang-m
Copy link
Member

@lang-m lang-m commented Jan 15, 2024

Ruff can do linting and formatting. We can use it to replace black, isort, and flake8.

Copy link
Contributor

PR Analysis

  • 🎯 Main theme: Switching from black, isort, and flake8 to ruff for linting and formatting.
  • 📝 PR summary: This PR replaces the existing linting and formatting tools (black, isort, and flake8) with ruff. It also includes the necessary changes in the code to comply with ruff's rules. The .pre-commit-config.yaml and pyproject.toml files have been updated accordingly.
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 2, because the PR mainly involves changes in the linting and formatting tools and the corresponding adjustments in the code. There are no significant logic changes.
  • 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is well-structured and the changes are consistent. However, it would be beneficial to include a brief explanation in the PR description about why ruff was chosen over the previous tools. This would provide more context to the reviewers and other contributors.

🤖 Code feedback:
relevant file.pre-commit-config.yaml
suggestion      

Consider adding a brief comment for each hook explaining its purpose. This would make it easier for other contributors to understand the reason for each hook. [medium]

relevant line- id: ruff

relevant filepyproject.toml
suggestion      

It would be beneficial to add a brief comment explaining the ignore-init-module-imports = true configuration. This would provide more context to the reviewers and other contributors. [medium]

relevant lineignore-init-module-imports = true


✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions

The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

Examples for extra instructions:

[pr_reviewer] # /review #
extra_instructions="""
In the code feedback section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation
  • When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]

meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section

The review tool provides several type of feedbacks, one of them is code suggestions.
If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results.
Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels

The review tool can auto-generate two specific types of labels for a PR:

  • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
  • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools

The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
require_score_review, require_soc2_review, enable_review_labels_effort, and more.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (30bf3c7) 93.49% compared to head (ef6a7ee) 93.48%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #515      +/-   ##
==========================================
- Coverage   93.49%   93.48%   -0.01%     
==========================================
  Files          28       28              
  Lines        3027     3025       -2     
==========================================
- Hits         2830     2828       -2     
  Misses        197      197              

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

@lang-m lang-m requested a review from samjrholt January 16, 2024 08:15
@lang-m lang-m merged commit f1b4cda into master Jan 16, 2024
7 checks passed
@lang-m lang-m deleted the ruff-pre-commit branch January 16, 2024 10:36
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.

3 participants