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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor refactoring of periodic statistics #56492

Merged
merged 5 commits into from Sep 22, 2021
Merged

Minor refactoring of periodic statistics #56492

merged 5 commits into from Sep 22, 2021

Conversation

emontnemery
Copy link
Contributor

Proposed change

Minor refactoring of periodic statistics to prepare for import of statistics

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)
  • 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

# Set meta data
result[entity_id]["meta"] = {
meta: StatisticMetaData = {
"statistic_id": entity_id,
Copy link
Member

Choose a reason for hiding this comment

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

Are we going to allow integrations to define their own statistic IDs when importing? I guess we can, but we should enforce it starts with <domain>-

"unit_of_measurement": unit,
"has_mean": "mean" in wanted_statistics[entity_id],
"has_sum": "sum" in wanted_statistics[entity_id],
}

# Make calculations
stat: dict = {}
stat: StatisticData = {"start": start}
Copy link
Member

Choose a reason for hiding this comment

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

This is what's not so cool about TypedDict: handling of optional fields.

"""Statistic data class."""

meta: StatisticMetaData
stat: tuple[StatisticData, ...]
Copy link
Member

Choose a reason for hiding this comment

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

Why is this a tuple?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It should be an Iterable, not a tuple.
The purpose is to allow inserting multiple datapoints for unchanged metadata, for example a day's or month's worth of hourly updates and not have to lookup the metadata already stored in the database for each point.

@balloob balloob merged commit 92253f5 into dev Sep 22, 2021
@balloob balloob deleted the statistics_refactor branch September 22, 2021 20:31
Dev automation moved this from Needs review to Done Sep 22, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Sep 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants