Rename SemanticVersion to ParsedVersion

Author: romanroibu

pupil_src/shared_modules/pupil_recording/info/recording_info.py

@@ -18,7 +18,7 @@
 import typing as T
 import uuid
 
-from version_utils import get_version, parse_version, SemanticVersion
+from version_utils import get_version, parse_version, ParsedVersion
 
 
 __all__ = ["RecordingInfo", "RecordingInfoFile", "RecordingInfoInvalidError"]
@@ -71,12 +71,12 @@ def __len__(self):
 
     @property
     @abc.abstractmethod
-    def meta_version(self) -> SemanticVersion:
+    def meta_version(self) -> ParsedVersion:
         pass
 
     @property
     @abc.abstractmethod
-    def min_player_version(self) -> SemanticVersion:
+    def min_player_version(self) -> ParsedVersion:
         pass
 
     @property
@@ -376,7 +376,7 @@ 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) -> SemanticVersion:
+    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)
@@ -437,7 +437,7 @@ def read_file_from_recording(rec_dir: str) -> "RecordingInfoFile":
 
     @staticmethod
     def create_empty_file(
-        rec_dir: str, fixed_version: T.Optional[SemanticVersion] = None
+        rec_dir: str, fixed_version: T.Optional[ParsedVersion] = None
     ) -> "RecordingInfoFile":
         """
         Creates a new `RecordingInfoFile` instance using the latest meta format version,
@@ -480,15 +480,15 @@ def validate(self):
     _info_file_versions = {}
 
     @classmethod
-    def register_child_class(cls, version: SemanticVersion, 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) -> SemanticVersion:
+    def get_latest_info_file_version(cls) -> ParsedVersion:
         if not cls._info_file_versions:
             raise ValueError(
                 "RecordingInfoFile not correctly initialized! No templates registered."

pupil_src/shared_modules/pupil_recording/info/recording_info_2_0.py

@@ -13,19 +13,19 @@
 
 from . import RecordingInfoFile
 from . import recording_info_utils as utils
-from version_utils import parse_version, SemanticVersion
+from version_utils import parse_version, ParsedVersion
 
 
 class _RecordingInfoFile_2_0(RecordingInfoFile):
 
     # RecordingInfo
 
     @property
-    def meta_version(self) -> SemanticVersion:
+    def meta_version(self) -> ParsedVersion:
         return parse_version("2.0")
 
     @property
-    def min_player_version(self) -> SemanticVersion:
+    def min_player_version(self) -> ParsedVersion:
         return parse_version("1.16")
 
     @property

pupil_src/shared_modules/pupil_recording/info/recording_info_2_1.py

@@ -12,7 +12,7 @@
 from . import RecordingInfoFile
 from .recording_info_2_0 import _RecordingInfoFile_2_0
 from . import recording_info_utils as utils
-from version_utils import parse_version, SemanticVersion
+from version_utils import parse_version, ParsedVersion
 
 
 class _RecordingInfoFile_2_1(_RecordingInfoFile_2_0):
@@ -24,7 +24,7 @@ class _RecordingInfoFile_2_1(_RecordingInfoFile_2_0):
     # meta version 2.0 have to be re-transformed.
 
     @property
-    def meta_version(self) -> SemanticVersion:
+    def meta_version(self) -> ParsedVersion:
         return parse_version("2.1")
 
     @property

pupil_src/shared_modules/pupil_recording/info/recording_info_2_2.py

@@ -12,19 +12,19 @@
 from . import RecordingInfoFile
 from .recording_info_2_0 import _RecordingInfoFile_2_0
 from . import recording_info_utils as utils
-from version_utils import parse_version, SemanticVersion
+from version_utils import parse_version, ParsedVersion
 
 
 class _RecordingInfoFile_2_2(_RecordingInfoFile_2_0):
 
     # Used to make Pupil v2.0 recordings backwards incompatible with v1.*
 
     @property
-    def meta_version(self) -> SemanticVersion:
+    def meta_version(self) -> ParsedVersion:
         return parse_version("2.2")
 
     @property
-    def min_player_version(self) -> SemanticVersion:
+    def min_player_version(self) -> ParsedVersion:
         return parse_version("2.0")
 
     @property

pupil_src/shared_modules/pupil_recording/info/recording_info_utils.py

@@ -18,10 +18,10 @@
 from methods import get_system_info
 
 from .recording_info import RecordingInfoFile
-from version_utils import parse_version, SemanticVersion
+from version_utils import parse_version, ParsedVersion
 
 
-def string_from_recording_version(value: SemanticVersion) -> str:
+def string_from_recording_version(value: ParsedVersion) -> str:
     return str(value)  # TODO: Make sure this conversion is correct
 
 

pupil_src/shared_modules/version_utils.py

@@ -34,14 +34,14 @@ def get_tag_commit() -> T.Optional[T.AnyStr]:
         return None
 
 
-SemanticVersion = T.Union[packaging.version.LegacyVersion, packaging.version.Version]
+ParsedVersion = T.Union[packaging.version.LegacyVersion, packaging.version.Version]
 
 
-def parse_version(vstring) -> SemanticVersion:
+def parse_version(vstring) -> ParsedVersion:
     return packaging.version.parse(vstring)
 
 
-def pupil_version() -> SemanticVersion:
+def pupil_version() -> ParsedVersion:
     return parse_version(pupil_version_string())