ZAM-369: Implement codebase_ai.py in analyzers directory

[codegen-sh]

Description

This PR implements the missing codebase_ai.py module in the codegen-on-oss/codegen_on_oss/analyzers/ directory. The module provides AI-powered code analysis and generation capabilities, including system prompt generation, context generation for AI models, and guidelines for generating and modifying code.

Changes

• Added codebase_ai.py module with the following features:
  • System prompt generation for code analysis
  • Context generation for AI models
  • Rules for generating and modifying code
  • Guidelines for handling docstrings and comments
  • Tool definitions for AI models
• Updated __init__.py to export the new module's functions and classes
• Added comprehensive tests for the new module
• Added an example script demonstrating how to use the module
• Added documentation in a README file

Testing

The implementation includes a comprehensive test suite in tests/analyzers/test_codebase_ai.py that covers all the functionality of the module.

Related Issues

Resolves ZAM-369

---

💻 View my work • About Codegen

Summary by Sourcery

Implement the new CodebaseAI analyzer to generate AI system prompts, context, and tools for code analysis and flagging, and add corresponding exports, tests, documentation, and an example usage script

New Features:

• Introduce a CodebaseAI module for AI-powered code analysis and generation with system prompt, context, and tool definitions
• Provide flagging capabilities via dedicated flag prompt and tools for marking code elements

Enhancements:

• Export CodebaseAI class and associated functions in the analyzers package init.py

Documentation:

• Add README documentation for the CodebaseAI module
• Include an example script demonstrating basic usage of the module

Tests:

• Add comprehensive unit tests covering system prompt, flag prompt, context generation, and tool definitions

Description by Korbit AI

What change is being made?

Implement codebase_ai.py module in the analyzers directory, update the __init__.py to include it, and add a README, an example usage script, and unit tests for the module.

Why are these changes being made?

These changes introduce AI-powered code analysis and generation capabilities to the Codegen analyzer system, extending its functionality to automate and enhance code handling with features like system prompt generation, context formatting, and tool definitions. The updated module supports integration with existing analyzers, and comprehensive testing ensures reliability and quality of the new features.

Is this description stale? Ask me to generate a new description by commenting /korbit-generate-pr-description

[sourcery-ai]

Reviewer's Guide

This PR introduces a new AI-driven code analysis module in the analyzers package—providing prompt and context generation, tool definitions, and a wrapper class—while updating exports, and adding tests, documentation, and an example script to demonstrate usage.

File-Level Changes

Change	Details	Files
Implement core AI prompt and tool generation functionality	Add generate_system_prompt and generate_flag_system_prompt functions Implement generate_context for multiple input types Define generate_tools and generate_flag_tools with proper schemas Create CodebaseAI class to wrap utility functions	codegen-on-oss/codegen_on_oss/analyzers/codebase_ai.py
Export new AI module and utilities in analyzer package	Add CodebaseAI, generate_* functions to init.py exports Maintain existing legacy interface order	codegen-on-oss/codegen_on_oss/analyzers/__init__.py
Add comprehensive tests for the new AI module	Cover prompt generation with/without target and context Verify context formatting for strings, Editables, Files, lists, dicts Assert proper tool definitions and flag logic Test CodebaseAI class methods	codegen-on-oss/tests/analyzers/test_codebase_ai.py
Provide usage documentation for the AI module	Create README with features, usage, API reference, and integration guidance Document system prompt, context, tools, and flagging workflows	codegen-on-oss/codegen_on_oss/analyzers/README_codebase_ai.md
Include example script demonstrating module usage	Show basic and combined prompt/context generation Illustrate tool retrieval and usage with logging Demonstrate integration in a standalone example	codegen-on-oss/examples/codebase_ai_example.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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

[korbit-ai]

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.

[codegen-sh]

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

💻 View my work

[codegen-sh]

✅ Fixed the failing checks in this commit. The issues were:

1. Formatting issues in the codebase_ai module:

   • Fixed markdown formatting in README_codebase_ai.md
   • Reorganized imports and fixed formatting in init.py
   • Updated type hints and formatting in codebase_ai.py to use modern Python syntax

2. Added python-dateutil as an explicit dependency in pyproject.toml to fix the deptry warning about transitive dependencies.

These changes should resolve the pre-commit check failures.

💻 View my work • React 👍 or 👎