Merge pull request #420 from bashtage/remove-deprecated-mode

MAINT: Remove deprecated mode

Author: bashtage

doc/source/change-log.rst

@@ -2,6 +2,26 @@
 
 Change Log
 ----------
+v2.3.0
+======
+- Added the :class:`~randomgen.blabla.BlaBla` PRNG which is based on the Blake 2b
+  hash function.  :class:`~randomgen.blabla.BlaBla` is a counter-based PRNG like
+  :class:`~randomgen.aes.AESCounter` and supports both :meth:`~randomgen.blabla.BlaBla.advance`
+  and :meth:`~randomgen.blabla.BlaBla.jumped`.
+- Removed ``mode`` from bit generator initialization. This argument has been deprecated since release 2.0.0.
+
+.. warning::
+
+    This change is backward incompatible. If ``mode`` is essential, you should continue to use legacy
+    versions.
+
+- Moved to the build system to meson which improves build time.
+- Fixed a breaking change that affected the use of :func:`functools.partial` test suite in
+  Python 3.14.
+
+.. note::
+
+   There was no version 2.2.0.
 
 v2.1.0
 ======

doc/source/index.rst

@@ -100,8 +100,8 @@ generators, 'in addition' to the standard PRNG in NumPy.  The included PRNGs are
   arbitrary number of steps or generating independent streams. See the
   `Random123`_ page for more details about this class of PRNG.
 * Other cryptographic-based generators: :class:`~randomgen.aes.AESCounter`,
-  :class:`~randomgen.speck128.SPECK128`, :class:`~randomgen.chacha.ChaCha`, and
-  :class:`~randomgen.hc128.HC128`.
+  :class:`~randomgen.speck128.SPECK128`, :class:`~randomgen.chacha.ChaCha`,
+  :class:`~randomgen.hc128.HC128`, and :class:`~randomgen.blabla.BlaBla`.
 * XoroShiro128+/++ - Improved version of XorShift128+ with better performance
   and statistical quality. Like the XorShift generators, it can be jumped
   to produce multiple streams in parallel applications. See
@@ -114,6 +114,8 @@ generators, 'in addition' to the standard PRNG in NumPy.  The included PRNGs are
   :meth:`~randomgen.xorshift1024.Xorshift1024.jumped` for details. More information
   about these PRNGs is available at the
   `xorshift, xoroshiro and xoshiro authors' page`_.
+* Other PRNGs including :class:`~randomgen.romu.Romu`, :class:`~randomgen.tyche.Tyche`,
+  and :class:`~randomgen.squares.Squares`.
 
 .. _`NumPy's documentation`: https://docs.scipy.org/doc/numpy/reference/routines.random.html
 .. _`dSFMT authors' page`: http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/SFMT/

doc/source/performance.py

@@ -5,7 +5,6 @@
 import pandas as pd
 
 from randomgen import (
-    BlaBla,
     DSFMT,
     EFIIX64,
     HC128,
@@ -20,6 +19,7 @@
     SFMT,
     SPECK128,
     AESCounter,
+    BlaBla,
     ChaCha,
     Philox,
     Romu,
@@ -92,6 +92,7 @@ def __init__(self, *args, **kwargs):
         kwargs.pop("variant", None)
         super().__init__(*args, variant="dxsm-128", **kwargs)
 
+
 class TycheOpenRand(Tyche):
     def __init__(self, *args, **kwargs):
         kwargs.pop("original", None)

randomgen/_deprecated_value.py

@@ -1,8 +1,6 @@
 #!python
 import numpy as np
 
-from randomgen._deprecated_value import _DeprecatedValue
-
 __all__ = ["AESCounter"]
 
 cdef uint64_t aes_uint64(void* st) noexcept nogil:
@@ -16,7 +14,7 @@ cdef double aes_double(void* st) noexcept nogil:
 
 cdef class AESCounter(BitGenerator):
     """
-    AESCounter(seed=None, *, counter=None, key=None, mode="sequence")
+    AESCounter(seed=None, *, counter=None, key=None)
 
     Container for the AES Counter pseudo-random number generator.
 
@@ -37,12 +35,6 @@ cdef class AESCounter(BitGenerator):
         another RNG before use, the value in key is directly set. Can be either
         a Python int in [0, 2**128) or a 2-element uint64 array.
         key and seed cannot both be used.
-    mode : {None, "sequence"}
-        Deprecated parameter. Do not use.
-
-        .. deprecated: 2.0.0
-
-           Starting in version 2, only seed sequences are supported.
 
     Attributes
     ----------
@@ -128,8 +120,8 @@ cdef class AESCounter(BitGenerator):
     .. [1] Advanced Encryption Standard. (n.d.). In Wikipedia. Retrieved
         June 1, 2019, from https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
     """
-    def __init__(self, seed=None, *, counter=None, key=None, mode=_DeprecatedValue):
-        BitGenerator.__init__(self, seed, mode=mode)
+    def __init__(self, seed=None, *, counter=None, key=None):
+        BitGenerator.__init__(self, seed)
         # Calloc since ctr needs to be 0
         self.rng_state = <aesctr_state_t *>PyArray_calloc_aligned(
             sizeof(aesctr_state_t), 1

randomgen/aes.pyx

@@ -14,7 +14,7 @@ cdef double blabla_double(void* st) noexcept nogil:
 
 cdef class BlaBla(BitGenerator):
     """
-    BlaBla(seed=None, *, counter=None, key=None, rounds=10, mode="sequence")
+    BlaBla(seed=None, *, counter=None, key=None, rounds=10)
 
     Container for the BlaBla family of counter pseudo-random number generators
 
@@ -351,12 +351,13 @@ cdef class BlaBla(BitGenerator):
 
     def advance(self, delta):
         """
-        Advance the state by delta steps
+        Advance the state by delta steps.
 
         Parameters
         ----------
         delta : int
-            Number of steps to advance the state.
+            Number of steps to advance the state. Delta can be any integer value,
+            but is wrapped to be in [0, 2**128) which is the size of the counter.
         """
         # Squeeze with wrap into [0, 2**128)
         delta = delta % (1 << 128)

randomgen/blabla.pyx

@@ -1,8 +1,6 @@
 #!python
 import numpy as np
 
-from randomgen._deprecated_value import _DeprecatedValue
-
 __all__ = ["ChaCha"]
 
 cdef uint64_t chacha_uint64(void* st) noexcept nogil:
@@ -16,7 +14,7 @@ cdef double chacha_double(void* st) noexcept nogil:
 
 cdef class ChaCha(BitGenerator):
     """
-    ChaCha(seed=None, *, counter=None, key=None, rounds=20, mode="sequence")
+    ChaCha(seed=None, *, counter=None, key=None, rounds=20)
 
     Container for the ChaCha family of Counter pseudo-random number generators
 
@@ -43,12 +41,6 @@ cdef class ChaCha(BitGenerator):
         The standard number of rounds in 20. Smaller values, usually 8 or
         more, can be used to reduce security properties of the random stream
         while improving performance.
-    mode : {None, "sequence"}
-        Deprecated parameter. Do not use.
-
-        .. deprecated: 2.0.0
-
-           Starting in version 2, only seed sequences are supported.
 
     Attributes
     ----------
@@ -134,9 +126,9 @@ cdef class ChaCha(BitGenerator):
          http://cr.yp.to/papers.html#chacha. 2008.01.28.
     """
     def __init__(
-            self, seed=None, *, counter=None, key=None, rounds=20, mode=_DeprecatedValue
+            self, seed=None, *, counter=None, key=None, rounds=20
     ):
-        BitGenerator.__init__(self, seed, mode=mode)
+        BitGenerator.__init__(self, seed)
         self.rng_state = <chacha_state_t *>PyArray_malloc_aligned(
             sizeof(chacha_state_t)
         )

randomgen/chacha.pyx

@@ -10,7 +10,6 @@ from numpy.random import SeedSequence
 cimport numpy as np
 from numpy.random.bit_generator cimport BitGenerator as _BitGenerator
 
-from randomgen._deprecated_value import _DeprecatedValue
 from randomgen.seed_sequence import ISeedSequence
 
 ISEED_SEQUENCES = (ISeedSequence, np.random.bit_generator.ISeedSequence)
@@ -54,26 +53,8 @@ cdef class BitGenerator(_BitGenerator):
     """
     Abstract class for all BitGenerators
     """
-    def __init__(self, seed, *, numpy_seed=False, mode=_DeprecatedValue):
-        if mode is not _DeprecatedValue:
-            msg = ("mode is deprecated and will be removed in a future version. "
-                   "Seeding defaults to a numpy.random.SeedSequence instance.")
-            if "numpy" in self._supported_modes():
-                msg += " Use numpy_seed=True to enforce numpy-compatible seeding."
-            warnings.warn(msg, FutureWarning)
-        if mode is not _DeprecatedValue and (
-                not isinstance(mode, str) or mode.lower() not in self._supported_modes()
-        ):
-            if len(self._supported_modes()) == 1:
-                msg = f"mode must be {self._supported_modes()[0]}"
-            else:
-                msg = (
-                        "mode must be one of: " +
-                        ", ".join(f"\"{mode}\"" for mode in self._supported_modes())
-                )
-            raise ValueError(msg)
-        mode = mode.lower() if isinstance(mode, str) else mode
-        self.mode = "numpy" if (numpy_seed or mode == "numpy") else "sequence"
+    def __init__(self, seed, *, numpy_seed=False):
+        self.mode = "numpy" if numpy_seed else "sequence"
         super().__init__(seed)
         if type(self) is BitGenerator:
             raise NotImplementedError(

randomgen/common.pyx

@@ -2,8 +2,6 @@
 
 import numpy as np
 
-from randomgen._deprecated_value import _DeprecatedValue
-
 __all__ = ["DSFMT"]
 
 DEF DSFMT_MEXP = 19937
@@ -25,7 +23,7 @@ cdef uint64_t dsfmt_raw(void *st) noexcept nogil:
 
 cdef class DSFMT(BitGenerator):
     """
-    DSFMT(seed=None, *, mode="sequence")
+    DSFMT(seed=None)
 
     Container for the SIMD-based Mersenne Twister pseudo RNG.
 
@@ -38,12 +36,6 @@ cdef class DSFMT(BitGenerator):
         ``None`` (the default). If `seed` is ``None``, then 764 32-bit unsigned
         integers are read from ``/dev/urandom`` (or the Windows analog) if
         available. If unavailable, a hash of the time and process ID is used.
-    mode : {None, "sequence"}
-        Deprecated parameter. Do not use.
-
-        .. deprecated: 2.0.0
-
-           Starting in version 2, only seed sequences are supported.
 
     Attributes
     ----------
@@ -114,8 +106,8 @@ cdef class DSFMT(BitGenerator):
            Sequences and Their Applications - SETA, 290--298, 2008.
     """
 
-    def __init__(self, seed=None, *, mode=_DeprecatedValue):
-        BitGenerator.__init__(self, seed, mode=mode)
+    def __init__(self, seed=None):
+        BitGenerator.__init__(self, seed)
         self.rng_state.state = <dsfmt_t *>PyArray_malloc_aligned(sizeof(dsfmt_t))
         self.rng_state.buffered_uniforms = <double *>PyArray_calloc_aligned(
             DSFMT_N64, sizeof(double)

randomgen/dsfmt.pyx

@@ -2,8 +2,6 @@
 # coding=utf-8
 import numpy as np
 
-from randomgen._deprecated_value import _DeprecatedValue
-
 __all__ = ["HC128"]
 
 cdef uint64_t hc128_uint64(void* st) noexcept nogil:
@@ -18,7 +16,7 @@ cdef double hc128_double(void* st) noexcept nogil:
 
 cdef class HC128(BitGenerator):
     """
-    HC128(seed=None, *, key=None, mode="sequence")
+    HC128(seed=None, *, key=None)
 
     Container for the HC-128 cipher-based pseudo-random number generator
 
@@ -35,12 +33,6 @@ cdef class HC128(BitGenerator):
         Key for HC128. The key is a 256-bit integer that contains both the
         key (lower 128 bits) and initial values (upper 128-bits) for the
         HC-128 cipher. key and seed cannot both be used.
-    mode : {None, "sequence"}
-        Deprecated parameter. Do not use.
-
-        .. deprecated: 2.0.0
-
-           Starting in version 2, only seed sequences are supported.
 
     Attributes
     ----------
@@ -111,8 +103,8 @@ cdef class HC128(BitGenerator):
     .. [2] Wu, Hongjun, "Stream Ciphers HC-128 and HC-256".
         https://www.ntu.edu.sg/home/wuhj/research/hc/index.html)
     """
-    def __init__(self, seed=None, *, key=None, mode=_DeprecatedValue):
-        BitGenerator.__init__(self, seed, mode=mode)
+    def __init__(self, seed=None, *, key=None):
+        BitGenerator.__init__(self, seed)
         self.seed(seed, key)
 
         self._bitgen.state = <void *>&self.rng_state