Skip to content

prefs

sleap.prefs

Handles SLEAP preferences.

Importing this module creates prefs, instance of Preferences class.

Classes:

Name Description
Preferences

Class for accessing SLEAP preferences.

Preferences

Bases: object

Class for accessing SLEAP preferences.

Methods:

Name Description
load

Load preferences from file, if not already loaded.
load_

Load preferences from file (regardless of whether loaded already).
reset_to_default

Reset preferences to default.
save

Save preferences to file.
Source code in sleap/prefs.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
class Preferences(object):
    """Class for accessing SLEAP preferences."""

    _prefs = None
    _defaults = {
        "medium step size": 10,
        "large step size": 100,
        "color predicted": False,
        "propagate track labels": True,
        "palette": "standard",
        "bold lines": False,
        "trail length": 0,
        "trail shade": "Normal",
        "trail width": 4.0,
        "trail node count": 1,
        "marker size": 4,
        "edge style": "Line",
        "window state": b"",
        "node label size": 12,
        "show non-visible nodes": True,
        "share usage data": True,
        "node marker sizes": (1, 2, 3, 4, 6, 8, 12),
        "node label sizes": (6, 9, 12, 18, 24, 36),
    }
    _filename = "preferences.yaml"

    def __init__(self):
        self.load()

    def load(self):
        """Load preferences from file, if not already loaded."""
        if self._prefs is None:
            self.load_()

    def load_(self):
        """Load preferences from file (regardless of whether loaded already)."""
        try:
            self._prefs = util.get_config_yaml(self._filename)
        except FileNotFoundError:
            pass

        self._prefs = self._prefs or {}

        for k, v in self._defaults.items():
            if k not in self._prefs:
                self._prefs[k] = v

    def save(self):
        """Save preferences to file."""
        util.save_config_yaml(self._filename, self._prefs)

    def reset_to_default(self):
        """Reset preferences to default."""
        util.save_config_yaml(self._filename, self._defaults)
        self.load()

    def _validate_key(self, key):
        if key not in self._defaults:
            raise KeyError(f"No preference matching '{key}'")

    def __contains__(self, item) -> bool:
        return item in self._defaults

    def __getitem__(self, key):
        self.load()
        self._validate_key(key)
        return self._prefs.get(key, self._defaults[key])

    def __setitem__(self, key, value):
        self.load()
        self._validate_key(key)
        self._prefs[key] = value

load()

Load preferences from file, if not already loaded.

Source code in sleap/prefs.py 
39
40
41
42
def load(self):
    """Load preferences from file, if not already loaded."""
    if self._prefs is None:
        self.load_()

load_()

Load preferences from file (regardless of whether loaded already).

Source code in sleap/prefs.py 
44
45
46
47
48
49
50
51
52
53
54
55
def load_(self):
    """Load preferences from file (regardless of whether loaded already)."""
    try:
        self._prefs = util.get_config_yaml(self._filename)
    except FileNotFoundError:
        pass

    self._prefs = self._prefs or {}

    for k, v in self._defaults.items():
        if k not in self._prefs:
            self._prefs[k] = v

reset_to_default()

Reset preferences to default.

Source code in sleap/prefs.py 
61
62
63
64
def reset_to_default(self):
    """Reset preferences to default."""
    util.save_config_yaml(self._filename, self._defaults)
    self.load()

save()

Save preferences to file.

Source code in sleap/prefs.py 
57
58
59
def save(self):
    """Save preferences to file."""
    util.save_config_yaml(self._filename, self._prefs)