Merge pull request #76 from maresb/fix-doctests-without-numba

Fix doctests when Numba is disabled

Author: dgilford

src/tcpyPI/numba.py

@@ -8,14 +8,33 @@
 import os
 from functools import wraps
 
+import numpy as np
+
 
 def noop_njit(*args, **kwargs):
-    """No-op decorator to replace @njit when numba is disabled."""
+    """No-op decorator to replace @njit when numba is disabled.
+
+    Note that this decorator isn't entirely a noop, because numba does some casting
+    of NumPy types to Python types. Since NumPy v2, NumPy types like np.float64 are
+    printed explicitly, so the doctests would fail without casting scalars back
+    to Python types.
+
+    See <https://github.com/numba/numba/issues/704> for more details about Numba's
+    behavior.
+    """
 
     def decorator(func):
         @wraps(func)
         def wrapper(*args, **kwargs):
-            return func(*args, **kwargs)
+            result = func(*args, **kwargs)
+            if isinstance(result, np.floating):
+                result = float(result)
+            elif isinstance(result, tuple):
+                # Cast components to float
+                result = tuple(
+                    float(x) if isinstance(x, np.floating) else x for x in result
+                )
+            return result
 
         return wrapper
 

src/tcpyPI/utilities.py

@@ -292,12 +292,10 @@ def decompose_pi(pi,sstk,t0,CKCD=0.9):
         tuple: (lnpi, lneff, lndiseq, lnCKCD)
         
     Examples:
-        >>> result = decompose_pi(70, 300, 200, 0.9)
-        >>> [x for x in result]
-        [8.496..., -0.693..., 9.295..., -0.105...]
-        >>> result = decompose_pi(50, 295, 210, 0.9)
-        >>> [x for x in result]
-        [7.824..., -0.904..., 8.833..., -0.105...]
+        >>> decompose_pi(70, 300, 200, 0.9)
+        (8.496..., -0.693..., 9.295..., -0.105...)
+        >>> decompose_pi(50, 295, 210, 0.9)
+        (7.824..., -0.904..., 8.833..., -0.105...)
 
     Exceptional cases:
         - Efficiency is non-positive