8000 API: move bit_generator and generator to be private · numpy/numpy@260bf67 · GitHub
[go: up one dir, main page]
Skip to content

Commit 260bf67

Browse files
mattipmattip
committed
API: move bit_generator and generator to be private
1 parent aeac7d5 commit 260bf67

20 files changed

+22
-33
lines changed

‎doc/source/reference/random/bit_generators/bitgenerators.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
BitGenerator
44
------------
55

6-
.. currentmodule:: numpy.random.bit_generator
6+
.. currentmodule:: numpy.random._bit_generator
77

88
.. autosummary::
99
:toctree: generated/

‎doc/source/reference/random/bit_generators/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,6 @@ convenient ways.
107107
:toctree: generated/
108108

109109
SeedSequence
110-
bit_generator.ISeedSequence
111-
bit_generator.ISpawnableSeedSequence
112-
bit_generator.SeedlessSeedSequence
110+
_bit_generator.ISeedSequence
111+
_bit_generator.ISpawnableSeedSequence
112+
_bit_generator.SeedlessSeedSequence

‎doc/source/reference/random/new-or-different.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Feature Older Equivalent Notes
2121
------------------ -------------------- -------------
2222
`~.Generator` `~.RandomState` ``Generator`` requires a stream
2323
source, called a `BitGenerator
24-
<bit_generators>` A number of these
24+
<_bit_generators>` A number of these
2525
are provided. ``RandomState`` uses
2626
the Mersenne Twister `~.MT19937` by
2727
default, but can also be instantiated

‎numpy/random/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,8 @@
182182
from . import _common
183183
from . import _bounded_integers
184184

185-
from .generator import Generator, default_rng
186-
from .bit_generator import SeedSequence
185+
from ._generator import Generator, default_rng
186+
from ._bit_generator import SeedSequence
187187
from ._mt19937 import MT19937
188188
from ._pcg64 import PCG64
189189
from ._philox import Philox

‎numpy/random/bit_generator.pxd renamed to ‎numpy/random/_bit_generator.pxd

File renamed without changes.

‎numpy/random/bit_generator.pyx renamed to ‎numpy/random/_bit_generator.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ def _coerce_to_uint32_array(x):
114114
Examples
115115
--------
116116
>>> import numpy as np
117-
>>> from numpy.random.bit_generator import _coerce_to_uint32_array
117+
>>> from numpy.random._bit_generator import _coerce_to_uint32_array
118118
>>> _coerce_to_uint32_array(12345)
119119
array([12345], dtype=uint32)
120120
>>> _coerce_to_uint32_array('12345')

‎numpy/random/_bounded_integers.pxd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import numpy as np
44
cimport numpy as np
55
ctypedef np.npy_bool bool_t
66

7-
from .bit_generator cimport bitgen_t
7+
from ._bit_generator cimport bitgen_t
88

99
cdef inline uint64_t _gen_mask(uint64_t max_val) nogil:
1010
"""Mask generator for use in bounded random numbers"""

‎numpy/random/_bounded_integers.pxd.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import numpy as np
44
cimport numpy as np
55
ctypedef np.npy_bool bool_t
66

7-
from .bit_generator cimport bitgen_t
7+
from ._bit_generator cimport bitgen_t
88

99
cdef inline uint64_t _gen_mask(uint64_t max_val) nogil:
1010
"""Mask generator for use in bounded random numbers"""

‎numpy/random/_common.pxd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ from libc.stdint cimport uint32_t, uint64_t, int32_t, int64_t
55
import numpy as np
66
cimport numpy as np
77

8-
from .bit_generator cimport bitgen_t
8+
from ._bit_generator cimport bitgen_t
99

1010
cdef double POISSON_LAM_MAX
1111
cdef double LEGACY_POISSON_LAM_MAX

‎numpy/random/generator.pyx renamed to ‎numpy/random/_generator.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ from ._bounded_integers cimport (_rand_bool, _rand_int32, _rand_int64,
1919
_rand_uint8, _gen_mask)
2020
from ._bounded_integers import _integers_types
2121
from ._pcg64 import PCG64
22-
from .bit_generator cimport bitgen_t
22+
from ._bit_generator cimport bitgen_t
2323
from ._common cimport (POISSON_LAM_MAX, CONS_POSITIVE, CONS_NONE,
2424
CONS_NON_NEGATIVE, CONS_BOUNDED_0_1, CONS_BOUNDED_GT_0_1,
2525
CONS_GT_1, CONS_POSITIVE_NOT_NAN, CONS_POISSON,

‎numpy/random/_mt19937.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import numpy as np
44
cimport numpy as np
55

66
from libc.stdint cimport uint32_t, uint64_t
7-
from .bit_generator cimport BitGenerator, SeedSequence
7+
from ._bit_generator cimport BitGenerator, SeedSequence
88

99
__all__ = ['MT19937']
1010

‎numpy/random/_pcg64.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ cimport numpy as np
33

44
from libc.stdint cimport uint32_t, uint64_t
55
from ._common cimport uint64_to_double, wrap_int
6-
from .bit_generator cimport BitGenerator
6+
from ._bit_generator cimport BitGenerator
77

88
__all__ = ['PCG64']
99

‎numpy/random/_philox.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ cimport numpy as np
1010

1111
from libc.stdint cimport uint32_t, uint64_t
1212
from ._common cimport uint64_to_double, int_to_array, wrap_int
13-
from .bit_generator cimport BitGenerator
13+
from ._bit_generator cimport BitGenerator
1414

1515
__all__ = ['Philox']
1616

‎numpy/random/_pickle.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from ._pcg64 import PCG64
44
from ._sfc64 import SFC64
55

6-
from .generator import Generator
6+
from ._generator import Generator
77
from ._mt19937 import MT19937
88

99
BitGenerators = {'MT19937': MT19937,

‎numpy/random/_sfc64.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ cimport numpy as np
33

44
from libc.stdint cimport uint32_t, uint64_t
55
from ._common cimport uint64_to_double
6-
from .bit_generator cimport BitGenerator
6+
from ._bit_generator cimport BitGenerator
77

88
__all__ = ['SFC64']
99

‎numpy/random/mtrand.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ from ._bounded_integers cimport (_rand_bool, _rand_int32, _rand_int64,
1717
_rand_uint8,)
1818
from ._bounded_integers import _integers_types
1919
from ._mt19937 import MT19937 as _MT19937
20-
from .bit_generator cimport bitgen_t
20+
from ._bit_generator cimport bitgen_t
2121
from ._common cimport (POISSON_LAM_MAX, CONS_POSITIVE, CONS_NONE,
2222
CONS_NON_NEGATIVE, CONS_BOUNDED_0_1, CONS_BOUNDED_GT_0_1, CONS_GTE_1,
2323
CONS_GT_1, LEGACY_CONS_POISSON,

‎numpy/random/setup.py

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ def generate_libraries(ext, build_dir):
8686
'bit_generator.pxd'],
8787
define_macros=_defs,
8888
)
89-
for gen in ['_common', 'bit_generator']:
89+
for gen in ['_common', '_bit_generator']:
9090
# gen.pyx
9191
config.add_extension(gen,
9292
sources=['{0}.c'.format(gen)],
@@ -102,7 +102,7 @@ def generate_libraries(ext, build_dir):
102102
'src/distributions/distributions.c',
103103
'src/distributions/random_hypergeometric.c',
104104
]
105-
for gen in ['generator', '_bounded_integers']:
105+
for gen in ['_generator', '_bounded_integers']:
106106
# gen.pyx, src/distributions/distributions.c
107107
config.add_extension(gen,
108108
sources=['{0}.c'.format(gen)] + other_srcs,
@@ -126,15 +126,6 @@ def generate_libraries(ext, build_dir):
126126
depends=['mtrand.pyx'],
127127
define_macros=defs + LEGACY_DEFS,
128128
)
129-
config.add_data_files('bit_generator.pxd')
130-
config.add_data_files('_bounded_integers.pxd')
131-
config.add_data_files('_common.pxd')
132-
# config.add_data_files('generator.pxd')
133-
# config.add_data_files('_mt19937.pxd')
134-
# config.add_data_files('_mtrand.pxd')
135-
# config.add_data_files('_pcg64.pxd')
136-
# config.add_data_files('_philox.pxd')
137-
# config.add_data_files('_sfc64.pxd')
138129
return config
139130

140131

‎numpy/random/tests/test_direct.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ def gauss_from_uint(x, n, bits):
120120
return gauss[:n]
121121

122122
def test_seedsequence():
123-
from numpy.random.bit_generator import (ISeedSequence,
123+
from numpy.random._bit_generator import (ISeedSequence,
124124
ISpawnableSeedSequence,
125125
SeedlessSeedSequence)
126126

‎numpy/random/tests/test_seed_sequence.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import numpy as np
22
from numpy.testing import assert_array_equal
33

4-
from numpy.random.bit_generator import SeedSequence
4+
from numpy.random._bit_generator import SeedSequence
55

66

77
def test_reference_data():

‎numpy/tests/test_public_api.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,8 +298,6 @@ def test_NPY_NO_EXPORT():
298298
"ma.timer_comparison",
299299
"matrixlib",
300300
"matrixlib.defmatrix",
301-
"random.bit_generator",
302-
"random.generator",
303301
"random.mtrand",
304302
"testing.print_coercion_tables",
305303
"testing.utils",

0 commit comments

Comments
 (0)
0