summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authorÉric Araujo <merwok@netwok.org>2010-11-16 19:13:50 +0000
committerÉric Araujo <merwok@netwok.org>2010-11-16 19:13:50 +0000
commit6e6cb8e0e491477614bae33c29f6e00d0d48c20b (patch)
tree0cb13cc6d94af48c5a4b78b360c75fcf6f93d406 /Doc
parentdbe7519da9d0a99d68aaa773cde2793900dad44f (diff)
downloadcpython-git-6e6cb8e0e491477614bae33c29f6e00d0d48c20b.tar.gz
Provide links to Python source where the code is short, readable and
informative adjunct to the docs. Forward-port of Raymond's r86225 and r86245 using the new source reST role added in #10334.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/ast.rst3
-rw-r--r--Doc/library/atexit.rst5
-rw-r--r--Doc/library/bisect.rst5
-rw-r--r--Doc/library/calendar.rst4
-rw-r--r--Doc/library/cmd.rst3
-rw-r--r--Doc/library/collections.rst8
-rw-r--r--Doc/library/contextlib.rst5
-rw-r--r--Doc/library/dis.rst4
-rw-r--r--Doc/library/filecmp.rst5
-rw-r--r--Doc/library/fileinput.rst5
-rw-r--r--Doc/library/fnmatch.rst4
-rw-r--r--Doc/library/functools.rst5
-rw-r--r--Doc/library/glob.rst3
-rw-r--r--Doc/library/heapq.rst5
-rw-r--r--Doc/library/keyword.rst5
-rw-r--r--Doc/library/linecache.rst5
-rw-r--r--Doc/library/pprint.rst5
-rw-r--r--Doc/library/queue.rst5
-rw-r--r--Doc/library/quopri.rst4
-rw-r--r--Doc/library/random.rst5
-rw-r--r--Doc/library/sched.rst4
-rw-r--r--Doc/library/shelve.rst4
-rw-r--r--Doc/library/shutil.rst6
-rw-r--r--Doc/library/string.rst5
-rw-r--r--Doc/library/textwrap.rst4
-rw-r--r--Doc/library/threading.rst5
-rw-r--r--Doc/library/tokenize.rst5
-rw-r--r--Doc/library/trace.rst4
-rw-r--r--Doc/library/uu.rst4
29 files changed, 134 insertions, 0 deletions
diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst
index 66b29e0946..a9821e1e8c 100644
--- a/Doc/library/ast.rst
+++ b/Doc/library/ast.rst
@@ -19,6 +19,9 @@ helper provided in this module. The result will be a tree of objects whose
classes all inherit from :class:`ast.AST`. An abstract syntax tree can be
compiled into a Python code object using the built-in :func:`compile` function.
+.. seealso::
+
+ Latest version of the :source:`ast module Python source code <Lib/ast.py>`
Node classes
------------
diff --git a/Doc/library/atexit.rst b/Doc/library/atexit.rst
index 104c73027d..1ce45c4df5 100644
--- a/Doc/library/atexit.rst
+++ b/Doc/library/atexit.rst
@@ -11,6 +11,11 @@ The :mod:`atexit` module defines functions to register and unregister cleanup
functions. Functions thus registered are automatically executed upon normal
interpreter termination.
+.. seealso::
+
+ Latest version of the :source:`atexit Python source code
+ <Lib/atexit.py>`
+
Note: the functions registered via this module are not called when the program
is killed by a signal not handled by Python, when a Python fatal internal error
is detected, or when :func:`os._exit` is called.
diff --git a/Doc/library/bisect.rst b/Doc/library/bisect.rst
index eb231598ed..ca853e0f82 100644
--- a/Doc/library/bisect.rst
+++ b/Doc/library/bisect.rst
@@ -14,6 +14,11 @@ approach. The module is called :mod:`bisect` because it uses a basic bisection
algorithm to do its work. The source code may be most useful as a working
example of the algorithm (the boundary conditions are already right!).
+.. seealso::
+
+ Latest version of the :source:`bisect module Python source code
+ <Lib/bisect.py>`
+
The following functions are provided:
diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst
index c8dac49e3c..4ebe616ade 100644
--- a/Doc/library/calendar.rst
+++ b/Doc/library/calendar.rst
@@ -21,6 +21,10 @@ in both directions. This matches the definition of the "proleptic Gregorian"
calendar in Dershowitz and Reingold's book "Calendrical Calculations", where
it's the base calendar for all computations.
+.. seealso::
+
+ Latest version of the :source:`calendar module Python source code
+ <Lib/calendar.py>`
.. class:: Calendar(firstweekday=0)
diff --git a/Doc/library/cmd.rst b/Doc/library/cmd.rst
index d0332aaf8f..53d62c5c94 100644
--- a/Doc/library/cmd.rst
+++ b/Doc/library/cmd.rst
@@ -11,6 +11,9 @@ command interpreters. These are often useful for test harnesses, administrative
tools, and prototypes that will later be wrapped in a more sophisticated
interface.
+.. seealso::
+
+ Latest version of the :source:`cmd module Python source code <Lib/cmd.py>`
.. class:: Cmd(completekey='tab', stdin=None, stdout=None)
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 439e3bf45c..e34e39479b 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -31,6 +31,11 @@ In addition to the concrete container classes, the collections module provides
ABCs (abstract base classes) that can be used to test whether a class provides a
particular interface, for example, whether it is hashable or a mapping.
+.. seealso::
+
+ Latest version of the :source:`collections module Python source code
+ <Lib/collections.py>`
+
:class:`Counter` objects
------------------------
@@ -1059,6 +1064,9 @@ Notes on using :class:`Set` and :class:`MutableSet` as a mixin:
.. seealso::
+ * Latest version of the :source:`Python source code for the collections
+ abstract base classes <Lib/_abcoll.py>`
+
* `OrderedSet recipe <http://code.activestate.com/recipes/576694/>`_ for an
example built on :class:`MutableSet`.
diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst
index 35eb882f66..5e1a11a116 100644
--- a/Doc/library/contextlib.rst
+++ b/Doc/library/contextlib.rst
@@ -9,6 +9,11 @@ This module provides utilities for common tasks involving the :keyword:`with`
statement. For more information see also :ref:`typecontextmanager` and
:ref:`context-managers`.
+.. seealso::
+
+ Latest version of the :source:`contextlib Python source code
+ <Lib/contextlib.py>`
+
Functions provided:
diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
index b6f1d9f1a9..cf880fcc02 100644
--- a/Doc/library/dis.rst
+++ b/Doc/library/dis.rst
@@ -10,6 +10,10 @@ disassembling it. The CPython bytecode which this module takes as an
input is defined in the file :file:`Include/opcode.h` and used by the compiler
and the interpreter.
+.. seealso::
+
+ Latest version of the :source:`dis module Python source code <Lib/dis.py>`
+
.. impl-detail::
Bytecode is an implementation detail of the CPython interpreter! No
diff --git a/Doc/library/filecmp.rst b/Doc/library/filecmp.rst
index f57dcceff0..d6cdd29cb5 100644
--- a/Doc/library/filecmp.rst
+++ b/Doc/library/filecmp.rst
@@ -10,6 +10,11 @@ The :mod:`filecmp` module defines functions to compare files and directories,
with various optional time/correctness trade-offs. For comparing files,
see also the :mod:`difflib` module.
+.. seealso::
+
+ Latest version of the :source:`filecmp Python source code
+ <Lib/filecmp.py>`
+
The :mod:`filecmp` module defines the following functions:
diff --git a/Doc/library/fileinput.rst b/Doc/library/fileinput.rst
index 7055f32ab0..9174830fc1 100644
--- a/Doc/library/fileinput.rst
+++ b/Doc/library/fileinput.rst
@@ -44,6 +44,11 @@ hook must be a function that takes two arguments, *filename* and *mode*, and
returns an accordingly opened file-like object. Two useful hooks are already
provided by this module.
+.. seealso::
+
+ Latest version of the :source:`fileinput Python source code
+ <Lib/fileinput.py>`
+
The following function is the primary interface of this module:
diff --git a/Doc/library/fnmatch.rst b/Doc/library/fnmatch.rst
index 0352b5233d..8af6c0b0bf 100644
--- a/Doc/library/fnmatch.rst
+++ b/Doc/library/fnmatch.rst
@@ -33,6 +33,10 @@ module. See module :mod:`glob` for pathname expansion (:mod:`glob` uses
a period are not special for this module, and are matched by the ``*`` and ``?``
patterns.
+.. seealso::
+
+ Latest version of the :source:`fnmatch Python source code
+ <Lib/fnmatch.py>`
.. function:: fnmatch(filename, pattern)
diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst
index 8e97c5409d..58c2429fd1 100644
--- a/Doc/library/functools.rst
+++ b/Doc/library/functools.rst
@@ -13,6 +13,11 @@ The :mod:`functools` module is for higher-order functions: functions that act on
or return other functions. In general, any callable object can be treated as a
function for the purposes of this module.
+.. seealso::
+
+ Latest version of the :source:`functools Python source code
+ <Lib/functools.py>`
+
The :mod:`functools` module defines the following functions:
.. function:: cmp_to_key(func)
diff --git a/Doc/library/glob.rst b/Doc/library/glob.rst
index 3e0322d1c9..0de763fd53 100644
--- a/Doc/library/glob.rst
+++ b/Doc/library/glob.rst
@@ -15,6 +15,9 @@ matched. This is done by using the :func:`os.listdir` and
subshell. (For tilde and shell variable expansion, use
:func:`os.path.expanduser` and :func:`os.path.expandvars`.)
+.. seealso::
+
+ Latest version of the :source:`glob module Python source code <Lib/glob.py>`
.. function:: glob(pathname)
diff --git a/Doc/library/heapq.rst b/Doc/library/heapq.rst
index 78beee9978..67bda5698d 100644
--- a/Doc/library/heapq.rst
+++ b/Doc/library/heapq.rst
@@ -11,6 +11,11 @@
This module provides an implementation of the heap queue algorithm, also known
as the priority queue algorithm.
+.. seealso::
+
+ Latest version of the :source:`heapq Python source code
+ <Lib/heapq.py>`
+
Heaps are arrays for which ``heap[k] <= heap[2*k+1]`` and ``heap[k] <=
heap[2*k+2]`` for all *k*, counting elements from zero. For the sake of
comparison, non-existing elements are considered to be infinite. The
diff --git a/Doc/library/keyword.rst b/Doc/library/keyword.rst
index a4bfa501bf..4d8a1f1434 100644
--- a/Doc/library/keyword.rst
+++ b/Doc/library/keyword.rst
@@ -19,3 +19,8 @@ This module allows a Python program to determine if a string is a keyword.
keywords are defined to only be active when particular :mod:`__future__`
statements are in effect, these will be included as well.
+
+.. seealso::
+
+ Latest version of the :source:`keyword module Python source code
+ <Lib/keyword.py>`
diff --git a/Doc/library/linecache.rst b/Doc/library/linecache.rst
index 688e297307..d8a9ff3af3 100644
--- a/Doc/library/linecache.rst
+++ b/Doc/library/linecache.rst
@@ -11,6 +11,11 @@ attempting to optimize internally, using a cache, the common case where many
lines are read from a single file. This is used by the :mod:`traceback` module
to retrieve source lines for inclusion in the formatted traceback.
+.. seealso::
+
+ Latest version of the :source:`linecache module Python source code
+ <Lib/linecache.py>`
+
The :mod:`linecache` module defines the following functions:
diff --git a/Doc/library/pprint.rst b/Doc/library/pprint.rst
index 932be754a2..82648a1e91 100644
--- a/Doc/library/pprint.rst
+++ b/Doc/library/pprint.rst
@@ -21,6 +21,11 @@ width constraint.
Dictionaries are sorted by key before the display is computed.
+.. seealso::
+
+ Latest version of the :source:`pprint module Python source code
+ <Lib/pprint.py>`
+
The :mod:`pprint` module defines one class:
.. First the implementation class:
diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst
index 0ee920bc6f..424998eb70 100644
--- a/Doc/library/queue.rst
+++ b/Doc/library/queue.rst
@@ -19,6 +19,11 @@ the first retrieved (operating like a stack). With a priority queue,
the entries are kept sorted (using the :mod:`heapq` module) and the
lowest valued entry is retrieved first.
+.. seealso::
+
+ Latest version of the :source:`queue module Python source code
+ <Lib/queue.py>`
+
The :mod:`queue` module defines the following classes and exceptions:
.. class:: Queue(maxsize=0)
diff --git a/Doc/library/quopri.rst b/Doc/library/quopri.rst
index d7c7204074..4eded5b766 100644
--- a/Doc/library/quopri.rst
+++ b/Doc/library/quopri.rst
@@ -17,6 +17,10 @@ few nonprintable characters; the base64 encoding scheme available via the
:mod:`base64` module is more compact if there are many such characters, as when
sending a graphics file.
+.. seealso::
+
+ Latest version of the :source:`quopri module Python source code
+ <Lib/quopri.py>`
.. function:: decode(input, output, header=False)
diff --git a/Doc/library/random.rst b/Doc/library/random.rst
index 55edcf8fef..7aa08942d8 100644
--- a/Doc/library/random.rst
+++ b/Doc/library/random.rst
@@ -8,6 +8,11 @@
This module implements pseudo-random number generators for various
distributions.
+.. seealso::
+
+ Latest version of the :source:`random module Python source code
+ <Lib/random.py>`
+
For integers, there is uniform selection from a range. For sequences, there is
uniform selection of a random element, a function to generate a random
permutation of a list in-place, and a function for random sampling without
diff --git a/Doc/library/sched.rst b/Doc/library/sched.rst
index 0290ec41cd..94f79915a2 100644
--- a/Doc/library/sched.rst
+++ b/Doc/library/sched.rst
@@ -10,6 +10,10 @@
The :mod:`sched` module defines a class which implements a general purpose event
scheduler:
+.. seealso::
+
+ Latest version of the :source:`sched module Python source code
+ <Lib/sched.py>`
.. class:: scheduler(timefunc, delayfunc)
diff --git a/Doc/library/shelve.rst b/Doc/library/shelve.rst
index f5374c9ed7..512788c9c9 100644
--- a/Doc/library/shelve.rst
+++ b/Doc/library/shelve.rst
@@ -13,6 +13,10 @@ arbitrary Python objects --- anything that the :mod:`pickle` module can handle.
This includes most class instances, recursive data types, and objects containing
lots of shared sub-objects. The keys are ordinary strings.
+.. seealso::
+
+ Latest version of the :source:`shelve module Python source code
+ <Lib/shelve.py>`
.. function:: open(filename, flag='c', protocol=None, writeback=False)
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index e9dfe65a6f..0144876719 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -15,6 +15,11 @@ collections of files. In particular, functions are provided which support file
copying and removal. For operations on individual files, see also the
:mod:`os` module.
+.. seealso::
+
+ Latest version of the :source:`shutil module Python source code
+ <Lib/shutil.py>`
+
.. warning::
Even the higher-level file copying functions (:func:`copy`, :func:`copy2`)
@@ -26,6 +31,7 @@ copying and removal. For operations on individual files, see also the
not be correct. On Windows, file owners, ACLs and alternate data streams
are not copied.
+
Directory and files operations
------------------------------
diff --git a/Doc/library/string.rst b/Doc/library/string.rst
index 69cc25bbdf..b785fc2c04 100644
--- a/Doc/library/string.rst
+++ b/Doc/library/string.rst
@@ -15,6 +15,11 @@ section, and also the string-specific methods described in the
:ref:`string-formatting` section. Also, see the :mod:`re` module for
string functions based on regular expressions.
+.. seealso::
+
+ Latest version of the :source:`string module Python source code
+ <Lib/string.py>`
+
String constants
----------------
diff --git a/Doc/library/textwrap.rst b/Doc/library/textwrap.rst
index f66416f3c6..f8817013b5 100644
--- a/Doc/library/textwrap.rst
+++ b/Doc/library/textwrap.rst
@@ -13,6 +13,10 @@ and a utility function :func:`dedent`. If you're just wrapping or filling one
or two text strings, the convenience functions should be good enough;
otherwise, you should use an instance of :class:`TextWrapper` for efficiency.
+.. seealso::
+
+ Latest version of the :source:`textwrap module Python source code
+ <Lib/textwrap.py>`
.. function:: wrap(text, width=70, **kwargs)
diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
index 702f4beeff..d3d7d9e612 100644
--- a/Doc/library/threading.rst
+++ b/Doc/library/threading.rst
@@ -17,6 +17,11 @@ The :mod:`dummy_threading` module is provided for situations where
methods and functions in this module in the Python 2.x series are still
supported by this module.
+.. seealso::
+
+ Latest version of the :source:`threading module Python source code
+ <Lib/threading.py>`
+
This module defines the following functions and objects:
diff --git a/Doc/library/tokenize.rst b/Doc/library/tokenize.rst
index 6a96609596..d7ae6382e4 100644
--- a/Doc/library/tokenize.rst
+++ b/Doc/library/tokenize.rst
@@ -12,6 +12,11 @@ implemented in Python. The scanner in this module returns comments as tokens
as well, making it useful for implementing "pretty-printers," including
colorizers for on-screen displays.
+.. seealso::
+
+ Latest version of the :source:`tokenize module Python source code
+ <Lib/tokenize.py>`
+
The primary entry point is a :term:`generator`:
.. function:: tokenize(readline)
diff --git a/Doc/library/trace.rst b/Doc/library/trace.rst
index f90f44b33e..878fbed7ea 100644
--- a/Doc/library/trace.rst
+++ b/Doc/library/trace.rst
@@ -10,6 +10,10 @@ annotated statement coverage listings, print caller/callee relationships and
list functions executed during a program run. It can be used in another program
or from the command line.
+.. seealso::
+
+ Latest version of the :source:`trace module Python source code
+ <Lib/trace.py>`
.. _trace-cli:
diff --git a/Doc/library/uu.rst b/Doc/library/uu.rst
index 7813e448e8..53d269b967 100644
--- a/Doc/library/uu.rst
+++ b/Doc/library/uu.rst
@@ -21,6 +21,10 @@ that, when required, the mode is ``'rb'`` or ``'wb'`` on Windows.
This code was contributed by Lance Ellinghouse, and modified by Jack Jansen.
+.. seealso::
+
+ Latest version of the :source:`uu module Python source code <Lib/uu.py>`
+
The :mod:`uu` module defines the following functions: