Skip to content

Conversation

@jaeminSon
Copy link

SUMMARY:
"Address #2111. Checked other directories and that was the only missing __init__.py"

TEST PLAN:
"pip install --no-build-isolation . and checked from llmcompressor.pipelines.sequential.ast_utils.auto_wrapper import AutoWrapper"

@github-actions
Copy link

👋 Hi! Thank you for contributing to llm-compressor. Please add the ready label when the PR is ready for review.

Note: This is required to complete the testing suite, please only add the label once the PR is code complete and local testing has been performed.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @jaeminSon, 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 addresses a packaging issue by adding a crucial "init.py" file to the "ast_utils" directory. This change ensures that the directory is properly recognized as a Python package, resolving potential import errors and improving the overall module structure and discoverability within the "llmcompressor" project.

Highlights

  • Python Package Structure: Introduced a missing "init.py" file within the "src/llmcompressor/pipelines/sequential/ast_utils/" directory to correctly define it as a Python package.
  • Module Exposure: The newly added "init.py" file now explicitly imports "auto_wrapper", "control_flow_analyzer", and "name_analyzer", making these modules directly accessible when importing from "ast_utils".
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 adds a missing __init__.py file to the src/llmcompressor/pipelines/sequential/ast_utils directory, correctly turning it into a Python package. However, the implementation uses wildcard imports, which is generally discouraged. My feedback includes a suggestion to use explicit imports and define __all__ to create a clear public API for the package, which aligns with Python best practices for readability and maintainability.

Comment on lines +1 to +4
# ruff: noqa
from .auto_wrapper import *
from .control_flow_analyzer import *
from .name_analyzer import * No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Using wildcard imports (from ... import *) is generally discouraged as it can lead to namespace pollution and make it difficult to trace where names are coming from. It's better to be explicit about what your package exports.

You can explicitly import the classes and define __all__ to control the public API of this package. This improves readability and maintainability. By making this change, the # ruff: noqa directive is no longer necessary.

Suggested change
# ruff: noqa
from .auto_wrapper import *
from .control_flow_analyzer import *
from .name_analyzer import *
from .auto_wrapper import AutoWrapper
from .control_flow_analyzer import ControlFlowAnalyzer
from .name_analyzer import NameAnalyzer
__all__ = [
"AutoWrapper",
"ControlFlowAnalyzer",
"NameAnalyzer",
]
References
  1. PEP 8, the style guide for Python code, advises against wildcard imports (from <module> import *) because they make it unclear which names are present in the namespace, confusing both readers and many automated tools. It is recommended to be explicit about imports. (link)

Copy link
Collaborator

Choose a reason for hiding this comment

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

would be good to do this^

# ruff: noqa
from .auto_wrapper import *
from .control_flow_analyzer import *
from .name_analyzer import * No newline at end of file
Copy link
Collaborator

Choose a reason for hiding this comment

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

failing formatting checks, it looks like your missing a newline at the end of the file, you can run make quality and make style to check whether your local changes pass our formatting checks.

Suggested change
from .name_analyzer import *
from .name_analyzer import *

Copy link
Collaborator

@HDCharles HDCharles left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution! lets round out the PR a bit more before landing.

  1. fix formatting issue
  2. add __all__ and static imports (feel free to just apply the suggestion from gemini)
  3. if we're going to add this init, we should probably move the existing imports for these 3 class to this new location.

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.

2 participants