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

Refactor the core config store #80457

Merged
merged 2 commits into from
Oct 17, 2022
Merged

Refactor the core config store #80457

merged 2 commits into from
Oct 17, 2022

Conversation

epenet
Copy link
Contributor

@epenet epenet commented Oct 17, 2022

Proposed change

Refactor the core config store by subclassing helpers.storage.Store

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
  • The code has been formatted using Black (black --fast 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:

# pylint: disable-next=import-outside-toplevel
from .helpers.storage import Store

class _ConfigStore(Store[dict[str, Any]]):
Copy link
Contributor Author

@epenet epenet Oct 17, 2022

Choose a reason for hiding this comment

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

Having it available as a class will help avoid discrepencies when adjusting the initialisation (for example when adding minor version) and migration.

@epenet epenet changed the title Add helper for Config Store Add class inheritance for Config Store Oct 17, 2022
@epenet epenet changed the title Add class inheritance for Config Store Refactor the core config store Oct 17, 2022
Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

Thanks, @epenet 👍

@epenet epenet merged commit bbb0b2a into home-assistant:dev Oct 17, 2022
@epenet epenet deleted the config-store branch October 17, 2022 08:13
@github-actions github-actions bot locked and limited conversation to collaborators Oct 18, 2022
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.

2 participants