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

Deprecate the dynamic package sensors in seventeentrack #116102

Open
wants to merge 5 commits into
base: dev
Choose a base branch
from

Conversation

shaiu
Copy link
Contributor

@shaiu shaiu commented Apr 24, 2024

Breaking changes

...

Proposed change

Add deprecation comments for the dynamic package sensors

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:

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][dev-checklist]
  • I have followed the [perfect PR recommendations][perfect-pr]
  • 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:

  • Documentation added/updated for [www.home-assistant.io][docs-repository]

If the code communicates with devices, web services, or third-party tools:

  • The [manifest file][manifest-docs] 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.

To help with the load of incoming pull requests:

  • I have reviewed two other [open pull requests][prs] in this repository.

@home-assistant home-assistant bot added cla-signed deprecation Indicates a breaking change to happen in the future integration: seventeentrack small-pr PRs with less than 30 lines. by-code-owner Quality Scale: No score labels Apr 24, 2024
@joostlek joostlek changed the title Add deprecation comments for the dynamic package sensors Deprecate the dynamic package sensors Apr 24, 2024
@joostlek joostlek changed the title Deprecate the dynamic package sensors Deprecate the dynamic package sensors in seventeentrack Apr 24, 2024
Copy link
Contributor

@davet2001 davet2001 left a comment

Choose a reason for hiding this comment

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

Since the beta for 2024.5 has now been cut, the earliest deprecation start will be 2024.6.

Also is it possible to raise a deprecation warning when the deprecated functions are used?

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

@home-assistant home-assistant bot marked this pull request as draft April 26, 2024 15:48
@shaiu
Copy link
Contributor Author

shaiu commented Apr 27, 2024

@joostlek what did we decide on here?

@joostlek
Copy link
Member

I think there are 2 things we should keep in mind after I did some reviewing of the code

  1. Can we get all data from the service call that was previously in the state attributes? I think we are missing the information from the individual package sensors
  2. We will probably have an options field with like "create individual package sensors" that will be fixed by a repair flow. So whenever you start the integration after this is merged, a repair issue will be raised, asking you to migrate to the service calls. If you press the submit button, the options to create those sensors will turn off and then those people are migrated.

I think it would also be nice to have some example templates in the documentation to help people get started with this new way of fetching the extra data. I can ask some people if they are able to help out with this.

@shaiu shaiu marked this pull request as ready for review April 28, 2024 13:29
@home-assistant home-assistant bot requested a review from davet2001 April 28, 2024 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
by-code-owner cla-signed deprecation Indicates a breaking change to happen in the future integration: seventeentrack Quality Scale: No score small-pr PRs with less than 30 lines.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants