Skip to content

Cleanup ZHA group entity lifecycle#33977

Merged
balloob merged 3 commits intohome-assistant:devfrom
dmulcahey:dm/zha-group-lifecycle-cleanup
Apr 10, 2020
Merged

Cleanup ZHA group entity lifecycle#33977
balloob merged 3 commits intohome-assistant:devfrom
dmulcahey:dm/zha-group-lifecycle-cleanup

Conversation

@dmulcahey
Copy link
Copy Markdown
Contributor

Breaking change

No

Proposed change

This PR closes some holes in the ZHA group entity lifecycle. The PR does the following:

  • Move state restore from the BaseZhaEntity to ZhaEntity because groups shouldn't restore state
  • Cleans up the entity registry when a group is removed
  • re-probes groups when members are added or removed ensuring that we always add or remove entities as needed

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml

Additional information

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.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

@probot-home-assistant
Copy link
Copy Markdown

Hey there @Adminiuga, mind taking a look at this pull request as its been labeled with a integration (zha) you are listed as a codeowner for? Thanks!

@dmulcahey dmulcahey requested a review from Adminiuga April 10, 2020 19:12
@dmulcahey dmulcahey added this to the 0.108.3 milestone Apr 10, 2020
Copy link
Copy Markdown
Contributor

@Adminiuga Adminiuga left a comment

Choose a reason for hiding this comment

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

LGTM

await self._zigpy_device.remove_from_group(group_id)
try:
await self._zigpy_device.remove_from_group(group_id)
except (zigpy.exceptions.DeliveryError, asyncio.TimeoutError) as ex:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'm on the fence whether we should use zigpy.exceptions.ZigbeeException instead of DeliveryError here. DeliverError is raised when the delivery fails (doh) but if usb port is disconnected or bellows is restarting it is going to be a different exception and either way any of those exceptions means the device hasn't received the request.

@balloob balloob merged commit 13dda7b into home-assistant:dev Apr 10, 2020
@dmulcahey dmulcahey deleted the dm/zha-group-lifecycle-cleanup branch April 10, 2020 20:30
balloob pushed a commit that referenced this pull request Apr 10, 2020
* Clean up ZHA group entity lifecycle

* group entities don't use state restore

* add tests
@balloob balloob mentioned this pull request Apr 10, 2020
@lock lock Bot locked and limited conversation to collaborators Apr 15, 2020
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.

ZHA light group entity_id not being written correctly

4 participants