Change the output of the connect() function

bouwew commented 1 month ago

Let it output the gateway firmware-version so it can be used for config_entry migration in HA.

Summary by CodeRabbit

Release Notes for Version 1.4.4

New Features
- The connect() function now outputs the gateway firmware version, providing enhanced information during the connection process.
Improvements
- Enhanced type handling for firmware version attributes across various classes, ensuring consistency and clarity in version representation.
- Updated tests to improve error handling and version validation, contributing to better reliability.
Chores
- Changelog updated to reflect the new version and summarize changes.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request primarily involve updates to the handling of firmware versioning within the Plugwise codebase. The connect() function now outputs the gateway firmware version, and several classes have modified their attributes and method signatures to utilize the Version type from the packaging.version module. Additionally, the project version has been incremented from 1.4.3 to 1.4.4, reflecting these updates.

Changes

File	Change Summary
CHANGELOG.md	Added new version entry v1.4.4; documented changes to `connect()` function.
plugwise/init.py	Updated `Smile` class: changed `smile_fw_version` and `smile_version` to `Version \| None`; modified `connect()` return type to `Version \| None`.
plugwise/helper.py	Updated `smile_fw_version` in `SmileHelper` to `Version \| None`; added conversion to string in `_appl_gateway_info`.
plugwise/legacy/helper.py	Updated `smile_fw_version` in `SmileLegacyHelper` to `Version \| None`; added import for `Version`.
plugwise/legacy/smile.py	Changed `smile_fw_version` parameter type in `SmileLegacyAPI` constructor to `Version \| None`.
plugwise/smile.py	Changed `smile_fw_version` parameter type in `SmileAPI` constructor to `Version \| None`.
pyproject.toml	Updated project version from "1.4.3" to "1.4.4".
tests/test_init.py	Enhanced tests: updated connection handling and assertions to use version objects.

Possibly related PRs

#619: The changes in this PR involve modifications to the connect() method in plugwise/__init__.py, which is relevant as the main PR also updates the connect() function to output the gateway firmware version.
#637: This PR includes changes to the connect() method in plugwise/__init__.py, which aligns with the main PR's focus on modifications to the connect() function, although the specific changes differ.

Suggested labels

quality

Suggested reviewers

CoMPaTech

🐰 In the code where we connect,
A version now shines, what a trek!
From strings to types, we leap and bound,
With Version in hand, clarity found.
In tests we trust, with checks so bright,
Plugwise is ready, 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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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` or `@coderabbitai title` 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (bebf8e2) to head (bd82299). Report is 14 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #639 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 20 20 Lines 3360 3370 +10 ========================================= + Hits 3360 3370 +10 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.