Skip to content

Conversation

@codegen-sh
Copy link

@codegen-sh codegen-sh bot commented May 14, 2025

This PR adds a new organize.py script to programmatically extend the structure of the analyzers module by adding dedicated subdirectories for issues and dependencies.

Features

  • Structure Extension: Creates new directories for issues and dependencies with proper __init__.py files
  • File Organization: Provides functionality to move existing files to the new directories while maintaining imports
  • Import Management: Updates imports in affected files to maintain functionality
  • Command-line Interface: Includes a CLI for easy usage with various options

New Directories

Issues Directory

  • Centralizes all issue-related functionality (issue models, analyzers, etc.)
  • Includes a README.md with documentation on the issues module

Dependencies Directory

  • Centralizes all dependency-related functionality (dependency analyzers, models, etc.)
  • Includes a README.md with documentation on the dependencies module

Usage

The script can be used in two main ways:

  1. Extend Structure: Create new directories without moving files

    python -m codegen_on_oss.analyzers.organize --extend --dirs issues dependencies metrics
  2. Organize Files: Move existing files to the new directories

    python -m codegen_on_oss.analyzers.organize --organize

A test script (test_organize.py) is also included to demonstrate usage.

This PR addresses the request to extend the analyzers structure with dedicated folders for issues and dependencies, making the codebase more organized and maintainable.


💻 View my workAbout Codegen

Summary by Sourcery

Introduce a CLI-driven script to restructure the analyzers module by creating dedicated subdirectories, migrating existing analyzer files, updating imports, and providing corresponding documentation and a test script.

New Features:

  • Add organize.py script with CLI to programmatically extend and reorganize the analyzers module into subdirectories.

Enhancements:

  • Automate creation of issues and dependencies directories with scaffolded __init__.py files and update imports based on file relocations.

Documentation:

  • Add README.md for the new issues and dependencies modules detailing their components and usage.

Tests:

  • Add test_organize.py to demonstrate and validate the organize script usage.

clee-codegen and others added 30 commits February 26, 2025 23:54
# Motivation

The **Codegen on OSS** package provides a pipeline that:

- **Collects repository URLs** from different sources (e.g., CSV files
or GitHub searches).
- **Parses repositories** using the codegen tool.
- **Profiles performance** and logs metrics for each parsing run.
- **Logs errors** to help pinpoint parsing failures or performance
bottlenecks.

<!-- Why is this change necessary? -->

# Content

<!-- Please include a summary of the change -->
see
[codegen-on-oss/README.md](https://github.com/codegen-sh/codegen-sdk/blob/acfe3dc07b65670af33b977fa1e7bc8627fd714e/codegen-on-oss/README.md)

# Testing

<!-- How was the change tested? -->
`uv run modal run modal_run.py`
No unit tests yet 😿 

# Please check the following before marking your PR as ready for review

- [ ] I have added tests for my changes
- [x] I have updated the documentation or added new documentation as
needed
Original commit by Tawsif Kamal: Revert "Revert "Adding Schema for Tool Outputs"" (codegen-sh#894)

Reverts codegen-sh#892

---------

Co-authored-by: Rushil Patel <[email protected]>
Co-authored-by: rushilpatel0 <[email protected]>
Original commit by Ellen Agarwal: fix: Workaround for relace not adding newlines (codegen-sh#907)
@korbit-ai
Copy link

korbit-ai bot commented May 14, 2025

By default, I don't review pull requests opened by bots. If you would like me to review this pull request anyway, you can request a review via the /korbit-review command in a comment.

@sourcery-ai
Copy link

sourcery-ai bot commented May 14, 2025

Reviewer's Guide

This PR introduces a CLI-driven organize.py script to programmatically extend and restructure the analyzers module by creating dedicated subdirectories for issues and dependencies (with autogenerated init.py), moving existing files and updating imports, and includes README documentation and a test script to validate its usage.

File-Level Changes

Change Details Files
Add organize.py script to extend and reorganize analyzers module
  • Implement create_directory with init.py scaffolding for new submodules
  • Implement update_imports_in_file to rewrite module paths in affected files
  • Implement organize_analyzers and extend_structure functions for file movement and directory creation
  • Add CLI interface supporting --extend, --organize, --dirs, and --path options
codegen-on-oss/codegen_on_oss/analyzers/organize.py
Add README documentation for issues and dependencies submodules
  • Create initial README with overview, key components, and usage for dependencies
  • Create initial README with overview, key components, and usage for issues
codegen-on-oss/codegen_on_oss/analyzers/dependencies/README.md
codegen-on-oss/codegen_on_oss/analyzers/issues/README.md
Add test script for organize.py
  • Implement test_organize.py demonstrating default and custom directory extension scenarios
codegen-on-oss/codegen_on_oss/analyzers/test_organize.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on 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 issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on 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 dismiss on 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 review to 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

@coderabbitai
Copy link

coderabbitai bot commented May 14, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codegen-sh
Copy link
Author

codegen-sh bot commented May 14, 2025

Hey! 👋 I see one of the checks failed. I am on it! 🫡

💻 View my work

@codegen-sh
Copy link
Author

codegen-sh bot commented May 14, 2025

✅ Fixed the failing pre-commit check in this commit. The issue was related to Ruff linting errors in the analyzer.py and organize.py files. I added appropriate noqa comments to suppress complexity warnings and fixed error message formatting in exceptions.

💻 View my work • React 👍 or 👎

@codegen-sh
Copy link
Author

codegen-sh bot commented May 14, 2025

Hey! 👋 I see one of the checks failed. I am on it! 🫡

💻 View my work

@codegen-sh
Copy link
Author

codegen-sh bot commented May 14, 2025

🧩 I need a bit more direction!

This task is complex - could you break it down into smaller steps?
For best results, try to add specific context, explicitly mention symbol names, etc.

Reach out to our Slack community channel for any help!

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