8000 Rename detect-blocking-io API value to match other APIs by agners · Pull Request #5964 · home-assistant/supervisor · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Rename detect-blocking-io API value to match other APIs #5964

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jun 20, 2025
Merged

Rename detect-blocking-io API value to match other APIs #5964

merged 2 commits into from
Jun 20, 2025

Conversation

agners
Copy link
Member
@agners agners commented Jun 20, 2025 •
edited by coderabbitai bot
Loading

Proposed change

For the new detect-blocking-io option, use dashes instead of underscores in on-at-startup for consistency with other API endpoints.

This is a breaking change, but since the API is really new and not really used yet, it is fairly safe to do so.

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:
  • Link to client library 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 or add-on configuration are added/changed:

Summary by CodeRabbit

  • Refactor
    • Updated the string representation of a configuration option to use hyphens instead of underscores.

@agners
Rename detect-blocking-io API value to match other APIs
f0fb556 
For the new detect-blocking-io option, use dashes instead of
underscores in `on-at-startup` for consistency with other API
endpoints.

This is a breaking change, but since the API is really new and not
really used yet, it is fairly safe to do so.
@agners agners mentioned this pull request Jun 20, 2025
Merged
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Jun 20, 2025 •
edited
Loading
📝 Walkthrough

Walkthrough

The string value for the ON_AT_STARTUP member of the DetectBlockingIO enumeration was changed from "on_at_startup" to "on-at-startup" in the constants module. Correspondingly, the test parameterization in the supervisor API tests was updated to use the new string value. No other code structure or logic was altered.

Changes

File(s) Change Summary
supervisor/api/const.py Updated DetectBlockingIO.ON_AT_STARTUP value to "on-at-startup"
tests/api/test_supervisor.py Modified test parameter from "on_at_startup" to "on-at-startup" in test_api_supervisor_options_blocking_io

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Pylint (3.3.7)
tests/api/test_supervisor.py
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between f0fb556 and 004bcfb.

📒 Files selected for processing (1)
  • tests/api/test_supervisor.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build aarch64 supervisor
  • GitHub Check: Build armv7 supervisor
  • GitHub Check: Build armhf supervisor
  • GitHub Check: Run tests Python 3.13.5
🔇 Additional comments (1)
tests/api/test_supervisor.py (1)

274-274: LGTM! Test parameter correctly updated to match the new enum value.

The change from "on_at_startup" to "on-at-startup" properly aligns the test parameter with the updated DetectBlockingIO.ON_AT_STARTUP enum value, maintaining consistency with the dash-based naming convention used in other API endpoints.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.

sairon
sairon requested changes Jun 20, 2025
View reviewed changes
Copy link
Member
@sairon sairon left a comment

Choose a reason for hiding this comment

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

The parameter passed to the test needs to be updated too.

@home-assistant home-assistant bot marked this pull request as draft June 20, 2025 07:56
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@agners agners marked this pull request as ready for review June 20, 2025 08:19
@home-assistant home-assistant bot requested a review from sairon June 20, 2025 08:19
sairon
sairon approved these changes Jun 20, 2025
View reviewed changes
Copy link
Member
@sairon sairon left a comment

Choose a reason for hiding this comment

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

Looks good, I prefer the consistency too.

@agners agners merged commit b030879 into main Jun 20, 2025
22 checks passed
@agners agners deleted the rename-detect-blocking-io-api-value branch June 20, 2025 10:52
@github-actions github-actions bot locked and limited conversation to collaborators Jun 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@sairon sairon sairon approved these changes

Assignees
No one assigned
Labels
breaking-change cla-signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@agners @sairon
0