diff options
author | H Lohaus <hlohaus@users.noreply.github.com> | 2024-01-14 15:32:51 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-14 15:32:51 +0100 |
commit | 1ca80ed48b55d6462b4bd445e66d4f7de7442c2b (patch) | |
tree | 05a94b53b83461b8249de965e093b4fd3722e2d1 /g4f/version.py | |
parent | Merge pull request #1466 from hlohaus/upp (diff) | |
parent | Change doctypes style to Google (diff) | |
download | gpt4free-1ca80ed48b55d6462b4bd445e66d4f7de7442c2b.tar gpt4free-1ca80ed48b55d6462b4bd445e66d4f7de7442c2b.tar.gz gpt4free-1ca80ed48b55d6462b4bd445e66d4f7de7442c2b.tar.bz2 gpt4free-1ca80ed48b55d6462b4bd445e66d4f7de7442c2b.tar.lz gpt4free-1ca80ed48b55d6462b4bd445e66d4f7de7442c2b.tar.xz gpt4free-1ca80ed48b55d6462b4bd445e66d4f7de7442c2b.tar.zst gpt4free-1ca80ed48b55d6462b4bd445e66d4f7de7442c2b.zip |
Diffstat (limited to '')
-rw-r--r-- | g4f/version.py | 93 |
1 files changed, 84 insertions, 9 deletions
diff --git a/g4f/version.py b/g4f/version.py index bb4b7f17..9201c75c 100644 --- a/g4f/version.py +++ b/g4f/version.py @@ -5,45 +5,120 @@ from importlib.metadata import version as get_package_version, PackageNotFoundEr from subprocess import check_output, CalledProcessError, PIPE from .errors import VersionNotFoundError +def get_pypi_version(package_name: str) -> str: + """ + Retrieves the latest version of a package from PyPI. + + Args: + package_name (str): The name of the package for which to retrieve the version. + + Returns: + str: The latest version of the specified package from PyPI. + + Raises: + VersionNotFoundError: If there is an error in fetching the version from PyPI. + """ + try: + response = requests.get(f"https://pypi.org/pypi/{package_name}/json").json() + return response["info"]["version"] + except requests.RequestException as e: + raise VersionNotFoundError(f"Failed to get PyPI version: {e}") + +def get_github_version(repo: str) -> str: + """ + Retrieves the latest release version from a GitHub repository. + + Args: + repo (str): The name of the GitHub repository. + + Returns: + str: The latest release version from the specified GitHub repository. + + Raises: + VersionNotFoundError: If there is an error in fetching the version from GitHub. + """ + try: + response = requests.get(f"https://api.github.com/repos/{repo}/releases/latest").json() + return response["tag_name"] + except requests.RequestException as e: + raise VersionNotFoundError(f"Failed to get GitHub release version: {e}") + def get_latest_version() -> str: + """ + Retrieves the latest release version of the 'g4f' package from PyPI or GitHub. + + Returns: + str: The latest release version of 'g4f'. + + Note: + The function first tries to fetch the version from PyPI. If the package is not found, + it retrieves the version from the GitHub repository. + """ try: + # Is installed via package manager? get_package_version("g4f") - response = requests.get("https://pypi.org/pypi/g4f/json").json() - return response["info"]["version"] + return get_pypi_version("g4f") except PackageNotFoundError: - url = "https://api.github.com/repos/xtekky/gpt4free/releases/latest" - response = requests.get(url).json() - return response["tag_name"] + # Else use Github version: + return get_github_version("xtekky/gpt4free") -class VersionUtils(): +class VersionUtils: + """ + Utility class for managing and comparing package versions of 'g4f'. + """ @cached_property def current_version(self) -> str: + """ + Retrieves the current version of the 'g4f' package. + + Returns: + str: The current version of 'g4f'. + + Raises: + VersionNotFoundError: If the version cannot be determined from the package manager, + Docker environment, or git repository. + """ # Read from package manager try: return get_package_version("g4f") except PackageNotFoundError: pass + # Read from docker environment version = environ.get("G4F_VERSION") if version: return version + # Read from git repository try: command = ["git", "describe", "--tags", "--abbrev=0"] return check_output(command, text=True, stderr=PIPE).strip() except CalledProcessError: pass + raise VersionNotFoundError("Version not found") - + @cached_property def latest_version(self) -> str: + """ + Retrieves the latest version of the 'g4f' package. + + Returns: + str: The latest version of 'g4f'. + """ return get_latest_version() - + def check_version(self) -> None: + """ + Checks if the current version of 'g4f' is up to date with the latest version. + + Note: + If a newer version is available, it prints a message with the new version and update instructions. + """ try: if self.current_version != self.latest_version: print(f'New g4f version: {self.latest_version} (current: {self.current_version}) | pip install -U g4f') except Exception as e: print(f'Failed to check g4f version: {e}') - + utils = VersionUtils()
\ No newline at end of file |