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

Deprecate conf_update_interval #20924

Conversation

@rohankapoorcom
Copy link
Member

commented Feb 10, 2019

Description:

As noticed in #20526 , CONF_UPDATE_INTERVAL and CONF_SCAN_INTERVAL serve identical purposes and CONF_SCAN_INTERVAL is used a lot more.

Now that we have a clean way to deprecate configs without causing breaking changes, (#20565) we can clean this up.

CONF_UPDATE_INTERVAL has been deprecated in 0.88 and is set to become invalid in 0.91 (three versions out). In 0.92, we can go ahead and do a final cleanup since all users should have migrated over by then.

Breaking Change: update_interval has been deprecated and replaced with scan_interval in all components and platforms. This is a soft deprecation in this release and will automatically become a hard breaking change in Home Assistant version 0.91.0.

Pull request in home-assistant.io with documentation (if applicable): home-assistant/home-assistant.io#8603

I need to go through all of these components/platforms and update the documentation.

Checklist:

  • The code change is tested and works locally.
  • Local tests pass with tox. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.

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

@rohankapoorcom rohankapoorcom requested review from Danielhiversen, fabaff and home-assistant/core as code owners Feb 10, 2019

@wafflebot wafflebot bot added the in progress label Feb 10, 2019

@dgomes

dgomes approved these changes Feb 12, 2019

Copy link
Contributor

left a comment

Looks good!

Show resolved Hide resolved tests/components/sensor/test_darksky.py Outdated

@rohankapoorcom rohankapoorcom force-pushed the rohankapoorcom:deprecate-conf-update-interval branch from a73384a to 4efa9b2 Feb 12, 2019

rohankapoorcom added some commits Feb 10, 2019

Fix Darksky tests correctly
This reverts commit a73384a.

@rohankapoorcom rohankapoorcom force-pushed the rohankapoorcom:deprecate-conf-update-interval branch from 065ecc1 to b7eb0ab Feb 16, 2019

@rohankapoorcom rohankapoorcom added this to the 0.88.0 milestone Feb 16, 2019

@rohankapoorcom rohankapoorcom referenced this pull request Feb 16, 2019

Merged

Deprecate conf_update_interval #8603

2 of 2 tasks complete
@MartinHjelmare
Copy link
Member

left a comment

The platform schema already has CONF_SCAN_INTERVAL so we should not overwrite that key in platforms.

Show resolved Hide resolved homeassistant/components/sensor/broadlink.py Outdated
Show resolved Hide resolved homeassistant/components/sensor/darksky.py Outdated
Show resolved Hide resolved homeassistant/components/sensor/broadlink.py Outdated
Show resolved Hide resolved homeassistant/components/sensor/darksky.py Outdated
Show resolved Hide resolved homeassistant/components/sensor/fedex.py Outdated
Show resolved Hide resolved homeassistant/components/sensor/fedex.py Outdated
Show resolved Hide resolved homeassistant/components/sensor/ups.py Outdated
Show resolved Hide resolved homeassistant/components/sensor/ups.py Outdated
@MartinHjelmare

This comment has been minimized.

Copy link
Member

commented Feb 16, 2019

Is this a fix and that's why it should go into 0.88?

@rohankapoorcom

This comment has been minimized.

Copy link
Member Author

commented Feb 16, 2019

Is this a fix and that's why it should go into 0.88?

No, I'm trying to place all of the configuration deprecations in a single release (there's already one in 0.88) so that it easier for users to remember when the deprecations became forcibly invalid.

All changes addressed and pushed up.

@MartinHjelmare

This comment has been minimized.

Copy link
Member

commented Feb 17, 2019

Nice!

@MartinHjelmare MartinHjelmare merged commit 481439d into home-assistant:dev Feb 17, 2019

3 checks passed

Hound No violations found. Woof!
cla-bot Everyone involved has signed the CLA
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@wafflebot wafflebot bot removed the in progress label Feb 17, 2019

@rohankapoorcom rohankapoorcom deleted the rohankapoorcom:deprecate-conf-update-interval branch Feb 17, 2019

balloob added a commit that referenced this pull request Feb 17, 2019

Deprecate conf_update_interval (#20924)
* Deprecate update_interval and replace with scan_interval

* Update tests

* Fix Darksky tests

* Fix Darksky tests correctly

This reverts commit a73384a.

* Provide the default for the non deprecated option

* Don't override default schema for sensors

@balloob balloob referenced this pull request Feb 20, 2019

Merged

0.88.0 #21238

@nickw444 nickw444 referenced this pull request Feb 25, 2019

Merged

Allow configuration of update interval for ness_alarm #21415

5 of 5 tasks complete

@rohankapoorcom rohankapoorcom referenced this pull request Apr 4, 2019

Merged

Remove all config deprecations invalidated in 0.91 #22704

2 of 3 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.