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

Add support for JSON fragments #107213

Merged
merged 45 commits into from Jan 8, 2024
Merged

Add support for JSON fragments #107213

merged 45 commits into from Jan 8, 2024

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jan 5, 2024

Proposed change

#102870 (comment)

Currently we have multiple copies a state in memory in different formats depending on which api asks for them. This will allow for better reuse of objects between formats and reduce the amount of serializations.

A common case for this is serializing state_changed Event objects since new_state and old_state can now use the previously serialized fragment instead of recreating it again. Additionally restore state can now reuse the fragment instead of serializing again each time it writes to disk.

We also avoid constructing a lot of ReadOnlyDict for the cases were the data is never exposed outside of core and only used to create json.

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

home-assistant bot commented Jan 5, 2024

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

Code owner commands

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

@bdraco bdraco changed the title Add support for JSON fragments to the helper Add support for JSON fragments Jan 5, 2024
homeassistant/core.py Outdated Show resolved Hide resolved
homeassistant/core.py Outdated Show resolved Hide resolved
@bdraco bdraco marked this pull request as ready for review January 5, 2024 20:34
@bdraco bdraco requested a review from a team as a code owner January 5, 2024 20:34
the naming was intented to make it clear you get back a mutable object and should be careful
but its already prefixed with _ to indicate its protected
@bdraco
Copy link
Member Author

bdraco commented Jan 8, 2024

Thanks

@bdraco bdraco merged commit d04e2d5 into dev Jan 8, 2024
49 checks passed
@bdraco bdraco deleted the json_fragments branch January 8, 2024 03:36
@github-actions github-actions bot locked and limited conversation to collaborators Jan 9, 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.

None yet

2 participants