Skip to content

Implement visualizations and fix mypy errors #112

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.

Sign up for GitHub

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

Jump to bottom
Closed
codegen-sh wants to merge 1 commit into from
Closed

Implement visualizations and fix mypy errors #112

codegen-sh wants to merge 1 commit into from
+739 −315

Conversation

@codegen-sh
Copy link

@codegen-sh codegen-sh bot commented May 13, 2025 •
edited by sourcery-ai bot
Loading

This PR implements visualization capabilities for call graphs and dead code analysis, and fixes mypy errors in the codebase.

Features Added

  • Call graph visualization with three visualizers:
    • CallGraphFromNode: Creates a directed call graph from a specified function
    • CallGraphFilter: Filters call graphs to show only specific methods (e.g., HTTP methods)
    • CallPathsBetweenNodes: Visualizes all paths between two specified functions
  • Dead code visualization with DeadCodeVisualizer
  • Example script showing how to use the visualizers
  • Updated README with documentation for the visualization features

Fixes

  • Added type annotation for graph in __init__.py
  • Fixed the path parameter in DiffLite.from_git_diff() to ensure it's never None
  • Added proper type annotations in issues.py for all variables flagged by mypy
  • Fixed category parameter handling in create_issue()

This PR replaces PR #111 with all the fixes for the mypy errors.

💻 View my work • About Codegen

Summary by Sourcery

Implement visualization capabilities for codebases and resolve mypy errors

New Features:

  • Add call graph visualizers (CallGraphFromNode, CallGraphFilter, CallPathsBetweenNodes)
  • Introduce DeadCodeVisualizer for dead code analysis
  • Provide an examples script showcasing visualization usage

Bug Fixes:

  • Resolve mypy errors by adding explicit type annotations and ignores in issues.py
  • Ensure non-null paths and add type annotations in diff_lite.py and graph initializer

Enhancements:

  • Introduce CodebaseVisualizer abstract base class to unify visualization interface

Documentation:

  • Revise README with installation instructions, usage examples for new visualizers, and licensing details

@sourcery-ai
Copy link

sourcery-ai bot commented May 13, 2025 •
edited
Loading

Reviewer's Guide

This PR adds complete visualization support for call graphs and dead code analysis, updates documentation with examples, and fixes various mypy errors by adding type annotations and tightening parameter handling.

File-Level Changes

Change Details Files
Introduce call graph visualizers
  • Add base CodebaseVisualizer abstract class
  • Implement CallGraphFromNode with recursive downstream call tracing
  • Implement CallGraphFilter to filter by class, methods, and skip tests
  • Implement CallPathsBetweenNodes to compute and subgraph all simple paths
 codegen_on_oss/visualizers/call_graph_from_node.py
codegen_on_oss/visualizers/codebase_visualizer.py
codegen_on_oss/visualizers/__init__.py
Implement dead code visualization
  • Add DeadCodeVisualizer to identify and graph first- and second-order dead functions
  • Exclude test files and decorated functions based on flags
 codegen_on_oss/visualizers/dead_code.py
Provide examples and update documentation
  • Revise README with new visualization feature descriptions and usage snippets
  • Add examples/visualization_examples.py demonstrating all visualizers
 README.md
examples/visualization_examples.py
Fix mypy errors via type annotations
  • Annotate graph as nx.DiGraph in context graph init
  • Ensure path is never None in DiffLite.from_git_diff
  • Add explicit type annotations and # type: ignore in issues.py
  • Tighten dictionary initializations with typed generics and handle empty category
 codegen_on_oss/analyzers/context/graph/__init__.py
codegen_on_oss/analyzers/diff_lite.py
codegen_on_oss/analyzers/issues.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

@korbit-ai
Copy link

korbit-ai bot commented May 13, 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.

@coderabbitai
Copy link

coderabbitai bot commented May 13, 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 13, 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 13, 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!

@codegen-sh codegen-sh bot mentioned this pull request May 13, 2025
Draft
@codegen-sh codegen-sh bot closed this May 13, 2025
@Zeeeepa Zeeeepa deleted the codegen-bot/fix-visualizations-mypy-errors branch May 13, 2025 23:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant