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

Modernize template weather #98064

Merged
merged 10 commits into from Aug 21, 2023
Merged

Modernize template weather #98064

merged 10 commits into from Aug 21, 2023

Conversation

gjohansson-ST
Copy link
Member

@gjohansson-ST gjohansson-ST commented Aug 8, 2023

Deprecation

The template weather entity have been updated:

  • The forecast state attribute is deprecated and will be removed in Home Assistant Core 2024.3, users should instead call the service weather.get_forecast

Proposed change

Modernize SMHI weather:

  • Add support for the weather.get_forecast service
  • Add support for daily weather forecasts ( as it's a template I had to choose one )

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

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

home-assistant bot commented Aug 8, 2023

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

Code owner commands

Code owners of template 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 template Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@gjohansson-ST gjohansson-ST added the deprecation Indicates a breaking change to happen in the future label Aug 8, 2023
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

Should we perhaps deprecate the forecast_template configuration parameter and replace with daily_forecast_template, hourly_forecast_template, twice_daily_forecast_template?

homeassistant/components/template/weather.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft August 9, 2023 06:53
@home-assistant
Copy link

home-assistant bot commented Aug 9, 2023

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@gjohansson-ST gjohansson-ST marked this pull request as ready for review August 9, 2023 18:24
homeassistant/components/template/weather.py Outdated Show resolved Hide resolved
homeassistant/components/template/weather.py Outdated Show resolved Hide resolved
homeassistant/components/template/weather.py Outdated Show resolved Hide resolved
homeassistant/components/template/weather.py Outdated Show resolved Hide resolved
homeassistant/components/template/weather.py Outdated Show resolved Hide resolved
homeassistant/components/template/weather.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft August 10, 2023 07:57
@gjohansson-ST gjohansson-ST marked this pull request as ready for review August 10, 2023 16:55
homeassistant/components/template/weather.py Outdated Show resolved Hide resolved
Comment on lines 421 to 422
if result is None or isinstance(result, TemplateError):
return None
Copy link
Contributor

Choose a reason for hiding this comment

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

If the template rendered to None, it's fine to return None, but if we got a TemplateError, shouldn't we raise?
Also, we should check the result is a list and raise if it isn't.

Copy link
Member Author

Choose a reason for hiding this comment

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

The template will take care of that and skip the validator and go directly to _update_forecast().
Didn't we say to always return an empty list even if there is something wrong with the forecast?

homeassistant/components/template/weather.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft August 15, 2023 10:10
@gjohansson-ST gjohansson-ST marked this pull request as ready for review August 16, 2023 19:57
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @gjohansson-ST 👍

@gjohansson-ST gjohansson-ST merged commit 207e3f9 into dev Aug 21, 2023
34 checks passed
@gjohansson-ST gjohansson-ST deleted the template-new-weather branch August 21, 2023 13:48
@github-actions github-actions bot locked and limited conversation to collaborators Aug 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-signed deprecation Indicates a breaking change to happen in the future has-tests integration: template new-feature Quality Scale: internal small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants