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

Set proper sensor device class for swiss_public_transport #106485

Merged
merged 1 commit into from
Jan 10, 2024

Conversation

miaucl
Copy link
Contributor

@miaucl miaucl commented Dec 27, 2023

Breaking change

The native_value of the sensor is no longer of type str (timestamp string) but a proper datetime. Further, all timestamps and durations in the additional fields are also proper datetime/duration objects.

Proposed change

Set the class of the sensor departure to TIMESTAMP instead of the generic str value and provide the native_value and the additional attributes accordingly.

Also, the values are nullable, as the api sometimes does not have a response to a request. This is now better reflected in a None value instead of an empty str.

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
  • 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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

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

@miaucl miaucl marked this pull request as draft December 27, 2023 16:18
@miaucl miaucl force-pushed the spt_sensor_device_class branch from f7d371d to 8f00ba9 Compare December 27, 2023 16:35
@miaucl miaucl marked this pull request as ready for review December 27, 2023 16:37
@miaucl miaucl force-pushed the spt_sensor_device_class branch from 8f00ba9 to 73821f9 Compare January 5, 2024 20:03
@home-assistant home-assistant bot marked this pull request as draft January 9, 2024 12:10
@home-assistant
Copy link

home-assistant bot commented Jan 9, 2024

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.

@miaucl miaucl force-pushed the spt_sensor_device_class branch from 73821f9 to e1e24fe Compare January 9, 2024 15:28
@miaucl miaucl marked this pull request as ready for review January 9, 2024 15:28
@home-assistant home-assistant bot requested a review from gjohansson-ST January 9, 2024 15:28
@miaucl miaucl force-pushed the spt_sensor_device_class branch from e1e24fe to 3266b9f Compare January 9, 2024 15:47
@home-assistant home-assistant bot marked this pull request as draft January 10, 2024 08:24
@miaucl miaucl force-pushed the spt_sensor_device_class branch from 3266b9f to 8ca3fcb Compare January 10, 2024 08:56
@miaucl
Copy link
Contributor Author

miaucl commented Jan 10, 2024

I realized, there might also be (rare) cases where no connection is available, which means connections[0] does not exist, either. Therefore I also check for departure before parsing to datetime.

@miaucl miaucl marked this pull request as ready for review January 10, 2024 08:59
@gjohansson-ST
Copy link
Member

Please don't force push in your changes. Do regular commits so one doesn't have to review from scratch all the time (perhaps not a big deal on this PR but for the future).

@miaucl
Copy link
Contributor Author

miaucl commented Jan 10, 2024

Please don't force push in your changes. Do regular commits so one doesn't have to review from scratch all the time (perhaps not a big deal on this PR but for the future).

Ok, no problem

Copy link
Member

@gjohansson-ST gjohansson-ST left a comment

Choose a reason for hiding this comment

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

Thanks @miaucl 👍

@gjohansson-ST gjohansson-ST merged commit 598e18c into home-assistant:dev Jan 10, 2024
23 checks passed
catsmanac pushed a commit to catsmanac/ha-core-dev that referenced this pull request Jan 10, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jan 11, 2024
@miaucl miaucl deleted the spt_sensor_device_class branch February 8, 2024 19:32
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants