-
Notifications
You must be signed in to change notification settings - Fork 379
Add ruff to pre-commit #1201
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
base: main
Are you sure you want to change the base?
Add ruff to pre-commit #1201
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @cyx-6, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on enhancing code quality and consistency by integrating the ruff
linter and formatter into the project's pre-commit
workflow. The changes include setting up ruff
as a pre-commit hook, configuring its behavior, and reformatting existing Python code to comply with ruff
's rules.
Highlights
- Pre-commit Integration: I have integrated
ruff-check
as a new hook into the project's.pre-commit-config.yaml
file. This ensures thatruff
runs automatically on staged changes, enforcing code style and catching common issues before commits are made. - Ruff Configuration: I have added a
[tool.ruff]
section topyproject.toml
, configuringruff
to exclude specific directories (3rdparty
,tests
) from its linting and formatting checks. This preventsruff
from modifying or flagging issues in third-party code or test files that might have different conventions. - Code Reformatting: I have applied
ruff
's formatting rules across numerous existing Python files. This involved changes such as the removal of unused imports, conversion of f-strings to regular strings where interpolation is not needed, and other minor stylistic adjustments to align the codebase withruff
's standards.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces ruff
to the pre-commit hooks and applies its formatting and linting rules across the Python codebase. The changes primarily consist of removing unused imports and applying minor stylistic improvements. I've provided feedback on the ruff
version in the pre-commit configuration and a suggestion to include the tests
directory in the linting scope.
@@ -59,3 +59,9 @@ repos: | |||
hooks: | |||
- id: cmake-format | |||
additional_dependencies: [pyyaml>=5.1] | |||
|
|||
- repo: https://github.com/astral-sh/ruff-pre-commit | |||
rev: v0.12.1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
extend-exclude = [ | ||
"3rdparty", | ||
"tests", | ||
] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📌 Description
Add ruff to pre-commit and reformat code to pass ruff rules.
🔍 Related Issues
🚀 Pull Request Checklist
Thank you for contributing to FlashInfer! Before we review your pull request, please make sure the following items are complete.
✅ Pre-commit Checks
pre-commit
by runningpip install pre-commit
(or used your preferred method).pre-commit install
.pre-commit run --all-files
and fixed any reported issues.🧪 Tests
unittest
, etc.).Reviewer Notes