feat: add support for propcache v1.0.0+

[bdraco]

v1.0.0 moved the public api to propcache.api

see aio-libs/propcache#21
see aio-libs/propcache#18
see aio-libs/propcache#19

Summary by CodeRabbit

• New Features

  • Introduced a compatibility layer for cached_property to enhance flexibility with the propcache library.
  • Enhanced ProtectApiClient with additional configuration parameters for improved interaction with the UniFi Protect API.
  • Added new methods for device management, including rebooting, adopting devices, and handling PTZ camera controls.

• Bug Fixes

  • Improved error handling in API requests for clearer exception messages.

• Documentation

  • Updated documentation to reflect changes in method signatures and new functionalities.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a compatibility layer for the cached_property from the propcache library, allowing for flexible imports based on availability. It modifies several files, particularly src/uiprotect/api.py, which sees significant updates to the ProtectApiClient class, including new methods and enhanced error handling. The src/uiprotect/data/base.py and src/uiprotect/data/types.py files also receive updates to improve handling of UFP JSON data and introduce new utility classes. Import statements across these files are adjusted to utilize the new compatibility layer.

Changes

File Path	Change Summary
src/uiprotect/_compat.py	Introduced a compatibility layer for cached_property, with fallback imports and defined __all__ variable.
src/uiprotect/api.py	Updated cached_property import to use the compatibility module. Enhanced ProtectApiClient with new constructor parameters and numerous new async methods for device management, error handling improvements, and streamlined device retrieval methods.
src/uiprotect/data/base.py	Changed cached_property import to the compatibility module. Enhanced ProtectBaseObject and subclasses with new methods for handling UFP JSON data, including unifi_dict_to_dict, and improved initialization methods. Added new properties and methods in ProtectModel and ProtectModelWithId for better device management.
src/uiprotect/data/types.py	Updated cached_property import to the compatibility module. Introduced new classes like Color and Version, and refined existing classes for better functionality.
src/uiprotect/data/websocket.py	Changed cached_property import to the compatibility module. Minor adjustments in WSJSONPacketFrame for JSON data handling, while retaining overall structure and functionality of WebSocket packet processing.

Possibly related PRs

• feat: cleanup processing of websocket packets #24: The changes in src/uiprotect/data/websocket.py involve the use of cached_property, which is directly related to the compatibility layer introduced in the main PR for cached_property in src/uiprotect/_compat.py.

Poem

🐰 In the garden of code, we hop and play,
With cached_property, we find our way.
New methods sprout, like flowers in bloom,
Enhancing our API, dispelling the gloom.
With each little change, our toolkit grows wide,
Together we flourish, with joy as our guide! 🌼

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines	Coverage Δ
src/uiprotect/_compat.py	100.00% <100.00%> (ø)
src/uiprotect/api.py	55.34% <100.00%> (ø)
src/uiprotect/data/base.py	91.38% <100.00%> (ø)
src/uiprotect/data/types.py	99.60% <100.00%> (ø)
src/uiprotect/data/websocket.py	90.97% <100.00%> (ø)