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

Tweak typing of Entity.platform #88321

Merged
merged 4 commits into from Jun 9, 2023
Merged

Tweak typing of Entity.platform #88321

merged 4 commits into from Jun 9, 2023

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Feb 17, 2023

Proposed change

Tweak typing of Entity.platform in a similar manner as we type Entity.hass to avoid unnecessary None-checks or asserts

Background:
Both Entity.hass and Entity.platform are assigned in Entity.add_to_platform_start and unassigned in Entity.add_to_platform_abort. This means that for basically the entire life cycle of an Entity object, both its hass and platform members have a valid value.

Needs #90585

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

@emontnemery emontnemery requested a review from a team as a code owner February 17, 2023 10:56
@emontnemery emontnemery marked this pull request as draft February 17, 2023 14:56
@MartinHjelmare
Copy link
Member

I'm missing the motivation for this PR in the PR description.

@emontnemery emontnemery mentioned this pull request Mar 8, 2023
19 tasks
@emontnemery emontnemery changed the title Tweak typing of Entity.hass and Entity.platform Tweak typing of Entity.platform Mar 31, 2023
@MartinHjelmare
Copy link
Member

Can you give an example where there was needed checks or asserts? What are you working on? It's nice to have some more context.

@emontnemery emontnemery mentioned this pull request Apr 11, 2023
20 tasks
@emontnemery emontnemery marked this pull request as ready for review June 9, 2023 07:17
@emontnemery emontnemery merged commit 4085c4f into dev Jun 9, 2023
51 checks passed
@emontnemery emontnemery deleted the entity_tweak_hass_platform branch June 9, 2023 08:56
@github-actions github-actions bot locked and limited conversation to collaborators Jun 10, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants