Merge pull request #444 from skirpichev/misc

Misc fixes
aleaxit · Oct 28, 2023 · 1253106 · 1253106
2 parents a751ea9 + b56dfe3
commit 1253106
Show file tree

Hide file tree

Showing 22 changed files with 95 additions and 97 deletions.
diff --git a/.github/workflows/pip_install_gmpy2.yml b/.github/workflows/pip_install_gmpy2.yml
@@ -20,7 +20,7 @@ jobs:
       - run: pip --verbose install --editable .[tests]
       - run: python test/runtests.py
       - run: PYTHONPATH=`pwd`/gmpy2 python test_cython/runtests.py
-        if: ${{ matrix.python-version == '3.11' }}
+        if: ${{ matrix.python-version != '3.13' }}
 
   linux:
     strategy:

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,10 +1,30 @@
 Welcome to gmpy2's documentation!
 =================================
 
+gmpy2 is a C-coded Python extension module that supports multiple-precision
+arithmetic.  It is the successor to the original gmpy module (supported only
+the GMP library). gmpy2 adds support for the MPFR (correctly rounded real
+floating-point arithmetic) and MPC (correctly rounded complex floating-point
+arithmetic) libraries.
+
+The following libraries are supported:
+
+* GMP for integer and rational arithmetic (https://gmplib.org)
+* MPFR (https://www.mpfr.org)
+* MPC (https://www.multiprecision.org/mpc/)
+* Generalized Lucas sequences and primality tests are based on the following
+  code:
+
+      * mpz_lucas: https://sourceforge.net/projects/mpzlucas/
+      * mpz_prp: https://sourceforge.net/projects/mpzprp/
+
+Contents
+--------
+
 .. toctree::
    :maxdepth: 2
 
-   intro
+   install
    overview
    mpz
    advmpz

diff --git a/docs/install.rst b/docs/install.rst
@@ -0,0 +1,11 @@
+Installation
+============
+
+gmpy2 requires CPython 3.7 or above.  Pre-compiled binary wheels are available
+on PyPI.  You can install latest release with pip::
+
+    pip install gmpy2
+
+or some specific version with::
+
+    pip install gmpy2==2.1.5
diff --git a/docs/intro.rst b/docs/intro.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -38,7 +38,7 @@ content-type = 'text/x-rst'
 
 [project.optional-dependencies]
 docs = ['sphinx>=4', 'sphinx-rtd-theme>=1']
-tests = ['pytest', 'hypothesis', 'cython', 'mpmath']
+tests = ['pytest', 'hypothesis', 'cython', 'mpmath', 'setuptools']
 
 [project.urls]
 Homepage = 'https://github.com/aleaxit/gmpy'

diff --git a/src/gmpy2.c b/src/gmpy2.c
@@ -704,10 +704,10 @@ static PyMethodDef Pygmpy_methods [] =
     { "bit_flip", GMPy_MPZ_bit_flip_function, METH_VARARGS, doc_bit_flip_function },
     { "bit_length", GMPy_MPZ_bit_length_function, METH_O, doc_bit_length_function },
     { "bit_mask", GMPy_MPZ_bit_mask, METH_O, doc_bit_mask },
-    { "bit_scan0", GMPy_MPZ_bit_scan0_function, METH_VARARGS, doc_bit_scan0_function },
-    { "bit_scan1", GMPy_MPZ_bit_scan1_function, METH_VARARGS, doc_bit_scan1_function },
+    { "bit_scan0", (PyCFunction)GMPy_MPZ_bit_scan0_function, METH_FASTCALL, doc_bit_scan0_function },
+    { "bit_scan1", (PyCFunction)GMPy_MPZ_bit_scan1_function, METH_FASTCALL, doc_bit_scan1_function },
     { "bit_set", GMPy_MPZ_bit_set_function, METH_VARARGS, doc_bit_set_function },
-    { "bit_test", GMPy_MPZ_bit_test_function, METH_VARARGS, doc_bit_test_function },
+    { "bit_test", (PyCFunction)GMPy_MPZ_bit_test_function, METH_FASTCALL, doc_bit_test_function },
     { "bincoef", GMPy_MPZ_Function_Bincoef, METH_VARARGS, GMPy_doc_mpz_function_bincoef },
     { "cmp", GMPy_MPANY_cmp, METH_VARARGS, GMPy_doc_mpany_cmp },
     { "cmp_abs", GMPy_MPANY_cmp_abs, METH_VARARGS, GMPy_doc_mpany_cmp_abs },

diff --git a/src/gmpy2_context.c b/src/gmpy2_context.c
@@ -350,7 +350,7 @@ GMPy_CTXT_Repr_Slot(CTXT_Object *self)
 static PyObject *
 GMPy_CTXT_Manager_Repr_Slot(CTXT_Manager_Object *self)
 {
-    return Py_BuildValue("s", "<gmpy2.ContextManagerObject>");
+    return PyUnicode_FromString("<gmpy2.ContextManagerObject>");
 }
 
 PyDoc_STRVAR(GMPy_doc_get_context,

diff --git a/src/gmpy2_convert.c b/src/gmpy2_convert.c
@@ -330,7 +330,7 @@ mpz_ascii(mpz_t z, int base, int option, int which)
         *(p++) = ')';
     *(p++) = '\00';
 
-    result = Py_BuildValue("s", buffer);
+    result = PyUnicode_FromString(buffer);
     if (negative == 1) {
         mpz_neg(z, z);
     }

diff --git a/src/gmpy2_convert_mpc.c b/src/gmpy2_convert_mpc.c
@@ -605,7 +605,7 @@ GMPy_MPC_Str_Slot(MPC_Object *self)
 
     sprintf(fmtstr, "{0:.%ld.%ldg}", rprec, iprec);
 
-    temp = Py_BuildValue("s", fmtstr);
+    temp = PyUnicode_FromString(fmtstr);
     if (!temp)
         return NULL;
     result = PyObject_CallMethod(temp, "format", "O", self);
@@ -631,7 +631,7 @@ GMPy_MPC_Repr_Slot(MPC_Object *self)
     else
         sprintf(fmtstr, "mpc('{0:.%ld.%ldg}')", rprec, iprec);
 
-    temp = Py_BuildValue("s", fmtstr);
+    temp = PyUnicode_FromString(fmtstr);
     if (!temp)
         return NULL;
     result = PyObject_CallMethod(temp, "format", "O", self);

diff --git a/src/gmpy2_convert_mpfr.c b/src/gmpy2_convert_mpfr.c
@@ -888,7 +888,7 @@ GMPy_MPFR_Str_Slot(MPFR_Object *self)
 
     sprintf(fmtstr, "{0:.%ldg}", precision);
 
-    temp = Py_BuildValue("s", fmtstr);
+    temp = PyUnicode_FromString(fmtstr);
     if (!temp)
         return NULL;
     result = PyObject_CallMethod(temp, "format", "O", self);
@@ -911,7 +911,7 @@ GMPy_MPFR_Repr_Slot(MPFR_Object *self)
     else
         sprintf(fmtstr, "mpfr('{0:.%ldg}')", precision);
 
-    temp = Py_BuildValue("s", fmtstr);
+    temp = PyUnicode_FromString(fmtstr);
     if (!temp)
         return NULL;
     result = PyObject_CallMethod(temp, "format", "O", self);

diff --git a/src/gmpy2_format.c b/src/gmpy2_format.c
@@ -332,11 +332,11 @@ GMPy_MPFR_Format(PyObject *self, PyObject *args)
         strcat(newbuf, buffer);
         strcat(newbuf, ".0");
         mpfr_free_str(buffer);
-        mpfrstr = Py_BuildValue("s", newbuf);
+        mpfrstr = PyUnicode_FromString(newbuf);
         free(newbuf);
     }
     else {
-        mpfrstr = Py_BuildValue("s", buffer);
+        mpfrstr = PyUnicode_FromString(buffer);
         mpfr_free_str(buffer);
     }
     if (!mpfrstr) {
@@ -618,7 +618,7 @@ GMPy_MPC_Format(PyObject *self, PyObject *args)
     mpfr_free_str(realbuf);
     mpfr_free_str(imagbuf);
 
-    tempstr = Py_BuildValue("s", tempbuf);
+    tempstr = PyUnicode_FromString(tempbuf);
     if (!tempstr) {
         free(tempbuf);
         return NULL;

diff --git a/src/gmpy2_misc.c b/src/gmpy2_misc.c
@@ -33,7 +33,7 @@ PyDoc_STRVAR(GMPy_doc_license,
 static PyObject *
 GMPy_get_license(PyObject *self, PyObject *args)
 {
-    return Py_BuildValue("s", gmpy_license);
+    return PyUnicode_FromString(gmpy_license);
 }
 
 PyDoc_STRVAR(GMPy_doc_version,
@@ -43,7 +43,7 @@ PyDoc_STRVAR(GMPy_doc_version,
 static PyObject *
 GMPy_get_version(PyObject *self, PyObject *args)
 {
-    return Py_BuildValue("s", gmpy_version);
+    return PyUnicode_FromString(gmpy_version);
 }
 
 PyDoc_STRVAR(GMPy_doc_mp_version,
@@ -83,5 +83,5 @@ Return the number of bits per limb.");
 static PyObject *
 GMPy_get_mp_limbsize(PyObject *self, PyObject *args)
 {
-    return Py_BuildValue("i", mp_bits_per_limb);
+    return PyLong_FromLong(mp_bits_per_limb);
 }
diff --git a/src/gmpy2_mpz.c b/src/gmpy2_mpz.c
@@ -95,13 +95,13 @@ static PyMethodDef GMPy_MPZ_methods[] = {
     { "bit_count", GMPy_MPZ_bit_count_method, METH_NOARGS, doc_bit_count_method },
     { "bit_flip", GMPy_MPZ_bit_flip_method, METH_O, doc_bit_flip_method },
     { "bit_length", GMPy_MPZ_bit_length_method, METH_NOARGS, doc_bit_length_method },
-    { "bit_scan0", GMPy_MPZ_bit_scan0_method, METH_VARARGS, doc_bit_scan0_method },
-    { "bit_scan1", GMPy_MPZ_bit_scan1_method, METH_VARARGS, doc_bit_scan1_method },
+    { "bit_scan0", (PyCFunction)GMPy_MPZ_bit_scan0_method, METH_FASTCALL, doc_bit_scan0_method },
+    { "bit_scan1", (PyCFunction)GMPy_MPZ_bit_scan1_method, METH_FASTCALL, doc_bit_scan1_method },
     { "bit_set", GMPy_MPZ_bit_set_method, METH_O, doc_bit_set_method },
     { "bit_test", GMPy_MPZ_bit_test_method, METH_O, doc_bit_test_method },
     { "conjugate", GMPy_MP_Method_Conjugate, METH_NOARGS, GMPy_doc_mp_method_conjugate },
     { "digits", GMPy_MPZ_Digits_Method, METH_VARARGS, GMPy_doc_mpz_digits_method },
-    { "is_congruent", GMPy_MPZ_Method_IsCongruent, METH_VARARGS, GMPy_doc_mpz_method_is_congruent },
+    { "is_congruent", (PyCFunction)GMPy_MPZ_Method_IsCongruent, METH_FASTCALL, GMPy_doc_mpz_method_is_congruent },
     { "is_divisible", GMPy_MPZ_Method_IsDivisible, METH_O, GMPy_doc_mpz_method_is_divisible },
     { "is_even", GMPy_MPZ_Method_IsEven, METH_NOARGS, GMPy_doc_mpz_method_is_even },
     { "is_odd", GMPy_MPZ_Method_IsOdd, METH_NOARGS, GMPy_doc_mpz_method_is_odd },

diff --git a/src/gmpy2_mpz_bitops.c b/src/gmpy2_mpz_bitops.c
@@ -96,12 +96,13 @@ PyDoc_STRVAR(doc_bit_scan0_method,
 "format), then `None` is returned.");
 
 static PyObject *
-GMPy_MPZ_bit_scan0_method(PyObject *self, PyObject *args)
+GMPy_MPZ_bit_scan0_method(PyObject *self, PyObject *const *args,
+                          Py_ssize_t nargs)
 {
     mp_bitcnt_t index, starting_bit = 0;
 
-    if (PyTuple_GET_SIZE(args) == 1) {
-        starting_bit = GMPy_Integer_AsMpBitCnt(PyTuple_GET_ITEM(args, 0));
+    if (nargs == 1) {
+        starting_bit = GMPy_Integer_AsMpBitCnt(args[0]);
         if (starting_bit == (mp_bitcnt_t)(-1) && PyErr_Occurred()) {
             return NULL;
         }
@@ -125,21 +126,22 @@ PyDoc_STRVAR(doc_bit_scan0_function,
 "format), then `None` is returned.");
 
 static PyObject *
-GMPy_MPZ_bit_scan0_function(PyObject *self, PyObject *args)
+GMPy_MPZ_bit_scan0_function(PyObject *self, PyObject *const *args,
+                            Py_ssize_t nargs)
 {
     mp_bitcnt_t index, starting_bit = 0;
     MPZ_Object *tempx = NULL;
 
-    if (PyTuple_GET_SIZE(args) == 0 || PyTuple_GET_SIZE(args) > 2) {
+    if (nargs == 0 || nargs > 2) {
         goto err;
     }
 
-    if (!(tempx = GMPy_MPZ_From_Integer(PyTuple_GET_ITEM(args, 0), NULL))) {
+    if (!(tempx = GMPy_MPZ_From_Integer(args[0], NULL))) {
         goto err;
     }
 
-    if (PyTuple_GET_SIZE(args) == 2) {
-        starting_bit = GMPy_Integer_AsMpBitCnt(PyTuple_GET_ITEM(args, 1));
+    if (nargs == 2) {
+        starting_bit = GMPy_Integer_AsMpBitCnt(args[1]);
         if (starting_bit == (mp_bitcnt_t)(-1) && PyErr_Occurred()) {
             goto err_index;
         }
@@ -170,12 +172,13 @@ PyDoc_STRVAR(doc_bit_scan1_method,
 "format), then `None` is returned.");
 
 static PyObject *
-GMPy_MPZ_bit_scan1_method(PyObject *self, PyObject *args)
+GMPy_MPZ_bit_scan1_method(PyObject *self, PyObject *const *args,
+                          Py_ssize_t nargs)
 {
     mp_bitcnt_t index, starting_bit = 0;
 
-    if (PyTuple_GET_SIZE(args) == 1) {
-        starting_bit = GMPy_Integer_AsMpBitCnt(PyTuple_GET_ITEM(args, 0));
+    if (nargs == 1) {
+        starting_bit = GMPy_Integer_AsMpBitCnt(args[0]);
         if (starting_bit == (mp_bitcnt_t)(-1) && PyErr_Occurred()) {
             return NULL;
         }
@@ -199,21 +202,22 @@ PyDoc_STRVAR(doc_bit_scan1_function,
 "format), then `None` is returned.");
 
 static PyObject *
-GMPy_MPZ_bit_scan1_function(PyObject *self, PyObject *args)
+GMPy_MPZ_bit_scan1_function(PyObject *self, PyObject *const *args,
+                            Py_ssize_t nargs)
 {
     mp_bitcnt_t index, starting_bit = 0;
     MPZ_Object *tempx = NULL;
 
-    if (PyTuple_GET_SIZE(args) == 0 || PyTuple_GET_SIZE(args) > 2) {
+    if (nargs == 0 || nargs > 2) {
         goto err;
     }
 
-    if (!(tempx = GMPy_MPZ_From_Integer(PyTuple_GET_ITEM(args, 0), NULL))) {
+    if (!(tempx = GMPy_MPZ_From_Integer(args[0], NULL))) {
         goto err;
     }
 
-    if (PyTuple_GET_SIZE(args) == 2) {
-        starting_bit = GMPy_Integer_AsMpBitCnt(PyTuple_GET_ITEM(args, 1));
+    if (nargs == 2) {
+        starting_bit = GMPy_Integer_AsMpBitCnt(args[1]);
         if (starting_bit == (mp_bitcnt_t)(-1) && PyErr_Occurred()) {
             goto err_index;
         }
@@ -242,21 +246,22 @@ PyDoc_STRVAR(doc_bit_test_function,
 "Return the value of the n-th bit of x.");
 
 static PyObject *
-GMPy_MPZ_bit_test_function(PyObject *self, PyObject *args)
+GMPy_MPZ_bit_test_function(PyObject *self, PyObject *const *args,
+                           Py_ssize_t nargs)
 {
     mp_bitcnt_t bit_index;
     int temp;
     MPZ_Object *tempx = NULL;
 
-    if (PyTuple_GET_SIZE(args) != 2) {
+    if (nargs != 2) {
         goto err;
     }
 
-    if (!(tempx = GMPy_MPZ_From_Integer(PyTuple_GET_ITEM(args, 0), NULL))) {
+    if (!(tempx = GMPy_MPZ_From_Integer(args[0], NULL))) {
         goto err;
     }
 
-    bit_index = GMPy_Integer_AsMpBitCnt(PyTuple_GET_ITEM(args, 1));
+    bit_index = GMPy_Integer_AsMpBitCnt(args[1]);
     if (bit_index == (mp_bitcnt_t)(-1) && PyErr_Occurred()) {
         goto err_index;
     }

diff --git a/src/gmpy2_mpz_bitops.h b/src/gmpy2_mpz_bitops.h
@@ -34,12 +34,12 @@ extern "C" {
 static PyObject * GMPy_MPZ_bit_length_function(PyObject *self, PyObject *other);
 static PyObject * GMPy_MPZ_bit_length_method(PyObject *self, PyObject *other);
 static PyObject * GMPy_MPZ_bit_mask(PyObject *self, PyObject *other);
-static PyObject * GMPy_MPZ_bit_scan0_function(PyObject *self, PyObject *args);
-static PyObject * GMPy_MPZ_bit_scan0_method(PyObject *self, PyObject *args);
-static PyObject * GMPy_MPZ_bit_scan1_function(PyObject *self, PyObject *args);
-static PyObject * GMPy_MPZ_bit_scan1_method(PyObject *self, PyObject *args);
+static PyObject * GMPy_MPZ_bit_scan0_function(PyObject *self, PyObject *const *args, Py_ssize_t nargs);
+static PyObject * GMPy_MPZ_bit_scan0_method(PyObject *self, PyObject *const *args, Py_ssize_t nargs);
+static PyObject * GMPy_MPZ_bit_scan1_function(PyObject *self, PyObject *const *args, Py_ssize_t nargs);
+static PyObject * GMPy_MPZ_bit_scan1_method(PyObject *self, PyObject *const *args, Py_ssize_t nargs);
 
-static PyObject * GMPy_MPZ_bit_test_function(PyObject *self, PyObject *args);
+static PyObject * GMPy_MPZ_bit_test_function(PyObject *self, PyObject *const *args, Py_ssize_t nargs);
 static PyObject * GMPy_MPZ_bit_test_method(PyObject *self, PyObject *other);
 static PyObject * GMPy_MPZ_bit_clear_function(PyObject *self, PyObject *args);
 static PyObject * GMPy_MPZ_bit_clear_method(PyObject *self, PyObject *other);

diff --git a/src/gmpy2_mpz_misc.c b/src/gmpy2_mpz_misc.c
@@ -1227,18 +1227,19 @@ PyDoc_STRVAR(GMPy_doc_mpz_method_is_congruent,
 "Returns `True` if x is congruent to y modulo m, else return `False`.");
 
 static PyObject *
-GMPy_MPZ_Method_IsCongruent(PyObject *self, PyObject *args)
+GMPy_MPZ_Method_IsCongruent(PyObject *self, PyObject *const *args,
+                            Py_ssize_t nargs)
 {
     int res;
     MPZ_Object *tempy = NULL, *tempm = NULL;
 
-    if (PyTuple_GET_SIZE(args) != 2) {
+    if (nargs != 2) {
         TYPE_ERROR("is_congruent() requires 2 integer arguments");
         return NULL;
     }
 
-    if (!(tempy = GMPy_MPZ_From_Integer(PyTuple_GET_ITEM(args, 0), NULL)) ||
-        !(tempm = GMPy_MPZ_From_Integer(PyTuple_GET_ITEM(args, 1), NULL))) {
+    if (!(tempy = GMPy_MPZ_From_Integer(args[0], NULL)) ||
+        !(tempm = GMPy_MPZ_From_Integer(args[1], NULL))) {
 
         Py_XDECREF((PyObject*)tempy);
         Py_XDECREF((PyObject*)tempm);