-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Releases/v1.26.0 branch: Implementation of SDK Version comparison for…
… API's (#60) * ENG-3221: Adding release version checks to SDK API's * Fixed syntax errors and decorator use * Resolved all type-checking errors in the recently added file '_Version.py' * Moved _version.py to smsdk folder * Updated mypy.ini * Addressing review feedback: 1) Refactored code to replace the global variable with a class attribute. 2) Implemented sorting of GitHub releases to obtain the latest version. * Addressing the code review comments. --------- Co-authored-by: JMkrish <[email protected]>
- Loading branch information
Showing
6 changed files
with
162 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Change Log | ||
|
|
||
| ## v1.26.0 | ||
|
|
||
| --- | ||
| 1. Added release version checks for API's | ||
| 2. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| # | ||
| """ | ||
| Track version information for sightmachine-sdk module here. | ||
| """ | ||
| import datetime | ||
| import typing as t_ | ||
| import itertools | ||
| import requests | ||
| import warnings | ||
| import functools | ||
| import re | ||
|
|
||
|
|
||
| class VersionInfo(t_.NamedTuple): | ||
| major: int | ||
| minor: int | ||
| patchlevel: int | ||
| releaselevel: t_.Optional[str] | ||
| serial: t_.Optional[int] | ||
|
|
||
| def __str__(self) -> str: | ||
| result = "".join( | ||
| itertools.chain( | ||
| ".".join(str(i) for i in self[:3] if i is not None), | ||
| (str(i) for i in self[3:] if i is not None), | ||
| ) | ||
| ) | ||
| return result | ||
|
|
||
|
|
||
| version_info = VersionInfo(1, 26, 0, "", None) | ||
| version = str(f"v{version_info}") | ||
|
|
||
|
|
||
| def sort_releases_descending( | ||
| releases: t_.List[t_.Dict[str, t_.Any]] | ||
| ) -> t_.List[t_.Dict[str, t_.Any]]: | ||
| def version_key(release: t_.Dict[str, t_.Any]) -> t_.List[t_.Union[int, str]]: | ||
| return [ | ||
| (int(i) if i.isdigit() else i) | ||
| for i in re.split(r"(\d+|\W+)", release["tag_name"].lower()) | ||
| if i | ||
| ] | ||
|
|
||
| return ( | ||
| sorted(releases, key=version_key, reverse=True) | ||
| if len(releases) > 1 | ||
| else releases | ||
| ) | ||
|
|
||
|
|
||
| def get_latest_release_version( | ||
| releases: t_.List[t_.Dict[str, t_.Any]] | ||
| ) -> t_.Optional[t_.Any]: | ||
| if releases: | ||
| sorted_releases = sort_releases_descending(releases) | ||
| return sorted_releases[0]["tag_name"] | ||
| return None | ||
|
|
||
|
|
||
| def get_latest_sdk_release() -> t_.Optional[t_.Any]: | ||
| api_url = f"https://api.github.com/repos/{owner}/{repo}/releases" | ||
|
|
||
| try: | ||
| response = requests.get(api_url, timeout=10) | ||
| response.raise_for_status() # To raise an HTTPError for any bad responses | ||
| releases = response.json() | ||
|
|
||
| if releases: | ||
| return get_latest_release_version(releases) | ||
| except requests.RequestException as e: | ||
| print(f"Error fetching latest SDK release: {e}") | ||
|
|
||
| return None | ||
|
|
||
|
|
||
| class VersionCheckDecorator: | ||
| api_version_printed = False | ||
| last_version_check_time = None | ||
|
|
||
| @classmethod | ||
| def version_check_decorator(cls, func: t_.Any) -> t_.Any: | ||
| @functools.wraps(func) | ||
| def wrapper(*args: t_.Any, **kwargs: t_.Any) -> t_.Any: | ||
| current_time = datetime.datetime.now() | ||
|
|
||
| # Check if a week has passed since the last version check | ||
| if cls.last_version_check_time is None or ( | ||
| current_time - cls.last_version_check_time > datetime.timedelta(days=7) | ||
| ): | ||
| cls.api_version_printed = False | ||
| cls.last_version_check_time = current_time | ||
|
|
||
| if not cls.api_version_printed: | ||
| latest_sdk_release = get_latest_sdk_release() | ||
| installed_sdk_release = version | ||
|
|
||
| if ( | ||
| installed_sdk_release is not None | ||
| and latest_sdk_release is not None | ||
| and latest_sdk_release != installed_sdk_release | ||
| ): | ||
| warnings.warn( | ||
| f"Installed SDK Version: {installed_sdk_release}. " | ||
| f"It is recommended to install release version ({latest_sdk_release}).", | ||
| DeprecationWarning, | ||
| ) | ||
| cls.api_version_printed = True | ||
|
|
||
| return func(*args, **kwargs) | ||
|
|
||
| return wrapper | ||
|
|
||
|
|
||
| # Initialize the flag to False | ||
| api_version_printed = False | ||
|
|
||
| owner = "sightmachine" | ||
| repo = "sightmachine-sdk" | ||
|
|
||
| # Define version_check_decorator here | ||
| version_check_decorator = VersionCheckDecorator.version_check_decorator |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters