search

DeebotUniverse / client.py

Deebot client library in python
https://deebot.readthedocs.io
GNU General Public License v3.0
27 stars 41 forks source link

Add command response #513

Closed lnx85 closed 3 months ago

lnx85 commented 3 months ago

As discussed here, this PR implements Command response.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes introduce a DeviceCommandResult dataclass for handling command responses, update command execution methods to return this new result type, and modify various command classes to better process and handle responses. Adjustments to test files ensure proper validation of the new response types. Additionally, the EventBus and device command execution processes have been updated to support these changes.

Changes

Files/Paths Change Summary
deebot_client/command.py Added DeviceCommandResult dataclass, updated Command class methods to return this new result type.
deebot_client/commands/json/life_span.py Modified GetLifeSpan class to handle response data differently and return LifeSpanEvent objects.
deebot_client/commands/json/pos.py Updated GetPos class to process response data and improve handling of positions and notifications.
deebot_client/device.py Updated execute_command and _execute_command methods to use DeviceCommandResult.
deebot_client/event_bus.py Added DeviceCommandExecute parameter to EventBus methods.
deebot_client/map.py Updated imports and method signatures to use DeviceCommandExecute.
tests/commands/__init__.py Modified function signatures, added VerifyResultCallback class, and new assert_command_response.
tests/commands/json/test_common.py Updated assertion to check device_reached attribute.
tests/commands/json/test_life_span.py Added new test function test_GetLifeSpan_response and updated imports.
tests/commands/json/test_pos.py Added new test function test_GetPos_response and updated imports.
tests/test_command.py Modified assertion in test_execute_api_timeout_error to check device_reached attribute.
tests/test_device.py Updated return value assignment to DeviceCommandResult in tests.
tests/test_event_bus.py Modified assertion to include request_response=False parameter.
README.md Removed import of CleanAction from deebot_client.commands.json.clean.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Device
    participant Command
    participant ResponseHandler

    User->>Device: execute_command(command, request_response=True)
    Device->>Command: execute()
    Command->>ResponseHandler: handle_response()
    ResponseHandler-->>Command: DeviceCommandResult
    Command-->>Device: DeviceCommandResult
    Device-->>User: DeviceCommandResult

Poem

In code we weave a brand-new tale, Commands now with results to hail, Devices speak, responses clear, Testing flows with no more fear. A rabbit's joy in bytes and bits, Our code now shines, no more fits! 🐇✨

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 .` - `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](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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
lnx85 commented 3 months ago

@coderabbitai review

coderabbitai[bot] commented 3 months ago
Actions Performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 95.23810% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 85.74%. Comparing base (d12ef19) to head (5ac27f5).

Files Patch % Lines
deebot_client/command.py 90.90% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## dev #513 +/- ## ========================================== + Coverage 85.71% 85.74% +0.03% ========================================== Files 87 87 Lines 3262 3269 +7 Branches 530 532 +2 ========================================== + Hits 2796 2803 +7 Misses 414 414 Partials 52 52 ```

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