Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`random` --- Generate pseudo-random numbers |
| 2 | ================================================ |
| 3 | |
| 4 | .. module:: random |
| 5 | :synopsis: Generate pseudo-random numbers with various common distributions. |
| 6 | |
| 7 | |
| 8 | This module implements pseudo-random number generators for various |
| 9 | distributions. |
| 10 | |
Raymond Hettinger | b21dac1 | 2010-09-07 05:32:49 +0000 | [diff] [blame^] | 11 | For integers, there is uniform selection from a range. For sequences, there is |
| 12 | uniform selection of a random element, a function to generate a random |
| 13 | permutation of a list in-place, and a function for random sampling without |
| 14 | replacement. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 15 | |
| 16 | On the real line, there are functions to compute uniform, normal (Gaussian), |
| 17 | lognormal, negative exponential, gamma, and beta distributions. For generating |
| 18 | distributions of angles, the von Mises distribution is available. |
| 19 | |
| 20 | Almost all module functions depend on the basic function :func:`random`, which |
| 21 | generates a random float uniformly in the semi-open range [0.0, 1.0). Python |
| 22 | uses the Mersenne Twister as the core generator. It produces 53-bit precision |
| 23 | floats and has a period of 2\*\*19937-1. The underlying implementation in C is |
| 24 | both fast and threadsafe. The Mersenne Twister is one of the most extensively |
| 25 | tested random number generators in existence. However, being completely |
| 26 | deterministic, it is not suitable for all purposes, and is completely unsuitable |
| 27 | for cryptographic purposes. |
| 28 | |
| 29 | The functions supplied by this module are actually bound methods of a hidden |
| 30 | instance of the :class:`random.Random` class. You can instantiate your own |
Raymond Hettinger | 28de64f | 2008-01-13 23:40:30 +0000 | [diff] [blame] | 31 | instances of :class:`Random` to get generators that don't share state. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 32 | |
| 33 | Class :class:`Random` can also be subclassed if you want to use a different |
| 34 | basic generator of your own devising: in that case, override the :meth:`random`, |
Raymond Hettinger | afd3045 | 2009-02-24 10:57:02 +0000 | [diff] [blame] | 35 | :meth:`seed`, :meth:`getstate`, and :meth:`setstate` methods. |
Benjamin Peterson | d18de0e | 2008-07-31 20:21:46 +0000 | [diff] [blame] | 36 | Optionally, a new generator can supply a :meth:`getrandbits` method --- this |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 37 | allows :meth:`randrange` to produce selections over an arbitrarily large range. |
| 38 | |
Benjamin Peterson | 21896a3 | 2010-03-21 22:03:03 +0000 | [diff] [blame] | 39 | The :mod:`random` module also provides the :class:`SystemRandom` class which |
| 40 | uses the system function :func:`os.urandom` to generate random numbers |
| 41 | from sources provided by the operating system. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 42 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 43 | Bookkeeping functions: |
| 44 | |
| 45 | |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 46 | .. function:: seed([x], version=2) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 47 | |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 48 | Initialize the random number generator. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 49 | |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 50 | If *x* is omitted or ``None``, the current system time is used. If |
| 51 | randomness sources are provided by the operating system, they are used |
| 52 | instead of the system time (see the :func:`os.urandom` function for details |
| 53 | on availability). |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 54 | |
Raymond Hettinger | f763a72 | 2010-09-07 00:38:15 +0000 | [diff] [blame] | 55 | If *x* is an int, it is used directly. |
| 56 | |
| 57 | With version 2 (the default), a :class:`str`, :class:`bytes`, or :class:`bytearray` |
| 58 | object gets converted to a :class:`int` and all of its bits are used. With version 1, |
| 59 | the :func:`hash` of *x* is used instead. |
| 60 | |
| 61 | .. versionchanged:: 3.2 |
| 62 | Moved to the version 2 scheme which uses all of the bits in a string seed. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 63 | |
| 64 | .. function:: getstate() |
| 65 | |
| 66 | Return an object capturing the current internal state of the generator. This |
| 67 | object can be passed to :func:`setstate` to restore the state. |
| 68 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 69 | |
| 70 | .. function:: setstate(state) |
| 71 | |
| 72 | *state* should have been obtained from a previous call to :func:`getstate`, and |
| 73 | :func:`setstate` restores the internal state of the generator to what it was at |
| 74 | the time :func:`setstate` was called. |
| 75 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 76 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 77 | .. function:: getrandbits(k) |
| 78 | |
Ezio Melotti | 0639d5a | 2009-12-19 23:26:38 +0000 | [diff] [blame] | 79 | Returns a Python integer with *k* random bits. This method is supplied with |
Georg Brandl | 5c10664 | 2007-11-29 17:41:05 +0000 | [diff] [blame] | 80 | the MersenneTwister generator and some other generators may also provide it |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 81 | as an optional part of the API. When available, :meth:`getrandbits` enables |
| 82 | :meth:`randrange` to handle arbitrarily large ranges. |
| 83 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 84 | |
| 85 | Functions for integers: |
| 86 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 87 | .. function:: randrange([start,] stop[, step]) |
| 88 | |
| 89 | Return a randomly selected element from ``range(start, stop, step)``. This is |
| 90 | equivalent to ``choice(range(start, stop, step))``, but doesn't actually build a |
| 91 | range object. |
| 92 | |
Raymond Hettinger | 0515661 | 2010-09-07 04:44:52 +0000 | [diff] [blame] | 93 | The positional argument pattern matches that of :func:`range`. Keyword arguments |
| 94 | should not be used because the function may use them in unexpected ways. |
| 95 | |
| 96 | .. versionchanged:: 3.2 |
| 97 | :meth:`randrange` is more sophisticated about producing equally distributed |
| 98 | values. Formerly it used a style like ``int(random()*n)`` which could produce |
| 99 | slightly uneven distributions. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 100 | |
| 101 | .. function:: randint(a, b) |
| 102 | |
Raymond Hettinger | afd3045 | 2009-02-24 10:57:02 +0000 | [diff] [blame] | 103 | Return a random integer *N* such that ``a <= N <= b``. Alias for |
| 104 | ``randrange(a, b+1)``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 105 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 106 | |
Georg Brandl | 55ac8f0 | 2007-09-01 13:51:09 +0000 | [diff] [blame] | 107 | Functions for sequences: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 108 | |
| 109 | .. function:: choice(seq) |
| 110 | |
| 111 | Return a random element from the non-empty sequence *seq*. If *seq* is empty, |
| 112 | raises :exc:`IndexError`. |
| 113 | |
| 114 | |
| 115 | .. function:: shuffle(x[, random]) |
| 116 | |
| 117 | Shuffle the sequence *x* in place. The optional argument *random* is a |
| 118 | 0-argument function returning a random float in [0.0, 1.0); by default, this is |
| 119 | the function :func:`random`. |
| 120 | |
| 121 | Note that for even rather small ``len(x)``, the total number of permutations of |
| 122 | *x* is larger than the period of most random number generators; this implies |
| 123 | that most permutations of a long sequence can never be generated. |
| 124 | |
| 125 | |
| 126 | .. function:: sample(population, k) |
| 127 | |
Raymond Hettinger | 1acde19 | 2008-01-14 01:00:53 +0000 | [diff] [blame] | 128 | Return a *k* length list of unique elements chosen from the population sequence |
| 129 | or set. Used for random sampling without replacement. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 130 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 131 | Returns a new list containing elements from the population while leaving the |
| 132 | original population unchanged. The resulting list is in selection order so that |
| 133 | all sub-slices will also be valid random samples. This allows raffle winners |
| 134 | (the sample) to be partitioned into grand prize and second place winners (the |
| 135 | subslices). |
| 136 | |
Guido van Rossum | 2cc30da | 2007-11-02 23:46:40 +0000 | [diff] [blame] | 137 | Members of the population need not be :term:`hashable` or unique. If the population |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 138 | contains repeats, then each occurrence is a possible selection in the sample. |
| 139 | |
| 140 | To choose a sample from a range of integers, use an :func:`range` object as an |
| 141 | argument. This is especially fast and space efficient for sampling from a large |
| 142 | population: ``sample(range(10000000), 60)``. |
| 143 | |
| 144 | The following functions generate specific real-valued distributions. Function |
| 145 | parameters are named after the corresponding variables in the distribution's |
| 146 | equation, as used in common mathematical practice; most of these equations can |
| 147 | be found in any statistics text. |
| 148 | |
| 149 | |
| 150 | .. function:: random() |
| 151 | |
| 152 | Return the next random floating point number in the range [0.0, 1.0). |
| 153 | |
| 154 | |
| 155 | .. function:: uniform(a, b) |
| 156 | |
Benjamin Peterson | b58dda7 | 2009-01-18 22:27:04 +0000 | [diff] [blame] | 157 | Return a random floating point number *N* such that ``a <= N <= b`` for |
| 158 | ``a <= b`` and ``b <= N <= a`` for ``b < a``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 159 | |
Raymond Hettinger | be40db0 | 2009-06-11 23:12:14 +0000 | [diff] [blame] | 160 | The end-point value ``b`` may or may not be included in the range |
| 161 | depending on floating-point rounding in the equation ``a + (b-a) * random()``. |
Benjamin Peterson | 35e8c46 | 2008-04-24 02:34:53 +0000 | [diff] [blame] | 162 | |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 163 | .. function:: triangular(low, high, mode) |
| 164 | |
Benjamin Peterson | b58dda7 | 2009-01-18 22:27:04 +0000 | [diff] [blame] | 165 | Return a random floating point number *N* such that ``low <= N <= high`` and |
Christian Heimes | cc47b05 | 2008-03-25 14:56:36 +0000 | [diff] [blame] | 166 | with the specified *mode* between those bounds. The *low* and *high* bounds |
| 167 | default to zero and one. The *mode* argument defaults to the midpoint |
| 168 | between the bounds, giving a symmetric distribution. |
Christian Heimes | fe337bf | 2008-03-23 21:54:12 +0000 | [diff] [blame] | 169 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 170 | |
| 171 | .. function:: betavariate(alpha, beta) |
| 172 | |
Benjamin Peterson | b58dda7 | 2009-01-18 22:27:04 +0000 | [diff] [blame] | 173 | Beta distribution. Conditions on the parameters are ``alpha > 0`` and |
| 174 | ``beta > 0``. Returned values range between 0 and 1. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 175 | |
| 176 | |
| 177 | .. function:: expovariate(lambd) |
| 178 | |
Mark Dickinson | 2f94736 | 2009-01-07 17:54:07 +0000 | [diff] [blame] | 179 | Exponential distribution. *lambd* is 1.0 divided by the desired |
| 180 | mean. It should be nonzero. (The parameter would be called |
| 181 | "lambda", but that is a reserved word in Python.) Returned values |
| 182 | range from 0 to positive infinity if *lambd* is positive, and from |
| 183 | negative infinity to 0 if *lambd* is negative. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 184 | |
| 185 | |
| 186 | .. function:: gammavariate(alpha, beta) |
| 187 | |
Benjamin Peterson | b58dda7 | 2009-01-18 22:27:04 +0000 | [diff] [blame] | 188 | Gamma distribution. (*Not* the gamma function!) Conditions on the |
| 189 | parameters are ``alpha > 0`` and ``beta > 0``. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 190 | |
| 191 | |
| 192 | .. function:: gauss(mu, sigma) |
| 193 | |
Benjamin Peterson | b58dda7 | 2009-01-18 22:27:04 +0000 | [diff] [blame] | 194 | Gaussian distribution. *mu* is the mean, and *sigma* is the standard |
| 195 | deviation. This is slightly faster than the :func:`normalvariate` function |
| 196 | defined below. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 197 | |
| 198 | |
| 199 | .. function:: lognormvariate(mu, sigma) |
| 200 | |
| 201 | Log normal distribution. If you take the natural logarithm of this |
| 202 | distribution, you'll get a normal distribution with mean *mu* and standard |
| 203 | deviation *sigma*. *mu* can have any value, and *sigma* must be greater than |
| 204 | zero. |
| 205 | |
| 206 | |
| 207 | .. function:: normalvariate(mu, sigma) |
| 208 | |
| 209 | Normal distribution. *mu* is the mean, and *sigma* is the standard deviation. |
| 210 | |
| 211 | |
| 212 | .. function:: vonmisesvariate(mu, kappa) |
| 213 | |
| 214 | *mu* is the mean angle, expressed in radians between 0 and 2\*\ *pi*, and *kappa* |
| 215 | is the concentration parameter, which must be greater than or equal to zero. If |
| 216 | *kappa* is equal to zero, this distribution reduces to a uniform random angle |
| 217 | over the range 0 to 2\*\ *pi*. |
| 218 | |
| 219 | |
| 220 | .. function:: paretovariate(alpha) |
| 221 | |
| 222 | Pareto distribution. *alpha* is the shape parameter. |
| 223 | |
| 224 | |
| 225 | .. function:: weibullvariate(alpha, beta) |
| 226 | |
| 227 | Weibull distribution. *alpha* is the scale parameter and *beta* is the shape |
| 228 | parameter. |
| 229 | |
| 230 | |
| 231 | Alternative Generators: |
| 232 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 233 | .. class:: SystemRandom([seed]) |
| 234 | |
| 235 | Class that uses the :func:`os.urandom` function for generating random numbers |
| 236 | from sources provided by the operating system. Not available on all systems. |
| 237 | Does not rely on software state and sequences are not reproducible. Accordingly, |
Raymond Hettinger | afd3045 | 2009-02-24 10:57:02 +0000 | [diff] [blame] | 238 | the :meth:`seed` method has no effect and is ignored. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 239 | The :meth:`getstate` and :meth:`setstate` methods raise |
| 240 | :exc:`NotImplementedError` if called. |
| 241 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 242 | |
| 243 | Examples of basic usage:: |
| 244 | |
| 245 | >>> random.random() # Random float x, 0.0 <= x < 1.0 |
| 246 | 0.37444887175646646 |
| 247 | >>> random.uniform(1, 10) # Random float x, 1.0 <= x < 10.0 |
| 248 | 1.1800146073117523 |
| 249 | >>> random.randint(1, 10) # Integer from 1 to 10, endpoints included |
| 250 | 7 |
| 251 | >>> random.randrange(0, 101, 2) # Even integer from 0 to 100 |
| 252 | 26 |
| 253 | >>> random.choice('abcdefghij') # Choose a random element |
| 254 | 'c' |
| 255 | |
| 256 | >>> items = [1, 2, 3, 4, 5, 6, 7] |
| 257 | >>> random.shuffle(items) |
| 258 | >>> items |
| 259 | [7, 3, 2, 5, 6, 4, 1] |
| 260 | |
| 261 | >>> random.sample([1, 2, 3, 4, 5], 3) # Choose 3 elements |
| 262 | [4, 1, 5] |
| 263 | |
| 264 | |
| 265 | |
| 266 | .. seealso:: |
| 267 | |
| 268 | M. Matsumoto and T. Nishimura, "Mersenne Twister: A 623-dimensionally |
| 269 | equidistributed uniform pseudorandom number generator", ACM Transactions on |
| 270 | Modeling and Computer Simulation Vol. 8, No. 1, January pp.3-30 1998. |
| 271 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 272 | |
Raymond Hettinger | 1fd32a6 | 2009-04-01 20:52:13 +0000 | [diff] [blame] | 273 | `Complementary-Multiply-with-Carry recipe |
Raymond Hettinger | 9743fd0 | 2009-04-03 05:47:33 +0000 | [diff] [blame] | 274 | <http://code.activestate.com/recipes/576707/>`_ for a compatible alternative |
| 275 | random number generator with a long period and comparatively simple update |
Raymond Hettinger | 1fd32a6 | 2009-04-01 20:52:13 +0000 | [diff] [blame] | 276 | operations. |
Raymond Hettinger | 435cb0f | 2010-09-06 23:36:31 +0000 | [diff] [blame] | 277 | |
| 278 | Notes on Reproducibility |
| 279 | ======================== |
| 280 | |
| 281 | Sometimes it is useful to be able to reproduce the sequences given by a pseudo |
| 282 | random number generator. By re-using a seed value, the same sequence should be |
| 283 | reproducible from run to run as long as multiple threads are not running. |
| 284 | |
| 285 | Most of the random module's algorithms and seeding functions are subject to |
| 286 | change across Python versions, but two aspects are guaranteed not to change: |
| 287 | |
| 288 | * If a new seeding method is added, then a backward compatible seeder will be |
| 289 | offered. |
| 290 | |
| 291 | * The generator's :meth:`random` method will continue to produce the same |
| 292 | sequence when the compatible seeder is given the same seed. |