8000 Add completed timestamp to TodoItem by karwosts · Pull Request #145820 · home-assistant/core · GitHub
[go: up one dir, main page]
Skip to content

Add completed timestamp to TodoItem #145820

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 2 commits into
base: dev
Choose a base branch
from
Draft

Add completed timestamp to TodoItem #145820

wants to merge 2 commits into from
+58 −22

Conversation

karwosts
Copy link
Contributor
@karwosts karwosts commented May 28, 2025 •
edited
Loading

Proposed change

For todo, track the timestamp when an item was marked completed in the TodoItem.
For local_todo, store and retrieve this from the ical storage.

Architecture: home-assistant/architecture#1178

Developer doc: home-assistant/developers.home-assistant#2683

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

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:

@karwosts karwosts requested review from a team and allenporter as code owners May 28, 2025 17:55
@home-assistant
Copy link

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

Code owner commands

Code owners of todo 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 todo 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
Copy link

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

Code owner commands

Code owners of local_todo 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 local_todo 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.

karwosts
karwosts commented May 28, 2025
View reviewed changes
homeassistant/components/todo/__init__.py
Comment on lines +497 to +501
if (
original_status != TodoItemStatus.COMPLETED
and status == TodoItemStatus.COMPLETED
):
updated_data["completed"] = dt_util.utcnow()
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is this appropriate to do here in the base class, or does this need to be re-implemented (or not done at all) in every todolist provider?

Copy link
Contributor

Choose a reason for hiding this comment

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

No, we should not do this here since this may be a read-only property for many implementations -- for example in the Google tasks the source of truth for this is the server.

Copy link
Contributor

Choose a reason for hiding this comment

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

In the case of local todo, i think it would make sense to do it in the ical library.

We probably also want to unset the completed date when the entry changes status to not completed and some other logic like that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree with moving this to local_todo, but could you elaborate what role you see the ical library would play in this feature? I would have thought the integration would just set the completed property on the Todo item in async_update_todo_item. I didn't see an additional role for the library there.

@karwosts karwosts mentioned this pull request May 28, 2025
Open
7 tasks
allenporter
allenporter requested changes May 31, 2025
View reviewed changes
homeassistant/components/todo/__init__.py
Comment on lines +497 to +501
if (
original_status != TodoItemStatus.COMPLETED
and status == TodoItemStatus.COMPLETED
):
updated_data["completed"] = dt_util.utcnow()
Copy link
Contributor

Choose a reason for hiding this comment

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

In the case of local todo, i think it would make sense to do it in the ical library.

We probably also want to unset the completed date when the entry changes status to not completed and some other logic like that.

@home-assistant home-assistant bot marked this pull request as draft May 31, 2025 22:04
@home-assistant
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@allenporter allenporter allenporter requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@allenporter allenporter

Labels
cla-signed core has-tests integration: local_todo integration: todo new-feature Quality Scale: internal Quality Scale: No score small-pr PRs with less than 30 lines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@karwosts @allenporter
0