Skip to content

Add extract_from_target websocket command #150124

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

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Conversation

abmantis
Copy link
Member

@abmantis abmantis commented Aug 6, 2025

Proposed change

Add a new expand_target websocket command so that frontend and core have a consistent way of expanding targets.

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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

home-assistant bot commented Aug 6, 2025

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

Code owner commands

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

Copy link
Contributor

@Copilot 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 adds a new expand_target websocket command that provides a consistent way for frontend and core to expand various target types (entities, devices, areas, labels) into their constituent entities and references.

  • Introduces a new websocket command expand_target that processes target selectors and returns expanded entity references
  • Adds comprehensive test coverage for the new command including edge cases and validation scenarios
  • Provides structured output including referenced entities/devices/areas and missing items for error handling

Reviewed Changes

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

File Description
homeassistant/components/websocket_api/commands.py Implements the new expand_target websocket command handler with validation and target expansion logic
tests/components/websocket_api/test_commands.py Adds comprehensive test suite covering various target types, edge cases, and validation scenarios
Comments suppressed due to low confidence (1)

tests/components/websocket_api/test_commands.py:158

  • The type annotation dict[str, str] is incorrect as targets can contain lists of strings, not just strings. Should be dict[str, Any] or a more specific type that accommodates the actual structure.
    assert len(runs) == 1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@MartinHjelmare MartinHjelmare marked this pull request as draft August 7, 2025 11:18
@abmantis abmantis marked this pull request as ready for review August 7, 2025 21:03
@abmantis abmantis requested a review from MartinHjelmare August 7, 2025 21:04
@abmantis abmantis changed the title Add expand_target websocket command Add extract_from_target websocket command Aug 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants