Suppress SyntaxWarning from CPE until fixed

[mdegat01]

Proposed change

Not a real fix unfortunately. But until there is a new release of CPE that includes nilp0inter/cpe#57 this is the best we can do. Continue logging the warning on dev systems though.

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 Warning in Supervisor logs after upgrade to 2024.08.0 #5226
• 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:

• Documentation added/updated for developers.home-assistant.io

Summary by CodeRabbit

• New Features

  • Enhanced logging behavior for SyntaxWarning to improve developer awareness in development environments while suppressing unnecessary warnings in production.
  • Introduced conditional logic for warning filtering based on environment settings.

• Improvements

  • Moved the import statement for CPE to optimize performance by delaying the import until necessary.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the logging behavior for SyntaxWarning in the supervisor/os/manager.py file. A context manager has been introduced to control warning visibility based on the SUPERVISOR_DEV environment variable and logging levels. This ensures that warnings are logged during development while being suppressed in production. Additionally, the import of CPE has been optimized by moving it inside the warning context. This overall adjustment improves performance and maintains crucial information flow.

Changes

Files	Change Summary
supervisor/os/manager.py	Introduced a context manager to control SyntaxWarning logging based on the SUPERVISOR_DEV variable and logging level. Moved CPE import inside the context to enhance performance. No changes to public entity declarations.

---

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
• Mastodon
• Reddit
• LinkedIn

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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)

supervisor/os/manager.py (1)

18-24: LGTM! Consider adding a comment to explain the context manager usage.

The context manager effectively suppresses SyntaxWarning in production while allowing it in development. The import of CPE inside the context is a good practice to delay the import until necessary.

Consider adding a comment to explain the purpose of the context manager for future maintainability.

+ # Suppress SyntaxWarning in production, allow in development
with catch_warnings():
    if not os.environ.get("SUPERVISOR_DEV") and not logging.getLogger(
        __name__
    ).isEnabledFor(logging.DEBUG):
        simplefilter("ignore", SyntaxWarning)

    from cpe import CPE