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: migrate more deprecated pydantic calls #324

Merged
merged 1 commit into from
Dec 11, 2024
Merged

fix: migrate more deprecated pydantic calls #324

merged 1 commit into from
Dec 11, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Dec 11, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced object state management in the Bootstrap class.
    • Improved error handling for WebSocket packet processing.
  • Bug Fixes

    • Refined error handling for exceptions in WebSocket processing.
  • Documentation

    • Updated logging method for event data representation.

Copy link
Contributor

coderabbitai bot commented Dec 11, 2024

Walkthrough

The pull request implements significant changes to the ProtectBaseObject class and its subclasses in src/uiprotect/data/base.py, primarily renaming the construct method to model_construct. This renaming is applied across multiple classes and updates internal method calls accordingly. The from_unifi_dict method is also adjusted to reflect this change. Additionally, modifications in src/uiprotect/data/bootstrap.py enhance object state management by replacing object copying with model_copy(), and error handling in WebSocket processing is improved. The log_event function in src/uiprotect/utils.py is updated to use event.model_dump() for logging.

Changes

File Change Summary
src/uiprotect/data/base.py Renamed construct to model_construct in ProtectBaseObject and subclasses; updated internal calls.
Modified from_unifi_dict in ProtectBaseObject to call model_construct instead of construct.
src/uiprotect/data/bootstrap.py Updated _process_ws_keyring_or_ulp_user_message and _process_device_update to use model_copy() instead of copy(). Improved error handling in process_ws_packet.
src/uiprotect/utils.py Changed logging in log_event from event.dict() to event.model_dump().

Possibly related PRs

🐰 In the code, I hop and play,
With names that change, I find my way.
From construct to model_construct,
My methods now more clear and tucked.
With logs that sing and states that gleam,
In the world of code, I chase my dream! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8fc27a3 and ddfcbc7.

📒 Files selected for processing (3)
  • src/uiprotect/data/base.py (5 hunks)
  • src/uiprotect/data/bootstrap.py (3 hunks)
  • src/uiprotect/utils.py (1 hunks)
🔇 Additional comments (9)
src/uiprotect/utils.py (1)

575-575: LGTM: Correctly migrated from pydantic v1 to v2

The change from event.dict() to event.model_dump() aligns with pydantic v2's API changes, where model_dump() is the recommended replacement for the deprecated dict() method.

src/uiprotect/data/bootstrap.py (3)

429-429: LGTM: Correctly migrated to pydantic v2's model_copy()

The change from copy() to model_copy() correctly implements pydantic v2's recommended method for creating deep copies of model instances.


464-464: LGTM: Consistent use of pydantic v2's model_copy()

The change maintains consistency in using pydantic v2's model_copy() for creating deep copies of model instances.


520-520: LGTM: Consistent use of pydantic v2's model_copy()

The change maintains consistency in using pydantic v2's model_copy() for creating deep copies of model instances.

src/uiprotect/data/base.py (5)

140-140: LGTM: Correctly migrated to pydantic v2's model_construct()

The change from construct() to model_construct() correctly implements pydantic v2's recommended method for constructing model instances.


Line range hint 143-171: LGTM: Comprehensive migration to pydantic v2's model_construct

The changes correctly:

  1. Rename the method from construct to model_construct
  2. Update all internal calls to use model_construct for child objects
  3. Maintain the existing functionality while adopting pydantic v2's API

376-376: LGTM: Correctly migrated to pydantic v2's model_construct

The change correctly updates the construction of empty model instances to use pydantic v2's model_construct().


397-397: LGTM: Correctly migrated to pydantic v2's model_construct

The change correctly updates the construction of empty model instances in list processing to use pydantic v2's model_construct().


594-600: LGTM: Correctly migrated to pydantic v2's model_construct

The change correctly renames the method to model_construct while maintaining the existing functionality of initializing the update_sync attribute.


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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

Attention: Patch coverage is 81.81818% with 2 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/uiprotect/data/bootstrap.py 66.66% 1 Missing ⚠️
src/uiprotect/utils.py 0.00% 1 Missing ⚠️
Files with missing lines Coverage Δ
src/uiprotect/data/base.py 91.35% <100.00%> (ø)
src/uiprotect/data/bootstrap.py 68.75% <66.66%> (ø)
src/uiprotect/utils.py 62.62% <0.00%> (ø)

@bdraco bdraco merged commit 50ef161 into main Dec 11, 2024
9 of 10 checks passed
@bdraco bdraco deleted the pydantic_2 branch December 11, 2024 22:34
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.

1 participant