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

Use single quotes in f-strings #5267

Merged
merged 1 commit into from
Aug 23, 2024
Merged

Use single quotes in f-strings #5267

merged 1 commit into from
Aug 23, 2024

Conversation

agners
Copy link
Member

@agners agners commented Aug 22, 2024

Proposed change

Instead of using double quotes in f-strings use single quotes. This works with Python 3.11 too. We don't use Python 3.11 anymore, but is useful when running pytest on Debian bookworm natively, which comes with Python 3.11.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to cli pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints of add-on configuration are added/changed:

Summary by CodeRabbit

  • Bug Fixes

    • Improved error message formatting in the backup process for enhanced clarity.
  • Style

    • Standardized string formatting by replacing double quotes with single quotes in log entries, promoting consistency.

@agners agners added the chore label Aug 22, 2024
@agners agners requested a review from sairon August 22, 2024 20:27
Copy link

coderabbitai bot commented Aug 22, 2024

Walkthrough

Walkthrough

The changes involve minor modifications to string formatting in the begin_backup method of supervisor/homeassistant/module.py and the journal_verbose_formatter function in supervisor/utils/systemd_journal.py. The adjustments include cosmetic changes to error message strings and the use of single quotes instead of double quotes for string literals. The core logic and functionality of both methods remain unchanged, with no alterations to exported or public entity declarations.

Changes

Files Change Summary
supervisor/homeassistant/module.py Minor modification to error message formatting in begin_backup method for improved readability.
supervisor/utils/systemd_journal.py Changed string literals from double quotes to single quotes in journal_verbose_formatter.

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

Instead of using double quotes in f-strings use single quotes. This
works with Python 3.11 too. We don't use Python 3.11 anymore, but is
useful when running pytest on Debian bookworm natively, which comes
with Python 3.11.
@agners agners force-pushed the fix-tests-on-python3.11 branch from 1ea9755 to 88b9536 Compare August 22, 2024 20:30
Copy link
Contributor

@mdegat01 mdegat01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean I guess its fine. But running the tests on an unsupported version of python seems problematic for other reasons. A failure or a pass may not be meaningful as it would have to be reproduced on a supported version of python.

@agners
Copy link
Member Author

agners commented Aug 23, 2024

I mean I guess its fine. But running the tests on an unsupported version of python seems problematic for other reasons. A failure or a pass may not be meaningful as it would have to be reproduced on a supported version of python.

Any local test only says that much, the devcontainer could be outdated too 😅 In the end we have CI for that.

It mainly allows quick checks of a particular test. Before parsing of the Python files even failed.

@agners agners merged commit 2a03123 into main Aug 23, 2024
19 checks passed
@agners agners deleted the fix-tests-on-python3.11 branch August 23, 2024 14:16
@github-actions github-actions bot locked and limited conversation to collaborators Aug 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants