Skip to content

common_version.py

SpyglassVersions

Bases: Manual

Track available Spyglass versions.

This table is populated with the current Spyglass version from PyPI. It is used to check if the current version is outdated based on letting the user be behind by a certain number of versions. Default is 1. If a developer is interested in adjusting this value, please submit a GitHub issue.

An alternative approach would track minor vs patch versions.

Source code in src/spyglass/common/common_version.py 
 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
@schema
class SpyglassVersions(dj.Manual):
    """Track available Spyglass versions.

    This table is populated with the current Spyglass version from PyPI. It is
    used to check if the current version is outdated based on letting the user
    be behind by a certain number of versions. Default is 1. If a developer is
    interested in adjusting this value, please submit a GitHub issue.

    An alternative approach would track minor vs patch versions.
    """

    definition = """
    version: varchar(16) # Spyglass version
    ---
    release_date: date   # Release date
    """

    def fetch_from_pypi(self) -> None:
        """Populate SpyglassVersion table with the current version."""
        response = requests.get("https://pypi.org/pypi/spyglass-neuro/json")

        if not response.ok:
            logger.error(f"Failed to fetch info from PyPI: {response.reason}")
            return

        versions = response.json()["releases"]
        inserts = [
            {"version": version, "release_date": releases[0]["upload_time"]}
            for version, releases in versions.items()
            if releases and "a" not in version and "b" not in version
        ]  # Skip alpha and beta versions

        self.insert(inserts, skip_duplicates=True)

    @property
    def env_var(self) -> bool:
        """Get SPYGLASS_UPDATED environment variable."""
        return str_to_bool(os_environ.get("SPYGLASS_UPDATED", "false"))

    @cached_property
    def is_up_to_date(self) -> bool:
        """Check if the current Spyglass version is up to date.

        Returns
        -------
        bool
            True if the current Spyglass version is up to date, False otherwise.
        """
        if self.env_var:
            return True

        return self.check_updated(allowed_versions_behind=1)

    def check_updated(self, allowed_versions_behind=1) -> bool:
        """Check if the current Spyglass version is updated.

        Parameters
        ----------
        allowed_versions_behind: int, optional
            Number of versions behind to consider up to date. Default is 1.

        Returns
        -------
        bool
            True if the current Spyglass version is up to date.

        Raises
        ------
        RuntimeError
            If the current Spyglass version is outdated.
        """
        if self.env_var:
            return True

        if not len(self):  # Assume populated means updated via weekly cron
            self.fetch_from_pypi()

        earliest_permit = self.fetch(
            "version",
            order_by="release_date DESC",
            limit=allowed_versions_behind + 1,
        )[-1]

        if version_parse(sg_verion) >= version_parse(earliest_permit):
            logger.info(
                f"Spyglass version {sg_verion} is up to date. "
                + f"Latest version is {earliest_permit}."
            )
            os_environ["SPYGLASS_UPDATED"] = "true"
            return True

        raise RuntimeError(
            f"Please upgrade Spyglass version.\n\tHave: {sg_verion}\n\t"
            + f"\n\tNeed: {earliest_permit} or later"
        )

fetch_from_pypi()

Populate SpyglassVersion table with the current version.

Source code in src/spyglass/common/common_version.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def fetch_from_pypi(self) -> None:
    """Populate SpyglassVersion table with the current version."""
    response = requests.get("https://pypi.org/pypi/spyglass-neuro/json")

    if not response.ok:
        logger.error(f"Failed to fetch info from PyPI: {response.reason}")
        return

    versions = response.json()["releases"]
    inserts = [
        {"version": version, "release_date": releases[0]["upload_time"]}
        for version, releases in versions.items()
        if releases and "a" not in version and "b" not in version
    ]  # Skip alpha and beta versions

    self.insert(inserts, skip_duplicates=True)

env_var property

Get SPYGLASS_UPDATED environment variable.

is_up_to_date cached property

Check if the current Spyglass version is up to date.

Returns:

Type Description
bool

True if the current Spyglass version is up to date, False otherwise.

check_updated(allowed_versions_behind=1)

Check if the current Spyglass version is updated.

Parameters:

Name Type Description Default
allowed_versions_behind

Number of versions behind to consider up to date. Default is 1.

 1

Returns:

Type Description
bool

True if the current Spyglass version is up to date.

Raises:

Type Description
RuntimeError

If the current Spyglass version is outdated.
Source code in src/spyglass/common/common_version.py 
 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
def check_updated(self, allowed_versions_behind=1) -> bool:
    """Check if the current Spyglass version is updated.

    Parameters
    ----------
    allowed_versions_behind: int, optional
        Number of versions behind to consider up to date. Default is 1.

    Returns
    -------
    bool
        True if the current Spyglass version is up to date.

    Raises
    ------
    RuntimeError
        If the current Spyglass version is outdated.
    """
    if self.env_var:
        return True

    if not len(self):  # Assume populated means updated via weekly cron
        self.fetch_from_pypi()

    earliest_permit = self.fetch(
        "version",
        order_by="release_date DESC",
        limit=allowed_versions_behind + 1,
    )[-1]

    if version_parse(sg_verion) >= version_parse(earliest_permit):
        logger.info(
            f"Spyglass version {sg_verion} is up to date. "
            + f"Latest version is {earliest_permit}."
        )
        os_environ["SPYGLASS_UPDATED"] = "true"
        return True

    raise RuntimeError(
        f"Please upgrade Spyglass version.\n\tHave: {sg_verion}\n\t"
        + f"\n\tNeed: {earliest_permit} or later"
    )