Merge pull request #119 from skirpichev/v0.2.1

v0.2.1

Author: skirpichev

.github/workflows/docs.yml

@@ -16,6 +16,7 @@ jobs:
           sudo apt-get install libgmp-dev
           sudo apt-get install texlive texlive-latex-extra latexmk
       - run: pip install --upgrade pip
+      - run: pip install -U git+https://github.com/picnixz/sphinx.git@fix/13188-classmethod-c
       - run: pip --verbose install --editable .[docs]
       - run: |
           alias sphinx-build='sphinx-build --color -W --keep-going'

.readthedocs.yaml

@@ -11,10 +11,11 @@ build:
         python: "3"
 python:
     install:
+        - requirements: docs/requirements.txt
         - method: pip
           path: .
-          extra_requirements:
-              - docs
+#         extra_requirements:
+#             - docs
 sphinx:
     fail_on_warning: true
     configuration: docs/conf.py

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Sergey B Kirpichev
+Copyright (c) 2024-2025 Sergey B Kirpichev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -17,12 +17,12 @@ The CPython (and most other Python implementations, like PyPy) is optimized to
 work with small integers.  Algorithms used here for "big enough" integers
 usually aren't best known in the field.  Fortunately, it's possible to use
 bindings (for example, the `gmpy2 <https://pypi.org/project/gmpy2/>`_ package)
-to the GNU Multiple Precision Arithmetic Library (GMP), which aims to be
-faster than any other bignum library for all operand sizes.
+to the GNU Multiple Precision Arithmetic Library (GMP), which aims to be faster
+than any other bignum library for all operand sizes.
 
 But such extension modules usually rely on default GMP's memory allocation
-functions and can't recover from errors such as out of memory.  So, e.g. it's
-easy to crash the Python interpreter during the interactive session.  Above
+functions and can't recover from errors such as out of memory.  So, it's easy
+to crash the Python interpreter during the interactive session.  Following
 example with the gmpy2 should work on most Unix systems:
 
 .. code:: pycon
@@ -42,6 +42,8 @@ The gmp module handles such errors correctly:
 
 .. code:: pycon
 
+   >>> import gmp, resource
+   >>> resource.setrlimit(resource.RLIMIT_AS, (1024*32*1024, -1))
    >>> z = gmp.mpz(29925959575501)
    >>> while True:
    ...     z = z*z

docs/conf.py

@@ -34,7 +34,7 @@
 
 # General information about the project.
 project = gmp.__package__
-copyright = "2024, Sergey B Kirpichev"
+copyright = "2024-2025, Sergey B Kirpichev"
 
 gmp_version = packaging.version.parse(gmp.__version__)
 

docs/requirements.txt

@@ -0,0 +1 @@
+sphinx @ git+https://github.com/picnixz/sphinx.git@fix/13188-classmethod-c

main.c

@@ -150,11 +150,8 @@ MPZ_abs(MPZ_Object *u)
     return res;
 }
 
-/* Maps 1-byte integer to digit character for bases up to 36 and
-   from 37 up to 62, respectively. */
-static const char *num_to_text36 = "0123456789abcdefghijklmnopqrstuvwxyz";
-static const char *num_to_text62 = ("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
-                                    "abcdefghijklmnopqrstuvwxyz");
+/* Maps 1-byte integer to digit character for bases up to 36. */
+static const char *num_to_text = "0123456789abcdefghijklmnopqrstuvwxyz";
 
 static const char *mpz_tag = "mpz(";
 static int OPT_TAG = 0x1;
@@ -163,9 +160,8 @@ static int OPT_PREFIX = 0x2;
 static PyObject *
 MPZ_to_str(MPZ_Object *u, int base, int options)
 {
-    if (base < 2 || base > 62) {
-        PyErr_SetString(PyExc_ValueError,
-                        "base must be in the interval [2, 62]");
+    if (base < 2 || base > 36) {
+        PyErr_SetString(PyExc_ValueError, "mpz base must be >= 2 and <= 36");
         return NULL;
     }
 
@@ -209,9 +205,6 @@ MPZ_to_str(MPZ_Object *u, int base, int options)
         return PyErr_NoMemory();
         /* LCOV_EXCL_STOP */
     }
-
-    const char *num_to_text = base > 36 ? num_to_text62 : num_to_text36;
-
     for (size_t i = 0; i < len; i++) {
         *p = num_to_text[*p];
         p++;
@@ -266,9 +259,9 @@ const unsigned char gmp_digit_value_tab[] =
 static MPZ_Object *
 MPZ_from_str(PyObject *obj, int base)
 {
-    if (base != 0 && (base < 2 || base > 62)) {
+    if (base != 0 && (base < 2 || base > 36)) {
         PyErr_SetString(PyExc_ValueError,
-                        "base must be 0 or in the interval [2, 62]");
+                        "mpz base must be >= 2 and <= 36, or 0");
         return NULL;
     }
 
@@ -339,11 +332,6 @@ MPZ_from_str(PyObject *obj, int base)
     }
 
     const unsigned char *digit_value = gmp_digit_value_tab;
-
-    if (base > 36) {
-        digit_value += 208;
-    }
-
     Py_ssize_t new_len = len;
 
     for (Py_ssize_t i = 0; i < len; i++) {
@@ -2136,7 +2124,7 @@ gmp_parse_pyargs(const gmp_pyargs *fnargs, int argidx[], PyObject *const *args,
 }
 
 static PyObject *
-vectorcall(PyObject *type, PyObject * const*args, size_t nargsf,
+vectorcall(PyObject *type, PyObject *const *args, size_t nargsf,
            PyObject *kwnames)
 {
     Py_ssize_t nargs = PyVectorcall_NARGS(nargsf);
@@ -2177,28 +2165,28 @@ str(PyObject *self)
     return MPZ_to_str((MPZ_Object *)self, 10, 0);
 }
 
-#define Number_Check(op) (PyFloat_Check((op)) \
-                          || PyComplex_Check((op)))
+#define Number_Check(op) (PyFloat_Check((op)) || PyComplex_Check((op)))
 
-#define CHECK_OP(u, a)            \
-    if (MPZ_Check(a)) {           \
-        u = (MPZ_Object *)a;      \
-        Py_INCREF(u);             \
-    }                             \
-    else if (PyLong_Check(a)) {   \
-        u = MPZ_from_int(a);      \
-        if (!u) {                 \
-            goto end;             \
-        }                         \
-    }                             \
-    else if (Number_Check(a)) {   \
-        goto numbers;             \
-    }                             \
-    else {                        \
-        goto fallback;            \
+#define CHECK_OP(u, a)          \
+    if (MPZ_Check(a)) {         \
+        u = (MPZ_Object *)a;    \
+        Py_INCREF(u);           \
+    }                           \
+    else if (PyLong_Check(a)) { \
+        u = MPZ_from_int(a);    \
+        if (!u) {               \
+            goto end;           \
+        }                       \
+    }                           \
+    else if (Number_Check(a)) { \
+        goto numbers;           \
+    }                           \
+    else {                      \
+        goto fallback;          \
     }
 
-static PyObject * to_float(PyObject *self);
+static PyObject *
+to_float(PyObject *self);
 
 static PyObject *
 richcompare(PyObject *self, PyObject *other, int op)
@@ -3362,7 +3350,7 @@ static struct PyModuleDef gmp_module = {
 };
 
 PyDoc_STRVAR(gmp_info__doc__,
-"gmp.gmplib_info\n\
+             "gmp.gmplib_info\n\
 \n\
 A named tuple that holds information about GNU GMP\n\
 and it's internal representation of integers.\n\

pyproject.toml

@@ -57,7 +57,9 @@ version = {attr = "setuptools_scm.get_version"}
 [project.optional-dependencies]
 tests = ["pytest", "hypothesis"]
 docs = ["sphinx"]
-develop = ["python-gmp[tests,docs]", "pre-commit"]
+develop = ["python-gmp[tests,docs]", "pre-commit", "pyperf",
+           "gmpy2>=2.2; platform_python_implementation!='PyPy'",
+           "python-flint>=0.7.0a5"]
 
 [tool.pytest.ini_options]
 addopts = "--durations=7"

tests/test_mpz.py

@@ -685,11 +685,9 @@ def test___sizeof__():
 def to_digits(n, base):
     if n == 0:
         return "0"
-    if base < 2 or base > 62:
-        raise ValueError("base must be in the interval [2, 62]")
+    if base < 2 or base > 36:
+        raise ValueError("mpz base must be >= 2 and <= 36")
     num_to_text = string.digits + string.ascii_lowercase
-    if base > 36:
-        num_to_text = num_to_text.upper() + string.ascii_lowercase
     digits = []
     if n < 0:
         sign = "-"
@@ -704,37 +702,7 @@ def to_digits(n, base):
     return sign + "".join(digits[::-1])
 
 
-def from_digits(s, base):
-    if s == "0":
-        return 0
-    if base < 2 or base > 62:
-        raise ValueError("base must be in the interval [2, 62]")
-    if base <= 36:
-        return int(s, base)
-    if s[0] == "-":
-        negative = True
-        s = s[1:]
-    else:
-        negative = False
-    n = 0
-    b = 1
-    for c in reversed(s):
-        v = ord(c)
-        if ord("0") <= v <= ord("9"):
-            v -= ord("0")
-        elif ord("A") <= v <= ord("Z"):
-            v -= ord("A") - 10
-        else:
-            if base <= 36:
-                v -= ord("a") - 10
-            else:
-                v -= ord("a") - 36
-        n += v*b
-        b *= base
-    return -n if negative else n
-
-
-@given(integers(), integers(min_value=2, max_value=62))
+@given(integers(), integers(min_value=2, max_value=36))
 def test_digits(x, base):
     mx = mpz(x)
     res = to_digits(x, base)
@@ -761,7 +729,7 @@ def test_digits_interface():
 
 
 @given(integers(), integers(min_value=2, max_value=36))
-def test_digits_frombase_low(x, base):
+def test_digits_frombase(x, base):
     mx = mpz(x)
     smx = mx.digits(base)
     assert mpz(smx, base) == mx
@@ -777,22 +745,6 @@ def test_digits_frombase_low(x, base):
         assert mpz(smx, smaller_base) == i
 
 
-@given(integers(), integers(min_value=37, max_value=62))
-def test_digits_frombase_high(x, base):
-    mx = mpz(x)
-    smx = mx.digits(base)
-    assert mpz(smx, base) == mx
-    assert from_digits(smx, base) == mx
-    smaller_base = (base + 2)//2 + 1
-    try:
-        g = from_digits(smx, smaller_base)
-    except ValueError:
-        with pytest.raises(ValueError):
-            mpz(smx, smaller_base)
-    else:
-        assert mpz(smx, smaller_base) == g
-
-
 @given(integers())
 def test_frombase_auto(x):
     mx = mpz(x)