Skip to content

shortcuts

sleap.gui.shortcuts

Class for accessing/setting keyboard shortcuts.

Classes:

Name Description
Shortcuts

Class for accessing keyboard shortcuts.

Shortcuts

Bases: object

Class for accessing keyboard shortcuts.

Shortcuts are saved in sleap/config/shortcuts.yaml

When instantiated, this reads in the shortcuts from the file.

Methods:

Name Description
__getitem__

Returns shortcut value, accessed by range, index, or key.
__len__

Returns number of shortcuts.
__setitem__

Sets shortcut by index.
reset_to_default

Reset shortcuts to default and save.
save

Saves all shortcuts to shortcut file.
Source code in sleap/gui/shortcuts.py 
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
class Shortcuts(object):
    """
    Class for accessing keyboard shortcuts.

    Shortcuts are saved in `sleap/config/shortcuts.yaml`

    When instantiated, this reads in the shortcuts from the file.
    """

    _shortcuts = None
    _names = (
        "new",
        "open",
        "save",
        "save as",
        "close",
        "add videos",
        "next video",
        "prev video",
        "goto frame",
        "select to frame",
        "add instance",
        "delete instance",
        "delete track",
        "transpose",
        "select next",
        "clear selection",
        "goto next labeled",
        "goto prev labeled",
        "goto last interacted",
        "goto next user",
        "goto next suggestion",
        "goto prev suggestion",
        "goto next track spawn",
        "show instances",
        "show labels",
        "show edges",
        "show trails",
        "color predicted",
        "fit",
        "learning",
        "export clip",
        "delete frame predictions",
        "delete clip predictions",
        "delete area predictions",
        "frame next",
        "frame prev",
        "frame next medium step",
        "frame prev medium step",
        "frame next large step",
        "frame prev large step",
        "export_analysis_current",
    )

    def __init__(self):
        shortcuts = util.get_config_yaml("shortcuts.yaml")
        defaults = util.get_config_yaml("shortcuts.yaml", get_defaults=True)

        self._shortcuts = self._process_shortcut_dict(shortcuts)
        self._defaults = self._process_shortcut_dict(defaults)

    def _process_shortcut_dict(self, shortcuts: dict) -> dict:
        for action in shortcuts.keys():
            # Ignore shortcuts which aren't in currently supported list
            if action not in self._names:
                continue

            # Use "" if there's no shortcut set
            key_string = shortcuts.get(action, None)
            key_string = "" if key_string is None else key_string

            if not key_string.strip():
                shortcuts[action] = ""
                continue

            try:
                shortcuts[action] = eval(key_string)
            except Exception:
                shortcuts[action] = QKeySequence.fromString(key_string)
        return shortcuts

    def save(self):
        """Saves all shortcuts to shortcut file."""
        data = dict()
        for key, val in self._shortcuts.items():
            # Only save shortcuts with names in supported list
            if key not in self._names:
                continue

            data[key] = val.toString() if isinstance(val, QKeySequence) else val

        util.save_config_yaml("shortcuts.yaml", data)

    def reset_to_default(self):
        """Reset shortcuts to default and save."""
        self._shortcuts = util.get_config_yaml("shortcuts.yaml", get_defaults=True)
        self.save()

    def __getitem__(self, idx: Union[slice, int, str]) -> Union[str, Dict[str, str]]:
        """
        Returns shortcut value, accessed by range, index, or key.

        Args:
            idx: Index (range, int, or str) of shortcut to access.

        Returns:
            If idx is int or string, then return value is the shortcut string.
            If idx is range, then return value is dictionary in which keys
            are shortcut name and value are shortcut strings.
        """
        if isinstance(idx, slice):
            # dict with names and values
            return {self._names[i]: self[i] for i in range(*idx.indices(len(self)))}
        elif isinstance(idx, int):
            # value
            idx = self._names[idx]
            return self[idx]

        # if idx not in self._names:
        #     print(f"No shortcut matching '{idx}'")

        return self._shortcuts.get(idx, self._defaults.get(idx, ""))

    def __setitem__(self, idx: Union[str, int], val: str):
        """Sets shortcut by index."""
        if type(idx) == int:
            key = self._names[idx]
            self[key] = val
        else:
            if idx not in self._names:
                raise KeyError(f"No shortcut matching '{idx}'")

            self._shortcuts[idx] = val

    def __len__(self):
        """Returns number of shortcuts."""
        return len(self._names)

__getitem__(idx)

Returns shortcut value, accessed by range, index, or key.

Parameters:

Name Type Description Default
idx Union[slice, int, str]

Index (range, int, or str) of shortcut to access.

 required

Returns:

Type Description
Union[str, Dict[str, str]]

If idx is int or string, then return value is the shortcut string. If idx is range, then return value is dictionary in which keys are shortcut name and value are shortcut strings.
Source code in sleap/gui/shortcuts.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def __getitem__(self, idx: Union[slice, int, str]) -> Union[str, Dict[str, str]]:
    """
    Returns shortcut value, accessed by range, index, or key.

    Args:
        idx: Index (range, int, or str) of shortcut to access.

    Returns:
        If idx is int or string, then return value is the shortcut string.
        If idx is range, then return value is dictionary in which keys
        are shortcut name and value are shortcut strings.
    """
    if isinstance(idx, slice):
        # dict with names and values
        return {self._names[i]: self[i] for i in range(*idx.indices(len(self)))}
    elif isinstance(idx, int):
        # value
        idx = self._names[idx]
        return self[idx]

    # if idx not in self._names:
    #     print(f"No shortcut matching '{idx}'")

    return self._shortcuts.get(idx, self._defaults.get(idx, ""))

__len__()

Returns number of shortcuts.

Source code in sleap/gui/shortcuts.py 
144
145
146
def __len__(self):
    """Returns number of shortcuts."""
    return len(self._names)

__setitem__(idx, val)

Sets shortcut by index.

Source code in sleap/gui/shortcuts.py 
133
134
135
136
137
138
139
140
141
142
def __setitem__(self, idx: Union[str, int], val: str):
    """Sets shortcut by index."""
    if type(idx) == int:
        key = self._names[idx]
        self[key] = val
    else:
        if idx not in self._names:
            raise KeyError(f"No shortcut matching '{idx}'")

        self._shortcuts[idx] = val

reset_to_default()

Reset shortcuts to default and save.

Source code in sleap/gui/shortcuts.py 
103
104
105
106
def reset_to_default(self):
    """Reset shortcuts to default and save."""
    self._shortcuts = util.get_config_yaml("shortcuts.yaml", get_defaults=True)
    self.save()

save()

Saves all shortcuts to shortcut file.

Source code in sleap/gui/shortcuts.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def save(self):
    """Saves all shortcuts to shortcut file."""
    data = dict()
    for key, val in self._shortcuts.items():
        # Only save shortcuts with names in supported list
        if key not in self._names:
            continue

        data[key] = val.toString() if isinstance(val, QKeySequence) else val

    util.save_config_yaml("shortcuts.yaml", data)