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

Use runtime_data for Swiss Public Transport #128369

Merged
merged 12 commits into from
Oct 21, 2024

Conversation

miaucl
Copy link
Contributor

@miaucl miaucl commented Oct 14, 2024

Proposed change

Implement config_entry.runtime_data instead of hass.data[<key>] based on this post: https://developers.home-assistant.io/blog/2024/04/30/store-runtime-data-inside-config-entry/

There was also a bug with the service call which returned a dict containing a datetime object instead of JsonValueType. This was overlooked as with hass.data, the type is Any. No it is typed and therefore mypy raised an error.

Now we cannot just return the dataclass but have to create a simpler dict only containing allowed value types.

--> Addressed in: #128391

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.

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 ready for review October 14, 2024 15:23
@miaucl miaucl requested a review from fabaff as a code owner October 14, 2024 15:23
@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 October 14, 2024 16:44
@epenet epenet changed the title Use runtime_data instead of hass.data[<key>] for Swiss Public Transport Use runtime_data for Swiss Public Transport Oct 14, 2024
@miaucl miaucl marked this pull request as ready for review October 15, 2024 20:12
@home-assistant home-assistant bot marked this pull request as draft October 16, 2024 21:41
@miaucl miaucl marked this pull request as ready for review October 17, 2024 06:54
@home-assistant home-assistant bot marked this pull request as draft October 21, 2024 08:25
@miaucl miaucl marked this pull request as ready for review October 21, 2024 08:44
@miaucl
Copy link
Contributor Author

miaucl commented Oct 21, 2024

@gjohansson-ST There shouldn't be any direct imports anymore now.

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 110751e into home-assistant:dev Oct 21, 2024
32 checks passed
@miaucl miaucl deleted the spt_runtime_data branch October 21, 2024 10:23
10100011 pushed a commit to 10100011/core that referenced this pull request Oct 21, 2024
* use runtime_data instead of hass.data[<key>]

* fix service response export type

* reduce runtime_data to be just the coordinator

* fix rebase

* fix ruff

* address reviews

* address reviews

* no general core import

* no general config_entries import

* fix also for services

* remove untyped config entry

* remove unneeded cast
@github-actions github-actions bot locked and limited conversation to collaborators Oct 22, 2024
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.

4 participants