Bugfix: Handle alphanumeric versions (like "1.0.0rc1") (PyPSA#1338)

* Bugfix version.py for alphanumeric versions like 1.0.0rc1

* Extended unit tests by alphanumeric versions and parse_version_tuple_function

* Using packaging.version to do version comparison

* Fixed conversion back to str.

* refactor: refactor version attributes and remove tuple versions

* fix: simplify regex version match

---------

Co-authored-by: lkstrp <lkstrp@pm.me>

Author: bobbyxng

doc/references/release-notes.rst

@@ -37,6 +37,10 @@ Features
 
 * Add additional standard line types from pandapower.
 
+* Refactored version attributes: ``__version_semver__`` → ``__version_base__``, 
+  ``__version_short__`` → ``__version_major_minor__``. Removed tuple versions.
+  Old names raise ``DeprecationWarning``.
+
 Bug Fixes
 ---------
 

pypsa/__init__.py

@@ -12,6 +12,8 @@
 )
 
 
+from typing import NoReturn
+
 from pypsa import (
     clustering,
     common,
@@ -32,10 +34,8 @@
 from pypsa.networks import Network, SubNetwork
 from pypsa.version import (
     __version__,
-    __version_semver__,
-    __version_semver_tuple__,
-    __version_short__,
-    __version_short_tuple__,
+    __version_base__,
+    __version_major_minor__,
 )
 
 version = __version__  # Alias for legacy access
@@ -48,10 +48,8 @@
 
 __all__ = [
     "__version__",
-    "__version_semver__",
-    "__version_short__",
-    "__version_semver_tuple__",
-    "__version_short_tuple__",
+    "__version_base__",
+    "__version_major_minor__",
     "version",
     "options",
     "set_option",
@@ -75,3 +73,35 @@
     "SubNetwork",
     "Components",
 ]
+
+
+def __getattr__(name: str) -> NoReturn:
+    """Handle deprecated version attributes."""
+    # Deprecated tuple versions (removed)
+    if name == "__version_short_tuple__":
+        msg = (
+            "pypsa.__version_short_tuple__ has been removed. "
+            "Use pypsa.__version_major_minor__ with packaging.version.parse() for version comparisons."
+        )
+        raise DeprecationWarning(msg)
+
+    if name == "__version_semver_tuple__":
+        msg = (
+            "pypsa.__version_semver_tuple__ has been removed. "
+            "Use pypsa.__version_base__ with packaging.version.parse() for version comparisons."
+        )
+        raise DeprecationWarning(msg)
+
+    # Deprecated version names (renamed)
+    if name == "__version_semver__":
+        msg = "pypsa.__version_semver__ is deprecated. Use pypsa.__version_base__ instead."
+        raise DeprecationWarning(msg)
+
+    if name == "__version_short__":
+        msg = "pypsa.__version_short__ is deprecated. Use pypsa.__version_major_minor__ instead."
+        raise DeprecationWarning(msg)
+
+    # Raise AttributeError for all other attributes
+    # __getattr__ is only called if the attribute is not found through normal lookup
+    msg = f"module '{__name__}' has no attribute '{name}'"
+    raise AttributeError(msg)

pypsa/common.py

@@ -19,7 +19,7 @@
 
 from pypsa._options import options
 from pypsa.definitions.structures import Dict
-from pypsa.version import __version_semver__
+from pypsa.version import __version_base__
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Sequence
@@ -154,7 +154,7 @@ def __get__(self, obj: Any, objtype: Any = None) -> Any:
 
 
 @lru_cache(maxsize=1)
-def _check_for_update(current_version: tuple, repo_owner: str, repo_name: str) -> str:
+def _check_for_update(current_version: str, repo_owner: str, repo_name: str) -> str:
     """Log a message if a newer version is available.
 
     Checks the latest release on GitHub and compares it to the current version. Does
@@ -163,8 +163,8 @@ def _check_for_update(current_version: tuple, repo_owner: str, repo_name: str) -
 
     Parameters
     ----------
-    current_version : tuple
-        The current version of the package as a tuple (major, minor, patch).
+    current_version : str
+        The current version of the package as a semantic version string.
     repo_owner : str
         The owner of the repository.
     repo_name : str
@@ -193,12 +193,14 @@ def _check_for_update(current_version: tuple, repo_owner: str, repo_name: str) -
         response = request.urlopen(req)  # noqa: S310
         latest_version = json.loads(response.read())["tag_name"].replace("v", "")
 
-        # Simple version comparison
-        latest = tuple(map(int, latest_version.split(".")))
+        # Version comparison using packaging.version
+        latest_parsed = version.parse(latest_version)
+        current_parsed = version.parse(current_version)
 
-        if latest > current_version:
-            current_version_str = ".".join(map(str, current_version))
-            return f"New version {latest_version} available! (Current: {current_version_str})"
+        if latest_parsed > current_parsed:
+            return (
+                f"New version {latest_version} available! (Current: {current_version})"
+            )
 
     except Exception:  # noqa: S110
         pass
@@ -565,7 +567,7 @@ def decorator(func: Callable) -> Callable:
         return deprecated(
             deprecated_in="1.0",
             removed_in="2.0",
-            current_version=__version_semver__,
+            current_version=__version_base__,
             details=details,
         )(func)
 
@@ -597,11 +599,11 @@ def deprecated_namespace(
         A wrapper function that warns about the deprecated namespace.
 
     """
-    current_version = version.parse(__version_semver__)
-    if version.parse(deprecated_in) > current_version and __version_semver__ != "0.0":
+    current_version = version.parse(__version_base__)
+    if version.parse(deprecated_in) > current_version and __version_base__ != "0.0":
         msg = (
             "'deprecated_namespace' can only be used in a version >= deprecated_in "
-            f"(current version: {__version_semver__}, deprecated_in: {deprecated_in})."
+            f"(current version: {__version_base__}, deprecated_in: {deprecated_in})."
         )
         raise ValueError(msg)
 

pypsa/examples.py

@@ -7,18 +7,22 @@
 from urllib.error import HTTPError, URLError
 from urllib.request import urlopen
 
+from packaging.version import parse as parse_version
+
 from pypsa.networks import Network
-from pypsa.version import __version_semver__, __version_semver_tuple__
+from pypsa.version import __version_base__
 
 logger = logging.getLogger(__name__)
 
 
 def _repo_url(
     master: bool = False, url: str = "https://github.com/PyPSA/PyPSA/raw/"
 ) -> str:
-    if master or __version_semver_tuple__ < (0, 35):  # Feature was added in 0.35.0
+    if master or parse_version(__version_base__) < parse_version(
+        "0.35.0"
+    ):  # Feature was added in 0.35.0
         return f"{url}master/"
-    return f"{url}v{__version_semver__}/"
+    return f"{url}v{__version_base__}/"
 
 
 def _check_url_availability(url: str) -> bool:

pypsa/network/io.py

@@ -18,14 +18,15 @@
 import pandas as pd
 import validators
 import xarray as xr
+from packaging.version import parse as parse_version
 from pandas.errors import ParserError
 from pyproj import CRS
 
 from pypsa._options import options
 from pypsa.common import _check_for_update, check_optional_dependency
 from pypsa.descriptors import _update_linkports_component_attrs
 from pypsa.network.abstract import _NetworkABC
-from pypsa.version import __version_semver__, __version_semver_tuple__
+from pypsa.version import __version_base__
 
 try:
     from cloudpathlib import AnyPath as Path
@@ -1267,11 +1268,9 @@ def _import_from_importer(
                 self.name = name
 
         if "pypsa_version" in attrs:
-            pypsa_version_tuple = tuple(
-                int(v) for v in attrs.pop("pypsa_version", "0.0.0").split(".")
-            )
+            pypsa_version = parse_version(attrs.pop("pypsa_version", "0.0.0"))
         else:
-            pypsa_version_tuple = (0, 0, 0)
+            pypsa_version = parse_version("0.0.0")
 
         for attr, val in attrs.items():
             if attr in ["model", "objective", "objective_constant"]:
@@ -1280,22 +1279,22 @@ def _import_from_importer(
                 setattr(self, attr, val)
 
         ## https://docs.python.org/3/tutorial/datastructures.html#comparing-sequences-and-other-types
-        if pypsa_version_tuple < __version_semver_tuple__:
-            pypsa_version_str = ".".join(map(str, pypsa_version_tuple))
+        if pypsa_version < parse_version(__version_base__):
+            pypsa_version_str = str(pypsa_version)
             logger.warning(
                 "Importing network from PyPSA version v%s while current version is v%s. Read the "
                 "release notes at https://pypsa.readthedocs.io/en/latest/release_notes.html "
                 "to prepare your network for import.",
                 pypsa_version_str,
-                __version_semver__,
+                __version_base__,
             )
 
         # Check for newer PyPSA version available
-        update_msg = _check_for_update(__version_semver_tuple__, "PyPSA", "pypsa")
+        update_msg = _check_for_update(__version_base__, "PyPSA", "pypsa")
         if update_msg:
             logger.info(update_msg)
 
-        if pypsa_version_tuple < (0, 18, 0):
+        if pypsa_version < parse_version("0.18.0"):
             self._multi_invest = 0
 
         # if there is snapshots.csv, read in snapshot data

pypsa/networks.py

@@ -50,7 +50,7 @@
 from pypsa.plot.accessor import PlotAccessor
 from pypsa.plot.maps import explore
 from pypsa.statistics.expressions import StatisticsAccessor
-from pypsa.version import __version_semver__
+from pypsa.version import __version_base__
 
 if TYPE_CHECKING:
     from collections.abc import Collection, Iterator, Sequence
@@ -127,7 +127,7 @@ def __init__(
         logging.basicConfig(level=logging.INFO)
 
         # Store PyPSA version
-        self._pypsa_version: str = __version_semver__
+        self._pypsa_version: str = __version_base__
 
         # Set attributes
         self._name = name

pypsa/version.py

@@ -4,14 +4,10 @@
 --------
 >>> pypsa.__version__ # doctest: +SKIP
 '0.34.0.post1.dev44+gf5e415b6'
->>> pypsa.__version_semver__ # doctest: +SKIP
+>>> pypsa.__version_base__ # doctest: +SKIP
 '0.34.0'
->>> pypsa.__version_short__ # doctest: +SKIP
+>>> pypsa.__version_major_minor__ # doctest: +SKIP
 '0.34'
->>> pypsa.__version_semver_tuple__ # doctest: +SKIP
-(0, 34, 0)
->>> pypsa.__version_short_tuple__ # doctest: +SKIP
-(0, 34)
 
 """
 
@@ -40,17 +36,15 @@ def check_pypsa_version(version_string: str) -> None:
     msg = f"Could not determine release_version of pypsa: {__version__}"
     raise ValueError(msg)
 
-__version_semver__ = match.group(0)
-__version_semver_tuple__ = tuple(map(int, __version_semver__.split(".")))
+__version_base__ = match.group(0)
 # e.g. "0.17"
 match = re.match(r"(\d+\.\d+)", __version__)
 
 if not match:
-    msg = f"Could not determine release_version_short of pypsa: {__version__}"
+    msg = f"Could not determine major_minor version of pypsa: {__version__}"
     raise ValueError(msg)
 
-__version_short__ = match.group(1)
-__version_short_tuple__ = tuple(map(int, __version_short__.split(".")))
+__version_major_minor__ = match.group(1)
 
 # Check pypsa version
 check_pypsa_version(__version__)

test/test_common.py

@@ -308,14 +308,14 @@ def read(self):
     [
         # Test case format: (current_version, latest_version, expected_message)
         (
-            (1, 0, 0),
+            "1.0.0",
             "2.0.0",
             "New version 2.0.0 available! (Current: 1.0.0)",
         ),  # newer version
-        ((1, 0, 0), "1.0.0", ""),  # same version
-        ((2, 0, 0), "1.0.0", ""),  # current is newer
+        ("1.0.0", "1.0.0", ""),  # same version
+        ("2.0.0", "1.0.0", ""),  # current is newer
         (
-            (1, 2, 2),
+            "1.2.2",
             "1.2.3",
             "New version 1.2.3 available! (Current: 1.2.2)",
         ),  # minor update
@@ -336,7 +336,7 @@ def test_check_for_update_error_handling():
         mock_urlopen.side_effect = Exception("Connection failed")
 
         _check_for_update.cache_clear()
-        result = _check_for_update((1, 0, 0), "test_owner", "test_repo")
+        result = _check_for_update("1.0.0", "test_owner", "test_repo")
         assert result == ""
 
 
@@ -346,7 +346,7 @@ def test_check_for_update_respects_network_option(mock_response):
 
     # Test that version check is skipped when network requests are disabled
     with pypsa.option_context("general.allow_network_requests", False):
-        result = _check_for_update((1, 0, 0), "test_owner", "test_repo")
+        result = _check_for_update("1.0.0", "test_owner", "test_repo")
         assert result == ""
 
     # Test that version check works when network requests are allowed
@@ -355,7 +355,7 @@ def test_check_for_update_respects_network_option(mock_response):
 
         _check_for_update.cache_clear()
         with pypsa.option_context("general.allow_network_requests", True):
-            result = _check_for_update((1, 0, 0), "test_owner", "test_repo")
+            result = _check_for_update("1.0.0", "test_owner", "test_repo")
             assert "New version 2.0.0 available!" in result
 
 

test/test_common_deprecations.py

@@ -14,7 +14,7 @@
 
 @pytest.fixture
 def mock_version_semver():
-    with patch("pypsa.common.__version_semver__", "1.0.0"):
+    with patch("pypsa.common.__version_base__", "1.0.0"):
         yield
 
 

test/test_version.py

@@ -1,9 +1,45 @@
+import pytest
+
+import pypsa
 from pypsa.version import check_pypsa_version
 
 
 def test_version_check(caplog):
+    caplog.clear()
     check_pypsa_version("0.20.0")
     assert caplog.text == ""
 
+    caplog.clear()
     check_pypsa_version("0.0")
     assert "The correct version of PyPSA could not be resolved" in caplog.text
+
+
+def test_version_deprecations():
+    """Test that deprecated version attributes raise DeprecationWarning."""
+    # Test deprecated renamed attributes
+    with pytest.raises(
+        DeprecationWarning,
+        match="pypsa.__version_semver__ is deprecated. Use pypsa.__version_base__ instead.",
+    ):
+        _ = pypsa.__version_semver__
+
+    with pytest.raises(
+        DeprecationWarning,
+        match="pypsa.__version_short__ is deprecated. Use pypsa.__version_major_minor__ instead.",
+    ):
+        _ = pypsa.__version_short__
+
+    # Test removed tuple attributes
+    with pytest.raises(
+        DeprecationWarning, match="pypsa.__version_semver_tuple__ has been removed"
+    ):
+        _ = pypsa.__version_semver_tuple__
+
+    with pytest.raises(
+        DeprecationWarning, match="pypsa.__version_short_tuple__ has been removed"
+    ):
+        _ = pypsa.__version_short_tuple__
+
+    # Test that new attributes work
+    assert isinstance(pypsa.__version_base__, str)
+    assert isinstance(pypsa.__version_major_minor__, str)