Merge pull request #271 from superannotateai/friday_427

Added logs

Author: VaghinakDev

src/superannotate/__init__.py

@@ -2,6 +2,9 @@
 import os
 import sys
 
+import requests
+import superannotate.lib.core as constances
+from packaging.version import parse
 from superannotate.lib.app.analytics.class_analytics import attribute_distribution
 from superannotate.lib.app.analytics.class_analytics import class_distribution
 from superannotate.lib.app.annotation_helpers import add_annotation_bbox_to_json
@@ -298,9 +301,27 @@
 
 __author__ = "Superannotate"
 
+
 WORKING_DIR = os.path.split(os.path.realpath(__file__))[0]
 sys.path.append(WORKING_DIR)
 logging.getLogger("botocore").setLevel(logging.CRITICAL)
 logging.config.fileConfig(
     os.path.join(WORKING_DIR, "logging.conf"), disable_existing_loggers=False
 )
+
+local_version = parse(__version__)
+if local_version.is_prerelease:
+    logging.info(constances.PACKAGE_VERSION_INFO_MESSAGE.format(__version__))
+req = requests.get('https://pypi.python.org/pypi/superannotate/json')
+if req.ok:
+    releases = req.json().get('releases', [])
+    pip_version = parse('0')
+    for release in releases:
+        ver = parse(release)
+        if not ver.is_prerelease or local_version.is_prerelease:
+            pip_version = max(pip_version, ver)
+    if pip_version.major > local_version.major:
+        logging.warning(constances.PACKAGE_VERSION_MAJOR_UPGRADE.format(local_version, pip_version))
+    elif pip_version > local_version:
+        logging.warning(constances.PACKAGE_VERSION_UPGRADE.format(local_version, pip_version)
+        )

src/superannotate/lib/core/__init__.py

@@ -102,6 +102,15 @@
 )
 MOVE_PROJECT_LIMIT_ERROR_MESSAGE = "The number of items you want to move exceeds the limit of 500 000 items per project."
 
+PACKAGE_VERSION_INFO_MESSAGE = "Development version {} of SuperAnnotate SDK is being used."
+
+PACKAGE_VERSION_MAJOR_UPGRADE = "There is a major upgrade of SuperAnnotate Python SDK available on PyPI. " \
+                          "We recommend upgrading. Run 'pip install --upgrade superannotate' to " \
+                          "upgrade from your version {} to {}."
+
+PACKAGE_VERSION_UPGRADE = "There is a newer version of SuperAnnotate Python SDK available on PyPI." \
+                      " Run 'pip install --upgrade superannotate' to" \
+                      " upgrade from your version {} to {}"
 __alL__ = (
     ProjectType,
     UserRole,

tests/unit/test_version_checking.py

@@ -0,0 +1,61 @@
+from unittest import TestCase
+from unittest.mock import patch
+from unittest.mock import Mock
+from tests.utils.helpers import catch_prints
+
+
+TEST_VERSION = "1.0.0b1"
+TEST_NEW_MAJOR_VERSION = "22.2.2"
+TEST_NEW_VERSION = "1.2.2"
+
+
+mock_response_1 = Mock(status_code=200)
+mock_response_1.json.return_value = {"releases": [TEST_NEW_MAJOR_VERSION]}
+mock_get_1 = Mock(return_value=mock_response_1)
+
+mock_response_2 = Mock(status_code=200)
+mock_response_2.json.return_value = {"releases": [TEST_NEW_VERSION]}
+mock_get_2 = Mock(return_value=mock_response_2)
+
+
+class TestVersionCheck(TestCase):
+
+    @patch('superannotate.version.__version__', TEST_VERSION)
+    @patch("requests.get", mock_get_1)
+    def test_dev_version_first_info_log(self):
+        with catch_prints() as out:
+            import src.superannotate
+            import src.superannotate.lib.core as constances
+            logs = out.getvalue().split("\n")
+            self.assertEqual(
+                logs[0],
+                "SA-PYTHON-SDK - INFO - " + constances.PACKAGE_VERSION_INFO_MESSAGE.format(TEST_VERSION)
+            )
+
+    @patch('superannotate.version.__version__', TEST_VERSION)
+    @patch("requests.get", mock_get_1)
+    def test_dev_version_major_update(self):
+        with catch_prints() as out:
+            import src.superannotate
+            import src.superannotate.lib.core as constances
+            logs = out.getvalue().split("\n")
+            self.assertEqual(
+                logs[1],
+                "SA-PYTHON-SDK - WARNING - " + constances.PACKAGE_VERSION_MAJOR_UPGRADE.format(
+                    TEST_VERSION, TEST_NEW_MAJOR_VERSION
+                )
+            )
+
+    @patch('superannotate.version.__version__', TEST_VERSION)
+    @patch("requests.get", mock_get_2)
+    def test_dev_version_update(self):
+        with catch_prints() as out:
+            import src.superannotate
+            import src.superannotate.lib.core as constances
+            logs = out.getvalue().split("\n")
+            self.assertEqual(
+                logs[1],
+                "SA-PYTHON-SDK - WARNING - " + constances.PACKAGE_VERSION_UPGRADE.format(TEST_VERSION,
+                                                                                         TEST_NEW_VERSION)
+            )
+