Skip to content

Remove f-strings with .strip(), not working #709

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

Merged
merged 5 commits into from
Feb 18, 2025
Merged

Remove f-strings with .strip(), not working #709

merged 5 commits into from
Feb 18, 2025

Conversation

bouwew
Copy link
Contributor

@bouwew bouwew commented Feb 17, 2025

Summary by CodeRabbit

  • Refactor
    • Streamlined the formatting of XML data strings for various methods, enhancing readability and consistency without affecting functionality.

@bouwew bouwew requested a review from a team as a code owner February 17, 2025 19:23
Copy link
Contributor

coderabbitai bot commented Feb 17, 2025

Walkthrough

The pull request updates XML data construction in the SmileLegacyAPI and SmileAPI classes by replacing multi-line string literals with single-line concatenations. Methods such as set_preset, set_schedule_state, and set_switch_state have been revised, with additional modifications to set_temperature in the legacy module and several others in the main module. The changes also remove the use of .strip() since the new format naturally omits extra whitespace, while leaving the overall functionality intact.

Changes

File Changes
plugwise/legacy/smile.py Updated XML string formatting in set_preset, set_schedule_state, set_switch_state, and set_temperature to single-line concatenation.
plugwise/smile.py Modified XML formatting in methods (set_number, set_offset, set_preset, set_dhw_mode, set_gateway_mode, set_regulation_mode, set_schedule_state, set_switch_state) by replacing multi-line strings with single-line concatenations and removing .strip() calls.

Possibly related PRs

  • More improvements #687: The changes in the main PR and the retrieved PR are related as both involve modifications to the same methods (set_preset, set_schedule_state, set_switch_state, and set_temperature) in the SmileLegacyAPI and SmileAPI classes, specifically focusing on the formatting of XML data strings.
  • Improve xml readability #707: The changes in the main PR and the retrieved PR are related as both modify the same methods (set_preset, set_schedule_state, set_switch_state, and set_temperature) in the SmileLegacyAPI class, but they implement opposite formatting styles for XML data strings.

Suggested reviewers

  • CoMPaTech

Poem

I'm the coded rabbit, hopping along each byte,
Revising XML strings to keep our data tight.
Multi-line woes replaced by a single, neat beat,
Each method now dances in a streamlined feat.
With whiskers twitching in joyful code delight,
I nibble on changes—hop, skip, and write! 🥕


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6c1fc6a and 90ed590.

📒 Files selected for processing (2)
  • plugwise/legacy/smile.py (5 hunks)
  • plugwise/smile.py (11 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • plugwise/legacy/smile.py
  • plugwise/smile.py

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. (Beta)
  • @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 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 Feb 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (70c72a4) to head (90ed590).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #709   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           21        21           
  Lines         3418      3418           
=========================================
  Hits          3418      3418           

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

Copy link

@bouwew bouwew merged commit 1a6d924 into main Feb 18, 2025
19 checks passed
@bouwew bouwew deleted the redo-xml branch February 18, 2025 08:53
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.

2 participants