Skip to content

Fix Proxmox VE storage usage percentage crash on missing used_fraction#167136

Merged
CoMPaTech merged 7 commits into
home-assistant:devfrom
irishpadres:fix-proxmoxve-storage-used-fraction
Apr 3, 2026
Merged

Fix Proxmox VE storage usage percentage crash on missing used_fraction#167136
CoMPaTech merged 7 commits into
home-assistant:devfrom
irishpadres:fix-proxmoxve-storage-used-fraction

Conversation

@irishpadres
Copy link
Copy Markdown
Contributor

@irishpadres irishpadres commented Apr 2, 2026

Proposed change

Fix KeyError: 'used_fraction' crash in the Proxmox VE integration's storage usage percentage sensor. Certain storage types (e.g., PBS datastores, pass-through mounts) do not include the used_fraction field in the Proxmox API response, causing the sensor to crash.

The fix changes data["used_fraction"] to data.get("used_fraction") so the sensor gracefully returns None (showing "Unknown" in the UI) when the key is absent instead of raising a KeyError.

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

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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 diff between library versions and ideally a link to the changelog/release notes is added to the PR description.

To help with the load of incoming pull requests:

Copilot AI review requested due to automatic review settings April 2, 2026 05:15
@irishpadres irishpadres requested a review from CoMPaTech as a code owner April 2, 2026 05:15
Copy link
Copy Markdown
Contributor

@home-assistant home-assistant Bot left a comment

Choose a reason for hiding this comment

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

Hello @irishpadres,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <email@address.com>"
      
      (substituting "Author Name" and "email@address.com" for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Apr 2, 2026

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
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Apr 2, 2026

Hey there @Corbeno, @erwindouna, @CoMPaTech, mind taking a look at this pull request as it has been labeled with an integration (proxmoxve) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of proxmoxve 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 proxmoxve 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, problem in config, problem in device, feature-request) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component, problem in config, problem in device, feature-request) on the pull request.

irishpadres and others added 2 commits April 1, 2026 22:18
Some Proxmox storage types do not return a `used_fraction` field in
the API response, causing a KeyError when the storage usage percentage
sensor tries to access it. Use `dict.get()` to gracefully handle the
missing key and report the sensor as unknown instead of crashing.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@irishpadres irishpadres force-pushed the fix-proxmoxve-storage-used-fraction branch from e26691f to ac1eeb4 Compare April 2, 2026 05:18
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request fixes a KeyError crash in the Proxmox VE integration's storage usage percentage sensor. Certain storage types (like PBS datastores and pass-through mounts) don't include the used_fraction field in the Proxmox API response, causing the sensor to fail. The fix changes from direct dictionary access to using .get() with proper None handling, allowing the sensor to gracefully show "Unknown" in the UI when the field is absent.

Changes:

  • Updated storage usage percentage sensor to use safe dictionary access for the used_fraction field
  • Added test coverage for the case where used_fraction is missing from storage data

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
homeassistant/components/proxmoxve/sensor.py Fixed KeyError crash by using data.get("used_fraction") instead of data["used_fraction"] with proper None handling
tests/components/proxmoxve/test_sensor.py Added test case validating graceful handling when used_fraction is missing from storage data

@irishpadres irishpadres marked this pull request as ready for review April 2, 2026 05:19
@home-assistant home-assistant Bot dismissed their stale review April 2, 2026 05:19

Stale

irishpadres and others added 2 commits April 1, 2026 22:22
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 2, 2026 05:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copy link
Copy Markdown
Member

@erwindouna erwindouna left a comment

Choose a reason for hiding this comment

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

Thanks @irishpadres! A few points to look into. :)

Comment thread homeassistant/components/proxmoxve/sensor.py Outdated
Comment thread tests/components/proxmoxve/test_sensor.py Outdated
Comment thread tests/components/proxmoxve/test_sensor.py Outdated
Copilot AI review requested due to automatic review settings April 2, 2026 05:36
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comment thread tests/components/proxmoxve/test_sensor.py Outdated
):
await setup_integration(hass, mock_config_entry)

state = hass.states.get("sensor.storage_local_storage_usage_percentage")
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

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

The test could be more defensive by explicitly checking that the state entity exists before accessing its state attribute. Without this check, a missing entity would raise an AttributeError instead of providing a clear assertion failure message.

Suggested change
state = hass.states.get("sensor.storage_local_storage_usage_percentage")
state = hass.states.get("sensor.storage_local_storage_usage_percentage")
assert state is not None

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Member

@erwindouna erwindouna left a comment

Choose a reason for hiding this comment

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

Looks good, thanks! Might ti check in the CLA error,before we can continue.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@irishpadres
Copy link
Copy Markdown
Contributor Author

cla error should be resolved now.

Copy link
Copy Markdown
Member

@CoMPaTech CoMPaTech left a comment

Choose a reason for hiding this comment

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

@CoMPaTech CoMPaTech modified the milestone: 2026.4.1 Apr 2, 2026
@CoMPaTech CoMPaTech merged commit 745107c into home-assistant:dev Apr 3, 2026
33 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Apr 4, 2026
@CoMPaTech CoMPaTech added this to the 2026.4.3 milestone Apr 12, 2026
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.

proxmox integration crash on 2026.4: KeyError for storage pool missing 'used_fraction'

6 participants