Skip to content
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.

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

fix: make class recognize parent when parent uses "capability" decorator #11078

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

MayasMess
Copy link

@MayasMess MayasMess commented Aug 2, 2024

Checklist

Summary by CodeRabbit

  • New Features

    • Enhanced type annotations for improved type safety and clarity in function signatures.
  • Bug Fixes

    • Increased robustness of the capability decorator, ensuring consistent type handling across decorated classes.

Copy link
Contributor

coderabbitai bot commented Aug 2, 2024

Walkthrough

The recent changes enhance type safety in the capability decorator within the decorators.py file. By introducing a generic type variable T, function signatures are now more precise, ensuring that decorated classes maintain consistent types. This improves clarity and robustness in type handling while preserving existing functionality.

Changes

Files Change Summary
.../api/decorators.py Enhanced type annotations by adding a generic type variable T to the capability decorator. Modified signatures for capability and wrapper functions to ensure type consistency.

Poem

In the land of code where rabbits play,
Type safety blooms in a bright new way.
With T hopping in, the types all align,
Decorators now dance, oh how they shine!
A sprinkle of clarity, a dash of delight,
Code's now more trusty, all feels just right! 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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.

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

@github-actions github-actions bot added ingestion PR or Issue related to the ingestion of metadata community-contribution PR or Issue raised by member(s) of DataHub Community labels Aug 2, 2024
@MayasMess
Copy link
Author

Issue created => #11077

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d5eda0d and 1ad4de5.

Files selected for processing (1)
  • metadata-ingestion/src/datahub/ingestion/api/decorators.py (2 hunks)
Additional comments not posted (3)
metadata-ingestion/src/datahub/ingestion/api/decorators.py (3)

8-8: Addition of the type variable T is appropriate.

This enhances the decorator's flexibility by allowing it to work with any type.


92-92: Type annotation change in capability function signature enhances type safety.

Changing the type annotation to Callable[[Type[T]], Type[T]] ensures that the decorator maintains consistent types.


97-97: Type annotation change in wrapper function enhances type safety.

Changing the type annotation to Type[T] ensures that the wrapper function operates on the same generic type, maintaining type consistency.

@MayasMess MayasMess changed the title fix: make class recognize parent when parent uses "capability" decorator fix: make class recognize parent when parent uses "capability" decorator #11077 Aug 2, 2024
@MayasMess MayasMess changed the title fix: make class recognize parent when parent uses "capability" decorator #11077 fix: make class recognize parent when parent uses "capability" decorator Aug 2, 2024
Copy link
Collaborator

@hsheth2 hsheth2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hsheth2
Copy link
Collaborator

hsheth2 commented Aug 6, 2024

@MayasMess looks like the linter isn't happy with these changes

@MayasMess
Copy link
Author

MayasMess commented Aug 14, 2024

I added a bound class to get around the linter but I'll let you see if the name fits. I think it's not very explicit...
Edit: It's still failing. I'll check that this weekend

@hsheth2 hsheth2 added the pending-submitter-response Issue/request has been reviewed but requires a response from the submitter label Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution PR or Issue raised by member(s) of DataHub Community ingestion PR or Issue related to the ingestion of metadata pending-submitter-response Issue/request has been reviewed but requires a response from the submitter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrong type hint for "capability" decorator
2 participants