Merge pull request #1993 from pupil-labs/better-version-comparison

Better version comparison

Author: papr

pupil_src/launchables/eye.py

@@ -141,7 +141,7 @@ def eye(
         # helpers/utils
         from uvc import get_time_monotonic
         from file_methods import Persistent_Dict
-        from version_utils import VersionFormat
+        from version_utils import parse_version
         from methods import normalize, denormalize, timer
         from av_writer import JPEG_Writer, MPEG_Writer, NonMonotonicTimestampError
         from ndsi import H264Writer
@@ -362,7 +362,7 @@ def on_drop(window, count, paths):
         session_settings = Persistent_Dict(
             os.path.join(g_pool.user_dir, "user_settings_eye{}".format(eye_id))
         )
-        if VersionFormat(session_settings.get("version", "0.0")) != g_pool.version:
+        if parse_version(session_settings.get("version", "0.0")) != g_pool.version:
             logger.info(
                 "Session setting are from a different version of this app. I will not use those."
             )

pupil_src/launchables/player.py

@@ -83,7 +83,7 @@ def player(
         from video_capture import File_Source
 
         # helpers/utils
-        from version_utils import VersionFormat
+        from version_utils import parse_version
         from methods import normalize, denormalize, delta_t, get_system_info
         import player_methods as pm
         from pupil_recording import PupilRecording
@@ -131,7 +131,7 @@ def player(
             InvalidRecordingException,
         )
 
-        assert VersionFormat(pyglui_version) >= VersionFormat(
+        assert parse_version(pyglui_version) >= parse_version(
             "1.28"
         ), "pyglui out of date, please upgrade to newest version"
 
@@ -346,7 +346,7 @@ def get_dt():
         session_settings = Persistent_Dict(
             os.path.join(user_dir, "user_settings_player")
         )
-        if VersionFormat(session_settings.get("version", "0.0")) != app_version:
+        if parse_version(session_settings.get("version", "0.0")) != app_version:
             logger.info(
                 "Session setting are a different version of this app. I will not use those."
             )
@@ -793,7 +793,7 @@ def player_drop(
         import glfw
         import gl_utils
         from OpenGL.GL import glClearColor
-        from version_utils import VersionFormat
+        from version_utils import parse_version
         from file_methods import Persistent_Dict
         from pyglui.pyfontstash import fontstash
         from pyglui.ui import get_roboto_font_path
@@ -830,7 +830,7 @@ def on_drop(window, count, paths):
         session_settings = Persistent_Dict(
             os.path.join(user_dir, "user_settings_player")
         )
-        if VersionFormat(session_settings.get("version", "0.0")) != app_version:
+        if parse_version(session_settings.get("version", "0.0")) != app_version:
             logger.info(
                 "Session setting are from a  different version of this app. I will not use those."
             )

pupil_src/launchables/service.py

@@ -88,7 +88,7 @@ def stop_eye_process(eye_id):
         # helpers/utils
         from file_methods import Persistent_Dict
         from methods import delta_t, get_system_info
-        from version_utils import VersionFormat
+        from version_utils import parse_version
         import audio
         from uvc import get_time_monotonic
 
@@ -183,7 +183,7 @@ def get_dt():
         session_settings = Persistent_Dict(
             os.path.join(g_pool.user_dir, "user_settings_service")
         )
-        if session_settings.get("version", VersionFormat("0.0")) < g_pool.version:
+        if parse_version(session_settings.get("version", "0.0")) < g_pool.version:
             logger.info(
                 "Session setting are from older version of this app. I will not use those."
             )

pupil_src/launchables/world.py

@@ -118,10 +118,10 @@ def detection_enabled_setter(is_on: bool):
 
         # display
         import glfw
-        from version_utils import VersionFormat
+        from version_utils import parse_version
         from pyglui import ui, cygl, __version__ as pyglui_version
 
-        assert VersionFormat(pyglui_version) >= VersionFormat(
+        assert parse_version(pyglui_version) >= parse_version(
             "1.27"
         ), "pyglui out of date, please upgrade to newest version"
         from pyglui.cygl.utils import Named_Texture
@@ -441,7 +441,7 @@ def get_dt():
         session_settings = Persistent_Dict(
             os.path.join(g_pool.user_dir, "user_settings_world")
         )
-        if VersionFormat(session_settings.get("version", "0.0")) != g_pool.version:
+        if parse_version(session_settings.get("version", "0.0")) != g_pool.version:
             logger.info(
                 "Session setting are from a different version of this app. I will not use those."
             )

pupil_src/shared_modules/audio_playback.py

@@ -26,10 +26,10 @@
 import gl_utils
 from audio_utils import Audio_Viz_Transform, NoAudioLoadedError, load_audio
 from plugin import System_Plugin_Base
-from version_utils import VersionFormat
+from version_utils import parse_version
 
 
-assert VersionFormat(av.__version__) >= VersionFormat("0.4.4")
+assert parse_version(av.__version__) >= parse_version("0.4.4")
 
 
 logger = logging.getLogger(__name__)

pupil_src/shared_modules/os_utils.py

@@ -10,17 +10,17 @@
 """
 
 import platform, sys, os, time, traceback
-from distutils.version import LooseVersion as VersionFormat
 import subprocess as sp
+from version_utils import parse_version
 
 import logging
 
 logger = logging.getLogger(__name__)
 
 os_name = platform.system()
 if os_name == "Darwin":
-    mac_version = VersionFormat(platform.mac_ver()[0])
-    min_version = VersionFormat("10.11.0")
+    mac_version = parse_version(platform.mac_ver()[0])
+    min_version = parse_version("10.11.0")
 
 if os_name == "Darwin" and mac_version >= min_version:
 

pupil_src/shared_modules/pupil_detector_plugins/detector_3d_plugin.py

@@ -9,7 +9,7 @@
 ---------------------------------------------------------------------------~(*)
 """
 import logging
-from distutils.version import LooseVersion as VersionFormat
+from version_utils import parse_version
 
 import pupil_detectors
 from pupil_detectors import Detector3D, DetectorBase, Roi
@@ -32,7 +32,7 @@
 
 logger = logging.getLogger(__name__)
 
-if VersionFormat(pupil_detectors.__version__) < VersionFormat("1.0.5"):
+if parse_version(pupil_detectors.__version__) < parse_version("1.0.5"):
     msg = (
         f"This version of Pupil requires pupil_detectors >= 1.0.5."
         f" You are running with pupil_detectors == {pupil_detectors.__version__}."

pupil_src/shared_modules/pupil_recording/__init__.py

@@ -8,9 +8,6 @@
 See COPYING and COPYING.LESSER for license details.
 ---------------------------------------------------------------------------~(*)
 """
-
-from packaging.version import Version
-
 from .info import RecordingInfoFile
 from .recording import PupilRecording
 from .recording_utils import InvalidRecordingException, assert_valid_recording_type

pupil_src/shared_modules/pupil_recording/info/__init__.py

@@ -8,13 +8,12 @@
 See COPYING and COPYING.LESSER for license details.
 ---------------------------------------------------------------------------~(*)
 """
-
-from .. import Version
 from .recording_info import RecordingInfoFile
 from .recording_info_2_0 import _RecordingInfoFile_2_0
 from .recording_info_2_1 import _RecordingInfoFile_2_1
 from .recording_info_2_2 import _RecordingInfoFile_2_2
+from version_utils import parse_version
 
-RecordingInfoFile.register_child_class(Version("2.0"), _RecordingInfoFile_2_0)
-RecordingInfoFile.register_child_class(Version("2.1"), _RecordingInfoFile_2_1)
-RecordingInfoFile.register_child_class(Version("2.2"), _RecordingInfoFile_2_2)
+RecordingInfoFile.register_child_class(parse_version("2.0"), _RecordingInfoFile_2_0)
+RecordingInfoFile.register_child_class(parse_version("2.1"), _RecordingInfoFile_2_1)
+RecordingInfoFile.register_child_class(parse_version("2.2"), _RecordingInfoFile_2_2)

pupil_src/shared_modules/pupil_recording/info/recording_info.py

@@ -18,11 +18,10 @@
 import typing as T
 import uuid
 
-from version_utils import get_version
+from version_utils import get_version, parse_version, ParsedVersion
 
-from .. import Version
 
-__all__ = ["RecordingInfo", "RecordingInfoFile", "RecordingInfoInvalidError", "Version"]
+__all__ = ["RecordingInfo", "RecordingInfoFile", "RecordingInfoInvalidError"]
 
 
 logger = logging.getLogger(__name__)
@@ -72,12 +71,12 @@ def __len__(self):
 
     @property
     @abc.abstractmethod
-    def meta_version(self) -> Version:
+    def meta_version(self) -> ParsedVersion:
         pass
 
     @property
     @abc.abstractmethod
-    def min_player_version(self) -> Version:
+    def min_player_version(self) -> ParsedVersion:
         pass
 
     @property
@@ -377,11 +376,11 @@ def does_recording_contain_info_file(rec_dir: str) -> bool:
         return os.path.isfile(file_path)
 
     @staticmethod
-    def detect_recording_info_file_version(rec_dir: str) -> Version:
+    def detect_recording_info_file_version(rec_dir: str) -> ParsedVersion:
         file_path = RecordingInfoFile._info_file_path(rec_dir=rec_dir)
         with open(file_path, "r") as file:
             read_dict = RecordingInfoFile._read_dict_from_file(file=file)
-        return Version(read_dict["meta_version"])
+        return parse_version(read_dict["meta_version"])
 
     @staticmethod
     def read_file_from_recording(rec_dir: str) -> "RecordingInfoFile":
@@ -403,7 +402,7 @@ def read_file_from_recording(rec_dir: str) -> "RecordingInfoFile":
                 info_file_path = RecordingInfoFile._info_file_path(rec_dir)
                 with open(info_file_path, "r") as f:
                     info_dict = RecordingInfoFile._read_dict_from_file(f)
-                min_player_version = Version(info_dict["min_player_version"])
+                min_player_version = parse_version(info_dict["min_player_version"])
             except Exception as e:
                 # Catching BaseException since at this point we don't know anything
                 logger.error(
@@ -415,9 +414,7 @@ def read_file_from_recording(rec_dir: str) -> "RecordingInfoFile":
                     f"Recording is too new to be opened with this version of Player!"
                 )
 
-            # TODO: get_version() returns a LooseVersion, but we are using
-            # packaging.Version now, need to adjust this across the codebase
-            if min_player_version > Version(get_version().vstring):
+            if min_player_version > get_version():
                 raise RecordingInfoInvalidError(
                     f"This recording requires Player version >= {min_player_version}!"
                 )
@@ -440,7 +437,7 @@ def read_file_from_recording(rec_dir: str) -> "RecordingInfoFile":
 
     @staticmethod
     def create_empty_file(
-        rec_dir: str, fixed_version: T.Optional[Version] = None
+        rec_dir: str, fixed_version: T.Optional[ParsedVersion] = None
     ) -> "RecordingInfoFile":
         """
         Creates a new `RecordingInfoFile` instance using the latest meta format version,
@@ -483,15 +480,15 @@ def validate(self):
     _info_file_versions = {}
 
     @classmethod
-    def register_child_class(cls, version: Version, child_class: type):
+    def register_child_class(cls, version: ParsedVersion, child_class: type):
         """Use this to register interface implementations for specific versions."""
         # NOTE: This is dependency inversion to avoids circular imports, because we
         # don't need to know our child classes.
         # TODO: Would be much cleaner with self-registering meta classes.
         cls._info_file_versions[version] = child_class
 
     @classmethod
-    def get_latest_info_file_version(cls) -> Version:
+    def get_latest_info_file_version(cls) -> ParsedVersion:
         if not cls._info_file_versions:
             raise ValueError(
                 "RecordingInfoFile not correctly initialized! No templates registered."