Fallback on semver compliant string instead of pep440

Author: bruno-f-cruz

docs/conf.py

@@ -19,7 +19,7 @@
 project = "AIND VR Foraging"
 copyright = "2025, Allen Institute for Neural Dynamics"
 author = "Bruno Cruz"
-release = aind_behavior_vr_foraging.__version__
+release = aind_behavior_vr_foraging.__semver__
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

src/aind_behavior_vr_foraging/__init__.py

@@ -1 +1,30 @@
-__version__ = "0.6.0-rc2"
+import re
+from importlib.metadata import PackageNotFoundError, version
+
+
+def pep440_to_semver(ver: str) -> str:
+    """
+    Convert a PEP 440 version to a SemVer-compatible string.
+
+    Examples:
+        1.2.3rc2   -> 1.2.3-rc2
+        1.2.3a1    -> 1.2.3-a1
+        1.2.3b1    -> 1.2.3-b1
+        1.2.3.dev4 -> 1.2.3-dev4
+        1.2.3.post1 -> 1.2.3+post1
+    """
+    # pre-release: a, b, rc -> -aN, -bN, -rcN
+    ver = re.sub(r"(?<=\d)(a|b|rc)(\d+)", r"-\1\2", ver)
+    # dev release: .devN -> -devN
+    ver = re.sub(r"\.dev(\d+)", r"-dev\1", ver)
+    # post release: .postN -> +postN
+    ver = re.sub(r"\.post(\d+)", r"+post\1", ver)
+    return ver
+
+
+try:
+    __semver__ = version(__name__)
+except PackageNotFoundError:
+    __semver__ = "0.0.0"
+
+__semver__ = pep440_to_semver(__semver__)

src/aind_behavior_vr_foraging/cli.py

@@ -3,7 +3,7 @@
 from pydantic import Field, RootModel
 from pydantic_settings import BaseSettings, CliApp, CliSubCommand
 
-from aind_behavior_vr_foraging import __version__, regenerate
+from aind_behavior_vr_foraging import __semver__, regenerate
 from aind_behavior_vr_foraging.data_mappers import DataMapperCli
 from aind_behavior_vr_foraging.data_qc import DataQcCli
 from aind_behavior_vr_foraging.launcher import ClabeCli
@@ -13,7 +13,7 @@ class VersionCli(RootModel):
     root: t.Any
 
     def cli_cmd(self) -> None:
-        print(__version__)
+        print(__semver__)
 
 
 class DslRegenerateCli(RootModel):

src/aind_behavior_vr_foraging/data_contract/__init__.py

@@ -6,7 +6,7 @@
 import contraqctor
 import semver
 
-from aind_behavior_vr_foraging import __version__
+from aind_behavior_vr_foraging import __semver__
 
 
 def _dataset_lookup_helper(version: str) -> t.Callable[[Path], contraqctor.contract.Dataset]:
@@ -22,7 +22,7 @@ def _dataset_lookup_helper(version: str) -> t.Callable[[Path], contraqctor.contr
     return partial(_dataset, version=version)
 
 
-def dataset(path: os.PathLike, version: str = __version__) -> contraqctor.contract.Dataset:
+def dataset(path: os.PathLike, version: str = __semver__) -> contraqctor.contract.Dataset:
     """
     Loads the dataset for the Aind VR Foraging project from a specified version.
 
@@ -37,7 +37,7 @@ def dataset(path: os.PathLike, version: str = __version__) -> contraqctor.contra
     return dataset_constructor(Path(path))
 
 
-def render_dataset(version: str = __version__) -> str:
+def render_dataset(version: str = __semver__) -> str:
     """Renders the dataset as a tree-like structure for visualization."""
     from contraqctor.contract.utils import print_data_stream_tree
 

src/aind_behavior_vr_foraging/data_qc.py

@@ -10,7 +10,7 @@
 from contraqctor.contract.harp import HarpDevice
 from matplotlib import pyplot as plt
 
-from aind_behavior_vr_foraging import __version__
+from aind_behavior_vr_foraging import __semver__
 from aind_behavior_vr_foraging.data_contract import dataset
 from aind_behavior_vr_foraging.rig import AindVrForagingRig
 
@@ -284,7 +284,7 @@ class DataQcCli(pydantic_settings.BaseSettings, cli_kebab_case=True):
     data_path: pydantic_settings.CliPositionalArg[os.PathLike] = pydantic.Field(
         description="Path to the session data directory."
     )
-    version: str = pydantic.Field(default=__version__, description="Version of the dataset.")
+    version: str = pydantic.Field(default=__semver__, description="Version of the dataset.")
 
     def cli_cmd(self):
         vr_dataset = dataset(Path(self.data_path), self.version)

src/aind_behavior_vr_foraging/rig.py

@@ -11,7 +11,7 @@
 import aind_behavior_services.rig as rig
 from pydantic import BaseModel, Field
 
-from aind_behavior_vr_foraging import __version__
+from aind_behavior_vr_foraging import __semver__
 
 
 class AindManipulatorAdditionalSettings(BaseModel):
@@ -35,7 +35,7 @@ class RigCalibration(BaseModel):
 
 
 class AindVrForagingRig(rig.AindBehaviorRigModel):
-    version: Literal[__version__] = __version__
+    version: Literal[__semver__] = __semver__
     triggered_camera_controller: rig.cameras.CameraController[rig.cameras.SpinnakerCamera] = Field(
         ..., description="Required camera controller to triggered cameras."
     )

src/aind_behavior_vr_foraging/task_logic.py

@@ -8,7 +8,7 @@
 from typing_extensions import TypeAliasType
 
 from aind_behavior_vr_foraging import (
-    __version__,
+    __semver__,
 )
 
 logger = logging.getLogger(__name__)
@@ -1006,6 +1006,6 @@ class AindVrForagingTaskLogic(AindBehaviorTaskLogicModel):
     It includes all task parameters, environment specifications, and control settings.
     """
 
-    version: Literal[__version__] = __version__
+    version: Literal[__semver__] = __semver__
     name: Literal["AindVrForaging"] = Field(default="AindVrForaging", description="Name of the task logic", frozen=True)
     task_parameters: AindVrForagingTaskParameters = Field(description="Parameters of the task logic")