Implementation of Inheritance Hierarchy Visualization

[codegen-sh]

Overview

This PR implements enhanced inheritance hierarchy visualization features for the Codegen repository as part of issue ZAM-423.

Features Implemented

1. Enhanced Inheritance Hierarchy Visualization

   • Added detailed relationship information to inheritance graphs
   • Implemented color coding for different types of classes (abstract, interface, concrete)
   • Added visual indicators for multiple inheritance

2. Interactive Features

   • Added support for filtering inheritance hierarchies by depth, package, and relationship type
   • Implemented collapsible/expandable nodes for large hierarchies
   • Added tooltips with detailed class information

3. Filtering Options

   • Added parameters to filter by depth, package/namespace, or relationship type
   • Implemented utility functions to apply filters to graphs

4. Improved Visual Representation

   • Added color coding for different types of classes
   • Implemented different node shapes based on class type
   • Added visual indicators for important class properties

5. Multiple Inheritance Handling

   • Added special handling for multiple inheritance in Python
   • Implemented visual indicators for multiple inheritance relationships
   • Added detection of potential diamond inheritance problems

Implementation Details

• Created a new module inheritance_viz.py with utilities for inheritance visualization
• Enhanced visualization_manager.py with methods for inheritance visualization
• Added new enums for inheritance relationship types
• Extended the Class class with methods for inheritance analysis
• Updated documentation with examples of the new features
• Added tests for the new functionality

Testing

Added comprehensive tests in tests/test_inheritance_visualization.py to verify the functionality of the new features.

Documentation

Updated the documentation in docs/building-with-codegen/codebase-visualization.mdx with examples of how to use the new inheritance visualization features.

---

💻 View my work • About Codegen

Summary by Sourcery

Implement enhanced inheritance hierarchy visualization with detailed relationships, interactive filtering, and highlighting features.

New Features:

• Create detailed inheritance graphs including superclasses, subclasses, interfaces, methods, and external modules.
• Enable interactive filtering by depth, package/namespace, and relationship type with collapsible/expandable nodes.
• Apply color coding and node shapes to distinguish class types, highlight multiple inheritance, and annotate method overrides.
• Expose a high-level visualize_inheritance_hierarchy API in the visualization manager for easy use.

Enhancements:

• Add graph utilities for depth-based filtering, layout application, depth and cluster annotations.
• Extend Class API with get_inheritance_hierarchy, get_common_superclasses, get_overridden_methods, and has_multiple_inheritance methods.

Documentation:

• Update documentation with advanced inheritance visualization examples and usage instructions.

Tests:

• Add comprehensive unit tests covering inheritance graph creation, multiple inheritance detection, common ancestor finding, and override annotation.

Chores:

• Add new enums for inheritance relation and node types.
• Update package.json metadata.

[sourcery-ai]

Reviewer's Guide

This PR delivers a full-featured inheritance hierarchy visualizer by introducing a new visualization module, extending existing utilities and APIs, integrating it into the visualization manager, updating documentation, and covering everything with tests.

File-Level Changes

Change	Details	Files
Add dedicated inheritance visualization module	Built graph creation with class, interface and external nodes Styled nodes by type, color and shape based on class metadata Traversed superclasses and subclasses with filtering by depth and package Detected and highlighted multiple inheritance and method overrides Exposed utility functions for common ancestors and layout filtering	src/codegen/visualizations/inheritance_viz.py
Integrate inheritance visualization into manager	Imported new viz utilities into visualization_manager Added visualize_inheritance_hierarchy method with filtering and flags Applied highlight and override enhancements before writing graph JSON	src/codegen/visualizations/visualization_manager.py
Extend graph utilities for filtering and layout	Implemented filter_graph_by_depth to limit nodes by depth Added apply_layout_to_graph with multiple layout options Added functions to tag nodes with depth and cluster metadata	src/codegen/visualizations/viz_utils.py
Enrich Class API with inheritance analysis	Added get_inheritance_hierarchy combining superclasses and subclasses Implemented get_common_superclasses and has_multiple_inheritance readers Added get_overridden_methods to detect method overrides	src/codegen/sdk/core/class_definition.py
Update visualization enums	Introduced InheritanceRelationType for extends/implements/uses Added InheritanceNodeType to classify node kinds	src/codegen/visualizations/enums.py
Revise documentation for enhanced inheritance graphs	Rewrote examples in codebase-visualization.mdx to showcase new API Added usage for filtering, highlighting and programmatic analysis	docs/building-with-codegen/codebase-visualization.mdx
Add comprehensive tests for inheritance features	Cover graph building, subclass and superclass addition Verify multiple inheritance detection and highlighting Test method override annotation and common ancestors logic	tests/test_inheritance_visualization.py
Minor package configuration update	Formatted release branches list Pinned yarn packageManager setting	package.json

---

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.
  • 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]

I see a check failed - I'm on it! 🫡

💻 View my work

[codegen-sh]

✅ Fixed the failing mypy check in PR #132 with this commit.

The issue was related to type errors in the inheritance_viz.py file:

1. Fixed type errors by converting node_id to string when adding to the visited set
2. Used _get_superclasses and _get_subclasses internal methods instead of the proxy properties
3. Added proper type checking for subclasses to ensure only Class instances are processed

The PR should now pass the mypy checks.

💻 View my work • React 👍 or 👎