Merge pull request #374 from bashtage/restore-mode

Restore mode

Author: bashtage

.pep8speaks.yml

@@ -1,11 +1,16 @@
 scanner:
     diff_only: False
-    linter: flake8  # Other option is flake8
+    linter: pycodestyle  # Other option is flake8
 
 pycodestyle:  # Same as scanner.linter value. Other option is flake8
     max-line-length: 99  # Default is 79 in PEP 8
     ignore:  # Errors and warnings to ignore
         - E203  # Whitespace before ':'
         - W503  # Line break occurred before a binary operator (W503)
+        - E301
+        - E302
+        - E305
+        - E501
+        - E701
 
 no_blank_comment: False  # If True, no comment is made on PR without any errors.

randomgen/_deprecated_value.py

@@ -0,0 +1,22 @@
+class _DeprecatedValueType:
+    """Special keyword value for deprecated arguments..
+
+    The instance of this class may be used as the default value assigned to a
+    keyword if the parameter is deprecated.
+    """
+
+    __instance = None
+
+    def __new__(cls):
+        # ensure that only one instance exists
+        if not cls.__instance:
+            cls.__instance = super().__new__(cls)
+        return cls.__instance
+
+    def __repr__(self):
+        return "<deprecated>"
+
+
+_DeprecatedValue = _DeprecatedValueType()
+
+__all__ = ["_DeprecatedValue"]

randomgen/_seed_sequence.pyx

@@ -44,8 +44,8 @@ except ImportError:
     randbits = SystemRandom().getrandbits
 
 import numpy as np
-cimport numpy as np
 
+cimport numpy as np
 from libc.stdint cimport uint32_t
 
 __all__ = ["SeedSequence", "SeedlessSeedSequence", "ISeedSequence",

randomgen/aes.pyx

@@ -2,7 +2,7 @@
 import numpy as np
 
 from randomgen.common cimport *
-
+from randomgen._deprecated_value import _DeprecatedValue
 
 __all__ = ["AESCounter"]
 
@@ -17,7 +17,7 @@ cdef double aes_double(void* st) noexcept nogil:
 
 cdef class AESCounter(BitGenerator):
     """
-    AESCounter(seed=None, *, counter=None, key=None)
+    AESCounter(seed=None, *, counter=None, key=None, mode=<deprecated>)
 
     Container for the AES Counter pseudo-random number generator.
 
@@ -38,6 +38,12 @@ 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
     ----------
@@ -123,8 +129,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):
-        BitGenerator.__init__(self, seed)
+    def __init__(self, seed=None, *, counter=None, key=None, mode=_DeprecatedValue):
+        BitGenerator.__init__(self, seed, mode=mode)
         # Calloc since ctr needs to be 0
         self.rng_state = <aesctr_state_t *>PyArray_calloc_aligned(
             sizeof(aesctr_state_t), 1

randomgen/chacha.pyx

@@ -3,6 +3,8 @@ import numpy as np
 
 from randomgen.common cimport *
 
+from randomgen._deprecated_value import _DeprecatedValue
+
 __all__ = ["ChaCha"]
 
 cdef uint64_t chacha_uint64(void* st) noexcept nogil:
@@ -16,7 +18,7 @@ cdef double chacha_double(void* st) noexcept nogil:
 
 cdef class ChaCha(BitGenerator):
     """
-    ChaCha(seed=None, *, counter=None, key=None, rounds=20)
+    ChaCha(seed=None, *, counter=None, key=None, rounds=20, mode=<deprecated>)
 
     Container for the ChaCha family of Counter pseudo-random number generators
 
@@ -43,6 +45,12 @@ 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
     ----------
@@ -127,8 +135,8 @@ cdef class ChaCha(BitGenerator):
     .. [1] Bernstein, D. J.. ChaCha, a variant of Salsa20.
          http://cr.yp.to/papers.html#chacha. 2008.01.28.
     """
-    def __init__(self, seed=None, *, counter=None, key=None, rounds=20):
-        BitGenerator.__init__(self, seed)
+    def __init__(self, seed=None, *, counter=None, key=None, rounds=20, mode=_DeprecatedValue):
+        BitGenerator.__init__(self, seed, mode=mode)
         self.rng_state = <chacha_state_t *>PyArray_malloc_aligned(
             sizeof(chacha_state_t)
         )

randomgen/common.pyx

@@ -1,18 +1,23 @@
 #!python
-import sys
 from collections import namedtuple
+import sys
+import warnings
+
 try:
     from threading import Lock
 except ImportError:
     from dummy_threading import Lock
 
 import numpy as np
-from numpy.random.bit_generator cimport BitGenerator as _BitGenerator
-from cpython cimport PyFloat_AsDouble
+
 cimport numpy as np
+from cpython cimport PyFloat_AsDouble
+from numpy.random.bit_generator cimport BitGenerator as _BitGenerator
 
-from randomgen.common cimport *
 from randomgen cimport api
+from randomgen.common cimport *
+
+from randomgen._deprecated_value import _DeprecatedValue
 from randomgen.seed_sequence import ISeedSequence
 
 ISEED_SEQUENCES = (ISeedSequence,)
@@ -43,14 +48,23 @@ cdef class BitGenerator(_BitGenerator):
     """
     Abstract class for all BitGenerators
     """
-    def __init__(self, seed, mode="sequence"):
-        if mode is not None and (not isinstance(mode, str) or mode.lower() not in self._supported_modes()):
+    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:
                 modes = ", ".join(f"\"{mode}\"" for mode in self._supported_modes())
             raise ValueError(f"mode must be one of: {modes}.")
-        self.mode = mode.lower()
+        mode = mode.lower() if isinstance(mode, str) else mode
+        self.mode = "numpy" if (numpy_seed or mode == "numpy") else "sequence"
         super().__init__(seed)
 
     def _supported_modes(self):

randomgen/dsfmt.pyx

@@ -3,7 +3,7 @@ import operator
 
 import numpy as np
 cimport numpy as np
-
+from randomgen._deprecated_value import _DeprecatedValue
 from randomgen.common cimport *
 
 __all__ = ["DSFMT"]
@@ -27,7 +27,7 @@ cdef uint64_t dsfmt_raw(void *st) noexcept nogil:
 
 cdef class DSFMT(BitGenerator):
     """
-    DSFMT(seed=None)
+    DSFMT(seed=None, *, mode=<deprecated>)
 
     Container for the SIMD-based Mersenne Twister pseudo RNG.
 
@@ -40,6 +40,12 @@ 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
     ----------
@@ -110,8 +116,8 @@ cdef class DSFMT(BitGenerator):
            Sequences and Their Applications - SETA, 290--298, 2008.
     """
 
-    def __init__(self, seed=None):
-        BitGenerator.__init__(self, seed)
+    def __init__(self, seed=None, *, mode=_DeprecatedValue):
+        BitGenerator.__init__(self, seed, mode=mode)
         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/examples/cython/extending.pyx

@@ -1,12 +1,14 @@
 #cython: language_level=3
+from cpython.pycapsule cimport PyCapsule_GetPointer, PyCapsule_IsValid
 from libc.stdint cimport uint32_t
-from cpython.pycapsule cimport PyCapsule_IsValid, PyCapsule_GetPointer
 
 import numpy as np
-cimport numpy as np
+
 cimport cython
+cimport numpy as np
 
 from randomgen.common cimport bitgen_t
+
 from randomgen.xoroshiro128 import Xoroshiro128
 
 np.import_array()

randomgen/examples/cython/extending_distributions.pyx

@@ -1,10 +1,13 @@
 #cython: language_level=3
 import numpy as np
-cimport numpy as np
+
 cimport cython
-from cpython.pycapsule cimport PyCapsule_IsValid, PyCapsule_GetPointer
+cimport numpy as np
+from cpython.pycapsule cimport PyCapsule_GetPointer, PyCapsule_IsValid
+
 from randomgen.common cimport *
 from randomgen.distributions cimport random_gauss_zig
+
 from randomgen.xoroshiro128 import Xoroshiro128
 
 

randomgen/examples/cython/low_level.pyx

@@ -1,13 +1,15 @@
 #cython: language_level=3, boundscheck=False, wraparound=False
+from cpython.pycapsule cimport PyCapsule_GetPointer, PyCapsule_IsValid
 from libc.stdint cimport uint32_t
-from cpython.pycapsule cimport PyCapsule_IsValid, PyCapsule_GetPointer
 
 import numpy as np
-cimport numpy as np
+
 cimport cython
+cimport numpy as np
 
 from randomgen.common cimport bitgen_t, uint64_to_double
 from randomgen.xoshiro256 cimport Xoshiro256, xoshiro256_next64
+
 from randomgen.xoshiro256 import Xoshiro256
 
 np.import_array()