Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 1 | import unittest |
R David Murray | e3e1c17 | 2013-04-02 12:47:23 -0400 | [diff] [blame] | 2 | import unittest.mock |
Tim Peters | 46c04e1 | 2002-05-05 20:40:00 +0000 | [diff] [blame] | 3 | import random |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 4 | import time |
Raymond Hettinger | 5f078ff | 2003-06-24 20:29:04 +0000 | [diff] [blame] | 5 | import pickle |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 6 | import warnings |
R David Murray | e3e1c17 | 2013-04-02 12:47:23 -0400 | [diff] [blame] | 7 | from functools import partial |
Victor Stinner | bd1b49a | 2016-10-19 10:11:37 +0200 | [diff] [blame] | 8 | from math import log, exp, pi, fsum, sin, factorial |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 9 | from test import support |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 10 | from fractions import Fraction |
Tim Peters | 46c04e1 | 2002-05-05 20:40:00 +0000 | [diff] [blame] | 11 | |
Ezio Melotti | 3e4a98b | 2013-04-19 05:45:27 +0300 | [diff] [blame] | 12 | class TestBasicOps: |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 13 | # Superclass with tests common to all generators. |
| 14 | # Subclasses must arrange for self.gen to retrieve the Random instance |
| 15 | # to be tested. |
Tim Peters | 46c04e1 | 2002-05-05 20:40:00 +0000 | [diff] [blame] | 16 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 17 | def randomlist(self, n): |
| 18 | """Helper function to make a list of random numbers""" |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 19 | return [self.gen.random() for i in range(n)] |
Tim Peters | 46c04e1 | 2002-05-05 20:40:00 +0000 | [diff] [blame] | 20 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 21 | def test_autoseed(self): |
| 22 | self.gen.seed() |
| 23 | state1 = self.gen.getstate() |
Raymond Hettinger | 3081d59 | 2003-08-09 18:30:57 +0000 | [diff] [blame] | 24 | time.sleep(0.1) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 25 | self.gen.seed() # diffent seeds at different times |
| 26 | state2 = self.gen.getstate() |
| 27 | self.assertNotEqual(state1, state2) |
Tim Peters | 46c04e1 | 2002-05-05 20:40:00 +0000 | [diff] [blame] | 28 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 29 | def test_saverestore(self): |
| 30 | N = 1000 |
| 31 | self.gen.seed() |
| 32 | state = self.gen.getstate() |
| 33 | randseq = self.randomlist(N) |
| 34 | self.gen.setstate(state) # should regenerate the same sequence |
| 35 | self.assertEqual(randseq, self.randomlist(N)) |
| 36 | |
| 37 | def test_seedargs(self): |
Mark Dickinson | 95aeae0 | 2012-06-24 11:05:30 +0100 | [diff] [blame] | 38 | # Seed value with a negative hash. |
| 39 | class MySeed(object): |
| 40 | def __hash__(self): |
| 41 | return -1729 |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 42 | for arg in [None, 0, 0, 1, 1, -1, -1, 10**20, -(10**20), |
Mark Dickinson | 95aeae0 | 2012-06-24 11:05:30 +0100 | [diff] [blame] | 43 | 3.14, 1+2j, 'a', tuple('abc'), MySeed()]: |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 44 | self.gen.seed(arg) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 45 | for arg in [list(range(3)), dict(one=1)]: |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 46 | self.assertRaises(TypeError, self.gen.seed, arg) |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 47 | self.assertRaises(TypeError, self.gen.seed, 1, 2, 3, 4) |
Raymond Hettinger | 5833587 | 2004-07-09 14:26:18 +0000 | [diff] [blame] | 48 | self.assertRaises(TypeError, type(self.gen), []) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 49 | |
R David Murray | e3e1c17 | 2013-04-02 12:47:23 -0400 | [diff] [blame] | 50 | @unittest.mock.patch('random._urandom') # os.urandom |
| 51 | def test_seed_when_randomness_source_not_found(self, urandom_mock): |
| 52 | # Random.seed() uses time.time() when an operating system specific |
| 53 | # randomness source is not found. To test this on machines were it |
| 54 | # exists, run the above test, test_seedargs(), again after mocking |
| 55 | # os.urandom() so that it raises the exception expected when the |
| 56 | # randomness source is not available. |
| 57 | urandom_mock.side_effect = NotImplementedError |
| 58 | self.test_seedargs() |
| 59 | |
Antoine Pitrou | 5e39433 | 2012-11-04 02:10:33 +0100 | [diff] [blame] | 60 | def test_shuffle(self): |
| 61 | shuffle = self.gen.shuffle |
| 62 | lst = [] |
| 63 | shuffle(lst) |
| 64 | self.assertEqual(lst, []) |
| 65 | lst = [37] |
| 66 | shuffle(lst) |
| 67 | self.assertEqual(lst, [37]) |
| 68 | seqs = [list(range(n)) for n in range(10)] |
| 69 | shuffled_seqs = [list(range(n)) for n in range(10)] |
| 70 | for shuffled_seq in shuffled_seqs: |
| 71 | shuffle(shuffled_seq) |
| 72 | for (seq, shuffled_seq) in zip(seqs, shuffled_seqs): |
| 73 | self.assertEqual(len(seq), len(shuffled_seq)) |
| 74 | self.assertEqual(set(seq), set(shuffled_seq)) |
Antoine Pitrou | 5e39433 | 2012-11-04 02:10:33 +0100 | [diff] [blame] | 75 | # The above tests all would pass if the shuffle was a |
| 76 | # no-op. The following non-deterministic test covers that. It |
| 77 | # asserts that the shuffled sequence of 1000 distinct elements |
| 78 | # must be different from the original one. Although there is |
| 79 | # mathematically a non-zero probability that this could |
| 80 | # actually happen in a genuinely random shuffle, it is |
| 81 | # completely negligible, given that the number of possible |
| 82 | # permutations of 1000 objects is 1000! (factorial of 1000), |
| 83 | # which is considerably larger than the number of atoms in the |
| 84 | # universe... |
| 85 | lst = list(range(1000)) |
| 86 | shuffled_lst = list(range(1000)) |
| 87 | shuffle(shuffled_lst) |
| 88 | self.assertTrue(lst != shuffled_lst) |
| 89 | shuffle(lst) |
| 90 | self.assertTrue(lst != shuffled_lst) |
| 91 | |
Raymond Hettinger | dc4872e | 2010-09-07 10:06:56 +0000 | [diff] [blame] | 92 | def test_choice(self): |
| 93 | choice = self.gen.choice |
| 94 | with self.assertRaises(IndexError): |
| 95 | choice([]) |
| 96 | self.assertEqual(choice([50]), 50) |
| 97 | self.assertIn(choice([25, 75]), [25, 75]) |
| 98 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 99 | def test_sample(self): |
| 100 | # For the entire allowable range of 0 <= k <= N, validate that |
| 101 | # the sample is of the correct length and contains only unique items |
| 102 | N = 100 |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 103 | population = range(N) |
| 104 | for k in range(N+1): |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 105 | s = self.gen.sample(population, k) |
| 106 | self.assertEqual(len(s), k) |
Raymond Hettinger | a690a99 | 2003-11-16 16:17:49 +0000 | [diff] [blame] | 107 | uniq = set(s) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 108 | self.assertEqual(len(uniq), k) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 109 | self.assertTrue(uniq <= set(population)) |
Raymond Hettinger | 8ec7881 | 2003-01-04 05:55:11 +0000 | [diff] [blame] | 110 | self.assertEqual(self.gen.sample([], 0), []) # test edge case N==k==0 |
R David Murray | e3e1c17 | 2013-04-02 12:47:23 -0400 | [diff] [blame] | 111 | # Exception raised if size of sample exceeds that of population |
| 112 | self.assertRaises(ValueError, self.gen.sample, population, N+1) |
Raymond Hettinger | bf87126 | 2016-11-21 14:34:33 -0800 | [diff] [blame] | 113 | self.assertRaises(ValueError, self.gen.sample, [], -1) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 114 | |
Raymond Hettinger | 7b0cf76 | 2003-01-17 17:23:23 +0000 | [diff] [blame] | 115 | def test_sample_distribution(self): |
| 116 | # For the entire allowable range of 0 <= k <= N, validate that |
| 117 | # sample generates all possible permutations |
| 118 | n = 5 |
| 119 | pop = range(n) |
| 120 | trials = 10000 # large num prevents false negatives without slowing normal case |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 121 | for k in range(n): |
Raymond Hettinger | ffdb8bb | 2004-09-27 15:29:05 +0000 | [diff] [blame] | 122 | expected = factorial(n) // factorial(n-k) |
Raymond Hettinger | 7b0cf76 | 2003-01-17 17:23:23 +0000 | [diff] [blame] | 123 | perms = {} |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 124 | for i in range(trials): |
Raymond Hettinger | 7b0cf76 | 2003-01-17 17:23:23 +0000 | [diff] [blame] | 125 | perms[tuple(self.gen.sample(pop, k))] = None |
| 126 | if len(perms) == expected: |
| 127 | break |
| 128 | else: |
| 129 | self.fail() |
| 130 | |
Raymond Hettinger | 66d09f1 | 2003-09-06 04:25:54 +0000 | [diff] [blame] | 131 | def test_sample_inputs(self): |
| 132 | # SF bug #801342 -- population can be any iterable defining __len__() |
Raymond Hettinger | a690a99 | 2003-11-16 16:17:49 +0000 | [diff] [blame] | 133 | self.gen.sample(set(range(20)), 2) |
Raymond Hettinger | 66d09f1 | 2003-09-06 04:25:54 +0000 | [diff] [blame] | 134 | self.gen.sample(range(20), 2) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 135 | self.gen.sample(range(20), 2) |
Raymond Hettinger | 66d09f1 | 2003-09-06 04:25:54 +0000 | [diff] [blame] | 136 | self.gen.sample(str('abcdefghijklmnopqrst'), 2) |
| 137 | self.gen.sample(tuple('abcdefghijklmnopqrst'), 2) |
| 138 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 139 | def test_sample_on_dicts(self): |
Raymond Hettinger | 1acde19 | 2008-01-14 01:00:53 +0000 | [diff] [blame] | 140 | self.assertRaises(TypeError, self.gen.sample, dict.fromkeys('abcdef'), 2) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 141 | |
Raymond Hettinger | 28aa4a0 | 2016-09-07 00:08:44 -0700 | [diff] [blame] | 142 | def test_choices(self): |
| 143 | choices = self.gen.choices |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 144 | data = ['red', 'green', 'blue', 'yellow'] |
| 145 | str_data = 'abcd' |
| 146 | range_data = range(4) |
| 147 | set_data = set(range(4)) |
| 148 | |
| 149 | # basic functionality |
| 150 | for sample in [ |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 151 | choices(data, k=5), |
| 152 | choices(data, range(4), k=5), |
Raymond Hettinger | 28aa4a0 | 2016-09-07 00:08:44 -0700 | [diff] [blame] | 153 | choices(k=5, population=data, weights=range(4)), |
| 154 | choices(k=5, population=data, cum_weights=range(4)), |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 155 | ]: |
| 156 | self.assertEqual(len(sample), 5) |
| 157 | self.assertEqual(type(sample), list) |
| 158 | self.assertTrue(set(sample) <= set(data)) |
| 159 | |
| 160 | # test argument handling |
Raymond Hettinger | 28aa4a0 | 2016-09-07 00:08:44 -0700 | [diff] [blame] | 161 | with self.assertRaises(TypeError): # missing arguments |
| 162 | choices(2) |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 163 | |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 164 | self.assertEqual(choices(data, k=0), []) # k == 0 |
| 165 | self.assertEqual(choices(data, k=-1), []) # negative k behaves like ``[0] * -1`` |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 166 | with self.assertRaises(TypeError): |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 167 | choices(data, k=2.5) # k is a float |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 168 | |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 169 | self.assertTrue(set(choices(str_data, k=5)) <= set(str_data)) # population is a string sequence |
| 170 | self.assertTrue(set(choices(range_data, k=5)) <= set(range_data)) # population is a range |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 171 | with self.assertRaises(TypeError): |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 172 | choices(set_data, k=2) # population is not a sequence |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 173 | |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 174 | self.assertTrue(set(choices(data, None, k=5)) <= set(data)) # weights is None |
| 175 | self.assertTrue(set(choices(data, weights=None, k=5)) <= set(data)) |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 176 | with self.assertRaises(ValueError): |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 177 | choices(data, [1,2], k=5) # len(weights) != len(population) |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 178 | with self.assertRaises(TypeError): |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 179 | choices(data, 10, k=5) # non-iterable weights |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 180 | with self.assertRaises(TypeError): |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 181 | choices(data, [None]*4, k=5) # non-numeric weights |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 182 | for weights in [ |
| 183 | [15, 10, 25, 30], # integer weights |
| 184 | [15.1, 10.2, 25.2, 30.3], # float weights |
| 185 | [Fraction(1, 3), Fraction(2, 6), Fraction(3, 6), Fraction(4, 6)], # fractional weights |
| 186 | [True, False, True, False] # booleans (include / exclude) |
| 187 | ]: |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 188 | self.assertTrue(set(choices(data, weights, k=5)) <= set(data)) |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 189 | |
| 190 | with self.assertRaises(ValueError): |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 191 | choices(data, cum_weights=[1,2], k=5) # len(weights) != len(population) |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 192 | with self.assertRaises(TypeError): |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 193 | choices(data, cum_weights=10, k=5) # non-iterable cum_weights |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 194 | with self.assertRaises(TypeError): |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 195 | choices(data, cum_weights=[None]*4, k=5) # non-numeric cum_weights |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 196 | with self.assertRaises(TypeError): |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 197 | choices(data, range(4), cum_weights=range(4), k=5) # both weights and cum_weights |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 198 | for weights in [ |
| 199 | [15, 10, 25, 30], # integer cum_weights |
| 200 | [15.1, 10.2, 25.2, 30.3], # float cum_weights |
| 201 | [Fraction(1, 3), Fraction(2, 6), Fraction(3, 6), Fraction(4, 6)], # fractional cum_weights |
| 202 | ]: |
Raymond Hettinger | 9016f28 | 2016-09-26 21:45:57 -0700 | [diff] [blame] | 203 | self.assertTrue(set(choices(data, cum_weights=weights, k=5)) <= set(data)) |
Raymond Hettinger | e8f1e00 | 2016-09-06 17:15:29 -0700 | [diff] [blame] | 204 | |
Raymond Hettinger | 7b16652 | 2016-10-14 01:19:38 -0400 | [diff] [blame] | 205 | # Test weight focused on a single element of the population |
| 206 | self.assertEqual(choices('abcd', [1, 0, 0, 0]), ['a']) |
| 207 | self.assertEqual(choices('abcd', [0, 1, 0, 0]), ['b']) |
| 208 | self.assertEqual(choices('abcd', [0, 0, 1, 0]), ['c']) |
| 209 | self.assertEqual(choices('abcd', [0, 0, 0, 1]), ['d']) |
| 210 | |
| 211 | # Test consistency with random.choice() for empty population |
| 212 | with self.assertRaises(IndexError): |
| 213 | choices([], k=1) |
| 214 | with self.assertRaises(IndexError): |
| 215 | choices([], weights=[], k=1) |
| 216 | with self.assertRaises(IndexError): |
| 217 | choices([], cum_weights=[], k=5) |
| 218 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 219 | def test_gauss(self): |
| 220 | # Ensure that the seed() method initializes all the hidden state. In |
| 221 | # particular, through 2.2.1 it failed to reset a piece of state used |
| 222 | # by (and only by) the .gauss() method. |
| 223 | |
| 224 | for seed in 1, 12, 123, 1234, 12345, 123456, 654321: |
| 225 | self.gen.seed(seed) |
| 226 | x1 = self.gen.random() |
| 227 | y1 = self.gen.gauss(0, 1) |
| 228 | |
| 229 | self.gen.seed(seed) |
| 230 | x2 = self.gen.random() |
| 231 | y2 = self.gen.gauss(0, 1) |
| 232 | |
| 233 | self.assertEqual(x1, x2) |
| 234 | self.assertEqual(y1, y2) |
| 235 | |
Raymond Hettinger | 5f078ff | 2003-06-24 20:29:04 +0000 | [diff] [blame] | 236 | def test_pickling(self): |
Serhiy Storchaka | bad1257 | 2014-12-15 14:03:42 +0200 | [diff] [blame] | 237 | for proto in range(pickle.HIGHEST_PROTOCOL + 1): |
| 238 | state = pickle.dumps(self.gen, proto) |
| 239 | origseq = [self.gen.random() for i in range(10)] |
| 240 | newgen = pickle.loads(state) |
| 241 | restoredseq = [newgen.random() for i in range(10)] |
| 242 | self.assertEqual(origseq, restoredseq) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 243 | |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 244 | def test_bug_1727780(self): |
| 245 | # verify that version-2-pickles can be loaded |
| 246 | # fine, whether they are created on 32-bit or 64-bit |
| 247 | # platforms, and that version-3-pickles load fine. |
| 248 | files = [("randv2_32.pck", 780), |
| 249 | ("randv2_64.pck", 866), |
| 250 | ("randv3.pck", 343)] |
| 251 | for file, value in files: |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 252 | f = open(support.findfile(file),"rb") |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 253 | r = pickle.load(f) |
| 254 | f.close() |
Raymond Hettinger | 0515661 | 2010-09-07 04:44:52 +0000 | [diff] [blame] | 255 | self.assertEqual(int(r.random()*1000), value) |
| 256 | |
| 257 | def test_bug_9025(self): |
| 258 | # Had problem with an uneven distribution in int(n*random()) |
| 259 | # Verify the fix by checking that distributions fall within expectations. |
| 260 | n = 100000 |
| 261 | randrange = self.gen.randrange |
| 262 | k = sum(randrange(6755399441055744) % 3 == 2 for i in range(n)) |
| 263 | self.assertTrue(0.30 < k/n < .37, (k/n)) |
Christian Heimes | cbf3b5c | 2007-12-03 21:02:03 +0000 | [diff] [blame] | 264 | |
Ezio Melotti | 3e4a98b | 2013-04-19 05:45:27 +0300 | [diff] [blame] | 265 | try: |
| 266 | random.SystemRandom().random() |
| 267 | except NotImplementedError: |
| 268 | SystemRandom_available = False |
| 269 | else: |
| 270 | SystemRandom_available = True |
| 271 | |
| 272 | @unittest.skipUnless(SystemRandom_available, "random.SystemRandom not available") |
| 273 | class SystemRandom_TestBasicOps(TestBasicOps, unittest.TestCase): |
Raymond Hettinger | 23f1241 | 2004-09-13 22:23:21 +0000 | [diff] [blame] | 274 | gen = random.SystemRandom() |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 275 | |
| 276 | def test_autoseed(self): |
| 277 | # Doesn't need to do anything except not fail |
| 278 | self.gen.seed() |
| 279 | |
| 280 | def test_saverestore(self): |
| 281 | self.assertRaises(NotImplementedError, self.gen.getstate) |
| 282 | self.assertRaises(NotImplementedError, self.gen.setstate, None) |
| 283 | |
| 284 | def test_seedargs(self): |
| 285 | # Doesn't need to do anything except not fail |
| 286 | self.gen.seed(100) |
| 287 | |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 288 | def test_gauss(self): |
| 289 | self.gen.gauss_next = None |
| 290 | self.gen.seed(100) |
| 291 | self.assertEqual(self.gen.gauss_next, None) |
| 292 | |
| 293 | def test_pickling(self): |
Serhiy Storchaka | bad1257 | 2014-12-15 14:03:42 +0200 | [diff] [blame] | 294 | for proto in range(pickle.HIGHEST_PROTOCOL + 1): |
| 295 | self.assertRaises(NotImplementedError, pickle.dumps, self.gen, proto) |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 296 | |
| 297 | def test_53_bits_per_float(self): |
| 298 | # This should pass whenever a C double has 53 bit precision. |
| 299 | span = 2 ** 53 |
| 300 | cum = 0 |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 301 | for i in range(100): |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 302 | cum |= int(self.gen.random() * span) |
| 303 | self.assertEqual(cum, span-1) |
| 304 | |
| 305 | def test_bigrand(self): |
| 306 | # The randrange routine should build-up the required number of bits |
| 307 | # in stages so that all bit positions are active. |
| 308 | span = 2 ** 500 |
| 309 | cum = 0 |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 310 | for i in range(100): |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 311 | r = self.gen.randrange(span) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 312 | self.assertTrue(0 <= r < span) |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 313 | cum |= r |
| 314 | self.assertEqual(cum, span-1) |
| 315 | |
| 316 | def test_bigrand_ranges(self): |
| 317 | for i in [40,80, 160, 200, 211, 250, 375, 512, 550]: |
Zachary Ware | a6edea5 | 2013-11-26 14:50:10 -0600 | [diff] [blame] | 318 | start = self.gen.randrange(2 ** (i-2)) |
| 319 | stop = self.gen.randrange(2 ** i) |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 320 | if stop <= start: |
Zachary Ware | a6edea5 | 2013-11-26 14:50:10 -0600 | [diff] [blame] | 321 | continue |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 322 | self.assertTrue(start <= self.gen.randrange(start, stop) < stop) |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 323 | |
| 324 | def test_rangelimits(self): |
| 325 | for start, stop in [(-2,0), (-(2**60)-2,-(2**60)), (2**60,2**60+2)]: |
| 326 | self.assertEqual(set(range(start,stop)), |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 327 | set([self.gen.randrange(start,stop) for i in range(100)])) |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 328 | |
R David Murray | e3e1c17 | 2013-04-02 12:47:23 -0400 | [diff] [blame] | 329 | def test_randrange_nonunit_step(self): |
| 330 | rint = self.gen.randrange(0, 10, 2) |
| 331 | self.assertIn(rint, (0, 2, 4, 6, 8)) |
| 332 | rint = self.gen.randrange(0, 2, 2) |
| 333 | self.assertEqual(rint, 0) |
| 334 | |
| 335 | def test_randrange_errors(self): |
| 336 | raises = partial(self.assertRaises, ValueError, self.gen.randrange) |
| 337 | # Empty range |
| 338 | raises(3, 3) |
| 339 | raises(-721) |
| 340 | raises(0, 100, -12) |
| 341 | # Non-integer start/stop |
| 342 | raises(3.14159) |
| 343 | raises(0, 2.71828) |
| 344 | # Zero and non-integer step |
| 345 | raises(0, 42, 0) |
| 346 | raises(0, 42, 3.14159) |
| 347 | |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 348 | def test_genrandbits(self): |
| 349 | # Verify ranges |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 350 | for k in range(1, 1000): |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 351 | self.assertTrue(0 <= self.gen.getrandbits(k) < 2**k) |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 352 | |
| 353 | # Verify all bits active |
| 354 | getbits = self.gen.getrandbits |
| 355 | for span in [1, 2, 3, 4, 31, 32, 32, 52, 53, 54, 119, 127, 128, 129]: |
| 356 | cum = 0 |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 357 | for i in range(100): |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 358 | cum |= getbits(span) |
| 359 | self.assertEqual(cum, 2**span-1) |
| 360 | |
| 361 | # Verify argument checking |
| 362 | self.assertRaises(TypeError, self.gen.getrandbits) |
| 363 | self.assertRaises(TypeError, self.gen.getrandbits, 1, 2) |
| 364 | self.assertRaises(ValueError, self.gen.getrandbits, 0) |
| 365 | self.assertRaises(ValueError, self.gen.getrandbits, -1) |
| 366 | self.assertRaises(TypeError, self.gen.getrandbits, 10.1) |
| 367 | |
| 368 | def test_randbelow_logic(self, _log=log, int=int): |
| 369 | # check bitcount transition points: 2**i and 2**(i+1)-1 |
| 370 | # show that: k = int(1.001 + _log(n, 2)) |
| 371 | # is equal to or one greater than the number of bits in n |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 372 | for i in range(1, 1000): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 373 | n = 1 << i # check an exact power of two |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 374 | numbits = i+1 |
| 375 | k = int(1.00001 + _log(n, 2)) |
| 376 | self.assertEqual(k, numbits) |
Guido van Rossum | e61fd5b | 2007-07-11 12:20:59 +0000 | [diff] [blame] | 377 | self.assertEqual(n, 2**(k-1)) |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 378 | |
| 379 | n += n - 1 # check 1 below the next power of two |
| 380 | k = int(1.00001 + _log(n, 2)) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 381 | self.assertIn(k, [numbits, numbits+1]) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 382 | self.assertTrue(2**k > n > 2**(k-2)) |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 383 | |
| 384 | n -= n >> 15 # check a little farther below the next power of two |
| 385 | k = int(1.00001 + _log(n, 2)) |
| 386 | self.assertEqual(k, numbits) # note the stronger assertion |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 387 | self.assertTrue(2**k > n > 2**(k-1)) # note the stronger assertion |
Raymond Hettinger | 356a459 | 2004-08-30 06:14:31 +0000 | [diff] [blame] | 388 | |
| 389 | |
Ezio Melotti | 3e4a98b | 2013-04-19 05:45:27 +0300 | [diff] [blame] | 390 | class MersenneTwister_TestBasicOps(TestBasicOps, unittest.TestCase): |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 391 | gen = random.Random() |
| 392 | |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 393 | def test_guaranteed_stable(self): |
| 394 | # These sequences are guaranteed to stay the same across versions of python |
| 395 | self.gen.seed(3456147, version=1) |
| 396 | self.assertEqual([self.gen.random().hex() for i in range(4)], |
| 397 | ['0x1.ac362300d90d2p-1', '0x1.9d16f74365005p-1', |
| 398 | '0x1.1ebb4352e4c4dp-1', '0x1.1a7422abf9c11p-1']) |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 399 | self.gen.seed("the quick brown fox", version=2) |
| 400 | self.assertEqual([self.gen.random().hex() for i in range(4)], |
Raymond Hettinger | 3fcf002 | 2010-12-08 01:13:53 +0000 | [diff] [blame] | 401 | ['0x1.1239ddfb11b7cp-3', '0x1.b3cbb5c51b120p-4', |
| 402 | '0x1.8c4f55116b60fp-1', '0x1.63eb525174a27p-1']) |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 403 | |
Raymond Hettinger | c7bab7c | 2016-08-31 15:01:08 -0700 | [diff] [blame] | 404 | def test_bug_27706(self): |
| 405 | # Verify that version 1 seeds are unaffected by hash randomization |
| 406 | |
| 407 | self.gen.seed('nofar', version=1) # hash('nofar') == 5990528763808513177 |
| 408 | self.assertEqual([self.gen.random().hex() for i in range(4)], |
| 409 | ['0x1.8645314505ad7p-1', '0x1.afb1f82e40a40p-5', |
| 410 | '0x1.2a59d2285e971p-1', '0x1.56977142a7880p-6']) |
| 411 | |
| 412 | self.gen.seed('rachel', version=1) # hash('rachel') == -9091735575445484789 |
| 413 | self.assertEqual([self.gen.random().hex() for i in range(4)], |
| 414 | ['0x1.0b294cc856fcdp-1', '0x1.2ad22d79e77b8p-3', |
| 415 | '0x1.3052b9c072678p-2', '0x1.578f332106574p-3']) |
| 416 | |
| 417 | self.gen.seed('', version=1) # hash('') == 0 |
| 418 | self.assertEqual([self.gen.random().hex() for i in range(4)], |
| 419 | ['0x1.b0580f98a7dbep-1', '0x1.84129978f9c1ap-1', |
| 420 | '0x1.aeaa51052e978p-2', '0x1.092178fb945a6p-2']) |
| 421 | |
Raymond Hettinger | 5833587 | 2004-07-09 14:26:18 +0000 | [diff] [blame] | 422 | def test_setstate_first_arg(self): |
| 423 | self.assertRaises(ValueError, self.gen.setstate, (1, None, None)) |
| 424 | |
| 425 | def test_setstate_middle_arg(self): |
| 426 | # Wrong type, s/b tuple |
| 427 | self.assertRaises(TypeError, self.gen.setstate, (2, None, None)) |
| 428 | # Wrong length, s/b 625 |
| 429 | self.assertRaises(ValueError, self.gen.setstate, (2, (1,2,3), None)) |
| 430 | # Wrong type, s/b tuple of 625 ints |
| 431 | self.assertRaises(TypeError, self.gen.setstate, (2, ('a',)*625, None)) |
| 432 | # Last element s/b an int also |
| 433 | self.assertRaises(TypeError, self.gen.setstate, (2, (0,)*624+('a',), None)) |
Serhiy Storchaka | 178f0b6 | 2015-07-24 09:02:53 +0300 | [diff] [blame] | 434 | # Last element s/b between 0 and 624 |
| 435 | with self.assertRaises((ValueError, OverflowError)): |
| 436 | self.gen.setstate((2, (1,)*624+(625,), None)) |
| 437 | with self.assertRaises((ValueError, OverflowError)): |
| 438 | self.gen.setstate((2, (1,)*624+(-1,), None)) |
Raymond Hettinger | 5833587 | 2004-07-09 14:26:18 +0000 | [diff] [blame] | 439 | |
R David Murray | e3e1c17 | 2013-04-02 12:47:23 -0400 | [diff] [blame] | 440 | # Little trick to make "tuple(x % (2**32) for x in internalstate)" |
| 441 | # raise ValueError. I cannot think of a simple way to achieve this, so |
| 442 | # I am opting for using a generator as the middle argument of setstate |
| 443 | # which attempts to cast a NaN to integer. |
| 444 | state_values = self.gen.getstate()[1] |
| 445 | state_values = list(state_values) |
| 446 | state_values[-1] = float('nan') |
| 447 | state = (int(x) for x in state_values) |
| 448 | self.assertRaises(TypeError, self.gen.setstate, (2, state, None)) |
| 449 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 450 | def test_referenceImplementation(self): |
| 451 | # Compare the python implementation with results from the original |
| 452 | # code. Create 2000 53-bit precision random floats. Compare only |
| 453 | # the last ten entries to show that the independent implementations |
| 454 | # are tracking. Here is the main() function needed to create the |
| 455 | # list of expected random numbers: |
| 456 | # void main(void){ |
| 457 | # int i; |
| 458 | # unsigned long init[4]={61731, 24903, 614, 42143}, length=4; |
| 459 | # init_by_array(init, length); |
| 460 | # for (i=0; i<2000; i++) { |
| 461 | # printf("%.15f ", genrand_res53()); |
| 462 | # if (i%5==4) printf("\n"); |
| 463 | # } |
| 464 | # } |
| 465 | expected = [0.45839803073713259, |
| 466 | 0.86057815201978782, |
| 467 | 0.92848331726782152, |
| 468 | 0.35932681119782461, |
| 469 | 0.081823493762449573, |
| 470 | 0.14332226470169329, |
| 471 | 0.084297823823520024, |
| 472 | 0.53814864671831453, |
| 473 | 0.089215024911993401, |
| 474 | 0.78486196105372907] |
| 475 | |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 476 | self.gen.seed(61731 + (24903<<32) + (614<<64) + (42143<<96)) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 477 | actual = self.randomlist(2000)[-10:] |
| 478 | for a, e in zip(actual, expected): |
| 479 | self.assertAlmostEqual(a,e,places=14) |
| 480 | |
| 481 | def test_strong_reference_implementation(self): |
| 482 | # Like test_referenceImplementation, but checks for exact bit-level |
| 483 | # equality. This should pass on any box where C double contains |
| 484 | # at least 53 bits of precision (the underlying algorithm suffers |
| 485 | # no rounding errors -- all results are exact). |
| 486 | from math import ldexp |
| 487 | |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 488 | expected = [0x0eab3258d2231f, |
| 489 | 0x1b89db315277a5, |
| 490 | 0x1db622a5518016, |
| 491 | 0x0b7f9af0d575bf, |
| 492 | 0x029e4c4db82240, |
| 493 | 0x04961892f5d673, |
| 494 | 0x02b291598e4589, |
| 495 | 0x11388382c15694, |
| 496 | 0x02dad977c9e1fe, |
| 497 | 0x191d96d4d334c6] |
| 498 | self.gen.seed(61731 + (24903<<32) + (614<<64) + (42143<<96)) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 499 | actual = self.randomlist(2000)[-10:] |
| 500 | for a, e in zip(actual, expected): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 501 | self.assertEqual(int(ldexp(a, 53)), e) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 502 | |
| 503 | def test_long_seed(self): |
| 504 | # This is most interesting to run in debug mode, just to make sure |
| 505 | # nothing blows up. Under the covers, a dynamically resized array |
| 506 | # is allocated, consuming space proportional to the number of bits |
| 507 | # in the seed. Unfortunately, that's a quadratic-time algorithm, |
| 508 | # so don't make this horribly big. |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 509 | seed = (1 << (10000 * 8)) - 1 # about 10K bytes |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 510 | self.gen.seed(seed) |
| 511 | |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 512 | def test_53_bits_per_float(self): |
| 513 | # This should pass whenever a C double has 53 bit precision. |
| 514 | span = 2 ** 53 |
| 515 | cum = 0 |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 516 | for i in range(100): |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 517 | cum |= int(self.gen.random() * span) |
| 518 | self.assertEqual(cum, span-1) |
| 519 | |
| 520 | def test_bigrand(self): |
| 521 | # The randrange routine should build-up the required number of bits |
| 522 | # in stages so that all bit positions are active. |
| 523 | span = 2 ** 500 |
| 524 | cum = 0 |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 525 | for i in range(100): |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 526 | r = self.gen.randrange(span) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 527 | self.assertTrue(0 <= r < span) |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 528 | cum |= r |
| 529 | self.assertEqual(cum, span-1) |
| 530 | |
| 531 | def test_bigrand_ranges(self): |
| 532 | for i in [40,80, 160, 200, 211, 250, 375, 512, 550]: |
Zachary Ware | a6edea5 | 2013-11-26 14:50:10 -0600 | [diff] [blame] | 533 | start = self.gen.randrange(2 ** (i-2)) |
| 534 | stop = self.gen.randrange(2 ** i) |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 535 | if stop <= start: |
Zachary Ware | a6edea5 | 2013-11-26 14:50:10 -0600 | [diff] [blame] | 536 | continue |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 537 | self.assertTrue(start <= self.gen.randrange(start, stop) < stop) |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 538 | |
| 539 | def test_rangelimits(self): |
| 540 | for start, stop in [(-2,0), (-(2**60)-2,-(2**60)), (2**60,2**60+2)]: |
Raymond Hettinger | a690a99 | 2003-11-16 16:17:49 +0000 | [diff] [blame] | 541 | self.assertEqual(set(range(start,stop)), |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 542 | set([self.gen.randrange(start,stop) for i in range(100)])) |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 543 | |
| 544 | def test_genrandbits(self): |
| 545 | # Verify cross-platform repeatability |
| 546 | self.gen.seed(1234567) |
| 547 | self.assertEqual(self.gen.getrandbits(100), |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 548 | 97904845777343510404718956115) |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 549 | # Verify ranges |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 550 | for k in range(1, 1000): |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 551 | self.assertTrue(0 <= self.gen.getrandbits(k) < 2**k) |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 552 | |
| 553 | # Verify all bits active |
| 554 | getbits = self.gen.getrandbits |
| 555 | for span in [1, 2, 3, 4, 31, 32, 32, 52, 53, 54, 119, 127, 128, 129]: |
| 556 | cum = 0 |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 557 | for i in range(100): |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 558 | cum |= getbits(span) |
| 559 | self.assertEqual(cum, 2**span-1) |
| 560 | |
Raymond Hettinger | 5833587 | 2004-07-09 14:26:18 +0000 | [diff] [blame] | 561 | # Verify argument checking |
| 562 | self.assertRaises(TypeError, self.gen.getrandbits) |
| 563 | self.assertRaises(TypeError, self.gen.getrandbits, 'a') |
| 564 | self.assertRaises(TypeError, self.gen.getrandbits, 1, 2) |
| 565 | self.assertRaises(ValueError, self.gen.getrandbits, 0) |
| 566 | self.assertRaises(ValueError, self.gen.getrandbits, -1) |
| 567 | |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 568 | def test_randbelow_logic(self, _log=log, int=int): |
| 569 | # check bitcount transition points: 2**i and 2**(i+1)-1 |
| 570 | # show that: k = int(1.001 + _log(n, 2)) |
| 571 | # is equal to or one greater than the number of bits in n |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 572 | for i in range(1, 1000): |
Guido van Rossum | e2a383d | 2007-01-15 16:59:06 +0000 | [diff] [blame] | 573 | n = 1 << i # check an exact power of two |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 574 | numbits = i+1 |
| 575 | k = int(1.00001 + _log(n, 2)) |
| 576 | self.assertEqual(k, numbits) |
Guido van Rossum | e61fd5b | 2007-07-11 12:20:59 +0000 | [diff] [blame] | 577 | self.assertEqual(n, 2**(k-1)) |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 578 | |
| 579 | n += n - 1 # check 1 below the next power of two |
| 580 | k = int(1.00001 + _log(n, 2)) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 581 | self.assertIn(k, [numbits, numbits+1]) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 582 | self.assertTrue(2**k > n > 2**(k-2)) |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 583 | |
| 584 | n -= n >> 15 # check a little farther below the next power of two |
| 585 | k = int(1.00001 + _log(n, 2)) |
| 586 | self.assertEqual(k, numbits) # note the stronger assertion |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 587 | self.assertTrue(2**k > n > 2**(k-1)) # note the stronger assertion |
Raymond Hettinger | 2f726e9 | 2003-10-05 09:09:15 +0000 | [diff] [blame] | 588 | |
R David Murray | e3e1c17 | 2013-04-02 12:47:23 -0400 | [diff] [blame] | 589 | @unittest.mock.patch('random.Random.random') |
Martin Panter | e26da7c | 2016-06-02 10:07:09 +0000 | [diff] [blame] | 590 | def test_randbelow_overridden_random(self, random_mock): |
R David Murray | e3e1c17 | 2013-04-02 12:47:23 -0400 | [diff] [blame] | 591 | # Random._randbelow() can only use random() when the built-in one |
| 592 | # has been overridden but no new getrandbits() method was supplied. |
| 593 | random_mock.side_effect = random.SystemRandom().random |
| 594 | maxsize = 1<<random.BPF |
| 595 | with warnings.catch_warnings(): |
| 596 | warnings.simplefilter("ignore", UserWarning) |
| 597 | # Population range too large (n >= maxsize) |
| 598 | self.gen._randbelow(maxsize+1, maxsize = maxsize) |
| 599 | self.gen._randbelow(5640, maxsize = maxsize) |
| 600 | |
| 601 | # This might be going too far to test a single line, but because of our |
| 602 | # noble aim of achieving 100% test coverage we need to write a case in |
| 603 | # which the following line in Random._randbelow() gets executed: |
| 604 | # |
| 605 | # rem = maxsize % n |
| 606 | # limit = (maxsize - rem) / maxsize |
| 607 | # r = random() |
| 608 | # while r >= limit: |
| 609 | # r = random() # <== *This line* <==< |
| 610 | # |
| 611 | # Therefore, to guarantee that the while loop is executed at least |
| 612 | # once, we need to mock random() so that it returns a number greater |
| 613 | # than 'limit' the first time it gets called. |
| 614 | |
| 615 | n = 42 |
| 616 | epsilon = 0.01 |
| 617 | limit = (maxsize - (maxsize % n)) / maxsize |
| 618 | random_mock.side_effect = [limit + epsilon, limit - epsilon] |
| 619 | self.gen._randbelow(n, maxsize = maxsize) |
| 620 | |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 621 | def test_randrange_bug_1590891(self): |
| 622 | start = 1000000000000 |
| 623 | stop = -100000000000000000000 |
| 624 | step = -200 |
| 625 | x = self.gen.randrange(start, stop, step) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 626 | self.assertTrue(stop < x <= start) |
Thomas Wouters | 902d6eb | 2007-01-09 23:18:33 +0000 | [diff] [blame] | 627 | self.assertEqual((x+stop)%step, 0) |
| 628 | |
Raymond Hettinger | 30d00e5 | 2016-10-29 16:55:36 -0700 | [diff] [blame] | 629 | def test_choices_algorithms(self): |
Raymond Hettinger | 24e4239 | 2016-11-13 00:42:56 -0500 | [diff] [blame] | 630 | # The various ways of specifying weights should produce the same results |
Raymond Hettinger | 30d00e5 | 2016-10-29 16:55:36 -0700 | [diff] [blame] | 631 | choices = self.gen.choices |
Raymond Hettinger | 6023d33 | 2016-11-21 15:32:08 -0800 | [diff] [blame] | 632 | n = 104729 |
Raymond Hettinger | 30d00e5 | 2016-10-29 16:55:36 -0700 | [diff] [blame] | 633 | |
| 634 | self.gen.seed(8675309) |
| 635 | a = self.gen.choices(range(n), k=10000) |
| 636 | |
| 637 | self.gen.seed(8675309) |
| 638 | b = self.gen.choices(range(n), [1]*n, k=10000) |
| 639 | self.assertEqual(a, b) |
| 640 | |
| 641 | self.gen.seed(8675309) |
| 642 | c = self.gen.choices(range(n), cum_weights=range(1, n+1), k=10000) |
| 643 | self.assertEqual(a, c) |
| 644 | |
Raymond Hettinger | 77d574d | 2016-10-29 17:42:36 -0700 | [diff] [blame] | 645 | # Amerian Roulette |
| 646 | population = ['Red', 'Black', 'Green'] |
| 647 | weights = [18, 18, 2] |
| 648 | cum_weights = [18, 36, 38] |
| 649 | expanded_population = ['Red'] * 18 + ['Black'] * 18 + ['Green'] * 2 |
| 650 | |
| 651 | self.gen.seed(9035768) |
| 652 | a = self.gen.choices(expanded_population, k=10000) |
| 653 | |
| 654 | self.gen.seed(9035768) |
| 655 | b = self.gen.choices(population, weights, k=10000) |
| 656 | self.assertEqual(a, b) |
| 657 | |
| 658 | self.gen.seed(9035768) |
| 659 | c = self.gen.choices(population, cum_weights=cum_weights, k=10000) |
| 660 | self.assertEqual(a, c) |
| 661 | |
Raymond Hettinger | 2d0c256 | 2009-02-19 09:53:18 +0000 | [diff] [blame] | 662 | def gamma(z, sqrt2pi=(2.0*pi)**0.5): |
| 663 | # Reflection to right half of complex plane |
| 664 | if z < 0.5: |
| 665 | return pi / sin(pi*z) / gamma(1.0-z) |
| 666 | # Lanczos approximation with g=7 |
| 667 | az = z + (7.0 - 0.5) |
| 668 | return az ** (z-0.5) / exp(az) * sqrt2pi * fsum([ |
| 669 | 0.9999999999995183, |
| 670 | 676.5203681218835 / z, |
| 671 | -1259.139216722289 / (z+1.0), |
| 672 | 771.3234287757674 / (z+2.0), |
| 673 | -176.6150291498386 / (z+3.0), |
| 674 | 12.50734324009056 / (z+4.0), |
| 675 | -0.1385710331296526 / (z+5.0), |
| 676 | 0.9934937113930748e-05 / (z+6.0), |
| 677 | 0.1659470187408462e-06 / (z+7.0), |
| 678 | ]) |
Raymond Hettinger | 3dd990c | 2003-01-05 09:20:06 +0000 | [diff] [blame] | 679 | |
Raymond Hettinger | 15ec373 | 2003-01-05 01:08:34 +0000 | [diff] [blame] | 680 | class TestDistributions(unittest.TestCase): |
| 681 | def test_zeroinputs(self): |
| 682 | # Verify that distributions can handle a series of zero inputs' |
| 683 | g = random.Random() |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 684 | x = [g.random() for i in range(50)] + [0.0]*5 |
Raymond Hettinger | 15ec373 | 2003-01-05 01:08:34 +0000 | [diff] [blame] | 685 | g.random = x[:].pop; g.uniform(1,10) |
| 686 | g.random = x[:].pop; g.paretovariate(1.0) |
| 687 | g.random = x[:].pop; g.expovariate(1.0) |
| 688 | g.random = x[:].pop; g.weibullvariate(1.0, 1.0) |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 689 | g.random = x[:].pop; g.vonmisesvariate(1.0, 1.0) |
Raymond Hettinger | 15ec373 | 2003-01-05 01:08:34 +0000 | [diff] [blame] | 690 | g.random = x[:].pop; g.normalvariate(0.0, 1.0) |
| 691 | g.random = x[:].pop; g.gauss(0.0, 1.0) |
| 692 | g.random = x[:].pop; g.lognormvariate(0.0, 1.0) |
| 693 | g.random = x[:].pop; g.vonmisesvariate(0.0, 1.0) |
| 694 | g.random = x[:].pop; g.gammavariate(0.01, 1.0) |
| 695 | g.random = x[:].pop; g.gammavariate(1.0, 1.0) |
| 696 | g.random = x[:].pop; g.gammavariate(200.0, 1.0) |
| 697 | g.random = x[:].pop; g.betavariate(3.0, 3.0) |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 698 | g.random = x[:].pop; g.triangular(0.0, 1.0, 1.0/3.0) |
Raymond Hettinger | 15ec373 | 2003-01-05 01:08:34 +0000 | [diff] [blame] | 699 | |
Raymond Hettinger | 3dd990c | 2003-01-05 09:20:06 +0000 | [diff] [blame] | 700 | def test_avg_std(self): |
| 701 | # Use integration to test distribution average and standard deviation. |
| 702 | # Only works for distributions which do not consume variates in pairs |
| 703 | g = random.Random() |
| 704 | N = 5000 |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 705 | x = [i/float(N) for i in range(1,N)] |
Raymond Hettinger | 3dd990c | 2003-01-05 09:20:06 +0000 | [diff] [blame] | 706 | for variate, args, mu, sigmasqrd in [ |
| 707 | (g.uniform, (1.0,10.0), (10.0+1.0)/2, (10.0-1.0)**2/12), |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 708 | (g.triangular, (0.0, 1.0, 1.0/3.0), 4.0/9.0, 7.0/9.0/18.0), |
Raymond Hettinger | 3dd990c | 2003-01-05 09:20:06 +0000 | [diff] [blame] | 709 | (g.expovariate, (1.5,), 1/1.5, 1/1.5**2), |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 710 | (g.vonmisesvariate, (1.23, 0), pi, pi**2/3), |
Raymond Hettinger | 3dd990c | 2003-01-05 09:20:06 +0000 | [diff] [blame] | 711 | (g.paretovariate, (5.0,), 5.0/(5.0-1), |
| 712 | 5.0/((5.0-1)**2*(5.0-2))), |
| 713 | (g.weibullvariate, (1.0, 3.0), gamma(1+1/3.0), |
| 714 | gamma(1+2/3.0)-gamma(1+1/3.0)**2) ]: |
| 715 | g.random = x[:].pop |
| 716 | y = [] |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 717 | for i in range(len(x)): |
Raymond Hettinger | 3dd990c | 2003-01-05 09:20:06 +0000 | [diff] [blame] | 718 | try: |
| 719 | y.append(variate(*args)) |
| 720 | except IndexError: |
| 721 | pass |
| 722 | s1 = s2 = 0 |
| 723 | for e in y: |
| 724 | s1 += e |
| 725 | s2 += (e - mu) ** 2 |
| 726 | N = len(y) |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 727 | self.assertAlmostEqual(s1/N, mu, places=2, |
| 728 | msg='%s%r' % (variate.__name__, args)) |
| 729 | self.assertAlmostEqual(s2/(N-1), sigmasqrd, places=2, |
| 730 | msg='%s%r' % (variate.__name__, args)) |
| 731 | |
| 732 | def test_constant(self): |
| 733 | g = random.Random() |
| 734 | N = 100 |
| 735 | for variate, args, expected in [ |
| 736 | (g.uniform, (10.0, 10.0), 10.0), |
| 737 | (g.triangular, (10.0, 10.0), 10.0), |
Raymond Hettinger | 978c6ab | 2014-05-25 17:25:27 -0700 | [diff] [blame] | 738 | (g.triangular, (10.0, 10.0, 10.0), 10.0), |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 739 | (g.expovariate, (float('inf'),), 0.0), |
| 740 | (g.vonmisesvariate, (3.0, float('inf')), 3.0), |
| 741 | (g.gauss, (10.0, 0.0), 10.0), |
| 742 | (g.lognormvariate, (0.0, 0.0), 1.0), |
| 743 | (g.lognormvariate, (-float('inf'), 0.0), 0.0), |
| 744 | (g.normalvariate, (10.0, 0.0), 10.0), |
| 745 | (g.paretovariate, (float('inf'),), 1.0), |
| 746 | (g.weibullvariate, (10.0, float('inf')), 10.0), |
| 747 | (g.weibullvariate, (0.0, 10.0), 0.0), |
| 748 | ]: |
| 749 | for i in range(N): |
| 750 | self.assertEqual(variate(*args), expected) |
Raymond Hettinger | 3dd990c | 2003-01-05 09:20:06 +0000 | [diff] [blame] | 751 | |
Mark Dickinson | be5f919 | 2013-02-10 14:16:10 +0000 | [diff] [blame] | 752 | def test_von_mises_range(self): |
| 753 | # Issue 17149: von mises variates were not consistently in the |
| 754 | # range [0, 2*PI]. |
| 755 | g = random.Random() |
| 756 | N = 100 |
| 757 | for mu in 0.0, 0.1, 3.1, 6.2: |
| 758 | for kappa in 0.0, 2.3, 500.0: |
| 759 | for _ in range(N): |
| 760 | sample = g.vonmisesvariate(mu, kappa) |
| 761 | self.assertTrue( |
| 762 | 0 <= sample <= random.TWOPI, |
| 763 | msg=("vonmisesvariate({}, {}) produced a result {} out" |
| 764 | " of range [0, 2*pi]").format(mu, kappa, sample)) |
| 765 | |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 766 | def test_von_mises_large_kappa(self): |
| 767 | # Issue #17141: vonmisesvariate() was hang for large kappas |
| 768 | random.vonmisesvariate(0, 1e15) |
| 769 | random.vonmisesvariate(0, 1e100) |
| 770 | |
R David Murray | e3e1c17 | 2013-04-02 12:47:23 -0400 | [diff] [blame] | 771 | def test_gammavariate_errors(self): |
| 772 | # Both alpha and beta must be > 0.0 |
| 773 | self.assertRaises(ValueError, random.gammavariate, -1, 3) |
| 774 | self.assertRaises(ValueError, random.gammavariate, 0, 2) |
| 775 | self.assertRaises(ValueError, random.gammavariate, 2, 0) |
| 776 | self.assertRaises(ValueError, random.gammavariate, 1, -3) |
| 777 | |
| 778 | @unittest.mock.patch('random.Random.random') |
| 779 | def test_gammavariate_full_code_coverage(self, random_mock): |
| 780 | # There are three different possibilities in the current implementation |
| 781 | # of random.gammavariate(), depending on the value of 'alpha'. What we |
| 782 | # are going to do here is to fix the values returned by random() to |
| 783 | # generate test cases that provide 100% line coverage of the method. |
| 784 | |
| 785 | # #1: alpha > 1.0: we want the first random number to be outside the |
| 786 | # [1e-7, .9999999] range, so that the continue statement executes |
| 787 | # once. The values of u1 and u2 will be 0.5 and 0.3, respectively. |
| 788 | random_mock.side_effect = [1e-8, 0.5, 0.3] |
| 789 | returned_value = random.gammavariate(1.1, 2.3) |
| 790 | self.assertAlmostEqual(returned_value, 2.53) |
| 791 | |
| 792 | # #2: alpha == 1: first random number less than 1e-7 to that the body |
| 793 | # of the while loop executes once. Then random.random() returns 0.45, |
| 794 | # which causes while to stop looping and the algorithm to terminate. |
| 795 | random_mock.side_effect = [1e-8, 0.45] |
| 796 | returned_value = random.gammavariate(1.0, 3.14) |
| 797 | self.assertAlmostEqual(returned_value, 2.507314166123803) |
| 798 | |
| 799 | # #3: 0 < alpha < 1. This is the most complex region of code to cover, |
| 800 | # as there are multiple if-else statements. Let's take a look at the |
| 801 | # source code, and determine the values that we need accordingly: |
| 802 | # |
| 803 | # while 1: |
| 804 | # u = random() |
| 805 | # b = (_e + alpha)/_e |
| 806 | # p = b*u |
| 807 | # if p <= 1.0: # <=== (A) |
| 808 | # x = p ** (1.0/alpha) |
| 809 | # else: # <=== (B) |
| 810 | # x = -_log((b-p)/alpha) |
| 811 | # u1 = random() |
| 812 | # if p > 1.0: # <=== (C) |
| 813 | # if u1 <= x ** (alpha - 1.0): # <=== (D) |
| 814 | # break |
| 815 | # elif u1 <= _exp(-x): # <=== (E) |
| 816 | # break |
| 817 | # return x * beta |
| 818 | # |
| 819 | # First, we want (A) to be True. For that we need that: |
| 820 | # b*random() <= 1.0 |
| 821 | # r1 = random() <= 1.0 / b |
| 822 | # |
| 823 | # We now get to the second if-else branch, and here, since p <= 1.0, |
| 824 | # (C) is False and we take the elif branch, (E). For it to be True, |
| 825 | # so that the break is executed, we need that: |
| 826 | # r2 = random() <= _exp(-x) |
| 827 | # r2 <= _exp(-(p ** (1.0/alpha))) |
| 828 | # r2 <= _exp(-((b*r1) ** (1.0/alpha))) |
| 829 | |
| 830 | _e = random._e |
| 831 | _exp = random._exp |
| 832 | _log = random._log |
| 833 | alpha = 0.35 |
| 834 | beta = 1.45 |
| 835 | b = (_e + alpha)/_e |
| 836 | epsilon = 0.01 |
| 837 | |
| 838 | r1 = 0.8859296441566 # 1.0 / b |
| 839 | r2 = 0.3678794411714 # _exp(-((b*r1) ** (1.0/alpha))) |
| 840 | |
| 841 | # These four "random" values result in the following trace: |
| 842 | # (A) True, (E) False --> [next iteration of while] |
| 843 | # (A) True, (E) True --> [while loop breaks] |
| 844 | random_mock.side_effect = [r1, r2 + epsilon, r1, r2] |
| 845 | returned_value = random.gammavariate(alpha, beta) |
| 846 | self.assertAlmostEqual(returned_value, 1.4499999999997544) |
| 847 | |
| 848 | # Let's now make (A) be False. If this is the case, when we get to the |
| 849 | # second if-else 'p' is greater than 1, so (C) evaluates to True. We |
| 850 | # now encounter a second if statement, (D), which in order to execute |
| 851 | # must satisfy the following condition: |
| 852 | # r2 <= x ** (alpha - 1.0) |
| 853 | # r2 <= (-_log((b-p)/alpha)) ** (alpha - 1.0) |
| 854 | # r2 <= (-_log((b-(b*r1))/alpha)) ** (alpha - 1.0) |
| 855 | r1 = 0.8959296441566 # (1.0 / b) + epsilon -- so that (A) is False |
| 856 | r2 = 0.9445400408898141 |
| 857 | |
| 858 | # And these four values result in the following trace: |
| 859 | # (B) and (C) True, (D) False --> [next iteration of while] |
| 860 | # (B) and (C) True, (D) True [while loop breaks] |
| 861 | random_mock.side_effect = [r1, r2 + epsilon, r1, r2] |
| 862 | returned_value = random.gammavariate(alpha, beta) |
| 863 | self.assertAlmostEqual(returned_value, 1.5830349561760781) |
| 864 | |
| 865 | @unittest.mock.patch('random.Random.gammavariate') |
| 866 | def test_betavariate_return_zero(self, gammavariate_mock): |
| 867 | # betavariate() returns zero when the Gamma distribution |
| 868 | # that it uses internally returns this same value. |
| 869 | gammavariate_mock.return_value = 0.0 |
| 870 | self.assertEqual(0.0, random.betavariate(2.71828, 3.14159)) |
Serhiy Storchaka | 6c22b1d | 2013-02-10 19:28:56 +0200 | [diff] [blame] | 871 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 872 | class TestModule(unittest.TestCase): |
| 873 | def testMagicConstants(self): |
| 874 | self.assertAlmostEqual(random.NV_MAGICCONST, 1.71552776992141) |
| 875 | self.assertAlmostEqual(random.TWOPI, 6.28318530718) |
| 876 | self.assertAlmostEqual(random.LOG4, 1.38629436111989) |
| 877 | self.assertAlmostEqual(random.SG_MAGICCONST, 2.50407739677627) |
| 878 | |
| 879 | def test__all__(self): |
| 880 | # tests validity but not completeness of the __all__ list |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 881 | self.assertTrue(set(random.__all__) <= set(dir(random))) |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 882 | |
Thomas Wouters | b213704 | 2007-02-01 18:02:27 +0000 | [diff] [blame] | 883 | def test_random_subclass_with_kwargs(self): |
| 884 | # SF bug #1486663 -- this used to erroneously raise a TypeError |
| 885 | class Subclass(random.Random): |
| 886 | def __init__(self, newarg=None): |
| 887 | random.Random.__init__(self) |
| 888 | Subclass(newarg=1) |
| 889 | |
| 890 | |
Raymond Hettinger | 40f6217 | 2002-12-29 23:03:38 +0000 | [diff] [blame] | 891 | if __name__ == "__main__": |
Ezio Melotti | 3e4a98b | 2013-04-19 05:45:27 +0300 | [diff] [blame] | 892 | unittest.main() |