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

@@ -35,29 +35,6 @@
 logger.addHandler(logging.StreamHandler(stdout))
 
 
-def oqs_python_version() -> Union[str, None]:
-    """liboqs-python version string."""
-    try:
-        result = importlib.metadata.version("liboqs-python")
-    except importlib.metadata.PackageNotFoundError:
-        warnings.warn("Please install liboqs-python using pip install", stacklevel=2)
-        return None
-    return result
-
-
-# liboqs-python tries to automatically install and load this liboqs version in
-# case no other version is found
-OQS_VERSION = oqs_python_version()
-
-
-def _countdown(seconds: int) -> None:
-    while seconds > 0:
-        logger.info("Installing in %s seconds...", seconds)
-        stdout.flush()
-        seconds -= 1
-        time.sleep(1)
-
-
 def _load_shared_obj(
     name: str,
     additional_searching_paths: Union[Sequence[Path], None] = None,
@@ -100,6 +77,14 @@ def _load_shared_obj(
     raise RuntimeError(msg)
 
 
+def _countdown(seconds: int) -> None:
+    while seconds > 0:
+        logger.info("Installing in %s seconds...", seconds)
+        stdout.flush()
+        seconds -= 1
+        time.sleep(1)
+
+
 def _install_liboqs(
     target_directory: Path,
     oqs_version_to_install: Union[str, None] = None,
@@ -188,7 +173,9 @@ def _load_liboqs() -> ct.CDLL:
         assert liboqs  # noqa: S101
     except RuntimeError:
         # We don't have liboqs, so we try to install it automatically
-        _install_liboqs(target_directory=oqs_install_dir, oqs_version_to_install=OQS_VERSION)
+        _install_liboqs(
+            target_directory=oqs_install_dir, oqs_version_to_install=OQS_VERSION
+        )
         # Try loading it again
         try:
             liboqs = _load_shared_obj(
@@ -206,11 +193,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
@@ -220,19 +202,58 @@ def native() -> ct.CDLL:
 native().OQS_init()
 
 
+def oqs_python_version() -> Union[str, None]:
+    """liboqs-python version string."""
+    try:
+        result = importlib.metadata.version("liboqs-python")
+    except importlib.metadata.PackageNotFoundError:
+        warnings.warn("Please install liboqs-python using pip install", stacklevel=2)
+        return None
+    return result
+
+
 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,
+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()
+
+# Expected return value from native OQS functions
+OQS_SUCCESS: Final[int] = 0
+OQS_ERROR: Final[int] = -1
 
 
 class MechanismNotSupportedError(Exception):
@@ -281,7 +302,9 @@ class KeyEncapsulation(ct.Structure):
         ("decaps_cb", ct.c_void_p),
     ]
 
-    def __init__(self, alg_name: str, secret_key: Union[int, bytes, None] = None) -> None:
+    def __init__(
+        self, alg_name: str, secret_key: Union[int, bytes, None] = None
+    ) -> None:
         """
         Create new KeyEncapsulation with the given algorithm.
 
@@ -435,9 +458,15 @@ def is_kem_enabled(alg_name: str) -> bool:
     return native().OQS_KEM_alg_is_enabled(ct.create_string_buffer(alg_name.encode()))
 
 
-_KEM_alg_ids = [native().OQS_KEM_alg_identifier(i) for i in range(native().OQS_KEM_alg_count())]
-_supported_KEMs: tuple[str, ...] = tuple([i.decode() for i in _KEM_alg_ids])  # noqa: N816
-_enabled_KEMs: tuple[str, ...] = tuple([i for i in _supported_KEMs if is_kem_enabled(i)])  # noqa: N816
+_KEM_alg_ids = [
+    native().OQS_KEM_alg_identifier(i) for i in range(native().OQS_KEM_alg_count())
+]
+_supported_KEMs: tuple[str, ...] = tuple(
+    [i.decode() for i in _KEM_alg_ids]
+)  # noqa: N816
+_enabled_KEMs: tuple[str, ...] = tuple(
+    [i for i in _supported_KEMs if is_kem_enabled(i)]
+)  # noqa: N816
 
 
 def get_enabled_kem_mechanisms() -> tuple[str, ...]:
@@ -478,7 +507,9 @@ class Signature(ct.Structure):
         ("verify_cb", ct.c_void_p),
     ]
 
-    def __init__(self, alg_name: str, secret_key: Union[int, bytes, None] = None) -> None:
+    def __init__(
+        self, alg_name: str, secret_key: Union[int, bytes, None] = None
+    ) -> None:
         """
         Create new Signature with the given algorithm.
 
@@ -723,9 +754,13 @@ def is_sig_enabled(alg_name: str) -> bool:
     return native().OQS_SIG_alg_is_enabled(ct.create_string_buffer(alg_name.encode()))
 
 
-_sig_alg_ids = [native().OQS_SIG_alg_identifier(i) for i in range(native().OQS_SIG_alg_count())]
+_sig_alg_ids = [
+    native().OQS_SIG_alg_identifier(i) for i in range(native().OQS_SIG_alg_count())
+]
 _supported_sigs: tuple[str, ...] = tuple([i.decode() for i in _sig_alg_ids])
-_enabled_sigs: tuple[str, ...] = tuple([i for i in _supported_sigs if is_sig_enabled(i)])
+_enabled_sigs: tuple[str, ...] = tuple(
+    [i for i in _supported_sigs if is_sig_enabled(i)]
+)
 
 
 def get_enabled_sig_mechanisms() -> tuple[str, ...]: