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

Update ReadOnlyEntityOptions typing #103813

Merged
merged 1 commit into from Nov 11, 2023
Merged

Conversation

cdce8p
Copy link
Member

@cdce8p cdce8p commented Nov 11, 2023

Proposed change

The Mapping class does not provide a __(r)or__ operator for assistant_options | {key: value}, this should be a dict typing. Additionally, even with ReadOnlyDict this will return a dict. This isn't an issue as it's passed through a converter with

options: ReadOnlyEntityOptionsType = attr.ib(
default=None, converter=_protect_entity_options
)

def _protect_entity_options(
data: EntityOptionsType | None,
) -> ReadOnlyEntityOptionsType:
"""Protect entity options from being modified."""
if data is None:
return ReadOnlyDict({})
return ReadOnlyDict({key: ReadOnlyDict(val) for key, val in data.items()})

Required for:

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • 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:

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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (homeassistant) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of homeassistant can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign homeassistant Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@cdce8p cdce8p added the smash Indicator this PR is close to finish for merging or closing label Nov 11, 2023
@cdce8p cdce8p requested a review from bdraco November 11, 2023 21:28
@cdce8p cdce8p merged commit 66d1a7f into home-assistant:dev Nov 11, 2023
53 checks passed
@cdce8p cdce8p deleted the type-readOnly branch November 11, 2023 21:30
@github-actions github-actions bot locked and limited conversation to collaborators Nov 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed code-quality core integration: homeassistant Quality Scale: internal small-pr PRs with less than 30 lines. smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants