Skip to content

web

sleap.gui.web

Module for checking for new releases on GitHub.

Classes:

Name Description
Release
ReleaseChecker

Checker for new releases of SLEAP on GitHub.

Functions:

Name Description
filter_test_releases

Filter test releases out of a list of Releases.
get_analytics_data

Gather data to be transmitted to analytics backend.
ping_analytics

Ping analytics service with anonymous usage data.

Release

Methods:

Name Description
from_json

Construct a release from a JSON-decoded response.
Source code in sleap/gui/web.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
@attr.s(auto_attribs=True)
class Release:
    title: str = attr.ib(order=False)
    version: str = attr.ib(order=False)
    prerelease: bool = attr.ib(order=False)
    date: pd.Timestamp
    url: str = attr.ib(order=False)
    description: str = attr.ib(order=False)

    @classmethod
    def from_json(cls, data: Dict) -> "Release":
        """Construct a release from a JSON-decoded response."""
        return cls(
            title=data["name"],
            version=data["tag_name"],
            prerelease=data["prerelease"],
            date=pd.to_datetime(data["published_at"]),
            url=data["html_url"],
            description=data["body"],
        )

from_json(data) classmethod

Construct a release from a JSON-decoded response.

Source code in sleap/gui/web.py 
22
23
24
25
26
27
28
29
30
31
32
@classmethod
def from_json(cls, data: Dict) -> "Release":
    """Construct a release from a JSON-decoded response."""
    return cls(
        title=data["name"],
        version=data["tag_name"],
        prerelease=data["prerelease"],
        date=pd.to_datetime(data["published_at"]),
        url=data["html_url"],
        description=data["body"],
    )

ReleaseChecker

Checker for new releases of SLEAP on GitHub.

This uses the GitHub REST API: https://docs.github.com/en/rest/releases/releases#list-releases

Attributes:

Name Type Description
repo_id str

The name of the repository (defaults to: "talmolab/sleap")
releases List[Release]

A list of Releases from querying GitHub.
checked bool

Indicates whether the releases page has been checked.

Methods:

Name Description
check_for_releases

Check online for new releases.
get_release

Get a release by version tag string.
Source code in sleap/gui/web.py 
 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
@attr.s(auto_attribs=True)
class ReleaseChecker:
    """Checker for new releases of SLEAP on GitHub.

    This uses the GitHub REST API:
    https://docs.github.com/en/rest/releases/releases#list-releases

    Attributes:
        repo_id: The name of the repository (defaults to: "talmolab/sleap")
        releases: A list of `Release`s from querying GitHub.
        checked: Indicates whether the releases page has been checked.
    """

    repo_id: str = REPO_ID
    releases: List[Release] = attr.ib(factory=list, converter=filter_test_releases)
    checked: bool = attr.ib(default=False, init=False)

    def check_for_releases(self) -> bool:
        """Check online for new releases.

        Returns:
            `True` if new releases were found, or `False` if no new releases or was not
            able to connect to the web.
        """
        try:
            self.checked = True
            response = requests.get(
                f"https://api.github.com/repos/{self.repo_id}/releases"
            )
        except (requests.ConnectionError, requests.Timeout):
            return False

        try:
            self.releases = [Release.from_json(r) for r in response.json()]
        except Exception:
            return False

        return True

    @property
    def latest_release(self) -> Release:
        """Return latest release."""
        if not self.checked:
            self.check_for_releases()
        releases = sorted(self.releases)
        if len(releases) == 0:
            return None
        else:
            return releases[-1]

    @property
    def latest_stable(self) -> Release:
        """Return latest stable release."""
        if not self.checked:
            self.check_for_releases()
        releases = sorted([rls for rls in self.releases if not rls.prerelease])
        if len(releases) == 0:
            return None
        else:
            return releases[-1]

    @property
    def latest_prerelease(self) -> Release:
        """Return latest prerelease."""
        if not self.checked:
            self.check_for_releases()
        releases = sorted([rls for rls in self.releases if rls.prerelease])
        if len(releases) == 0:
            return None
        else:
            return releases[-1]

    def get_release(self, version: str) -> Release:
        """Get a release by version tag string.

        Args:
            version: Release version tag (e.g., "v1.0.9")

        Returns:
            The `Release` object with the associated version number.
        """
        if not self.checked:
            self.check_for_releases()

        for rls in self.releases:
            if rls.version == version:
                return rls

        raise ValueError(
            f"Release version was not found: {version}. "
            "Check the page online for a full listing: "
            f"https://github.com/{self.repo_id}"
        )

latest_prerelease property

Return latest prerelease.

latest_release property

Return latest release.

latest_stable property

Return latest stable release.

check_for_releases()

Check online for new releases.

Returns:

Type Description
bool

True if new releases were found, or False if no new releases or was not able to connect to the web.
Source code in sleap/gui/web.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def check_for_releases(self) -> bool:
    """Check online for new releases.

    Returns:
        `True` if new releases were found, or `False` if no new releases or was not
        able to connect to the web.
    """
    try:
        self.checked = True
        response = requests.get(
            f"https://api.github.com/repos/{self.repo_id}/releases"
        )
    except (requests.ConnectionError, requests.Timeout):
        return False

    try:
        self.releases = [Release.from_json(r) for r in response.json()]
    except Exception:
        return False

    return True

get_release(version)

Get a release by version tag string.

Parameters:

Name Type Description Default
version str

Release version tag (e.g., "v1.0.9")

 required

Returns:

Type Description
Release

The Release object with the associated version number.
Source code in sleap/gui/web.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def get_release(self, version: str) -> Release:
    """Get a release by version tag string.

    Args:
        version: Release version tag (e.g., "v1.0.9")

    Returns:
        The `Release` object with the associated version number.
    """
    if not self.checked:
        self.check_for_releases()

    for rls in self.releases:
        if rls.version == version:
            return rls

    raise ValueError(
        f"Release version was not found: {version}. "
        "Check the page online for a full listing: "
        f"https://github.com/{self.repo_id}"
    )

filter_test_releases(releases)

Filter test releases out of a list of Releases.

Parameters:

Name Type Description Default
releases List[Release]

A list of Releases.

 required

Returns:

Type Description
List[Release]

The filtered list of Releases. Any Release that has a description containing the string "Do not use this release. This is a test." will be excluded.
Source code in sleap/gui/web.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def filter_test_releases(releases: List[Release]) -> List[Release]:
    """Filter test releases out of a list of `Release`s.

    Args:
        releases: A list of `Release`s.

    Returns:
        The filtered list of `Release`s. Any `Release` that has a description
        containing the string `"Do not use this release. This is a test."` will be
        excluded.
    """
    # Exclude releases tagged with test string.
    return [
        rls
        for rls in releases
        if "Do not use this release. This is a test." not in rls.description
    ]

get_analytics_data()

Gather data to be transmitted to analytics backend.

Source code in sleap/gui/web.py 
149
150
151
152
153
154
155
156
157
158
159
160
161
def get_analytics_data() -> Dict[str, Any]:
    """Gather data to be transmitted to analytics backend."""
    import os
    import sleap
    from pathlib import Path
    import platform

    return {
        "sleap_version": sleap.__version__,
        "python_version": platform.python_version(),
        "conda_env": Path(os.environ.get("CONDA_PREFIX", "")).stem,
        "platform": platform.platform(),
    }

ping_analytics()

Ping analytics service with anonymous usage data.

Notes

This only gets called when the GUI starts and obeys user preferences for data collection.

See https://docs.sleap.ai/latest/help/#usage for more information.

Source code in sleap/gui/web.py 
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
def ping_analytics():
    """Ping analytics service with anonymous usage data.

    Notes:
        This only gets called when the GUI starts and obeys user preferences for data
        collection.

        See https://docs.sleap.ai/latest/help/#usage for more information.
    """
    import threading

    analytics_data = get_analytics_data()

    def _ping_analytics():
        try:
            requests.post(
                ANALYTICS_ENDPOINT,
                json=analytics_data,
            )
        except (requests.ConnectionError, requests.Timeout):
            pass

    # Fire and forget.
    threading.Thread(target=_ping_analytics).start()