Warning only when (major, minor) versions differ

Signed-off-by: Vlad Gheorghiu <[email protected]>

Author: vsoftco

CHANGES.md

@@ -1,6 +1,12 @@
 # Pre-release
 
 - Added type checking and automatic linting/formatting, https://github.com/open-quantum-safe/liboqs-python/pull/97
+- Added a utility function for de-structuring version strings in `oqs.py`
+  - `version(version_str: str) -> tuple[str, str, str]:` - Returns a tuple
+    containing the
+    (major, minor, patch) versions
+- A warning is issued only if the liboqs-python version's major and minor
+  numbers differ from those of liboqs, ignoring the patch version
 
 # Version 0.12.0 - January 15, 2025
 

oqs/oqs.py

@@ -34,6 +34,25 @@
 logger.setLevel(logging.INFO)
 logger.addHandler(logging.StreamHandler(stdout))
 
+# Expected return value from native OQS functions
+OQS_SUCCESS: Final[int] = 0
+OQS_ERROR: Final[int] = -1
+
+
+def native() -> ct.CDLL:
+    """Handle to native liboqs handler."""
+    return _liboqs
+
+
+# liboqs initialization
+native().OQS_init()
+
+
+def oqs_version() -> str:
+    """`liboqs` version string."""
+    native().OQS_version.restype = ct.c_char_p
+    return ct.c_char_p(native().OQS_version()).value.decode("UTF-8")  # type: ignore[union-attr]
+
 
 def oqs_python_version() -> Union[str, None]:
     """liboqs-python version string."""
@@ -45,6 +64,31 @@ def oqs_python_version() -> Union[str, None]:
     return result
 
 
+def version(version_str: str) -> tuple[str, str, str]:
+    parts = version_str.split(".")
+
+    major = parts[0] if len(parts) > 0 else ""
+    minor = parts[1] if len(parts) > 1 else ""
+    patch = parts[2] if len(parts) > 2 else ""
+
+    return major, minor, patch
+
+
+oqs_ver = oqs_version()
+oqs_ver_major, oqs_ver_minor, oqs_ver_patch = version(oqs_ver)
+
+oqs_python_ver = oqs_python_version()
+if oqs_python_ver:
+    oqs_python_ver_major, oqs_python_ver_minor, oqs_python_ver_patch = version(oqs_python_ver)
+    # Warn the user if the liboqs version differs from liboqs-python version
+    if not (oqs_ver_major == oqs_python_ver_major and oqs_ver_minor == oqs_python_ver_minor):
+        warnings.warn(
+            f"liboqs version (major, minor) {oqs_version()} differs from liboqs-python version "
+            f"{oqs_python_version()}",
+            stacklevel=2,
+        )
+
+
 # liboqs-python tries to automatically install and load this liboqs version in
 # case no other version is found
 OQS_VERSION = oqs_python_version()
@@ -206,35 +250,6 @@ def _load_liboqs() -> ct.CDLL:
 _liboqs = _load_liboqs()
 
 
-# Expected return value from native OQS functions
-OQS_SUCCESS: Final[int] = 0
-OQS_ERROR: Final[int] = -1
-
-
-def native() -> ct.CDLL:
-    """Handle to native liboqs handler."""
-    return _liboqs
-
-
-# liboqs initialization
-native().OQS_init()
-
-
-def oqs_version() -> str:
-    """`liboqs` version string."""
-    native().OQS_version.restype = ct.c_char_p
-    return ct.c_char_p(native().OQS_version()).value.decode("UTF-8")  # type: ignore[union-attr]
-
-
-# Warn the user if the liboqs version differs from liboqs-python version
-if oqs_version() != oqs_python_version():
-    warnings.warn(
-        f"liboqs version {oqs_version()} differs from liboqs-python version "
-        f"{oqs_python_version()}",
-        stacklevel=2,
-    )
-
-
 class MechanismNotSupportedError(Exception):
     """Exception raised when an algorithm is not supported by OQS."""