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

Fix availability for GIOS index sensors #113021

Merged
merged 2 commits into from Mar 12, 2024

Conversation

bieniu
Copy link
Member

@bieniu bieniu commented Mar 10, 2024

Breaking change

Improves availability to avoid AttributeError when measurement station suddenly does not return data for one sensor.

Proposed change

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

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:

sensor_data = getattr(self.coordinator.data, self.entity_description.key)
available = super().available and bool(sensor_data)
Copy link
Member

Choose a reason for hiding this comment

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

bool(sensor_data) will be False if the value is 0. Should you check against None instead ?

Copy link
Member Author

Choose a reason for hiding this comment

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

sensor_data could be a Sensor object or None, it couldn't be 0 https://github.com/bieniu/gios/blob/d836f0c048bf2eb2847559467c5b05f264c42641/gios/model.py#L20


# Sometimes the API returns sensor data without indexes
if self.entity_description.subkey:
if self.entity_description.subkey and available:
return available and bool(sensor_data.index)
Copy link
Member

Choose a reason for hiding this comment

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

An index can also be 0 ?

Copy link
Member Author

Choose a reason for hiding this comment

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

index is a non-empty string (good, very_good, moderate, etc.) or None https://github.com/bieniu/gios/blob/d836f0c048bf2eb2847559467c5b05f264c42641/gios/model.py#L12

@frenck frenck requested a review from balloob March 11, 2024 18:05
@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Mar 11, 2024
@balloob balloob merged commit f01095f into home-assistant:dev Mar 12, 2024
21 checks passed
@bieniu bieniu deleted the gios-fix-availability branch March 12, 2024 16:59
@anarion80
Copy link

Thanks! :)

frenck pushed a commit that referenced this pull request Mar 13, 2024
* Fix availability for index sensors

* Improve test_availability()

---------

Co-authored-by: Maciej Bieniek <478555+bieniu@users.noreply.github.com>
@frenck frenck mentioned this pull request Mar 13, 2024
xeniter pushed a commit to xeniter/core that referenced this pull request Mar 13, 2024
* Fix availability for index sensors

* Improve test_availability()

---------

Co-authored-by: Maciej Bieniek <478555+bieniu@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Mar 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GIOS AttributeError: 'NoneType' object has no attribute 'index'
4 participants