Skip to content

Add update class method to DataUpdateCoordinator#32724

Merged
frenck merged 9 commits intodevfrom
frenck-2020-0291
Mar 12, 2020
Merged

Add update class method to DataUpdateCoordinator#32724
frenck merged 9 commits intodevfrom
frenck-2020-0291

Conversation

@frenck
Copy link
Copy Markdown
Member

@frenck frenck commented Mar 12, 2020

Proposed change

This PR implements an update method (async_update_data) in the DataUpdateCoordinator class.

This allows one to extend the DataUpdateCoordinator and implement an override on the update method.

As suggested by @balloob @ #32565 (comment)

Will be used to cleaning up the implementation of PR #32565

PS: Added one additional test, out of the scope of this PR, to improve coverage.

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

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

The integration reached or maintains the following Integration Quality Scale:

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

Comment thread homeassistant/helpers/update_coordinator.py Outdated
Comment thread homeassistant/helpers/update_coordinator.py Outdated
Comment thread homeassistant/helpers/update_coordinator.py Outdated
Comment thread homeassistant/helpers/update_coordinator.py Outdated
Comment thread homeassistant/helpers/update_coordinator.py Outdated
@frenck frenck merged commit ff92a8b into dev Mar 12, 2020
@frenck frenck deleted the frenck-2020-0291 branch March 12, 2020 23:27
@lock lock Bot locked and limited conversation to collaborators Mar 17, 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.

3 participants