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

refactor: use "left_to_right" in place of smart union for pydantic 2 compatibility #1132

Merged
merged 4 commits into from
Jul 8, 2024

Conversation

Czaki
Copy link
Collaborator

@Czaki Czaki commented Jul 8, 2024

Summary by CodeRabbit

  • New Features

    • Added default values and adjusted type hints in the AlgorithmSelection class for improved configuration.
    • Included pydantic key in the matrix configuration for enhanced test coverage.
  • Chores

    • Updated import statements to align with new dependencies.
    • Enhanced naming in the test job to reflect additional configuration parameters.

@Czaki Czaki added this to the 0.15.3 milestone Jul 8, 2024
Copy link
Contributor

sourcery-ai bot commented Jul 8, 2024

🧙 Sourcery has finished reviewing your pull request!


Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

coderabbitai bot commented Jul 8, 2024

Walkthrough

This update introduces refinements to PartSegCore by adjusting import statements and refining the AlgorithmSelection class with new default values and type hints. Additionally, updates to GitHub workflows incorporate a pydantic key for enhanced testing configurations.

Changes

Files Change Summary
package/PartSegCore/algorithm_describe_base.py Updated imports related to pydantic.fields and enhanced the values attribute in AlgorithmSelection with default values and adjusted type hints.
.github/workflows/base_test_workflow.yml Enhanced the job name in the test job by adding $inputs.pydantic for better identification.
.github/workflows/tests.yml Added the pydantic key to the matrix configuration in the jobs section to expand test coverage.

Poem

In the code, where algorithms play,
Fields now dance in a refined way.
Pydantic whispers in each test,
Ensuring our logic is at its best.
With workflows fine-tuned like a breeze,
PartSegCore thrives with newfound ease.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

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 2aeb2ec and 3270633.

Files selected for processing (1)
  • package/PartSegCore/algorithm_describe_base.py (2 hunks)
Additional comments not posted (2)
package/PartSegCore/algorithm_describe_base.py (2)

13-13: Import statement update approved.

The import statement now includes both Field and FieldInfo from pydantic.fields, which is necessary for the changes in the values attribute.


403-403: Attribute update approved.

The values attribute in the AlgorithmSelection class now uses the Field function with union_mode="left_to_right", ensuring compatibility with Pydantic 2.

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 3270633 and d6e8ec9.

Files selected for processing (2)
  • .github/workflows/base_test_workflow.yml (1 hunks)
  • .github/workflows/tests.yml (1 hunks)
Files skipped from review due to trivial changes (2)
  • .github/workflows/base_test_workflow.yml
  • .github/workflows/tests.yml

@Czaki Czaki changed the title refactor: use "left_to_right" in palce of smart union for pydantic 2 compatybility refactor use "left_to_right" in palce of smart union for pydantic 2 compatybility Jul 8, 2024
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 d6e8ec9 and b599ec0.

Files selected for processing (1)
  • package/PartSegCore/algorithm_describe_base.py (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • package/PartSegCore/algorithm_describe_base.py

Copy link

codecov bot commented Jul 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.93%. Comparing base (2aeb2ec) to head (c43acac).
Report is 71 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1132   +/-   ##
========================================
  Coverage    92.93%   92.93%           
========================================
  Files          205      205           
  Lines        32519    32516    -3     
========================================
- Hits         30220    30218    -2     
+ Misses        2299     2298    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Czaki Czaki changed the title refactor use "left_to_right" in palce of smart union for pydantic 2 compatybility refactor: use "left_to_right" in place of smart union for pydantic 2 compatibility Jul 8, 2024
Copy link

sonarqubecloud bot commented Jul 8, 2024

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 b599ec0 and c43acac.

Files selected for processing (1)
  • .github/workflows/tests.yml (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/tests.yml

@Czaki Czaki merged commit c2587a1 into develop Jul 8, 2024
53 of 55 checks passed
@Czaki Czaki deleted the pydantic2_warning branch July 8, 2024 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant