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

Support time entities in time conditions #124575

Draft
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

silamon
Copy link
Contributor

@silamon silamon commented Aug 25, 2024

Proposed change

Allow the new time entities introduced in 2023.6 to be used in automation 'time' conditions, just like input_datetime helpers and sensors with timestamp device class.

This PR builds further on the closed PR #119428.

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 Ruff (ruff format 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.

To help with the load of incoming pull requests:

@silamon
Copy link
Contributor Author

silamon commented Aug 25, 2024

Frontend PR is still the original and approved: home-assistant/frontend#21069

try:
after = datetime.strptime(after_entity.state, "%H:%M:%S").time()
except ValueError:
return False
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we return False here? When does a time entity have a state which can't be parsed?
Should we instead check the state is not in (unavailable, unknown) as for timestamp sensors; if it is return False, and if the state can't be parsed raise ConditionError?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's to let the unit test pass:
hass.states.async_set("time.invalid_timestamp", "This is not a timestamp")

If the state becomes invalid, I don't think we should raise?

Copy link
Contributor

@emontnemery emontnemery Sep 16, 2024

Choose a reason for hiding this comment

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

Right, but calling hass.states.async_set with a value the time entity can't have in a test is not a good test IMO.

Based on the time entity's implementation, its state can be:

  • unavailable if the time entity's available property is False
  • unknown if the the time entity's native_value is None
  • a valid time string

@joostlek joostlek marked this pull request as draft October 21, 2024 14:29
@joostlek
Copy link
Member

Converting to draft as there seem to be open comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants