Skip to content

Define public names of the image integration - #186623

Merged
balloob merged 1 commit into
devfrom
epenet/20261015-image-all
Oct 15, 2026
Merged

balloob merged 1 commit into
devfrom
epenet/20261015-image-all

Conversation

@epenet

@epenet epenet commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

Breaking change

For developers only: as the image integration now defines __all__, from homeassistant.components.image import * only imports the names listed in it, instead of every public name of the module. No such wildcard import was found in core or in the custom integrations of the HACS default repositories. Explicit imports are not affected.

Proposed change

Define the public names of the image integration with __all__, as already done by sensor, cover, select, number and other entity platforms.

This came up with @joostlek during refactoring: why the # noqa: F401 markers were needed on the package root imports, and whether they could be removed. Listing the public names in __all__ states that intent explicitly, so the markers are no longer needed.

It was checked against:

  • core: every name imported from homeassistant.components.image by other integrations is included. With no_implicit_reexport temporarily enabled for the image integration (it is currently disabled for homeassistant.components.*), mypy reports no re-export issue on the 29 core modules importing from it;
  • HACS: every name imported from the package root by the custom integrations in the HACS default repositories (~2,400) is included, apart from the internal DATA_COMPONENT key.

Enforcing this with mypy (no_implicit_reexport for the entity platforms) will follow once all of them define __all__. No functional 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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to developer documentation pull request:
  • Link to frontend pull request:

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 balanced review requested due to automatic review settings October 15, 2026 09:14
@epenet
epenet requested a review from a team as a code owner October 15, 2026 09:14
@home-assistant

Copy link
Copy Markdown
Contributor

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (image) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of image 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 image 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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The export list covers existing core imports, and no blocking issues were identified.

0 open findings

What changed in this PR

Defines the image integration’s public API explicitly, consistent with other entity platforms.

Changes:

  • Adds __all__ to declare public exports.
  • Removes the redundant # noqa: F401 suppression.
File Description
homeassistant/​components/​image/​__init__.py Declares public exports without changing runtime image behavior.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@balloob
balloob merged commit 99ca3c7 into dev Oct 15, 2026
56 checks passed
@balloob
balloob deleted the epenet/20261015-image-all branch October 15, 2026 15:32
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 16, 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.

3 participants