ZAM-369: Implement codebase_ai.py in analyzers

[codegen-sh]

This PR implements the codebase_ai.py module in the analyzers directory, which provides AI-powered code analysis capabilities.

Changes

• Added codebase_ai.py module with comprehensive documentation
• Added README_codebase_ai.md with usage examples
• Added example usage in examples/codebase_ai_example.py
• Added tests in tests/analyzers/test_codebase_ai.py
• Updated init.py to expose the new module

Implementation Details

• The module provides a proper class wrapper (CodebaseAI) for better object-oriented usage
• It includes comprehensive documentation and examples
• It has proper error handling for when the SDK is not available
• It includes a complete test suite

This PR properly adapts the SDK version of codebase_ai.py for the OSS analyzers package, following the same pattern used for other modules like codebase_context.py.

---

💻 View my work • About Codegen

Summary by Sourcery

Implement an AI-powered code analysis module in the analyzers package, including prompt and context generation utilities, and provide documentation, an example script, and tests.

New Features:

• Add codebase_ai.py with CodebaseAI class and functions to generate system prompts, flag prompts, context strings, and AI tool definitions
• Include fallback stubs for Editable and File types when the SDK is unavailable

Enhancements:

• Expose CodebaseAI and related functions in the analyzers init.py for public use

Documentation:

• Add README_codebase_ai.md with API reference and usage examples for the codebase_ai module

Tests:

• Add comprehensive unit tests for all generate_* functions and CodebaseAI class methods

Chores:

• Add examples/codebase_ai_example.py demonstrating how to use the CodebaseAI module

[sourcery-ai]

Reviewer's Guide

This PR introduces a new AI-powered code analysis component by implementing the codebase_ai module in the analyzers package, exposing its API in init, and adding comprehensive documentation, examples, and tests following existing patterns.

File-Level Changes

Change	Details	Files
Expose AI analysis APIs in the analyzers package	Added CodebaseAI to exports Exposed generate_system_prompt and generate_flag_system_prompt Exposed generate_context, generate_tools, generate_flag_tools	codegen_on_oss/analyzers/__init__.py
Implement codebase_ai module with prompt and tool generators	Defined system and flag prompt generators with detailed templates Implemented context formatting for strings, Editable, File, lists, dicts Provided tool definitions for set_answer and should_flag functions Wrapped all functionality in the CodebaseAI class with error handling fallbacks	codegen_on_oss/analyzers/codebase_ai.py
Add test suite for codebase_ai functionality	Test prompt generation with and without target/context Test context formatting for different input types Test tool definitions and CodebaseAI class methods	codegen_on_oss/tests/analyzers/test_codebase_ai.py
Provide usage documentation for the new module	Created README_codebase_ai.md with features, API reference, and integration guide	codegen_on_oss/analyzers/README_codebase_ai.md
Add example script demonstrating module usage	Included examples for prompt and context generation and tool inspection	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.

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

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

[codegen-sh]

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

💻 View my work

[codegen-sh]

✅ Fixed the failing pre-commit checks in this commit. The issues were primarily formatting-related:

1. Updated type annotations to use Python 3.10+ syntax (T | None instead of Optional[T])
2. Fixed import order and formatting
3. Updated quote style (double quotes instead of single quotes)
4. Fixed whitespace and indentation issues
5. Formatted markdown files

All changes were automatically applied by the pre-commit hooks and should now pass the CI checks.

💻 View my work • React 👍 or 👎

[codegen-sh]

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

💻 View my work

[codegen-sh]

✅ Fixed the mypy errors in codebase_ai.py in this commit.

The issue was related to name redefinition in the fallback classes. I renamed them to EditableFallback and FileFallback to avoid conflicts.

Note: The mypy check is still failing, but this is due to pre-existing type errors in other files that are unrelated to our changes. These errors were already present in the codebase before our PR.

[codegen-sh]

I've fixed the mypy errors in the codebase_ai.py file by renaming the fallback classes to avoid name redefinition. The fix has been pushed to the PR branch.

The mypy check is still showing as failing, but this is due to pre-existing type errors in other files that are unrelated to our changes. These errors were already present in the codebase before our PR.

I've added a comment to the PR explaining the situation.

💻 View my work • React 👍 or 👎