Keyboard shortcuts by osn07 · Pull Request #134 · toolsforexperiments/instrumentserver

osn07 · 2026-05-07T02:31:48Z

Adds customizable keyboard shortcuts that a user can execute to streamline instrumentserver workflow

…es a user's individual shortcut preferences. ShortcutEditorDialog handles UI interactions and updates a KSM class instance accordingly. base_instrument.py was updated to implement these new classes and add a button to edit keyboard shortcuts.

…to Station or Log. alert column on right side indicates three states: ok (white), unsaved (orange), and duplicate (red). alert displays tooltip for each tooltip. ServerGui now holds a shortcut editor and shortcut manager, which is passed to an instrument tab when opened.

marcosfrenkel · 2026-05-07T17:50:17Z


    @staticmethod
-    def _matches_any_pattern(name: str, patterns: List[str]) -> bool:
+    def _matches_any_pattern(name: str, patterns: Optional[List[str]]) -> bool:


why add the Optional but not a None argument? is this really optional?

marcosfrenkel · 2026-05-07T17:51:27Z


        # Indicates if a column is using delegates.
-        self.delegateColumns = delegateColumns
+        self.delegateColumns: List[int] = delegateColumns or []


does changing the default change the behaviour downstream?

the default set in the param list is None. the variable is used later in for loops, but if it is None, will this not raise an error? if it is empty, the loop will just exit immediately

marcosfrenkel · 2026-05-07T17:55:17Z

+    when Save is clicked. Use 'Save to file' / 'Load from file' to persist across sessions.
+
+    Each row has a small colored indicator dot in the rightmost column:
+      - white : saved and unique


I haven't been able to make it white even when saved

is it transparent? it just looks normal to me

marcosfrenkel · 2026-05-07T21:24:14Z

+            else QtCore.Qt.SortOrder.DescendingOrder
+        )
+        header.setSortIndicator(col, new_order)
+


why do we need all these new slots?

I removed the first three and refactored the code accordingly. As for the final four, they act as thin wrappers. They need to resolve what the currently selected item is to execute, something the right-click (for trash/star item) implicitly does

why was the refactor needed though?

marcosfrenkel · 2026-05-07T21:26:52Z

On top of the specific coding things 2 things are left on this:

Make sure we can fully navigate the interface with arrow keys; being able to press the right arrow key and edit the value of a parameter directly.
Make the config aspect of the shortcuts be in the config of the server itself instead of having its own dedicated file

…back

…lso, removed 'Save' button, so only can save to file

marcosfrenkel · 2026-05-26T20:33:47Z

A few things that should probably become issues:

when hovering over buttons, there should be the hotkey in parenthesis.
the shortcuts seem to be applying to the functions/parameters sections inconsistently

marcosfrenkel · 2026-05-26T18:33:23Z

            modelKwargs["sub_port"] = kwargs.pop("sub_port")

+        shortcutManager = kwargs.pop("shortcutManager", None)
+        print(shortcutManager)


Remove print statement

marcosfrenkel · 2026-05-26T20:08:07Z

+        if not patterns:
+            return False
        for pattern in patterns:


Patterns is a list of strings, how is not [] different than iterating over []?

marcosfrenkel · 2026-05-26T20:10:59Z

    @QtCore.Slot()
-    def promoteStar(self) -> None:
-        self.proxyModel.onToggleStar()
+    def _starCurrentItem(self) -> None:
+        proxy_index = self.view.currentIndex()
+        if not proxy_index.isValid():
+            return
+        source_index = self.proxyModel.mapToSource(proxy_index)
+        if source_index.column() != 0:
+            source_index = source_index.sibling(source_index.row(), 0)
+        item = self.model.itemFromIndex(source_index)
+        if isinstance(item, ItemBase):
+            self.view.lastSelectedItem = item
+            self.view.itemStarToggle.emit(item)

    @QtCore.Slot()
-    def refreshAll(self) -> None:
-        self.model.refreshAll()
+    def _trashCurrentItem(self) -> None:
+        proxy_index = self.view.currentIndex()
+        if not proxy_index.isValid():
+            return
+        source_index = self.proxyModel.mapToSource(proxy_index)
+        if source_index.column() != 0:
+            source_index = source_index.sibling(source_index.row(), 0)
+        item = self.model.itemFromIndex(source_index)
+        if isinstance(item, ItemBase):
+            self.view.lastSelectedItem = item
+            self.view.itemTrashToggle.emit(item)


why are these 2 functions, instead of being the same one with a flag for star/trash? all the code is exactly the same except the last line

marcosfrenkel · 2026-05-26T20:11:32Z

+            else QtCore.Qt.SortOrder.DescendingOrder
+        )
+        header.setSortIndicator(col, new_order)
+


why was the refactor needed though?

marcosfrenkel · 2026-05-26T20:17:38Z

+
+from instrumentserver import QtCore, QtGui, QtWidgets, getInstrumentserverPath
+
+_ICON_DIR = getInstrumentserverPath("resource", "icons")


Load icons the same way we do in the rest of the project:

instrumentserver/src/instrumentserver/gui/base_instrument.py

Line 570 in b9a7eb5

self.starIcon = QtGui.QIcon(":/icons/star.svg")

marcosfrenkel · 2026-05-26T20:24:58Z

+    when Save is clicked. Use 'Save to file' / 'Load from file' to persist across sessions.
+
+    Each row has a small colored indicator dot in the rightmost column:
+      - white : saved and unique


is it transparent? it just looks normal to me

osn07 added 4 commits May 4, 2026 22:57

added more shortcuts and implemented there backend actions

1c205a4

ruff edits v2

c64a489

osn07 force-pushed the keyboard-shortcuts branch from 2525bff to c64a489 Compare May 7, 2026 04:03

marcosfrenkel requested changes May 7, 2026

View reviewed changes

osn07 added 7 commits May 18, 2026 17:25

shortcuts now stored in server config file instead of separate JSON file

b618362

can now click right to jump focus to parameters value. addressed feed…

d0ffee5

…back

getting tests to pass part 1

e87e19c

getting tests to pass part 2

741af7a

getting tests to pass part 3

aaa8386

forgot to commit base instrument. part 4

b087eec

rewrote tests because loadConfig now returns 7 values instead of 6. a…

f918010

…lso, removed 'Save' button, so only can save to file

marcosfrenkel requested changes May 26, 2026

View reviewed changes


		from instrumentserver import QtCore, QtGui, QtWidgets, getInstrumentserverPath

		_ICON_DIR = getInstrumentserverPath("resource", "icons")

Conversation

osn07 commented May 7, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcosfrenkel commented May 7, 2026

Uh oh!

marcosfrenkel commented May 26, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants