Skip to content

Commit 65a93c5

Browse files
committed
BUG: preserve BitGenerator state after failed reinitialization
Validate seed inputs before mutating BitGenerator state so a failed reinitialization cannot leave a valid generator with a NULL state pointer. Validate Philox counter/key inputs before calling the base initializer for the same reason. Closes numpygh-28784.
1 parent 5551144 commit 65a93c5

3 files changed

Lines changed: 35 additions & 7 deletions

File tree

‎numpy/random/_philox.pyx‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,11 +166,16 @@ cdef class Philox(BitGenerator):
166166
def __init__(self, seed=None, counter=None, key=None):
167167
if seed is not None and key is not None:
168168
raise ValueError('seed and key cannot be both used')
169+
170+
counter = 0 if counter is None else counter
171+
counter = int_to_array(counter, 'counter', 256, 64)
172+
if key is not None:
173+
key = int_to_array(key, 'key', 128, 64)
174+
169175
BitGenerator.__init__(self, seed)
170176
self.rng_state.ctr = &self.philox_ctr
171177
self.rng_state.key = &self.philox_key
172178
if key is not None:
173-
key = int_to_array(key, 'key', 128, 64)
174179
for i in range(2):
175180
self.rng_state.key.v[i] = key[i]
176181
# The seed sequence is invalid.
@@ -179,8 +184,6 @@ cdef class Philox(BitGenerator):
179184
key = self._seed_seq.generate_state(2, np.uint64)
180185
for i in range(2):
181186
self.rng_state.key.v[i] = key[i]
182-
counter = 0 if counter is None else counter
183-
counter = int_to_array(counter, 'counter', 256, 64)
184187
for i in range(4):
185188
self.rng_state.ctr.v[i] = counter[i]
186189

‎numpy/random/bit_generator.pyx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -534,18 +534,19 @@ cdef class BitGenerator:
534534
"""
535535

536536
def __init__(self, seed=None):
537-
self.lock = RLock()
538-
self._bitgen.state = <void *>0
539537
if type(self) is BitGenerator:
540538
raise NotImplementedError('BitGenerator is a base class and cannot be instantized')
541539

540+
if not isinstance(seed, ISeedSequence):
541+
seed = SeedSequence(seed)
542+
543+
self.lock = RLock()
544+
self._bitgen.state = <void *>0
542545
self._ctypes = None
543546
self._cffi = None
544547

545548
cdef const char *name = "BitGenerator"
546549
self.capsule = PyCapsule_New(<void *>&self._bitgen, name, NULL)
547-
if not isinstance(seed, ISeedSequence):
548-
seed = SeedSequence(seed)
549550
self._seed_seq = seed
550551

551552
# Pickling support:

‎numpy/random/tests/test_direct.py‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,30 @@ def generate_state(self, n_words, dtype=np.uint32):
226226
rng.bit_generator.spawn(5)
227227

228228

229+
@pytest.mark.parametrize(
230+
"bit_generator_cls", [MT19937, PCG64, PCG64DXSM, SFC64, Philox]
231+
)
232+
def test_failed_reinitialization_preserves_state(bit_generator_cls):
233+
bit_generator = bit_generator_cls(1234)
234+
expected = bit_generator_cls(1234).random_raw(10)
235+
236+
with pytest.raises(ValueError):
237+
bit_generator.__init__(("",))
238+
239+
assert_array_equal(bit_generator.random_raw(10), expected)
240+
241+
242+
@pytest.mark.parametrize("kwargs", [{"counter": "invalid"}, {"key": "invalid"}])
243+
def test_philox_failed_reinitialization_preserves_state(kwargs):
244+
bit_generator = Philox(1234)
245+
expected = Philox(1234).random_raw(10)
246+
247+
with pytest.raises(ValueError):
248+
bit_generator.__init__(**kwargs)
249+
250+
assert_array_equal(bit_generator.random_raw(10), expected)
251+
252+
229253
class Base:
230254
dtype = np.uint64
231255
data2 = data1 = {}

0 commit comments

Comments
 (0)