Display warning message when importing outdated versions (#757)

Author: matheuspinheirosantos

CHANGELOG.md

@@ -30,6 +30,10 @@ You can check your current version with the following command:
 
 For more information, see [UP42 Python package description](https://pypi.org/project/up42-py/).
 
+### 2.4.0a4
+**July 16, 2025**
+- Display warning when importing outdated versions
+
 ### 2.4.0a3
 **July 15, 2025**
 - Deprecated the `webhooks` module and the `base::get_credits_balance` function

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "up42-py"
-version = "2.4.0a3"
+version = "2.4.0a4"
 description = "Python SDK for UP42, the geospatial marketplace and developer platform."
 authors = ["UP42 GmbH <[email protected]>"]
 license = "https://github.com/up42/up42-py/blob/master/LICENSE"

tests/version/test_version_control.py

@@ -0,0 +1,41 @@
+import random
+
+import mock
+import requests_mock as req_mock
+from packaging import version
+
+from up42.version import version_control
+
+fake_latest_version = "10.0.0"
+fake_installed_version = "1.0.0"
+
+
+class TestBuildMessage:
+    def test_should_build_warn_message(self):
+        assert (
+            version_control.build_outdated_version_message(fake_installed_version, fake_latest_version)
+            == f"You're using an outdated version of the UP42 Python SDK: v{fake_installed_version}. A newer version is available: v{fake_latest_version}.\nPlease upgrade to the latest version using **pip install --upgrade up42-py** or conda **conda update -c conda-forge up42-py**."  # pylint: disable=line-too-long # noqa: E501
+        )
+
+
+class TestCheckLatestVersion:
+    def test_should_warn_if_not_latest_version(
+        self,
+        requests_mock: req_mock.Mocker,
+    ):
+        warn = mock.MagicMock()
+        requests_mock.get(url="https://pypi.org/pypi/up42-py/json", json={"info": {"version": fake_latest_version}})
+        message = "not latest version"
+        build_warning_message = mock.MagicMock(return_value=message)
+        version_control.check_is_latest_version(fake_installed_version, warn, build_warning_message)
+        build_warning_message.assert_called_with(fake_installed_version, version.Version(fake_latest_version))
+        warn.assert_called_with(message)
+
+    def test_should_ignore_http_error_exception(
+        self,
+        requests_mock: req_mock.Mocker,
+    ):
+        requests_mock.get(url="https://pypi.org/pypi/up42-py/json", status_code=random.randint(400, 599))
+        unused = mock.MagicMock()
+        version_control.check_is_latest_version(fake_installed_version, unused, unused)
+        unused.assert_not_called()

up42/__init__.py

@@ -39,11 +39,14 @@
 from up42.tasking import FeasibilityStudy, FeasibilityStudySorting, Quotation, QuotationSorting, Tasking
 from up42.tools import get_example_aoi, read_vector_file
 from up42.utils import get_up42_py_version
+from up42.version import version_control
 from up42.webhooks import Webhook
 
 stac_extend()
 
 __version__ = get_up42_py_version()
+version_control.check_is_latest_version(__version__)
+
 __all__ = [
     cast(
         Union[Type, Callable],

up42/version/version_control.py

@@ -0,0 +1,28 @@
+import warnings
+
+import requests
+from packaging import version
+from requests import exceptions
+
+
+def _get_latest_version():
+    response = requests.get("https://pypi.org/pypi/up42-py/json", timeout=2)
+    response.raise_for_status()
+    return version.parse(response.json()["info"]["version"])
+
+
+def build_outdated_version_message(installed_version, latest_version):
+    return f"You're using an outdated version of the UP42 Python SDK: v{installed_version}. A newer version is available: v{latest_version}.\nPlease upgrade to the latest version using **pip install --upgrade up42-py** or conda **conda update -c conda-forge up42-py**."  # pylint: disable=line-too-long # noqa: E501
+
+
+def check_is_latest_version(
+    installed_version: str,
+    warn=warnings.warn,
+    build_warning_message=build_outdated_version_message,
+):
+    try:
+        latest_version = _get_latest_version()
+        if version.Version(installed_version) < latest_version:
+            warn(build_warning_message(installed_version, latest_version))
+    except exceptions.HTTPError:
+        pass