Redo local_context() at C level, correct context() docs

Author: skirpichev

gmpy2/__init__.py

@@ -1,6 +1,5 @@
 from .gmpy2 import *
 from .gmpy2 import __version__
-from .gmpy2 import _local_context
 # Internal variables/functions are not imported by * above.
 # These are used by some python level functions and are needed
 # at the top level.
@@ -9,11 +8,3 @@
     from .gmpy2 import _C_API, _mpmath_normalize, _mpmath_create
 except ImportError:
     from .gmpy2 import _mpmath_normalize, _mpmath_create
-
-
-def local_context(*args, **kwargs):
-    """Alias of `context()`, for compatibility."""
-    import warnings
-    warnings.warn("local_context() is deprecated, use context() instead",
-                  DeprecationWarning)
-    return context(*args, **kwargs)

src/gmpy2.c

@@ -888,7 +888,7 @@ static PyMethodDef Pygmpy_methods [] =
     { "lgamma", GMPy_Context_Lgamma, METH_O, GMPy_doc_function_lgamma },
     { "li2", GMPy_Context_Li2, METH_O, GMPy_doc_function_li2 },
     { "lngamma", GMPy_Context_Lngamma, METH_O, GMPy_doc_function_lngamma },
-    { "_local_context", (PyCFunction)GMPy_CTXT_Local_Context2, METH_VARARGS | METH_KEYWORDS, GMPy_doc_local_context2 },
+    { "local_context", (PyCFunction)GMPy_CTXT_Local, METH_VARARGS | METH_KEYWORDS, GMPy_doc_local_context },
     { "log", GMPy_Context_Log, METH_O, GMPy_doc_function_log },
     { "log1p", GMPy_Context_Log1p, METH_O, GMPy_doc_function_log1p },
     { "log10", GMPy_Context_Log10, METH_O, GMPy_doc_function_log10 },

src/gmpy2_context.c

@@ -528,26 +528,43 @@ _parse_context_args(CTXT_Object *ctxt, PyObject *kwargs)
     return 1;
 }
 
-PyDoc_STRVAR(GMPy_doc_local_context2,
-"helper function for local_context");
+PyDoc_STRVAR(GMPy_doc_local_context,
+"local_context(**kwargs) -> context\n"
+"local_context(context, /, **kwargs) -> context\n\n"
+"Return a new context for controlling gmpy2 arithmetic, based either\n"
+"on the current context or on a ctx value.  Context options additionally\n"
+"can be overriden by keyword arguments.");
 
 static PyObject *
-GMPy_CTXT_Local_Context2(PyObject *self, PyObject *args, PyObject *kwargs)
+GMPy_CTXT_Local(PyObject *self, PyObject *args, PyObject *kwargs)
 {
     CTXT_Object *result = NULL, *temp = NULL;
 
+    if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
+                         "local_context() is deprecated, "
+                         "use context(get_context()) instead.")) {
+        return NULL;
+    }
 
     if (PyTuple_GET_SIZE(args) == 0) {
         if (!(temp = (CTXT_Object*)GMPy_CTXT_Get())) {
+            /* LCOV_EXCL_START */
             return NULL;
+            /* LCOV_EXCL_STOP */
         }
         if (!(result = (CTXT_Object*)GMPy_CTXT_Copy(temp, NULL))) {
+            /* LCOV_EXCL_START */
             return NULL;
+            /* LCOV_EXCL_STOP */
         }
         Py_DECREF((PyObject*)temp);
     }
     else if (PyTuple_GET_SIZE(args) == 1 && CTXT_Check(PyTuple_GET_ITEM(args, 0))) {
-        result = (CTXT_Object*)GMPy_CTXT_Copy(PyTuple_GET_ITEM(args, 0), NULL);
+        if (!(result = (CTXT_Object*)GMPy_CTXT_Copy(PyTuple_GET_ITEM(args, 0), NULL))) {
+            /* LCOV_EXCL_START */
+            return NULL;
+            /* LCOV_EXCL_STOP */
+        }
     }
     else {
         VALUE_ERROR("_local_context() only supports [[context][,keyword]] arguments");
@@ -569,8 +586,8 @@ PyDoc_STRVAR(GMPy_doc_context,
 "context(**kwargs)\n"
 "context(ctx, /, **kwargs)\n\n"
 "Return a new context for controlling gmpy2 arithmetic, based either\n"
-"on the current context or on a ctx value.  Context options additionally\n"
-"can be overriden by keyword arguments.");
+"on the default context or on a given by ctx value.  Context options\n"
+"additionally can be overriden by keyword arguments.");
 
 static PyObject *
 GMPy_CTXT_Context(PyTypeObject *type, PyObject *args, PyObject *kwargs)
@@ -586,7 +603,11 @@ GMPy_CTXT_Context(PyTypeObject *type, PyObject *args, PyObject *kwargs)
         }
     }
     else if (PyTuple_GET_SIZE(args) == 1 && CTXT_Check(PyTuple_GET_ITEM(args, 0))) {
-        result = (CTXT_Object*)GMPy_CTXT_Copy(PyTuple_GET_ITEM(args, 0), NULL);
+        if (!(result = (CTXT_Object*)GMPy_CTXT_Copy(PyTuple_GET_ITEM(args, 0), NULL))) {
+            /* LCOV_EXCL_START */
+            return NULL;
+            /* LCOV_EXCL_STOP */
+        }
     }
     else {
         VALUE_ERROR("context() only supports [[context][,keyword]] arguments");

test/test_context.py

@@ -1,7 +1,10 @@
+import warnings
+
 import pytest
 
 import gmpy2
-from gmpy2 import context, get_context, ieee, mpc, mpfr, mpz, set_context
+from gmpy2 import (context, get_context, ieee, local_context, mpc, mpfr, mpz,
+                   set_context)
 
 
 def test_context_abs():
@@ -160,9 +163,9 @@ def test_context():
 
 def test_nested_context():
     set_context(context())
-    
+
     r = [get_context().precision]
-    
+
     with ieee(128):
         r.append(get_context().precision)
         with ieee(256):
@@ -177,9 +180,9 @@ def test_nested_context():
 
 def test_nested_context():
     set_context(context())
-    
+
     r = [get_context().precision]
-    
+
     with context(ieee(128)):
         r.append(get_context().precision)
         with context(ieee(256)):
@@ -254,3 +257,24 @@ def test_context_repr():
  erange=False,\n        trap_divzero=False, divzero=False,\n\
         allow_complex=False,\n        rational_division=False,\n\
         allow_release_gil=False)"""
+
+
+def test_local_context_deprecated():
+    with pytest.deprecated_call():
+        local_context()
+
+    with warnings.catch_warnings():
+        warnings.simplefilter("error", DeprecationWarning)
+        pytest.raises(DeprecationWarning, lambda: local_context())
+
+
+@pytest.mark.filterwarnings("ignore:.*:DeprecationWarning")
+def test_local_context():
+    get_context().precision = 123
+    with context() as ctx:
+        assert ctx.precision == 53
+    with local_context() as ctx:
+        assert ctx.precision == 123
+
+    pytest.raises(ValueError, lambda: local_context(1, 2))
+    pytest.raises(ValueError, lambda: local_context(spam=123))