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

Change output template filters timestamp_local and timestamp_utc to isoformat #60269

Merged
merged 1 commit into from
Nov 24, 2021

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Nov 24, 2021

Breaking change

The timestamp_local and timestamp_utc template functions/filters have changed their output format. The timestamp is now formatted to iso standards and contains timezone information.

Previously a timestamp from these would look like: 2016-07-21 16:39:04. Now it is formatted as: 2016-07-21T16:39:04+01:00.

This change may break templates that need a specific format, in those cases, you can use the timestamp_custom template filter instead.

Proposed change

The current template filters timestamp_local and timestamp_utc do not add timezone information. When used with MQTT to assign a sensor with device_class 'timestamp` timezone information must be available or an exception will be thrown.

This PR changes the output for the template filters timestamp_local and timestamp_utc to isoformat(), this ensures that current users of these filters have no timezone issues.

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

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.
  • 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.

The integration reached or maintains the following Integration Quality Scale:

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

To help with the load of incoming pull requests:

@frenck
Copy link
Member

frenck commented Nov 24, 2021

Updated breaking change section a bit from my format, hope you don't mind.

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.

Thanks, @jbouwh 👍

Dev automation moved this from Needs review to Reviewer approved Nov 24, 2021
@frenck frenck merged commit fa0d3a6 into home-assistant:dev Nov 24, 2021
Dev automation moved this from Reviewer approved to Done Nov 24, 2021
@jbouwh jbouwh deleted the add-tz-info branch November 24, 2021 10:13
@github-actions github-actions bot locked and limited conversation to collaborators Nov 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants