FIX: Fix pickling support

Fix pickling support and finalize test
Change RNG_NAME to RNG_MOD_NAME to be more explicit and avoid conflict
Clean up appveyor

Author: Sheppard, Kevin

README.md

@@ -35,7 +35,6 @@ identical sequence of random numbers for a given seed.
 ## Plans
 It is essentially complete.  There are a few rough edges that need to be smoothed.
 
-  * Pickling support
   * Stream support for MLFG and MRG32K3A
   * Creation of additional streams from a RandomState where supported (i.e. 
   a `next_stream()` method)

appveyor.yml

@@ -22,7 +22,5 @@ build_script:
   - pip install . -vvv
 
 test_script:
-  - echo %cd%
   - cd ..
-  - echo %cd%
   - nosetests randomstate

randomstate/__init__.py

@@ -1,4 +1,4 @@
 from __future__ import division, absolute_import, print_function
 
-from randomstate.prng.mt19937.mt19937 import *
+from randomstate.prng.mt19937 import *
 import randomstate.prng

randomstate/config.pxi

@@ -1,3 +1,3 @@
 # Autogenerated
 
-DEF RNG_NAME='xorshift128'
+DEF RNG_MOD_NAME='xorshift128'

randomstate/interface.pyx

@@ -28,22 +28,22 @@ np.import_array()
 include "config.pxi"
 #include "src/common/binomial.pxi"
 
-IF RNG_NAME == 'pcg32':
+IF RNG_MOD_NAME == 'pcg32':
     include "shims/pcg-32/pcg-32.pxi"
-IF RNG_NAME == 'pcg64':
+IF RNG_MOD_NAME == 'pcg64':
     IF PCG128_EMULATED:
         include "shims/pcg-64/pcg-64-emulated.pxi"
     ELSE:
         include "shims/pcg-64/pcg-64.pxi"
-IF RNG_NAME == 'mt19937':
+IF RNG_MOD_NAME == 'mt19937':
     include "shims/random-kit/random-kit.pxi"
-IF RNG_NAME == 'xorshift128':
+IF RNG_MOD_NAME == 'xorshift128':
     include "shims/xorshift128/xorshift128.pxi"
-IF RNG_NAME == 'xorshift1024':
+IF RNG_MOD_NAME == 'xorshift1024':
     include "shims/xorshift1024/xorshift1024.pxi"
-IF RNG_NAME == 'mrg32k3a':
+IF RNG_MOD_NAME == 'mrg32k3a':
     include "shims/mrg32k3a/mrg32k3a.pxi"
-IF RNG_NAME == 'mlfg_1279_861':
+IF RNG_MOD_NAME == 'mlfg_1279_861':
     include "shims/mlfg-1279-861/mlfg-1279-861.pxi"
 
 IF NORMAL_METHOD == 'inv':
@@ -213,9 +213,7 @@ cdef class RandomState:
         self.set_state(state)
 
     def __reduce__(self):
-        # TODO: This is wrong
-        # TODO: Removed np.random.__RandomState_ctor - This is needed on a RNG-by-RNG basis
-        return (randomstate.prng.__generic_ctor, (RNG_NAME,), self.get_state())
+        return (randomstate.prng.__generic_ctor, (RNG_MOD_NAME,), self.get_state())
 
     IF RNG_NAME == 'mt19937':
         def seed(self, seed=None):

randomstate/prng/__init__.py

@@ -1,27 +1,46 @@
-from randomstate.prng.mt19937 import mt19937
-from randomstate.prng.mlfg_1279_861 import mlfg_1279_861
-from randomstate.prng.mrg32k3a import mrg32k3a
-from randomstate.prng.pcg32 import pcg32
-from randomstate.prng.pcg64 import pcg64
-from randomstate.prng.xorshift1024 import xorshift1024
-from randomstate.prng.xorshift128 import xorshift128
+from .xorshift128 import xorshift128
+from .xorshift1024 import xorshift1024
+from .mlfg_1279_861 import mlfg_1279_861
+from .mt19937 import mt19937
+from .mrg32k3a import mrg32k3a
+from .pcg32 import pcg32
+from .pcg64 import pcg64
 
-def __generic_ctor(rng_name='mt19937'):
-    print(rng_name)
-    if rng_name == 'mt19937':
+def __generic_ctor(mod_name='mt19937'):
+    """
+    Pickling helper function that returns a mod_name.RandomState object
+
+    Parameters
+    ----------
+    mod_name: str
+        String containing the module name
+
+    Returns
+    -------
+    rs: RandomState
+        RandomState from the module randomstate.prng.mod_name
+    """
+    print(mod_name)
+    try:
+        mod_name = mod_name.decode('ascii')
+    except AttributeError:
+        pass
+    print(mod_name)
+    if mod_name == 'mt19937':
         mod = mt19937
-    elif rng_name == 'mlfg_1279_861':
+    elif mod_name == 'mlfg_1279_861':
         mod = mlfg_1279_861
-    elif rng_name == 'mrg32k3a':
+    elif mod_name == 'mrg32k3a':
         mod = mrg32k3a
-    elif rng_name == 'pcg32':
+    elif mod_name == 'pcg32':
         mod = pcg32
-    elif rng_name == 'pcg64':
+    elif mod_name == 'pcg64':
         mod = pcg64
-    elif rng_name == 'pcg32':
+    elif mod_name == 'pcg32':
         mod = pcg32
-    elif rng_name == 'xorshift128+':
+    elif mod_name == 'xorshift128':
         mod = xorshift128
-    elif rng_name == 'xorshift1024*':
+    elif mod_name == 'xorshift1024':
         mod = xorshift1024
+
     return mod.RandomState(0)

randomstate/prng/mlfg_1279_861/__init__.py

@@ -0,0 +1 @@
+from .mlfg_1279_861 import *

randomstate/prng/mrg32k3a/__init__.py

@@ -0,0 +1 @@
+from .mrg32k3a import *

randomstate/prng/mt19937/__init__.py

@@ -0,0 +1 @@
+from .mt19937 import *

randomstate/prng/pcg32/__init__.py

@@ -0,0 +1 @@
+from .pcg32 import *