-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Experiment: Discovery docs diff with in generator improvements #15459
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?
Conversation
Summary of ChangesHello @ohmayr, 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 introduces significant internal enhancements to the client library generator, focusing on performance, build efficiency, and code quality tooling. It integrates a new performance logging system to provide insights into execution times, transitions the code formatting workflow to the high-performance Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
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 significant performance improvements to the generator, primarily by replacing black and isort with the much faster ruff for formatting and import sorting. The Dockerfile has also been optimized for better layer caching, which will speed up local development builds. Additionally, a helpful performance profiling decorator (@track_time) has been added to measure the execution time of key functions. The changes are well-structured and focused on performance. I have a couple of minor suggestions to improve the robustness of the new ruff integration and to clean up the code.
I am having trouble creating individual review comments. Click here to see my feedback.
.generator/cli.py (391)
This log line appears to be commented out. To keep the code clean, it should either be re-enabled if logging is desired here, or removed if it's no longer needed.
.generator/cli.py (392-418)
The subprocess.run calls for ruff use check=False and redirect both stdout and stderr to subprocess.DEVNULL. This will silently ignore any errors that ruff encounters (e.g., parsing errors in the generated Python files), which could mask underlying problems. While the FileNotFoundError is handled, other execution errors will not be reported.
I suggest capturing stderr and logging it as a warning if the subprocess returns a non-zero exit code. This will make debugging much easier if ruff has issues with the generated code.
# STEP A: Fix Imports (like isort)
check_run = subprocess.run(
[
"ruff", "check",
"--select", "I", # Only run Import sorting rules
"--fix", # Auto-fix them
"--line-length=88", # Match Black default
"--known-first-party=google", # Prevent 'google' moving to 3rd party block
output
],
check=False,
capture_output=True,
text=True
)
if check_run.returncode != 0:
logger.warning(f"Ruff check failed:\n{check_run.stderr}")
# STEP B: Format Code (like black)
format_run = subprocess.run(
[
"ruff", "format",
"--line-length=88", # Match Black default
output
],
check=False,
capture_output=True,
text=True
)
if format_run.returncode != 0:
logger.warning(f"Ruff format failed:\n{format_run.stderr}")df31327 to
8a752b0
Compare
This PR demonstrates the discovery docs changes with the following changes in rst.py file in the generator:
Fixes #<issue_number_goes_here> 🦕