]> granicus.if.org Git - python/commitdiff
Document which part of the random module module are guaranteed.
authorRaymond Hettinger <python@rcn.com>
Mon, 6 Sep 2010 23:36:31 +0000 (23:36 +0000)
committerRaymond Hettinger <python@rcn.com>
Mon, 6 Sep 2010 23:36:31 +0000 (23:36 +0000)
Doc/library/random.rst
Misc/NEWS

index bf89ade3d37f25078b9721de17ad5f222be96bb6..6ef5d209fcf7734f48a3a416f16458594c7f66fe 100644 (file)
@@ -270,3 +270,19 @@ Examples of basic usage::
    <http://code.activestate.com/recipes/576707/>`_ for a compatible alternative
    random number generator with a long period and comparatively simple update
    operations.
+
+Notes on Reproducibility
+========================
+
+Sometimes it is useful to be able to reproduce the sequences given by a pseudo
+random number generator.  By re-using a seed value, the same sequence should be
+reproducible from run to run as long as multiple threads are not running.
+
+Most of the random module's algorithms and seeding functions are subject to
+change across Python versions, but two aspects are guaranteed not to change:
+
+* If a new seeding method is added, then a backward compatible seeder will be
+  offered.
+
+* The generator's :meth:`random` method will continue to produce the same
+  sequence when the compatible seeder is given the same seed.
index 262983b31378cc66b02ecb0bc5786c1b44bd8af8..014164ea7d7ce25f07357ac238b9e14da63885bc 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -13,6 +13,11 @@ Core and Builtins
 Library
 -------
 
+- Updates to the random module:
+
+  * Document which parts of the module are guaranteed to stay the same
+    across versions and which parts are subject to change.
+
 - collections.OrderedDict now supports a new method for repositioning
   keys to either end.