Skip to content

Handle IPP sw_version returned as list from printer#172543

Draft
frenck wants to merge 1 commit into
devfrom
frenck-2026-0646
Draft

Handle IPP sw_version returned as list from printer#172543
frenck wants to merge 1 commit into
devfrom
frenck-2026-0646

Conversation

@frenck
Copy link
Copy Markdown
Member

@frenck frenck commented May 29, 2026

Proposed change

Some printers return printer-firmware-string-version as a list of strings via IPP. The integration passes this directly as sw_version to the device registry, which expects a string.

Convert list values to a comma-separated string before passing to the device registry.

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 May 29, 2026 08:07
@frenck frenck requested a review from ctalkington as a code owner May 29, 2026 08:07
@home-assistant home-assistant Bot added bugfix cla-signed integration: ipp small-pr PRs with less than 30 lines. Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage Top 50 Integration is ranked within the top 50 by usage labels May 29, 2026
@home-assistant
Copy link
Copy Markdown
Contributor

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

Code owner commands

Code owners of ipp can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant mark-draft Mark the pull request as draft.
  • @home-assistant ready-for-review Remove the draft status from the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign ipp Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant update-branch Update the pull request branch with the base branch.
  • @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.

@frenck frenck added this to the 2026.6.0 milestone May 29, 2026
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 PR fixes IPP device registration when printers return firmware versions as a list instead of a string, preventing sw_version from receiving an unsupported type.

Changes:

  • Normalizes list-valued IPP firmware versions into a comma-separated string before building DeviceInfo.
  • Leaves existing scalar firmware version behavior unchanged.

Comment thread homeassistant/components/ipp/entity.py
Comment on lines +27 to +30
version = self.coordinator.data.info.version
if isinstance(version, list):
version = ", ".join(str(v) for v in version)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

info.version is typed as str | None in the lib, so I think it's an issue of the lib, that it returns a list here?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

You're right, the lib types version as str | None but returns a list at runtime. That's a library bug. Want me to close this and file upstream on pyipp instead?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Although that would be a breaking change for the library. That said, I don't know about the data formats of the library and what they represent. In the end, we use the library output in our ways.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'll file an issue report to the lib and let's see what is the outcome there.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

mypy is failing, can you take a look?

@home-assistant home-assistant Bot marked this pull request as draft May 29, 2026 08:43
@home-assistant
Copy link
Copy Markdown
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfix cla-signed integration: ipp Quality Scale: No score small-pr PRs with less than 30 lines. Top 50 Integration is ranked within the top 50 by usage Top 100 Integration is ranked within the top 100 by usage Top 200 Integration is ranked within the top 200 by usage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Detected that integration 'ipp' passes a non-string value of type list as sw_version

5 participants