core
core copied to clipboard
Deprecate extra state attributes in Habitica task sensors
Proposed change
The task sensors in the Habitica integration have extra state attributes containing the complete raw json data of the corresponding task types. The to-do and dailies sensors have already been deprecated as they were migrated to the todo platform. The remaining sensors habits and rewards were not migrated as it is not possible to represent them appropriately. These sensors will remain and display the amount of habits and rewards the users have in their Habitica accounts, only the state attributes will be removed.
when it is detected that these sensors are used in an automation or script a repair issue is raised informing about the deprecation. As the amount of habits and rewards is a number that doesn't tend to change often once set up, it is very unlikely that the state is used for automations. It can be assumed quite safely that the sensors are used in automations for their attributes. Another use for the attributes could be in templates, but i think that cannot be detected in HA.
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)
- [x] 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: https://github.com/home-assistant/home-assistant.io/pull/35231
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
) - [ ] Tests have been added to verify that the new code works.
If user exposed functionality or configuration variables are added/changed:
- [x] Documentation added/updated for www.home-assistant.io
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 runningpython3 -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:
- [ ] I have reviewed two other open pull requests in this repository.