core icon indicating copy to clipboard operation
core copied to clipboard
Published 1 day ago • verified publisher icon home-assistant

Change Tibber get_prices action to return datetimes as str

Open functionpointer opened this issue 1 year ago • 5 comments

Breaking change

Changes tibber.get_prices action (fka service) responses to include datetimes as string.

Previously it was raw datetime objects.

Automations or template sensors using this may need to be modified with an as_datetime filter. More information: https://www.home-assistant.io/docs/configuration/templating/#time

Proposed change

The get_prices action returns a dict including datetime objects. However, actions (fka services) should be returning a ServiceResponse, which only allows str, int, float, bool, None as well as lists and dicts of them.

This really should have been caught by a type checker. It also presents issues when using the response with templates: https://github.com/home-assistant/core/issues/123293

This PR fixes the issue by returning the datetime objects as strings. They are verified to be compatible with isoformat().

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)
  • [X] 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 #123293
  • This PR is related to issue:
  • Link to documentation pull request:

Due to overlapping changes with datetime code, this PR should be merged first: https://github.com/home-assistant/core/pull/123289

Checklist

  • [X] The code change is tested and works locally.
  • [X] Local tests pass. Your PR cannot be merged unless tests pass
  • [X] There is no commented out code in this PR.
  • [X] I have followed the development checklist
  • [X] I have followed the perfect PR recommendations
  • [X] The code has been formatted using Ruff (ruff format homeassistant tests)
  • [X] 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.

To help with the load of incoming pull requests:

functionpointer avatar Aug 14 '24 11:08 functionpointer

Hey there @danielhiversen, mind taking a look at this pull request as it has been labeled with an integration (tibber) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of tibber 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 tibber Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

home-assistant[bot] avatar Aug 14 '24 11:08 home-assistant[bot]

👋 @functionpointer

Any reason why this PR is in draft?

../Frenck

frenck avatar Sep 27 '24 11:09 frenck

👋 @functionpointer

Any reason why this PR is in draft?

../Frenck

Due to overlapping changes with datetime code, this PR should be merged first: https://github.com/home-assistant/core/pull/123289

functionpointer avatar Sep 27 '24 11:09 functionpointer

https://github.com/home-assistant/core/pull/123289 is merged

volkerrichert avatar Oct 07 '24 09:10 volkerrichert

#123289 is merged

Yes, it is. Therefore i have marked this PR as "ready for review".

functionpointer avatar Oct 07 '24 12:10 functionpointer