bpo-46018: Ensure that math.expm1 does not raise on underflow (GH-29997)

(cherry picked from commit 3363e1cb05d0d19ed172ea63606d8cb6268747fc)

Co-authored-by: Steve Dower <steve.dower@python.org>

diff --git a/Misc/NEWS.d/next/Library/2021-12-09-00-44-42.bpo-46018.hkTI7v.rst b/Misc/NEWS.d/next/Library/2021-12-09-00-44-42.bpo-46018.hkTI7v.rst
new file mode 100644 (file)
index 0000000..6ff76f5
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2021-12-09-00-44-42.bpo-46018.hkTI7v.rst
@@ -0,0 +1 @@
+Ensure that :func:`math.expm1` does not raise on underflow.

diff --git a/Modules/mathmodule.c b/Modules/mathmodule.c
index c974601b95e37bea9ebd068f792d897509bc645d..1f16849a3e6f6ecf413f8d9ec6144692ccb463f9 100644 (file)
--- a/Modules/mathmodule.c
+++ b/Modules/mathmodule.c
@@ -971,9 +971,13 @@ is_error(double x)
          * On some platforms (Ubuntu/ia64) it seems that errno can be
          * set to ERANGE for subnormal results that do *not* underflow
          * to zero.  So to be safe, we'll ignore ERANGE whenever the
-         * function result is less than one in absolute value.
+         * function result is less than 1.5 in absolute value.
+         *
+         * bpo-46018: Changed to 1.5 to ensure underflows in expm1()
+         * are correctly detected, since the function may underflow
+         * toward -1.0 rather than 0.0.
          */
-        if (fabs(x) < 1.0)
+        if (fabs(x) < 1.5)
             result = 0;
         else
             PyErr_SetString(PyExc_OverflowError,