Replace prefix-only entity search with substring matching via set_search_match_mode by Copilot · Pull Request #14 · gensyn/HomeAssistantPlugin

Copilot · 2026-03-06T19:13:01Z

Investigate @brombomb's set_search_match_mode suggestion
Revert the previous EntryRow-based approach entirely
Add _set_substring_search() helper calling widget.set_search_match_mode(Gtk.StringFilterMatchMode.SUBSTRING)
Apply to domain_combo, entity_combo (in BaseCore) and action_combo (in PerformAction)
Module-level try/except import of Gtk so tests without GTK work transparently
Add widget property (+setter) to ComboRow test mock — fixes AttributeError: property 'widget' of 'ParameterComboRow' object has no setter in CI
3 new unit tests for _set_substring_search
All locally-runnable tests pass; CI failures fixed

Original prompt

This section details on the original issue you should resolve

<issue_title>Improve Entity Search to use Substring Matching (fuzzy/contains) instead of Prefix Matching</issue_title>
<issue_description>The current implementation of the entity selector search appears to use exact start-of-string matching. This requires users to type the full domain prefix (e.g., switch.) to find specific entities, rather than being able to search by the friendly name or unique identifier directly.

Current Behavior

Searching for an entity only returns results if the search query matches the beginning of the entity ID.
Example: To find `switch.wyze_plug`, typing `wyze` returns no results. The user must type `switch.wy` to see the entity in the dropdown.
Expected Behavior

The search should utilize "in-string" (substring) matching or fuzzy matching. Typing any part of the entity ID should filter the list to include all entities containing that string.
Example: Typing `wyze` should return all entities containing that word, regardless of the domain prefix (e.g., `switch.wyze_plug_1`, `switch.wyze_light_2`).
</issue_description>

<agent_instructions>The orignal search implementation of the Adw.ComboRow only searches for list items that start with the search term. Within this repository we use GtkHelper.GenerativeUI.ComboRow which adds additional functionality to Adw.ComboRow and is implemented at https://github.com/StreamController/StreamController/blob/main/GtkHelper/ComboRow.py.
Have a look and see if you can figure out how to have the search term also match substrings of list items at any position. If the change would better be implemented in the StreamController repository you can suggest that as well.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes Improve Entity Search to use Substring Matching (fuzzy/contains) instead of Prefix Matching #13

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

- Add entity_search_entry (EntryRow) to BaseCore UI for filtering entities - Add _apply_entity_filter() for case-insensitive substring matching - Add _on_entity_search_changed() callback to update filter on text change - Clear search when domain changes via set_ui_value() - entity_combo now uses enable_search=False (built-in search disabled) - Update get_config_rows() in all 3 action subclasses - Add locale entries for search label in en_US and de_DE - Add 5 new tests for filter behaviour (substring, empty, case-insensitive, integration) - Update existing tests to include entity_search_entry mock Co-authored-by: gensyn <36128035+gensyn@users.noreply.github.com>

brombomb · 2026-03-07T02:11:35Z

I went looking through the docs and found this:
https://gnome.pages.gitlab.gnome.org/libadwaita/doc/1.2/method.ComboRow.set_search_match_mode.html

Which lead me to:

https://docs.gtk.org/gtk4/enum.StringFilterMatchMode.html

Does something like this look feasible?

        if hasattr(self.action_combo.widget, "set_search_match_mode"):
            self.action_combo.widget.set_search_match_mode(Gtk.StringFilterMatchMode.SUBSTRING)

gensyn · 2026-03-07T07:44:54Z

@copilot What do you think about @brombomb's idea?

@brombomb

Replace the EntryRow-based filtering approach with the built-in Adw.ComboRow.set_search_match_mode(SUBSTRING) API (libadwaita >= 1.2), as suggested by @brombomb. Falls back silently on older versions. Applied to domain_combo, entity_combo, and action_combo. No extra UI rows needed — the existing search popup now matches substrings. Co-authored-by: gensyn <36128035+gensyn@users.noreply.github.com>

Copilot · 2026-03-07T07:51:19Z

@copilot What do you think about @brombomb's idea?

@brombomb's idea is the right approach — much cleaner than adding a separate EntryRow. I've switched to it in 74aca3a.

The implementation adds a small _set_substring_search() helper that calls widget.set_search_match_mode(Gtk.StringFilterMatchMode.SUBSTRING) after each ComboRow is created (applied to domain_combo, entity_combo, and action_combo). A module-level try/except import of Gtk means the code silently falls back to prefix matching on libadwaita < 1.2, with no extra UI rows and no manual filtering logic needed.

gensyn · 2026-03-07T09:33:01Z

Ah, it makes sense if this is a newer addition to ADW. I know I had a go at this years ago when I first wrote the plugin and Copilot is biased towards older code. I will try out the proposed change within the next days.

gensyn · 2026-03-07T10:42:51Z

@copilot Please fix the failing tests in your commit.

…oRow tests Add a setter to the widget property so test setup code that does combo_row.widget = Mock() works. Store the backing value in _widget (defaulting to self for the default-widget-is-self behaviour). Co-authored-by: gensyn <36128035+gensyn@users.noreply.github.com>

Copilot · 2026-03-07T10:45:17Z

@copilot Please fix the failing tests in your commit.

Fixed in 96720a0. The widget property I added to the ComboRow mock was read-only, which broke any test that does combo_row.widget = Mock() in its setup (6 tests in test_parameter_combo_row.py). Added a setter that stores the value in a _widget backing attribute (defaulting to self).

…y-search-matching

Copilot

Pull request overview

Updates the Home Assistant plugin UI to use substring-based matching for ComboRow search (so users can find entities/actions without typing the full domain prefix), while also modernizing type hints across the codebase and adjusting the unit-test mocks/CI setup to accommodate the change.

Changes:

Add _set_substring_search() helper (using set_search_match_mode(...SUBSTRING)) and apply it to domain/entity/action ComboRows.
Update test mocks + add unit tests covering _set_substring_search behavior across supported/unsupported widget capabilities.
Modernize typing annotations (e.g., Dict → dict, List → list) and adjust CI matrices.

Reviewed changes

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

Show a summary per file

File	Description
test/stream_controller_mock/src/backend/PluginManager/PluginBase.py	Updates type annotations to builtin generics for mock plugin base.
test/stream_controller_mock/GtkHelper/GenerativeUI/ComboRow.py	Extends ComboRow mock with `widget` property + setter to match production expectations.
test/backend/test_backend_get_entity.py	Updates typing and formatting in backend entity unit tests.
test/actions/perform_action/parameters/test_parameter_row.py	Fixes mutable default arg in test helper and updates typing/import cleanup.
test/actions/cores/base_core/test_base_core_create_ui_elements.py	Adds unit tests for `_set_substring_search` and imports it for testing.
backend/home_assistant_websocket.py	Modernizes typing (`dict`, `tuple`) and minor formatting in websocket client.
backend/home_assistant_backend.py	Modernizes typing and minor import/order/formatting adjustments.
actions/show_text/text_window.py	Updates typing annotations (`list`) and import ordering.
actions/show_text/text_settings.py	Updates typing annotations (`tuple`) and import ordering.
actions/show_text/text_row.py	Updates typing annotations (`list`, `dict`) and removes unused typing imports.
actions/show_text/text_helper.py	Updates typing annotations and minor formatting alignment.
actions/show_text/text_customization.py	Updates typing annotations (`tuple`, `dict`) and import ordering/spacing.
actions/show_text/text_action.py	Updates typing annotations (`list`) and formatting for constructor call.
actions/show_icon/icon_window.py	Updates typing annotations (`list`) used by the customization window.
actions/show_icon/icon_settings.py	Updates typing annotations (`tuple`) and removes unused imports.
actions/show_icon/icon_row.py	Updates typing annotations (`list`, `dict`) and removes unused typing imports.
actions/show_icon/icon_helper.py	Updates typing annotations (`dict`, `list`, `tuple`) and minor import ordering.
actions/show_icon/icon_customization.py	Updates typing annotations (`tuple`, `dict`) for customization objects.
actions/show_icon/icon_action.py	Updates typing annotations (`list`) and import ordering/formatting.
actions/perform_action/perform_settings.py	Updates typing annotations for parameters dict return type.
actions/perform_action/perform_action.py	Imports and applies `_set_substring_search` to the action ComboRow.
actions/perform_action/parameters/parameter_row.py	Minor typing/import cleanup and spacing adjustments.
actions/perform_action/parameters/parameter_combo_row.py	Updates typing annotation for `items` parameter to builtin `list`.
actions/level_dial/level_window.py	Updates typing annotations (`list`) for the customization window.
actions/level_dial/level_row.py	Updates typing annotations (`list`, `dict`) and function signature.
actions/level_dial/level_dial.py	Updates typing annotations (`dict`, `list`, `tuple`) and minor formatting.
actions/level_dial/level_customization.py	Updates typing annotations (`tuple`, `dict`) for customization objects.
actions/cores/customization_core/customization_window.py	Updates typing annotations and long import formatting.
actions/cores/customization_core/customization_settings.py	Minor formatting for long list comprehension and insert call.
actions/cores/customization_core/customization_row.py	Updates typing annotations (`list`, `dict`) and removes unused imports.
actions/cores/customization_core/customization_helper.py	Updates typing annotations (`tuple`) and minor arithmetic formatting.
actions/cores/customization_core/customization_core.py	Updates typing annotation to builtin `list[str]` for attribute list.
actions/cores/customization_core/customization.py	Updates typing annotation for `export()` return type.
actions/cores/base_core/base_core.py	Adds `_set_substring_search()` and applies it to domain/entity ComboRows.
.github/workflows/test.yml	Removes Python 3.12 from unit test matrix.
.github/workflows/pylint.yml	Removes Python 3.12 from pylint matrix.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-08T19:19:21Z

.github/workflows/test.yml

    strategy:
      matrix:
-        python-version: ["3.12", "3.13"]
+        python-version: ["3.13"]


The CI workflow drops Python 3.12 from the test matrix. If the project still intends to support 3.12 (as it did previously), this reduces coverage and can let compatibility regressions slip in. If 3.12 support is intentionally being removed, it would be good to note that explicitly in the PR description (and/or any support policy docs).

Suggested change

python-version: ["3.13"]

python-version: ["3.12", "3.13"]

Copilot · 2026-03-08T19:19:21Z

.github/workflows/pylint.yml

    strategy:
      matrix:
-        python-version: ["3.12", "3.13"]
+        python-version: ["3.13"]


The pylint workflow also removes Python 3.12 from the matrix. If 3.12 remains a supported runtime, consider keeping it here as well (or documenting the intentional support drop in the PR description).

Suggested change

python-version: ["3.13"]

python-version: ["3.12", "3.13"]

Copilot · 2026-03-08T19:19:21Z

actions/cores/base_core/base_core.py

 from GtkHelper.GenerativeUI.ComboRow import ComboRow
 from HomeAssistantPlugin.actions import const
+from gi.repository import Gtk
 from src.backend.PluginManager.ActionCore import ActionCore


+def _set_substring_search(combo_row: ComboRow) -> None:
+    """Enable substring search mode on a ComboRow if supported by the installed libadwaita version."""
+    try:
+        widget = combo_row.widget
+        if hasattr(widget, "set_search_match_mode"):
+            widget.set_search_match_mode(Gtk.StringFilterMatchMode.SUBSTRING)
+    except AttributeError:
+        pass


base_core.py imports Gtk directly at module import time and without gi.require_version('Gtk', '4.0'). This differs from the pattern used elsewhere in the repo and also contradicts the PR description about a module-level try/except for GTK to keep tests/headless imports working. Consider importing gi + calling gi.require_version before importing Gtk, and guarding the Gtk import (or moving it inside _set_substring_search) so the module can still be imported when GTK isn’t available; _set_substring_search can then no-op when Gtk is missing.

Copilot · 2026-03-08T19:19:22Z

actions/perform_action/perform_action.py

+from HomeAssistantPlugin.actions.cores.base_core.base_core import BaseCore, requires_initialization, \
+    _set_substring_search


_set_substring_search is imported from base_core into PerformAction, but the leading underscore conventionally marks it as private to its defining module. Consider renaming it to a non-underscored helper (or moving it into a small shared UI/util module) to avoid relying on a “private” symbol across modules.

Copilot

Pull request overview

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

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

actions/cores/base_core/base_core.py

Initial plan

d89c577

Copilot AI assigned Copilot and gensyn Mar 6, 2026

Copilot started work on behalf of gensyn March 6, 2026 19:13 View session

Copilot AI changed the title ~~[WIP] Improve entity search to use substring matching~~ Replace prefix-only entity search with substring matching via dedicated search entry Mar 6, 2026

Copilot finished work on behalf of gensyn March 6, 2026 19:38

gensyn mentioned this pull request Mar 6, 2026

Improve Entity Search to use Substring Matching (fuzzy/contains) instead of Prefix Matching #13

Closed

Copilot started work on behalf of gensyn March 7, 2026 07:45 View session

Copilot AI changed the title ~~Replace prefix-only entity search with substring matching via dedicated search entry~~ Replace prefix-only entity search with substring matching via set_search_match_mode Mar 7, 2026

Copilot finished work on behalf of gensyn March 7, 2026 07:51

Copilot started work on behalf of gensyn March 7, 2026 10:42 View session

Copilot finished work on behalf of gensyn March 7, 2026 10:45

gensyn added 2 commits March 8, 2026 19:47

Merge remote-tracking branch 'origin/main' into copilot/improve-entit…

6f64b2a

…y-search-matching

Removed unnecessary typing imports

30334a4

gensyn requested a review from Copilot March 8, 2026 19:15

Copilot started reviewing on behalf of gensyn March 8, 2026 19:15 View session

Copilot AI reviewed Mar 8, 2026

View reviewed changes

Changes to adhere to Python best practices

1cc4846

gensyn requested a review from Copilot March 9, 2026 07:35

Copilot started reviewing on behalf of gensyn March 9, 2026 07:35 View session

Copilot AI reviewed Mar 9, 2026

View reviewed changes

actions/cores/base_core/base_core.py Show resolved Hide resolved

gensyn marked this pull request as ready for review March 9, 2026 07:41

gensyn merged commit 2ffddc9 into main Mar 9, 2026
6 checks passed

gensyn deleted the copilot/improve-entity-search-matching branch March 9, 2026 15:02

		from HomeAssistantPlugin.actions.cores.base_core.base_core import BaseCore, requires_initialization, \
		_set_substring_search

Conversation

Copilot AI commented Mar 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comments on the Issue (you are @copilot in this section)

Uh oh!

brombomb commented Mar 7, 2026

Uh oh!

gensyn commented Mar 7, 2026

Uh oh!

Copilot AI commented Mar 7, 2026

Uh oh!

gensyn commented Mar 7, 2026

Uh oh!

gensyn commented Mar 7, 2026

Uh oh!

Copilot AI commented Mar 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Mar 6, 2026 •

edited

Loading