Bryans suggestions

Author: andrewelamb

synapseclient/core/version_check.py

@@ -11,11 +11,11 @@
 
 """
 
-import importlib
 import json
 import logging
 import re
 import sys
+from importlib.resources import files
 from typing import Any, Optional
 
 import httpx
@@ -37,7 +37,8 @@ def version_check(
     Recommends upgrade, if a newer version exists.
 
     This wraps the _version_check function in a try except block.
-    The purpose of this is so that no exception caught running the version check stops the client from running.
+    The purpose of this is so that no exception caught running the version
+      check stops the client from running.
 
     Arguments:
         current_version: The current version of the package.
@@ -178,7 +179,7 @@ def _get_local_package_metadata() -> dict[str, Any]:
     Returns:
         dict[str, Any]: This will have various fields relating the version of the client
     """
-    ref = importlib.resources.files("synapseclient").joinpath("synapsePythonClient")
+    ref = files("synapseclient").joinpath("synapsePythonClient")
     with ref.open("r") as fp:
         pkg_metadata = json.loads(fp.read())
     return pkg_metadata

tests/integration/synapseclient/core/test_version_check.py

@@ -1,19 +1,24 @@
 """Integration tests for version checking"""
 
+from pytest_mock import MockerFixture
+
+import synapseclient.core.version_check
 from synapseclient.core.version_check import _get_version_info_from_pypi, version_check
 
 
-async def test_version_check():
+async def test_version_check(mocker: MockerFixture):
     """Integration checks for version_check"""
-    # Check current version against pypi version file
-    version_check()
-
     # Should be higher than current version and return true
     assert version_check(current_version="999.999.999")
 
     # Test out of date version
     assert not version_check(current_version="0.0.1")
 
+    # Assert _get_version_info_from_pypi called  when running version_check
+    spy = mocker.spy(synapseclient.core.version_check, "_get_version_info_from_pypi")
+    version_check()
+    spy.assert_called_once()
+
 
 def test_get_version_info_from_pypi():
     """Integration test for _get_version_info_from_pypi"""