diff options
| author | Terry Jan Reedy <tjreedy@udel.edu> | 2016-06-11 15:02:54 -0400 |
|---|---|---|
| committer | Terry Jan Reedy <tjreedy@udel.edu> | 2016-06-11 15:02:54 -0400 |
| commit | 54cb82bd17469410c5eb5f5e723063aa2e2b87d8 (patch) | |
| tree | 601d3e857425d45dda1157c6f784a2ae19a9f0e6 | |
| parent | 76e3aa4006a7fe203b5e8c52009a14db054f5d81 (diff) | |
| download | cpython-54cb82bd17469410c5eb5f5e723063aa2e2b87d8.tar.gz | |
Issue #22558: Add remaining doc links to source code for Python-coded modules.
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
224 files changed, 539 insertions, 136 deletions
diff --git a/Doc/library/2to3.rst b/Doc/library/2to3.rst index 15b72dd42b..6fc28656b8 100644 --- a/Doc/library/2to3.rst +++ b/Doc/library/2to3.rst @@ -449,10 +449,14 @@ and off individually. They are described here in more detail. .. module:: lib2to3 :synopsis: the 2to3 library + .. moduleauthor:: Guido van Rossum .. moduleauthor:: Collin Winter .. moduleauthor:: Benjamin Peterson <benjamin@python.org> +**Source code:** :source:`Lib/lib2to3/` + +-------------- .. note:: diff --git a/Doc/library/__main__.rst b/Doc/library/__main__.rst index a46993d55e..a64faf1bbe 100644 --- a/Doc/library/__main__.rst +++ b/Doc/library/__main__.rst @@ -5,6 +5,8 @@ .. module:: __main__ :synopsis: The environment where the top-level script is run. +-------------- + ``'__main__'`` is the name of the scope in which top-level code executes. A module's __name__ is set equal to ``'__main__'`` when read from standard input, a script, or from an interactive prompt. diff --git a/Doc/library/_thread.rst b/Doc/library/_thread.rst index 7122861c45..0d2d818f5f 100644 --- a/Doc/library/_thread.rst +++ b/Doc/library/_thread.rst @@ -4,13 +4,14 @@ .. module:: _thread :synopsis: Low-level threading API. - .. index:: single: light-weight processes single: processes, light-weight single: binary semaphores single: semaphores, binary +-------------- + This module provides low-level primitives for working with multiple threads (also called :dfn:`light-weight processes` or :dfn:`tasks`) --- multiple threads of control sharing their global data space. For synchronization, simple locks diff --git a/Doc/library/abc.rst b/Doc/library/abc.rst index 7a73704bf6..966003bd45 100644 --- a/Doc/library/abc.rst +++ b/Doc/library/abc.rst @@ -3,6 +3,7 @@ .. module:: abc :synopsis: Abstract base classes according to PEP 3119. + .. moduleauthor:: Guido van Rossum .. sectionauthor:: Georg Brandl .. much of the content adapted from docstrings diff --git a/Doc/library/aifc.rst b/Doc/library/aifc.rst index 6fbcf286cf..23a96207d0 100644 --- a/Doc/library/aifc.rst +++ b/Doc/library/aifc.rst @@ -4,14 +4,13 @@ .. module:: aifc :synopsis: Read and write audio files in AIFF or AIFC format. +**Source code:** :source:`Lib/aifc.py` .. index:: single: Audio Interchange File Format single: AIFF single: AIFF-C -**Source code:** :source:`Lib/aifc.py` - -------------- This module provides support for reading and writing AIFF and AIFF-C files. diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst index 6a7f8ef725..10789e9f88 100644 --- a/Doc/library/argparse.rst +++ b/Doc/library/argparse.rst @@ -3,6 +3,7 @@ .. module:: argparse :synopsis: Command-line option and argument parsing library. + .. moduleauthor:: Steven Bethard <steven.bethard@gmail.com> .. sectionauthor:: Steven Bethard <steven.bethard@gmail.com> diff --git a/Doc/library/array.rst b/Doc/library/array.rst index 00406e016e..24f3f62ae7 100644 --- a/Doc/library/array.rst +++ b/Doc/library/array.rst @@ -4,9 +4,10 @@ .. module:: array :synopsis: Space efficient arrays of uniformly typed numeric values. - .. index:: single: arrays +-------------- + This module defines an object type which can compactly represent an array of basic values: characters, integers, floating point numbers. Arrays are sequence types and behave very much like lists, except that the type of objects stored in diff --git a/Doc/library/asynchat.rst b/Doc/library/asynchat.rst index 56ad4f8f3f..ae72d26122 100644 --- a/Doc/library/asynchat.rst +++ b/Doc/library/asynchat.rst @@ -3,6 +3,7 @@ .. module:: asynchat :synopsis: Support for asynchronous command/response protocols. + .. moduleauthor:: Sam Rushing <rushing@nightmare.com> .. sectionauthor:: Steve Holden <sholden@holdenweb.com> diff --git a/Doc/library/asyncio.rst b/Doc/library/asyncio.rst index 9b4d65e5da..f764c683b1 100644 --- a/Doc/library/asyncio.rst +++ b/Doc/library/asyncio.rst @@ -4,6 +4,10 @@ .. module:: asyncio :synopsis: Asynchronous I/O, event loop, coroutines and tasks. +.. versionadded:: 3.4 + +**Source code:** :source:`Lib/asyncio/` + .. note:: The asyncio package has been included in the standard library on a @@ -11,10 +15,6 @@ changes (up to and including removal of the module) may occur if deemed necessary by the core developers. -.. versionadded:: 3.4 - -**Source code:** :source:`Lib/asyncio/` - -------------- This module provides infrastructure for writing single-threaded concurrent diff --git a/Doc/library/asyncore.rst b/Doc/library/asyncore.rst index 02ae72afdd..61061be34e 100644 --- a/Doc/library/asyncore.rst +++ b/Doc/library/asyncore.rst @@ -4,6 +4,7 @@ .. module:: asyncore :synopsis: A base class for developing asynchronous socket handling services. + .. moduleauthor:: Sam Rushing <rushing@nightmare.com> .. sectionauthor:: Christopher Petrilli <petrilli@amber.org> .. sectionauthor:: Steve Holden <sholden@holdenweb.com> diff --git a/Doc/library/atexit.rst b/Doc/library/atexit.rst index dbdd81e6d0..1d84d4587f 100644 --- a/Doc/library/atexit.rst +++ b/Doc/library/atexit.rst @@ -3,9 +3,11 @@ .. module:: atexit :synopsis: Register and execute cleanup functions. + .. moduleauthor:: Skip Montanaro <skip@pobox.com> .. sectionauthor:: Skip Montanaro <skip@pobox.com> +-------------- The :mod:`atexit` module defines functions to register and unregister cleanup functions. Functions thus registered are automatically executed upon normal diff --git a/Doc/library/audioop.rst b/Doc/library/audioop.rst index 08d5f81016..bad9da2ec6 100644 --- a/Doc/library/audioop.rst +++ b/Doc/library/audioop.rst @@ -4,6 +4,7 @@ .. module:: audioop :synopsis: Manipulate raw audio data. +-------------- The :mod:`audioop` module contains some useful operations on sound fragments. It operates on sound fragments consisting of signed integer samples 8, 16, 24 diff --git a/Doc/library/base64.rst b/Doc/library/base64.rst index 4b28b4ef0d..080d9d77ec 100644 --- a/Doc/library/base64.rst +++ b/Doc/library/base64.rst @@ -5,11 +5,14 @@ :synopsis: RFC 3548: Base16, Base32, Base64 Data Encodings; Base85 and Ascii85 +**Source code:** :source:`Lib/base64.py` .. index:: pair: base64; encoding single: MIME; base64 encoding +-------------- + This module provides functions for encoding binary data to printable ASCII characters and decoding such encodings back to binary data. It provides encoding and decoding functions for the encodings specified in diff --git a/Doc/library/binascii.rst b/Doc/library/binascii.rst index 1752c63929..878d8db53c 100644 --- a/Doc/library/binascii.rst +++ b/Doc/library/binascii.rst @@ -5,12 +5,13 @@ :synopsis: Tools for converting between binary and various ASCII-encoded binary representations. - .. index:: module: uu module: base64 module: binhex +-------------- + The :mod:`binascii` module contains a number of methods to convert between binary and various ASCII-encoded binary representations. Normally, you will not use these functions directly but use wrapper modules like :mod:`uu`, diff --git a/Doc/library/binhex.rst b/Doc/library/binhex.rst index 43c78237d2..359ab23b2f 100644 --- a/Doc/library/binhex.rst +++ b/Doc/library/binhex.rst @@ -4,6 +4,9 @@ .. module:: binhex :synopsis: Encode and decode files in binhex4 format. +**Source code:** :source:`Lib/binhex.py` + +-------------- This module encodes and decodes files in binhex4 format, a format allowing representation of Macintosh files in ASCII. Only the data fork is handled. diff --git a/Doc/library/builtins.rst b/Doc/library/builtins.rst index 2cca1d05df..4b589a588d 100644 --- a/Doc/library/builtins.rst +++ b/Doc/library/builtins.rst @@ -4,6 +4,7 @@ .. module:: builtins :synopsis: The module that provides the built-in namespace. +-------------- This module provides direct access to all 'built-in' identifiers of Python; for example, ``builtins.open`` is the full name for the built-in function diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst index 1b8d9cffc6..6c49d9fffe 100644 --- a/Doc/library/bz2.rst +++ b/Doc/library/bz2.rst @@ -3,11 +3,15 @@ .. module:: bz2 :synopsis: Interfaces for bzip2 compression and decompression. + .. moduleauthor:: Gustavo Niemeyer <niemeyer@conectiva.com> .. moduleauthor:: Nadeem Vawda <nadeem.vawda@gmail.com> .. sectionauthor:: Gustavo Niemeyer <niemeyer@conectiva.com> .. sectionauthor:: Nadeem Vawda <nadeem.vawda@gmail.com> +**Source code:** :source:`Lib/bz2.py` + +-------------- This module provides a comprehensive interface for compressing and decompressing data using the bzip2 compression algorithm. diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst index 3187c43a84..df76e33668 100644 --- a/Doc/library/calendar.rst +++ b/Doc/library/calendar.rst @@ -4,6 +4,7 @@ .. module:: calendar :synopsis: Functions for working with calendars, including some emulation of the Unix cal program. + .. sectionauthor:: Drew Csillag <drew_csillag@geocities.com> **Source code:** :source:`Lib/calendar.py` diff --git a/Doc/library/cgi.rst b/Doc/library/cgi.rst index 7e496ca361..0bc2c35137 100644 --- a/Doc/library/cgi.rst +++ b/Doc/library/cgi.rst @@ -4,6 +4,7 @@ .. module:: cgi :synopsis: Helpers for running Python scripts via the Common Gateway Interface. +**Source code:** :source:`Lib/cgi.py` .. index:: pair: WWW; server @@ -13,8 +14,6 @@ single: URL single: Common Gateway Interface -**Source code:** :source:`Lib/cgi.py` - -------------- Support module for Common Gateway Interface (CGI) scripts. diff --git a/Doc/library/cgitb.rst b/Doc/library/cgitb.rst index 6827c8eb5b..b65a6355fe 100644 --- a/Doc/library/cgitb.rst +++ b/Doc/library/cgitb.rst @@ -3,9 +3,11 @@ .. module:: cgitb :synopsis: Configurable traceback handler for CGI scripts. + .. moduleauthor:: Ka-Ping Yee <ping@lfw.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> +**Source code:** :source:`Lib/cgitb.py` .. index:: single: CGI; exceptions @@ -13,6 +15,8 @@ single: exceptions; in CGI scripts single: tracebacks; in CGI scripts +-------------- + The :mod:`cgitb` module provides a special exception handler for Python scripts. (Its name is a bit misleading. It was originally designed to display extensive traceback information in HTML for CGI scripts. It was later generalized to also diff --git a/Doc/library/chunk.rst b/Doc/library/chunk.rst index a90e9f808b..5e24df923e 100644 --- a/Doc/library/chunk.rst +++ b/Doc/library/chunk.rst @@ -3,9 +3,11 @@ .. module:: chunk :synopsis: Module to read IFF chunks. + .. moduleauthor:: Sjoerd Mullender <sjoerd@acm.org> .. sectionauthor:: Sjoerd Mullender <sjoerd@acm.org> +**Source code:** :source:`Lib/chunk.py` .. index:: single: Audio Interchange File Format @@ -14,6 +16,8 @@ single: Real Media File Format single: RMFF +-------------- + This module provides an interface for reading files that use EA IFF 85 chunks. [#]_ This format is used in at least the Audio Interchange File Format (AIFF/AIFF-C) and the Real Media File Format (RMFF). The WAVE audio file format diff --git a/Doc/library/cmath.rst b/Doc/library/cmath.rst index ab619a082a..62ddb6bc48 100644 --- a/Doc/library/cmath.rst +++ b/Doc/library/cmath.rst @@ -4,6 +4,7 @@ .. module:: cmath :synopsis: Mathematical functions for complex numbers. +-------------- This module is always available. It provides access to mathematical functions for complex numbers. The functions in this module accept integers, diff --git a/Doc/library/cmd.rst b/Doc/library/cmd.rst index 1ab2d7423f..61ef0f6744 100644 --- a/Doc/library/cmd.rst +++ b/Doc/library/cmd.rst @@ -3,6 +3,7 @@ .. module:: cmd :synopsis: Build line-oriented command interpreters. + .. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com> **Source code:** :source:`Lib/cmd.py` diff --git a/Doc/library/code.rst b/Doc/library/code.rst index 275201c69b..443af699f2 100644 --- a/Doc/library/code.rst +++ b/Doc/library/code.rst @@ -6,6 +6,8 @@ **Source code:** :source:`Lib/code.py` +-------------- + The ``code`` module provides facilities to implement read-eval-print loops in Python. Two classes and convenience functions are included which can be used to build applications which provide an interactive interpreter prompt. diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index a2530deff2..1add30072f 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -3,6 +3,7 @@ .. module:: codecs :synopsis: Encode and decode data and streams. + .. moduleauthor:: Marc-André Lemburg <mal@lemburg.com> .. sectionauthor:: Marc-André Lemburg <mal@lemburg.com> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> @@ -17,6 +18,8 @@ single: streams pair: stackable; streams +-------------- + This module defines base classes for standard Python codecs (encoders and decoders) and provides access to the internal Python codec registry, which manages the codec and error handling lookup process. Most standard codecs diff --git a/Doc/library/codeop.rst b/Doc/library/codeop.rst index 9ae4176485..a52d2c62c4 100644 --- a/Doc/library/codeop.rst +++ b/Doc/library/codeop.rst @@ -3,9 +3,14 @@ .. module:: codeop :synopsis: Compile (possibly incomplete) Python code. + .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Michael Hudson <mwh@python.net> +**Source code:** :source:`Lib/codeop.py` + +-------------- + The :mod:`codeop` module provides utilities upon which the Python read-eval-print loop can be emulated, as is done in the :mod:`code` module. As a result, you probably don't want to use the module directly; if you want to diff --git a/Doc/library/collections.abc.rst b/Doc/library/collections.abc.rst index e76ca78340..61682ccd37 100644 --- a/Doc/library/collections.abc.rst +++ b/Doc/library/collections.abc.rst @@ -3,20 +3,21 @@ .. module:: collections.abc :synopsis: Abstract base classes for containers + .. moduleauthor:: Raymond Hettinger <python at rcn.com> .. sectionauthor:: Raymond Hettinger <python at rcn.com> .. versionadded:: 3.3 Formerly, this module was part of the :mod:`collections` module. +**Source code:** :source:`Lib/_collections_abc.py` + .. testsetup:: * from collections import * import itertools __name__ = '<doctest>' -**Source code:** :source:`Lib/_collections_abc.py` - -------------- This module provides :term:`abstract base classes <abstract base class>` that diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst index b8f0621d1a..4936b3a0f8 100644 --- a/Doc/library/collections.rst +++ b/Doc/library/collections.rst @@ -3,17 +3,18 @@ .. module:: collections :synopsis: Container datatypes + .. moduleauthor:: Raymond Hettinger <python@rcn.com> .. sectionauthor:: Raymond Hettinger <python@rcn.com> +**Source code:** :source:`Lib/collections/__init__.py` + .. testsetup:: * from collections import * import itertools __name__ = '<doctest>' -**Source code:** :source:`Lib/collections/__init__.py` - -------------- This module implements specialized container datatypes providing alternatives to diff --git a/Doc/library/colorsys.rst b/Doc/library/colorsys.rst index f1447e83b0..c33f531cc1 100644 --- a/Doc/library/colorsys.rst +++ b/Doc/library/colorsys.rst @@ -3,6 +3,7 @@ .. module:: colorsys :synopsis: Conversion functions between RGB and other color systems. + .. sectionauthor:: David Ascher <da@python.net> **Source code:** :source:`Lib/colorsys.py` diff --git a/Doc/library/compileall.rst b/Doc/library/compileall.rst index c5736f2043..511c581ad0 100644 --- a/Doc/library/compileall.rst +++ b/Doc/library/compileall.rst @@ -8,7 +8,6 @@ -------------- - This module provides some utility functions to support installing Python libraries. These functions compile Python source files in a directory tree. This module can be used to create the cached byte-code files at library diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst index c5dc8d7d90..eeae96aab9 100644 --- a/Doc/library/configparser.rst +++ b/Doc/library/configparser.rst @@ -19,6 +19,8 @@ single: ini file single: Windows ini file +-------------- + This module provides the :class:`ConfigParser` class which implements a basic configuration language which provides a structure similar to what's found in Microsoft Windows INI files. You can use this to write Python programs which diff --git a/Doc/library/copy.rst b/Doc/library/copy.rst index 02ef0e5ee7..a8adcadbe0 100644 --- a/Doc/library/copy.rst +++ b/Doc/library/copy.rst @@ -4,6 +4,10 @@ .. module:: copy :synopsis: Shallow and deep copy operations. +**Source code:** :source:`Lib/copy.py` + +-------------- + Assignment statements in Python do not copy objects, they create bindings between a target and an object. For collections that are mutable or contain mutable items, a copy is sometimes needed so one can change one copy without diff --git a/Doc/library/copyreg.rst b/Doc/library/copyreg.rst index 18306c7f99..eeabb4c658 100644 --- a/Doc/library/copyreg.rst +++ b/Doc/library/copyreg.rst @@ -4,11 +4,14 @@ .. module:: copyreg :synopsis: Register pickle support functions. +**Source code:** :source:`Lib/copyreg.py` .. index:: module: pickle module: copy +-------------- + The :mod:`copyreg` module offers a way to define functions used while pickling specific objects. The :mod:`pickle` and :mod:`copy` modules use those functions when pickling/copying those objects. The module provides configuration diff --git a/Doc/library/crypt.rst b/Doc/library/crypt.rst index 0661426f71..a21c1e7a75 100644 --- a/Doc/library/crypt.rst +++ b/Doc/library/crypt.rst @@ -4,15 +4,19 @@ .. module:: crypt :platform: Unix :synopsis: The crypt() function used to check Unix passwords. + .. moduleauthor:: Steven D. Majewski <sdm7g@virginia.edu> .. sectionauthor:: Steven D. Majewski <sdm7g@virginia.edu> .. sectionauthor:: Peter Funk <pf@artcom-gmbh.de> +**Source code:** :source:`Lib/crypt.py` .. index:: single: crypt(3) pair: cipher; DES +-------------- + This module implements an interface to the :manpage:`crypt(3)` routine, which is a one-way hash function based upon a modified DES algorithm; see the Unix man page for further details. Possible uses include storing hashed passwords diff --git a/Doc/library/csv.rst b/Doc/library/csv.rst index 4fcfaef258..7fb4fc8256 100644 --- a/Doc/library/csv.rst +++ b/Doc/library/csv.rst @@ -3,6 +3,7 @@ .. module:: csv :synopsis: Write and read tabular data to and from delimited files. + .. sectionauthor:: Skip Montanaro <skip@pobox.com> **Source code:** :source:`Lib/csv.py` @@ -11,6 +12,8 @@ single: csv pair: data; tabular +-------------- + The so-called CSV (Comma Separated Values) format is the most common import and export format for spreadsheets and databases. CSV format was used for many years prior to attempts to describe the format in a standardized way in diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst index 508ffc3b4a..a675790737 100644 --- a/Doc/library/ctypes.rst +++ b/Doc/library/ctypes.rst @@ -3,8 +3,10 @@ .. module:: ctypes :synopsis: A foreign function library for Python. + .. moduleauthor:: Thomas Heller <theller@python.net> +-------------- :mod:`ctypes` is a foreign function library for Python. It provides C compatible data types, and allows calling functions in DLLs or shared libraries. It can be diff --git a/Doc/library/curses.ascii.rst b/Doc/library/curses.ascii.rst index 6bc1fb9ae3..f3661d9bc5 100644 --- a/Doc/library/curses.ascii.rst +++ b/Doc/library/curses.ascii.rst @@ -3,9 +3,11 @@ .. module:: curses.ascii :synopsis: Constants and set-membership functions for ASCII characters. + .. moduleauthor:: Eric S. Raymond <esr@thyrsus.com> .. sectionauthor:: Eric S. Raymond <esr@thyrsus.com> +-------------- The :mod:`curses.ascii` module supplies name constants for ASCII characters and functions to test membership in various ASCII character classes. The constants diff --git a/Doc/library/curses.panel.rst b/Doc/library/curses.panel.rst index a3c8bda63c..c99c37a565 100644 --- a/Doc/library/curses.panel.rst +++ b/Doc/library/curses.panel.rst @@ -3,8 +3,10 @@ .. module:: curses.panel :synopsis: A panel stack extension that adds depth to curses windows. + .. sectionauthor:: A.M. Kuchling <amk@amk.ca> +-------------- Panels are windows with the added feature of depth, so they can be stacked on top of each other, and only the visible portions of each window will be diff --git a/Doc/library/curses.rst b/Doc/library/curses.rst index 144f7f8c7f..b12a325f37 100644 --- a/Doc/library/curses.rst +++ b/Doc/library/curses.rst @@ -5,9 +5,12 @@ :synopsis: An interface to the curses library, providing portable terminal handling. :platform: Unix + .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Eric Raymond <esr@thyrsus.com> +-------------- + The :mod:`curses` module provides an interface to the curses library, the de-facto standard for portable advanced terminal handling. diff --git a/Doc/library/datetime.rst b/Doc/library/datetime.rst index 3c6081902d..9254ae8cfa 100644 --- a/Doc/library/datetime.rst +++ b/Doc/library/datetime.rst @@ -3,12 +3,15 @@ .. module:: datetime :synopsis: Basic date and time types. + .. moduleauthor:: Tim Peters <tim@zope.com> .. sectionauthor:: Tim Peters <tim@zope.com> .. sectionauthor:: A.M. Kuchling <amk@amk.ca> **Source code:** :source:`Lib/datetime.py` +-------------- + .. XXX what order should the types be discussed in? The :mod:`datetime` module supplies classes for manipulating dates and times in diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst index 5df9eab904..6f64196a8a 100644 --- a/Doc/library/dbm.rst +++ b/Doc/library/dbm.rst @@ -4,6 +4,10 @@ .. module:: dbm :synopsis: Interfaces to various Unix "database" formats. +**Source code:** :source:`Lib/dbm/__init__.py` + +-------------- + :mod:`dbm` is a generic interface to variants of the DBM database --- :mod:`dbm.gnu` or :mod:`dbm.ndbm`. If none of these modules is installed, the slow-but-simple implementation in module :mod:`dbm.dumb` will be used. There diff --git a/Doc/library/decimal.rst b/Doc/library/decimal.rst index d46f850fd7..528f97b1ab 100644 --- a/Doc/library/decimal.rst +++ b/Doc/library/decimal.rst @@ -23,6 +23,8 @@ # make sure each group gets a fresh context setcontext(Context()) +-------------- + The :mod:`decimal` module provides support for fast correctly-rounded decimal floating point arithmetic. It offers several advantages over the :class:`float` datatype: diff --git a/Doc/library/difflib.rst b/Doc/library/difflib.rst index f161e2f5e0..59a6478d8d 100644 --- a/Doc/library/difflib.rst +++ b/Doc/library/difflib.rst @@ -3,6 +3,7 @@ .. module:: difflib :synopsis: Helpers for computing differences between objects. + .. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net> .. sectionauthor:: Tim Peters <tim_one@users.sourceforge.net> .. Markup by Fred L. Drake, Jr. <fdrake@acm.org> @@ -14,6 +15,8 @@ import sys from difflib import * +-------------- + This module provides classes and functions for comparing sequences. It can be used for example, for comparing files, and can produce difference information in various formats, including HTML and context and unified diff --git a/Doc/library/distutils.rst b/Doc/library/distutils.rst index 12ad8c0b7b..62abc85ac3 100644 --- a/Doc/library/distutils.rst +++ b/Doc/library/distutils.rst @@ -4,8 +4,10 @@ .. module:: distutils :synopsis: Support for building and installing Python modules into an existing Python installation. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> +-------------- The :mod:`distutils` package provides support for building and installing additional modules into a Python installation. The new modules may be either diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst index 9f7d12c626..c58f417c31 100644 --- a/Doc/library/doctest.rst +++ b/Doc/library/doctest.rst @@ -5,11 +5,15 @@ .. module:: doctest :synopsis: Test pieces of code within docstrings. + .. moduleauthor:: Tim Peters <tim@python.org> .. sectionauthor:: Tim Peters <tim@python.org> .. sectionauthor:: Moshe Zadka <moshez@debian.org> .. sectionauthor:: Edward Loper <edloper@users.sourceforge.net> +**Source code:** :source:`Lib/doctest.py` + +-------------- The :mod:`doctest` module searches for pieces of text that look like interactive Python sessions, and then executes those sessions to verify that they work diff --git a/Doc/library/email.charset.rst b/Doc/library/email.charset.rst index c0fab8f057..161d86a3b7 100644 --- a/Doc/library/email.charset.rst +++ b/Doc/library/email.charset.rst @@ -4,6 +4,9 @@ .. module:: email.charset :synopsis: Character Sets +**Source code:** :source:`Lib/email/charset.py` + +-------------- This module provides a class :class:`Charset` for representing character sets and character set conversions in email messages, as well as a character set diff --git a/Doc/library/email.contentmanager.rst b/Doc/library/email.contentmanager.rst index f53d34b34c..cd63728372 100644 --- a/Doc/library/email.contentmanager.rst +++ b/Doc/library/email.contentmanager.rst @@ -7,6 +7,10 @@ .. moduleauthor:: R. David Murray <rdmurray@bitdance.com> .. sectionauthor:: R. David Murray <rdmurray@bitdance.com> +.. versionadded:: 3.4 + as a :term:`provisional module <provisional package>`. + +**Source code:** :source:`Lib/email/contentmanager.py` .. note:: @@ -15,8 +19,7 @@ changes (up to and including removal of the module) may occur if deemed necessary by the core developers. -.. versionadded:: 3.4 - as a :term:`provisional module <provisional package>`. +-------------- The :mod:`~email.message` module provides a class that can represent an arbitrary email message. That basic message model has a useful and flexible diff --git a/Doc/library/email.encoders.rst b/Doc/library/email.encoders.rst index 916ba5d18a..9d7f9bf5e9 100644 --- a/Doc/library/email.encoders.rst +++ b/Doc/library/email.encoders.rst @@ -4,6 +4,9 @@ .. module:: email.encoders :synopsis: Encoders for email message payloads. +**Source code:** :source:`Lib/email/encoders.py` + +-------------- When creating :class:`~email.message.Message` objects from scratch, you often need to encode the payloads for transport through compliant mail servers. This diff --git a/Doc/library/email.errors.rst b/Doc/library/email.errors.rst index 294e3edbdc..8470783e81 100644 --- a/Doc/library/email.errors.rst +++ b/Doc/library/email.errors.rst @@ -4,6 +4,9 @@ .. module:: email.errors :synopsis: The exception classes used by the email package. +**Source code:** :source:`Lib/email/errors.py` + +-------------- The following exception classes are defined in the :mod:`email.errors` module: diff --git a/Doc/library/email.generator.rst b/Doc/library/email.generator.rst index 3ed6e3b195..d596ed8d85 100644 --- a/Doc/library/email.generator.rst +++ b/Doc/library/email.generator.rst @@ -4,6 +4,9 @@ .. module:: email.generator :synopsis: Generate flat text email messages from a message structure. +**Source code:** :source:`Lib/email/generator.py` + +-------------- One of the most common tasks is to generate the flat text of the email message represented by a message object structure. You will need to do this if you want diff --git a/Doc/library/email.header.rst b/Doc/library/email.header.rst index 346d23fc8c..e94837c1c9 100644 --- a/Doc/library/email.header.rst +++ b/Doc/library/email.header.rst @@ -4,6 +4,9 @@ .. module:: email.header :synopsis: Representing non-ASCII headers +**Source code:** :source:`Lib/email/header.py` + +-------------- :rfc:`2822` is the base standard that describes the format of email messages. It derives from the older :rfc:`822` standard which came into widespread use at diff --git a/Doc/library/email.headerregistry.rst b/Doc/library/email.headerregistry.rst index 4af083f885..0707bd858a 100644 --- a/Doc/library/email.headerregistry.rst +++ b/Doc/library/email.headerregistry.rst @@ -7,6 +7,10 @@ .. moduleauthor:: R. David Murray <rdmurray@bitdance.com> .. sectionauthor:: R. David Murray <rdmurray@bitdance.com> +.. versionadded:: 3.3 + as a :term:`provisional module <provisional package>`. + +**Source code:** :source:`Lib/email/headerregistry.py` .. note:: @@ -15,8 +19,7 @@ changes (up to and including removal of the module) may occur if deemed necessary by the core developers. -.. versionadded:: 3.3 - as a :term:`provisional module <provisional package>`. +-------------- Headers are represented by customized subclasses of :class:`str`. The particular class used to represent a given header is determined by the diff --git a/Doc/library/email.iterators.rst b/Doc/library/email.iterators.rst index f92f460249..f3e9e184a5 100644 --- a/Doc/library/email.iterators.rst +++ b/Doc/library/email.iterators.rst @@ -4,6 +4,9 @@ .. module:: email.iterators :synopsis: Iterate over a message object tree. +**Source code:** :source:`Lib/email/iterators.py` + +-------------- Iterating over a message object tree is fairly easy with the :meth:`Message.walk <email.message.Message.walk>` method. The diff --git a/Doc/library/email.message.rst b/Doc/library/email.message.rst index b91f26d120..91a694f3ec 100644 --- a/Doc/library/email.message.rst +++ b/Doc/library/email.message.rst @@ -4,6 +4,9 @@ .. module:: email.message :synopsis: The base class representing email messages. +**Source code:** :source:`Lib/email/message.py` + +-------------- The central class in the :mod:`email` package is the :class:`Message` class, imported from the :mod:`email.message` module. It is the base class for the diff --git a/Doc/library/email.mime.rst b/Doc/library/email.mime.rst index 67d0a67954..8297deaf93 100644 --- a/Doc/library/email.mime.rst +++ b/Doc/library/email.mime.rst @@ -4,6 +4,9 @@ .. module:: email.mime :synopsis: Build MIME messages. +**Source code:** :source:`Lib/email/mime/` + +-------------- Ordinarily, you get a message object structure by passing a file or some text to a parser, which parses the text and returns the root message object. However diff --git a/Doc/library/email.parser.rst b/Doc/library/email.parser.rst index 177adc62e7..93c09ad960 100644 --- a/Doc/library/email.parser.rst +++ b/Doc/library/email.parser.rst @@ -4,6 +4,9 @@ .. module:: email.parser :synopsis: Parse flat text email messages to produce a message object structure. +**Source code:** :source:`Lib/email/parser.py` + +-------------- Message object structures can be created in one of two ways: they can be created from whole cloth by instantiating :class:`~email.message.Message` objects and diff --git a/Doc/library/email.policy.rst b/Doc/library/email.policy.rst index 045b119303..47f321227a 100644 --- a/Doc/library/email.policy.rst +++ b/Doc/library/email.policy.rst @@ -9,6 +9,9 @@ .. versionadded:: 3.3 +**Source code:** :source:`Lib/email/policy.py` + +-------------- The :mod:`email` package's prime focus is the handling of email messages as described by the various email and MIME RFCs. However, the general format of diff --git a/Doc/library/email.rst b/Doc/library/email.rst index 95c0a2f4a8..e8bb02bff5 100644 --- a/Doc/library/email.rst +++ b/Doc/library/email.rst @@ -4,10 +4,14 @@ .. module:: email :synopsis: Package supporting the parsing, manipulating, and generating email messages, including MIME documents. + .. moduleauthor:: Barry A. Warsaw <barry@python.org> .. sectionauthor:: Barry A. Warsaw <barry@python.org> .. Copyright (C) 2001-2010 Python Software Foundation +**Source code:** :source:`Lib/email/__init__.py` + +-------------- The :mod:`email` package is a library for managing email messages, including MIME and other :rfc:`2822`\ -based message documents. It is specifically *not* diff --git a/Doc/library/email.util.rst b/Doc/library/email.util.rst index 219e2847ea..5cff7465df 100644 --- a/Doc/library/email.util.rst +++ b/Doc/library/email.util.rst @@ -4,6 +4,9 @@ .. module:: email.utils :synopsis: Miscellaneous email package utilities. +**Source code:** :source:`Lib/email/utils.py` + +-------------- There are several useful utilities provided in the :mod:`email.utils` module: diff --git a/Doc/library/ensurepip.rst b/Doc/library/ensurepip.rst index d589f1cf12..6aeeabc306 100644 --- a/Doc/library/ensurepip.rst +++ b/Doc/library/ensurepip.rst @@ -7,6 +7,8 @@ .. versionadded:: 3.4 +-------------- + The :mod:`ensurepip` package provides support for bootstrapping the ``pip`` installer into an existing Python installation or virtual environment. This bootstrapping approach reflects the fact that ``pip`` is an independent diff --git a/Doc/library/errno.rst b/Doc/library/errno.rst index 22a5cbc450..1cbd51c582 100644 --- a/Doc/library/errno.rst +++ b/Doc/library/errno.rst @@ -4,6 +4,7 @@ .. module:: errno :synopsis: Standard errno system symbols. +---------------- This module makes available standard ``errno`` system symbols. The value of each symbol is the corresponding integer value. The names and descriptions are diff --git a/Doc/library/faulthandler.rst b/Doc/library/faulthandler.rst index 3a5badd0ff..deedea1f26 100644 --- a/Doc/library/faulthandler.rst +++ b/Doc/library/faulthandler.rst @@ -6,6 +6,8 @@ .. versionadded:: 3.3 +---------------- + This module contains functions to dump Python tracebacks explicitly, on a fault, after a timeout, or on a user signal. Call :func:`faulthandler.enable` to install fault handlers for the :const:`SIGSEGV`, :const:`SIGFPE`, diff --git a/Doc/library/fcntl.rst b/Doc/library/fcntl.rst index 508c4a5342..88112f6b7e 100644 --- a/Doc/library/fcntl.rst +++ b/Doc/library/fcntl.rst @@ -4,13 +4,15 @@ .. module:: fcntl :platform: Unix :synopsis: The fcntl() and ioctl() system calls. -.. sectionauthor:: Jaap Vermeulen +.. sectionauthor:: Jaap Vermeulen .. index:: pair: UNIX; file control pair: UNIX; I/O control +---------------- + This module performs file control and I/O control on file descriptors. It is an interface to the :c:func:`fcntl` and :c:func:`ioctl` Unix routines. For a complete description of these calls, see :manpage:`fcntl(2)` and diff --git a/Doc/library/filecmp.rst b/Doc/library/filecmp.rst index 06d3f21300..31b9b4afab 100644 --- a/Doc/library/filecmp.rst +++ b/Doc/library/filecmp.rst @@ -3,6 +3,7 @@ .. module:: filecmp :synopsis: Compare files efficiently. + .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> **Source code:** :source:`Lib/filecmp.py` diff --git a/Doc/library/fileinput.rst b/Doc/library/fileinput.rst index a55bbe324f..aa4c529b2a 100644 --- a/Doc/library/fileinput.rst +++ b/Doc/library/fileinput.rst @@ -3,6 +3,7 @@ .. module:: fileinput :synopsis: Loop over standard input or a list of files. + .. moduleauthor:: Guido van Rossum <guido@python.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> diff --git a/Doc/library/fnmatch.rst b/Doc/library/fnmatch.rst index 68b437f2c0..85ac484965 100644 --- a/Doc/library/fnmatch.rst +++ b/Doc/library/fnmatch.rst @@ -4,13 +4,12 @@ .. module:: fnmatch :synopsis: Unix shell style filename pattern matching. +**Source code:** :source:`Lib/fnmatch.py` .. index:: single: filenames; wildcard expansion .. index:: module: re -**Source code:** :source:`Lib/fnmatch.py` - -------------- This module provides support for Unix shell-style wildcards, which are *not* the diff --git a/Doc/library/formatter.rst b/Doc/library/formatter.rst index 8e8e201ae1..6c10ac6fab 100644 --- a/Doc/library/formatter.rst +++ b/Doc/library/formatter.rst @@ -8,6 +8,7 @@ .. deprecated:: 3.4 Due to lack of usage, the formatter module has been deprecated. +-------------- This module supports two interface definitions, each with multiple implementations: The *formatter* interface, and the *writer* interface which is diff --git a/Doc/library/fpectl.rst b/Doc/library/fpectl.rst index fb15f69445..e4b528cf0b 100644 --- a/Doc/library/fpectl.rst +++ b/Doc/library/fpectl.rst @@ -4,10 +4,10 @@ .. module:: fpectl :platform: Unix :synopsis: Provide control for floating point exception handling. + .. moduleauthor:: Lee Busby <busby1@llnl.gov> .. sectionauthor:: Lee Busby <busby1@llnl.gov> - .. note:: The :mod:`fpectl` module is not built by default, and its usage is discouraged @@ -16,6 +16,8 @@ .. index:: single: IEEE-754 +-------------- + Most computers carry out floating point operations in conformance with the so-called IEEE-754 standard. On any real computer, some floating point operations produce results that cannot be expressed as a normal floating point diff --git a/Doc/library/fractions.rst b/Doc/library/fractions.rst index d24f80ac4b..b5a818e1ca 100644 --- a/Doc/library/fractions.rst +++ b/Doc/library/fractions.rst @@ -3,6 +3,7 @@ .. module:: fractions :synopsis: Rational numbers. + .. moduleauthor:: Jeffrey Yasskin <jyasskin at gmail.com> .. sectionauthor:: Jeffrey Yasskin <jyasskin at gmail.com> diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst index 242d236dcd..233e11fb5a 100644 --- a/Doc/library/ftplib.rst +++ b/Doc/library/ftplib.rst @@ -4,13 +4,12 @@ .. module:: ftplib :synopsis: FTP protocol client (requires sockets). +**Source code:** :source:`Lib/ftplib.py` .. index:: pair: FTP; protocol single: FTP; ftplib (standard module) -**Source code:** :source:`Lib/ftplib.py` - -------------- This module defines the class :class:`FTP` and a few related items. The diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst index f4d7fdf856..2dbcb5cc16 100644 --- a/Doc/library/functools.rst +++ b/Doc/library/functools.rst @@ -3,6 +3,7 @@ .. module:: functools :synopsis: Higher-order functions and operations on callable objects. + .. moduleauthor:: Peter Harris <scav@blueyonder.co.uk> .. moduleauthor:: Raymond Hettinger <python@rcn.com> .. moduleauthor:: Nick Coghlan <ncoghlan@gmail.com> diff --git a/Doc/library/gc.rst b/Doc/library/gc.rst index d11c2e1282..4af16a9dfd 100644 --- a/Doc/library/gc.rst +++ b/Doc/library/gc.rst @@ -3,9 +3,11 @@ .. module:: gc :synopsis: Interface to the cycle-detecting garbage collector. + .. moduleauthor:: Neil Schemenauer <nas@arctrix.com> .. sectionauthor:: Neil Schemenauer <nas@arctrix.com> +-------------- This module provides an interface to the optional garbage collector. It provides the ability to disable the collector, tune the collection frequency, diff --git a/Doc/library/getopt.rst b/Doc/library/getopt.rst index 832d458bde..336deab28c 100644 --- a/Doc/library/getopt.rst +++ b/Doc/library/getopt.rst @@ -7,8 +7,6 @@ **Source code:** :source:`Lib/getopt.py` --------------- - .. note:: The :mod:`getopt` module is a parser for command line options whose API is @@ -17,6 +15,8 @@ less code and get better help and error messages should consider using the :mod:`argparse` module instead. +-------------- + This module helps scripts to parse the command line arguments in ``sys.argv``. It supports the same conventions as the Unix :c:func:`getopt` function (including the special meanings of arguments of the form '``-``' and '``--``'). Long diff --git a/Doc/library/getpass.rst b/Doc/library/getpass.rst index 94cf95f1af..5eb9f04a8d 100644 --- a/Doc/library/getpass.rst +++ b/Doc/library/getpass.rst @@ -3,10 +3,15 @@ .. module:: getpass :synopsis: Portable reading of passwords and retrieval of the userid. + .. moduleauthor:: Piers Lauder <piers@cs.su.oz.au> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. Windows (& Mac?) support by Guido van Rossum. +**Source code:** :source:`Lib/getpass.py` + +-------------- + The :mod:`getpass` module provides two functions: diff --git a/Doc/library/gettext.rst b/Doc/library/gettext.rst index 514cc5a989..ea439b527f 100644 --- a/Doc/library/gettext.rst +++ b/Doc/library/gettext.rst @@ -3,6 +3,7 @@ .. module:: gettext :synopsis: Multilingual internationalization services. + .. moduleauthor:: Barry A. Warsaw <barry@python.org> .. sectionauthor:: Barry A. Warsaw <barry@python.org> diff --git a/Doc/library/glob.rst b/Doc/library/glob.rst index 4c01bf6f1e..328eef30f1 100644 --- a/Doc/library/glob.rst +++ b/Doc/library/glob.rst @@ -4,11 +4,10 @@ .. module:: glob :synopsis: Unix shell style pathname pattern expansion. +**Source code:** :source:`Lib/glob.py` .. index:: single: filenames; pathname expansion -**Source code:** :source:`Lib/glob.py` - -------------- The :mod:`glob` module finds all the pathnames matching a specified pattern diff --git a/Doc/library/grp.rst b/Doc/library/grp.rst index 88821406a3..a30e6229db 100644 --- a/Doc/library/grp.rst +++ b/Doc/library/grp.rst @@ -5,6 +5,7 @@ :platform: Unix :synopsis: The group database (getgrnam() and friends). +-------------- This module provides access to the Unix group database. It is available on all Unix versions. diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst index 900764b47f..30be3354af 100644 --- a/Doc/library/hashlib.rst +++ b/Doc/library/hashlib.rst @@ -3,16 +3,16 @@ .. module:: hashlib :synopsis: Secure hash and message digest algorithms. + .. moduleauthor:: Gregory P. Smith <greg@krypto.org> .. sectionauthor:: Gregory P. Smith <greg@krypto.org> +**Source code:** :source:`Lib/hashlib.py` .. index:: single: message digest, MD5 single: secure hash algorithm, SHA1, SHA224, SHA256, SHA384, SHA512 -**Source code:** :source:`Lib/hashlib.py` - -------------- This module implements a common interface to many different secure hash and diff --git a/Doc/library/heapq.rst b/Doc/library/heapq.rst index 45720bfaac..7e33e74814 100644 --- a/Doc/library/heapq.rst +++ b/Doc/library/heapq.rst @@ -3,6 +3,7 @@ .. module:: heapq :synopsis: Heap queue algorithm (a.k.a. priority queue). + .. moduleauthor:: Kevin O'Connor .. sectionauthor:: Guido van Rossum <guido@python.org> .. sectionauthor:: François Pinard diff --git a/Doc/library/hmac.rst b/Doc/library/hmac.rst index 1446da6ee6..bb44866879 100644 --- a/Doc/library/hmac.rst +++ b/Doc/library/hmac.rst @@ -3,6 +3,7 @@ .. module:: hmac :synopsis: Keyed-Hashing for Message Authentication (HMAC) implementation + .. moduleauthor:: Gerhard Häring <ghaering@users.sourceforge.net> .. sectionauthor:: Gerhard Häring <ghaering@users.sourceforge.net> diff --git a/Doc/library/html.entities.rst b/Doc/library/html.entities.rst index 7e29280d2a..067e1b1e5a 100644 --- a/Doc/library/html.entities.rst +++ b/Doc/library/html.entities.rst @@ -3,6 +3,7 @@ .. module:: html.entities :synopsis: Definitions of HTML general entities. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> **Source code:** :source:`Lib/html/entities.py` diff --git a/Doc/library/html.parser.rst b/Doc/library/html.parser.rst index 2f93c0b7be..16abb40621 100644 --- a/Doc/library/html.parser.rst +++ b/Doc/library/html.parser.rst @@ -4,13 +4,12 @@ .. module:: html.parser :synopsis: A simple parser that can handle HTML and XHTML. +**Source code:** :source:`Lib/html/parser.py` .. index:: single: HTML single: XHTML -**Source code:** :source:`Lib/html/parser.py` - -------------- This module defines a class :class:`HTMLParser` which serves as the basis for diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst index 5a6a4a73fb..8954648976 100644 --- a/Doc/library/http.client.rst +++ b/Doc/library/http.client.rst @@ -4,6 +4,7 @@ .. module:: http.client :synopsis: HTTP and HTTPS protocol client (requires sockets). +**Source code:** :source:`Lib/http/client.py` .. index:: pair: HTTP; protocol @@ -11,8 +12,6 @@ .. index:: module: urllib.request -**Source code:** :source:`Lib/http/client.py` - -------------- This module defines classes which implement the client side of the HTTP and diff --git a/Doc/library/http.cookiejar.rst b/Doc/library/http.cookiejar.rst index f2e1c691a0..5370601544 100644 --- a/Doc/library/http.cookiejar.rst +++ b/Doc/library/http.cookiejar.rst @@ -3,6 +3,7 @@ .. module:: http.cookiejar :synopsis: Classes for automatic handling of HTTP cookies. + .. moduleauthor:: John J. Lee <jjl@pobox.com> .. sectionauthor:: John J. Lee <jjl@pobox.com> diff --git a/Doc/library/http.cookies.rst b/Doc/library/http.cookies.rst index 56c52f8a8b..4b45d4bc38 100644 --- a/Doc/library/http.cookies.rst +++ b/Doc/library/http.cookies.rst @@ -3,6 +3,7 @@ .. module:: http.cookies :synopsis: Support for HTTP state management (cookies). + .. moduleauthor:: Timothy O'Malley <timo@alum.mit.edu> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> diff --git a/Doc/library/http.rst b/Doc/library/http.rst index 1fce9c98df..be661c5e8c 100644 --- a/Doc/library/http.rst +++ b/Doc/library/http.rst @@ -4,11 +4,13 @@ .. module:: http :synopsis: HTTP status codes and messages +**Source code:** :source:`Lib/http/__init__.py` + .. index:: pair: HTTP; protocol single: HTTP; http (standard module) -**Source code:** :source:`Lib/http/__init__.py` +-------------- :mod:`http` is a package that collects several modules for working with the HyperText Transfer Protocol: diff --git a/Doc/library/http.server.rst b/Doc/library/http.server.rst index 05ad2d7bab..16c4fac947 100644 --- a/Doc/library/http.server.rst +++ b/Doc/library/http.server.rst @@ -4,6 +4,7 @@ .. module:: http.server :synopsis: HTTP server and request handlers. +**Source code:** :source:`Lib/http/server.py` .. index:: pair: WWW; server @@ -11,8 +12,6 @@ single: URL single: httpd -**Source code:** :source:`Lib/http/server.py` - -------------- This module defines classes for implementing HTTP servers (Web servers). diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst index 2140e85f04..9ca92ceb55 100644 --- a/Doc/library/idle.rst +++ b/Doc/library/idle.rst @@ -3,12 +3,16 @@ IDLE ==== +.. moduleauthor:: Guido van Rossum <guido@python.org> + +**Source code:** :source:`Lib/idlelib/` + .. index:: single: IDLE single: Python Editor single: Integrated Development Environment -.. moduleauthor:: Guido van Rossum <guido@python.org> +-------------- IDLE is Python's Integrated Development and Learning Environment. diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst index dbd8e7747f..c25e7d8611 100644 --- a/Doc/library/imaplib.rst +++ b/Doc/library/imaplib.rst @@ -3,6 +3,7 @@ .. module:: imaplib :synopsis: IMAP4 protocol client (requires sockets). + .. moduleauthor:: Piers Lauder <piers@communitysolutions.com.au> .. sectionauthor:: Piers Lauder <piers@communitysolutions.com.au> .. revised by ESR, January 2000 @@ -10,14 +11,13 @@ .. changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>, November 2002 +**Source code:** :source:`Lib/imaplib.py` .. index:: pair: IMAP4; protocol pair: IMAP4_SSL; protocol pair: IMAP4_stream; protocol -**Source code:** :source:`Lib/imaplib.py` - -------------- This module defines three classes, :class:`IMAP4`, :class:`IMAP4_SSL` and diff --git a/Doc/library/imp.rst b/Doc/library/imp.rst index 68a6b681ef..9828ba6fe2 100644 --- a/Doc/library/imp.rst +++ b/Doc/library/imp.rst @@ -5,11 +5,15 @@ :synopsis: Access the implementation of the import statement. :deprecated: +**Source code:** :source:`Lib/imp.py` + .. deprecated:: 3.4 The :mod:`imp` package is pending deprecation in favor of :mod:`importlib`. .. index:: statement: import +-------------- + This module provides an interface to the mechanisms used to implement the :keyword:`import` statement. It defines the following constants and functions: diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst index 953e21b3a3..3302446b40 100644 --- a/Doc/library/importlib.rst +++ b/Doc/library/importlib.rst @@ -9,6 +9,9 @@ .. versionadded:: 3.1 +**Source code:** :source:`Lib/importlib/__init__.py` + +-------------- Introduction ------------ diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index ff628de1bd..b28d0f9885 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -3,6 +3,7 @@ .. module:: inspect :synopsis: Extract information and source code from live objects. + .. moduleauthor:: Ka-Ping Yee <ping@lfw.org> .. sectionauthor:: Ka-Ping Yee <ping@lfw.org> diff --git a/Doc/library/io.rst b/Doc/library/io.rst index 53d6f271e8..23df18f8e7 100644 --- a/Doc/library/io.rst +++ b/Doc/library/io.rst @@ -3,6 +3,7 @@ .. module:: io :synopsis: Core tools for working with streams. + .. moduleauthor:: Guido van Rossum <guido@python.org> .. moduleauthor:: Mike Verdone <mike.verdone@gmail.com> .. moduleauthor:: Mark Russell <mark.russell@zen.co.uk> @@ -11,6 +12,10 @@ .. moduleauthor:: Benjamin Peterson <benjamin@python.org> .. sectionauthor:: Benjamin Peterson <benjamin@python.org> +**Source code:** :source:`Lib/io.py` + +-------------- + .. _io-overview: Overview diff --git a/Doc/library/ipaddress.rst b/Doc/library/ipaddress.rst index f6bfcf9d51..23526b6c42 100644 --- a/Doc/library/ipaddress.rst +++ b/Doc/library/ipaddress.rst @@ -3,6 +3,7 @@ .. module:: ipaddress :synopsis: IPv4/IPv6 manipulation library. + .. moduleauthor:: Peter Moody **Source code:** :source:`Lib/ipaddress.py` diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst index c6e2544d3c..dfc1ddc2d7 100644 --- a/Doc/library/itertools.rst +++ b/Doc/library/itertools.rst @@ -3,14 +3,15 @@ .. module:: itertools :synopsis: Functions creating iterators for efficient looping. + .. moduleauthor:: Raymond Hettinger <python@rcn.com> .. sectionauthor:: Raymond Hettinger <python@rcn.com> - .. testsetup:: from itertools import * +-------------- This module implements a number of :term:`iterator` building blocks inspired by constructs from APL, Haskell, and SML. Each has been recast in a form diff --git a/Doc/library/json.rst b/Doc/library/json.rst index c41b4a35c6..174e734115 100644 --- a/Doc/library/json.rst +++ b/Doc/library/json.rst @@ -3,9 +3,14 @@ .. module:: json :synopsis: Encode and decode the JSON format. + .. moduleauthor:: Bob Ippolito <bob@redivi.com> .. sectionauthor:: Bob Ippolito <bob@redivi.com> +**Source code:** :source:`Lib/json/__init__.py` + +-------------- + `JSON (JavaScript Object Notation) <http://json.org>`_, specified by :rfc:`7159` (which obsoletes :rfc:`4627`) and by `ECMA-404 <http://www.ecma-international.org/publications/standards/Ecma-404.htm>`_, diff --git a/Doc/library/linecache.rst b/Doc/library/linecache.rst index 3f14885b06..ae3de9fc0a 100644 --- a/Doc/library/linecache.rst +++ b/Doc/library/linecache.rst @@ -3,6 +3,7 @@ .. module:: linecache :synopsis: This module provides random access to individual lines from text files. + .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> **Source code:** :source:`Lib/linecache.py` diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst index dd17d4f4b4..5aaf4a398f 100644 --- a/Doc/library/locale.rst +++ b/Doc/library/locale.rst @@ -3,9 +3,13 @@ .. module:: locale :synopsis: Internationalization services. + .. moduleauthor:: Martin von Löwis <martin@v.loewis.de> .. sectionauthor:: Martin von Löwis <martin@v.loewis.de> +**Source code:** :source:`Lib/locale.py` + +-------------- The :mod:`locale` module opens access to the POSIX locale database and functionality. The POSIX locale mechanism allows programmers to deal with diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst index fd6a47778f..e196724b82 100644 --- a/Doc/library/logging.config.rst +++ b/Doc/library/logging.config.rst @@ -4,10 +4,11 @@ .. module:: logging.config :synopsis: Configuration of the logging module. - .. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com> +**Source code:** :source:`Lib/logging/config.py` + .. sidebar:: Important This page contains only reference information. For tutorials, @@ -17,8 +18,6 @@ * :ref:`Advanced Tutorial <logging-advanced-tutorial>` * :ref:`Logging Cookbook <logging-cookbook>` -**Source code:** :source:`Lib/logging/config.py` - -------------- This section describes the API for configuring the logging module. diff --git a/Doc/library/logging.handlers.rst b/Doc/library/logging.handlers.rst index 5936e12e07..855adabf86 100644 --- a/Doc/library/logging.handlers.rst +++ b/Doc/library/logging.handlers.rst @@ -4,10 +4,11 @@ .. module:: logging.handlers :synopsis: Handlers for the logging module. - .. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com> +**Source code:** :source:`Lib/logging/handlers.py` + .. sidebar:: Important This page contains only reference information. For tutorials, @@ -17,8 +18,6 @@ * :ref:`Advanced Tutorial <logging-advanced-tutorial>` * :ref:`Logging Cookbook <logging-cookbook>` -**Source code:** :source:`Lib/logging/handlers.py` - -------------- .. currentmodule:: logging diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst index 8c834f0ed2..72da385d72 100644 --- a/Doc/library/logging.rst +++ b/Doc/library/logging.rst @@ -4,10 +4,10 @@ .. module:: logging :synopsis: Flexible event logging system for applications. - .. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com> +**Source code:** :source:`Lib/logging/__init__.py` .. index:: pair: Errors; logging @@ -20,9 +20,6 @@ * :ref:`Advanced Tutorial <logging-advanced-tutorial>` * :ref:`Logging Cookbook <logging-cookbook>` - -**Source code:** :source:`Lib/logging/__init__.py` - -------------- This module defines functions and classes which implement a flexible event diff --git a/Doc/library/lzma.rst b/Doc/library/lzma.rst index 054600530b..f99c495ce9 100644 --- a/Doc/library/lzma.rst +++ b/Doc/library/lzma.rst @@ -3,11 +3,15 @@ .. module:: lzma :synopsis: A Python wrapper for the liblzma compression library. + .. moduleauthor:: Nadeem Vawda <nadeem.vawda@gmail.com> .. sectionauthor:: Nadeem Vawda <nadeem.vawda@gmail.com> .. versionadded:: 3.3 +**Source code:** :source:`Lib/lzma.py` + +-------------- This module provides classes and convenience functions for compressing and decompressing data using the LZMA compression algorithm. Also included is a file diff --git a/Doc/library/macpath.rst b/Doc/library/macpath.rst index b7a5d89239..b08bbe0809 100644 --- a/Doc/library/macpath.rst +++ b/Doc/library/macpath.rst @@ -4,6 +4,9 @@ .. module:: macpath :synopsis: Mac OS 9 path manipulation functions. +**Source code:** :source:`Lib/macpath.py` + +-------------- This module is the Mac OS 9 (and earlier) implementation of the :mod:`os.path` module. It can be used to manipulate old-style Macintosh pathnames on Mac OS X diff --git a/Doc/library/mailbox.rst b/Doc/library/mailbox.rst index 1082bf9687..81244c2ed0 100644 --- a/Doc/library/mailbox.rst +++ b/Doc/library/mailbox.rst @@ -3,9 +3,13 @@ .. module:: mailbox :synopsis: Manipulate mailboxes in various formats + .. moduleauthor:: Gregory K. Johnson <gkj@gregorykjohnson.com> .. sectionauthor:: Gregory K. Johnson <gkj@gregorykjohnson.com> +**Source code:** :source:`Lib/mailbox.py` + +-------------- This module defines two classes, :class:`Mailbox` and :class:`Message`, for accessing and manipulating on-disk mailboxes and the messages they contain. diff --git a/Doc/library/marshal.rst b/Doc/library/marshal.rst index 8bf0e0322a..1ffc6effc7 100644 --- a/Doc/library/marshal.rst +++ b/Doc/library/marshal.rst @@ -5,6 +5,7 @@ :synopsis: Convert Python objects to streams of bytes and back (with different constraints). +-------------- This module contains functions that can read and write Python values in a binary format. The format is specific to Python, but independent of machine diff --git a/Doc/library/math.rst b/Doc/library/math.rst index 80e65bbb51..3fdea18cfd 100644 --- a/Doc/library/math.rst +++ b/Doc/library/math.rst @@ -8,6 +8,8 @@ from math import fsum +-------------- + This module is always available. It provides access to the mathematical functions defined by the C standard. diff --git a/Doc/library/mimetypes.rst b/Doc/library/mimetypes.rst index 9e91b8a459..464248c3ea 100644 --- a/Doc/library/mimetypes.rst +++ b/Doc/library/mimetypes.rst @@ -3,13 +3,13 @@ .. module:: mimetypes :synopsis: Mapping of filename extensions to MIME types. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> +**Source code:** :source:`Lib/mimetypes.py` .. index:: pair: MIME; content type -**Source code:** :source:`Lib/mimetypes.py` - -------------- The :mod:`mimetypes` module converts between a filename or URL and the MIME type diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst index ce807e43eb..8f538339aa 100644 --- a/Doc/library/mmap.rst +++ b/Doc/library/mmap.rst @@ -4,6 +4,7 @@ .. module:: mmap :synopsis: Interface to memory-mapped files for Unix and Windows. +-------------- Memory-mapped file objects behave like both :class:`bytearray` and like :term:`file objects <file object>`. You can use mmap objects in most places diff --git a/Doc/library/modulefinder.rst b/Doc/library/modulefinder.rst index e84a4964a0..7b39ce7d1a 100644 --- a/Doc/library/modulefinder.rst +++ b/Doc/library/modulefinder.rst @@ -1,12 +1,11 @@ :mod:`modulefinder` --- Find modules used by a script ===================================================== -.. sectionauthor:: A.M. Kuchling <amk@amk.ca> - - .. module:: modulefinder :synopsis: Find modules used by a script. +.. sectionauthor:: A.M. Kuchling <amk@amk.ca> + **Source code:** :source:`Lib/modulefinder.py` -------------- diff --git a/Doc/library/msilib.rst b/Doc/library/msilib.rst index 15768e1aed..0a42032974 100644 --- a/Doc/library/msilib.rst +++ b/Doc/library/msilib.rst @@ -4,12 +4,16 @@ .. module:: msilib :platform: Windows :synopsis: Creation of Microsoft Installer files, and CAB files. + .. moduleauthor:: Martin v. Löwis <martin@v.loewis.de> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> +**Source code:** :source:`Lib/msilib/__init__.py` .. index:: single: msi +-------------- + The :mod:`msilib` supports the creation of Microsoft Installer (``.msi``) files. Because these files often contain an embedded "cabinet" file (``.cab``), it also exposes an API to create CAB files. Support for reading ``.cab`` files is diff --git a/Doc/library/msvcrt.rst b/Doc/library/msvcrt.rst index fadaf05a09..b334eeb314 100644 --- a/Doc/library/msvcrt.rst +++ b/Doc/library/msvcrt.rst @@ -4,8 +4,10 @@ .. module:: msvcrt :platform: Windows :synopsis: Miscellaneous useful routines from the MS VC++ runtime. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> +-------------- These functions provide access to some useful capabilities on Windows platforms. Some higher-level modules use these functions to build the Windows diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index be6c28ce0c..c5c092c1ce 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -4,6 +4,9 @@ .. module:: multiprocessing :synopsis: Process-based parallelism. +**Source code:** :source:`Lib/multiprocessing/` + +-------------- Introduction ------------ diff --git a/Doc/library/netrc.rst b/Doc/library/netrc.rst index 23ffed69eb..cdc2616368 100644 --- a/Doc/library/netrc.rst +++ b/Doc/library/netrc.rst @@ -4,6 +4,7 @@ .. module:: netrc :synopsis: Loading of .netrc files. + .. moduleauthor:: Eric S. Raymond <esr@snark.thyrsus.com> .. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com> diff --git a/Doc/library/nis.rst b/Doc/library/nis.rst index 9e2b572cab..10c67cbb81 100644 --- a/Doc/library/nis.rst +++ b/Doc/library/nis.rst @@ -5,9 +5,11 @@ .. module:: nis :platform: Unix :synopsis: Interface to Sun's NIS (Yellow Pages) library. + .. moduleauthor:: Fred Gansevles <Fred.Gansevles@cs.utwente.nl> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> +-------------- The :mod:`nis` module gives a thin wrapper around the NIS library, useful for central administration of several hosts. diff --git a/Doc/library/nntplib.rst b/Doc/library/nntplib.rst index 9fb1b4594d..9790e3a0b2 100644 --- a/Doc/library/nntplib.rst +++ b/Doc/library/nntplib.rst @@ -4,13 +4,12 @@ .. module:: nntplib :synopsis: NNTP protocol client (requires sockets). +**Source code:** :source:`Lib/nntplib.py` .. index:: pair: NNTP; protocol single: Network News Transfer Protocol -**Source code:** :source:`Lib/nntplib.py` - -------------- This module defines the class :class:`NNTP` which implements the client side of diff --git a/Doc/library/numbers.rst b/Doc/library/numbers.rst index 718a50e02f..1b594952ea 100644 --- a/Doc/library/numbers.rst +++ b/Doc/library/numbers.rst @@ -4,6 +4,9 @@ .. module:: numbers :synopsis: Numeric abstract base classes (Complex, Real, Integral, etc.). +**Source code:** :source:`Lib/numbers.py` + +-------------- The :mod:`numbers` module (:pep:`3141`) defines a hierarchy of numeric :term:`abstract base classes <abstract base class>` which progressively define diff --git a/Doc/library/operator.rst b/Doc/library/operator.rst index c01e63b77a..8121b480cb 100644 --- a/Doc/library/operator.rst +++ b/Doc/library/operator.rst @@ -3,16 +3,16 @@ .. module:: operator :synopsis: Functions corresponding to the standard operators. + .. sectionauthor:: Skip Montanaro <skip@automatrix.com> +**Source code:** :source:`Lib/operator.py` .. testsetup:: import operator from operator import itemgetter, iadd -**Source code:** :source:`Lib/operator.py` - -------------- The :mod:`operator` module exports a set of efficient functions corresponding to diff --git a/Doc/library/optparse.rst b/Doc/library/optparse.rst index c5db3ea7a1..9a4ba4e6ed 100644 --- a/Doc/library/optparse.rst +++ b/Doc/library/optparse.rst @@ -4,15 +4,16 @@ .. module:: optparse :synopsis: Command-line option parsing library. :deprecated: + .. moduleauthor:: Greg Ward <gward@python.net> .. sectionauthor:: Greg Ward <gward@python.net> +**Source code:** :source:`Lib/optparse.py` + .. deprecated:: 3.2 The :mod:`optparse` module is deprecated and will not be developed further; development will continue with the :mod:`argparse` module. -**Source code:** :source:`Lib/optparse.py` - -------------- :mod:`optparse` is a more convenient, flexible, and powerful library for parsing diff --git a/Doc/library/os.path.rst b/Doc/library/os.path.rst index 3703a209ce..bf0dface7e 100644 --- a/Doc/library/os.path.rst +++ b/Doc/library/os.path.rst @@ -4,8 +4,14 @@ .. module:: os.path :synopsis: Operations on pathnames. +**Source code:** :source:`Lib/posixpath.py` (for POSIX), +:source:`Lib/ntpath.py` (for Windows NT), +and :source:`Lib/macpath.py` (for Macintosh) + .. index:: single: path; operations +-------------- + This module implements some useful functions on pathnames. To read or write files see :func:`open`, and for accessing the filesystem see the :mod:`os` module. The path parameters can be passed as either strings, diff --git a/Doc/library/os.rst b/Doc/library/os.rst index 80de2bd475..743efb691a 100644 --- a/Doc/library/os.rst +++ b/Doc/library/os.rst @@ -4,6 +4,9 @@ .. module:: os :synopsis: Miscellaneous operating system interfaces. +**Source code:** :source:`Lib/os.py` + +-------------- This module provides a portable way of using operating system dependent functionality. If you just want to read or write a file see :func:`open`, if diff --git a/Doc/library/ossaudiodev.rst b/Doc/library/ossaudiodev.rst index 211328feea..ec40c0b93a 100644 --- a/Doc/library/ossaudiodev.rst +++ b/Doc/library/ossaudiodev.rst @@ -5,6 +5,7 @@ :platform: Linux, FreeBSD :synopsis: Access to OSS-compatible audio devices. +-------------- This module allows you to access the OSS (Open Sound System) audio interface. OSS is available for a wide range of open-source and commercial Unices, and is diff --git a/Doc/library/parser.rst b/Doc/library/parser.rst index 3e1e31bc79..c3b699a360 100644 --- a/Doc/library/parser.rst +++ b/Doc/library/parser.rst @@ -3,10 +3,10 @@ .. module:: parser :synopsis: Access parse trees for Python source code. + .. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> - .. Copyright 1995 Virginia Polytechnic Institute and State University and Fred L. Drake, Jr. This copyright notice must be distributed on all copies, but this document otherwise may be distributed as part of the Python @@ -16,6 +16,8 @@ .. index:: single: parsing; Python source code +-------------- + The :mod:`parser` module provides an interface to Python's internal parser and byte-code compiler. The primary purpose for this interface is to allow Python code to edit the parse tree of a Python expression and create executable code diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst index 2f0654440d..f803fb6274 100644 --- a/Doc/library/pathlib.rst +++ b/Doc/library/pathlib.rst @@ -5,9 +5,13 @@ .. module:: pathlib :synopsis: Object-oriented filesystem paths +.. versionadded:: 3.4 + +**Source code:** :source:`Lib/pathlib.py` + .. index:: single: path; operations -.. versionadded:: 3.4 +-------------- This module offers classes representing filesystem paths with semantics appropriate for different operating systems. Path classes are divided diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst index c144db6c1a..4520a9b6f3 100644 --- a/Doc/library/pdb.rst +++ b/Doc/library/pdb.rst @@ -8,10 +8,10 @@ **Source code:** :source:`Lib/pdb.py` --------------- - .. index:: single: debugging +-------------- + The module :mod:`pdb` defines an interactive source code debugger for Python programs. It supports setting (conditional) breakpoints and single stepping at the source line level, inspection of stack frames, source code listing, and diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst index 7e09b03cc6..0d64191d79 100644 --- a/Doc/library/pickle.rst +++ b/Doc/library/pickle.rst @@ -1,6 +1,14 @@ :mod:`pickle` --- Python object serialization ============================================= +.. module:: pickle + :synopsis: Convert Python objects to streams of bytes and back. + +.. sectionauthor:: Jim Kerr <jbkerr@sr.hp.com>. +.. sectionauthor:: Barry Warsaw <barry@python.org> + +**Source code:** :source:`Lib/pickle.py` + .. index:: single: persistence pair: persistent; objects @@ -9,11 +17,7 @@ pair: flattening; objects pair: pickling; objects -.. module:: pickle - :synopsis: Convert Python objects to streams of bytes and back. -.. sectionauthor:: Jim Kerr <jbkerr@sr.hp.com>. -.. sectionauthor:: Barry Warsaw <barry@python.org> - +-------------- The :mod:`pickle` module implements binary protocols for serializing and de-serializing a Python object structure. *"Pickling"* is the process diff --git a/Doc/library/pipes.rst b/Doc/library/pipes.rst index 69e891db29..0a22da1f55 100644 --- a/Doc/library/pipes.rst +++ b/Doc/library/pipes.rst @@ -4,6 +4,7 @@ .. module:: pipes :platform: Unix :synopsis: A Python interface to Unix shell pipelines. + .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> **Source code:** :source:`Lib/pipes.py` diff --git a/Doc/library/platform.rst b/Doc/library/platform.rst index e679317f06..eea0abbae4 100644 --- a/Doc/library/platform.rst +++ b/Doc/library/platform.rst @@ -3,6 +3,7 @@ .. module:: platform :synopsis: Retrieves as much platform identifying data as possible. + .. moduleauthor:: Marc-André Lemburg <mal@egenix.com> .. sectionauthor:: Bjorn Pettersen <bpettersen@corp.fairisaac.com> diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index 2c1f3dd79e..9ba226607d 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -3,16 +3,17 @@ .. module:: plistlib :synopsis: Generate and parse Mac OS X plist files. + .. moduleauthor:: Jack Jansen .. sectionauthor:: Georg Brandl <georg@python.org> .. (harvested from docstrings in the original file) +**Source code:** :source:`Lib/plistlib.py` + .. index:: pair: plist; file single: property list -**Source code:** :source:`Lib/plistlib.py` - -------------- This module provides an interface for reading and writing the "property list" diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst index 8468f4c498..ffabc32b6e 100644 --- a/Doc/library/poplib.rst +++ b/Doc/library/poplib.rst @@ -3,13 +3,14 @@ .. module:: poplib :synopsis: POP3 protocol client (requires sockets). + .. sectionauthor:: Andrew T. Csillag .. revised by ESR, January 2000 -.. index:: pair: POP3; protocol - **Source code:** :source:`Lib/poplib.py` +.. index:: pair: POP3; protocol + -------------- This module defines a class, :class:`POP3`, which encapsulates a connection to a diff --git a/Doc/library/posix.rst b/Doc/library/posix.rst index 06bab04aaa..9cbc5505ae 100644 --- a/Doc/library/posix.rst +++ b/Doc/library/posix.rst @@ -5,6 +5,7 @@ :platform: Unix :synopsis: The most common POSIX system calls (normally used via module os). +-------------- This module provides access to operating system functionality that is standardized by the C Standard and the POSIX standard (a thinly disguised Unix diff --git a/Doc/library/pprint.rst b/Doc/library/pprint.rst index b109efe174..65d94fe386 100644 --- a/Doc/library/pprint.rst +++ b/Doc/library/pprint.rst @@ -3,6 +3,7 @@ .. module:: pprint :synopsis: Data pretty printer. + .. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> diff --git a/Doc/library/pty.rst b/Doc/library/pty.rst index b8a3897ab8..0ab766065d 100644 --- a/Doc/library/pty.rst +++ b/Doc/library/pty.rst @@ -4,9 +4,13 @@ .. module:: pty :platform: Linux :synopsis: Pseudo-Terminal Handling for Linux. + .. moduleauthor:: Steen Lumholt .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> +**Source code:** :source:`Lib/pty.py` + +-------------- The :mod:`pty` module defines operations for handling the pseudo-terminal concept: starting another process and being able to write to and read from its diff --git a/Doc/library/pwd.rst b/Doc/library/pwd.rst index 2c17d9e036..03ebb02e4e 100644 --- a/Doc/library/pwd.rst +++ b/Doc/library/pwd.rst @@ -5,6 +5,7 @@ :platform: Unix :synopsis: The password database (getpwnam() and friends). +-------------- This module provides access to the Unix user account and password database. It is available on all Unix versions. diff --git a/Doc/library/py_compile.rst b/Doc/library/py_compile.rst index 97f2b20d2a..65f76b8bb8 100644 --- a/Doc/library/py_compile.rst +++ b/Doc/library/py_compile.rst @@ -3,13 +3,14 @@ .. module:: py_compile :synopsis: Generate byte-code files from Python source files. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. documentation based on module docstrings -.. index:: pair: file; byte-code - **Source code:** :source:`Lib/py_compile.py` +.. index:: pair: file; byte-code + -------------- The :mod:`py_compile` module provides a function to generate a byte-code file diff --git a/Doc/library/pyclbr.rst b/Doc/library/pyclbr.rst index 13eaabf594..32842717bc 100644 --- a/Doc/library/pyclbr.rst +++ b/Doc/library/pyclbr.rst @@ -3,6 +3,7 @@ .. module:: pyclbr :synopsis: Supports information extraction for a Python class browser. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> **Source code:** :source:`Lib/pyclbr.py` diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index b5e3233619..f1bfab9a3b 100644 --- a/Doc/library/pydoc.rst +++ b/Doc/library/pydoc.rst @@ -3,17 +3,17 @@ .. module:: pydoc :synopsis: Documentation generator and online help system. + .. moduleauthor:: Ka-Ping Yee <ping@lfw.org> .. sectionauthor:: Ka-Ping Yee <ping@lfw.org> +**Source code:** :source:`Lib/pydoc.py` .. index:: single: documentation; generation single: documentation; online single: help; online -**Source code:** :source:`Lib/pydoc.py` - -------------- The :mod:`pydoc` module automatically generates documentation from Python diff --git a/Doc/library/pyexpat.rst b/Doc/library/pyexpat.rst index 3bc26cecb7..29c9f347d2 100644 --- a/Doc/library/pyexpat.rst +++ b/Doc/library/pyexpat.rst @@ -3,8 +3,10 @@ .. module:: xml.parsers.expat :synopsis: An interface to the Expat non-validating XML parser. + .. moduleauthor:: Paul Prescod <paul@prescod.net> +-------------- .. Markup notes: diff --git a/Doc/library/quopri.rst b/Doc/library/quopri.rst index 3a74cf8511..3c31125435 100644 --- a/Doc/library/quopri.rst +++ b/Doc/library/quopri.rst @@ -4,13 +4,12 @@ .. module:: quopri :synopsis: Encode and decode files using the MIME quoted-printable encoding. +**Source code:** :source:`Lib/quopri.py` .. index:: pair: quoted-printable; encoding single: MIME; quoted-printable encoding -**Source code:** :source:`Lib/quopri.py` - -------------- This module performs quoted-printable transport encoding and decoding, as diff --git a/Doc/library/re.rst b/Doc/library/re.rst index ceb795976d..18d5596794 100644 --- a/Doc/library/re.rst +++ b/Doc/library/re.rst @@ -3,9 +3,13 @@ .. module:: re :synopsis: Regular expression operations. + .. moduleauthor:: Fredrik Lundh <fredrik@pythonware.com> .. sectionauthor:: Andrew M. Kuchling <amk@amk.ca> +**Source code:** :source:`Lib/re.py` + +-------------- This module provides regular expression matching operations similar to those found in Perl. diff --git a/Doc/library/readline.rst b/Doc/library/readline.rst index 5f4438e641..e17e69c183 100644 --- a/Doc/library/readline.rst +++ b/Doc/library/readline.rst @@ -4,8 +4,10 @@ .. module:: readline :platform: Unix :synopsis: GNU readline support for Python. + .. sectionauthor:: Skip Montanaro <skip@pobox.com> +-------------- The :mod:`readline` module defines a number of functions to facilitate completion and reading/writing of history files from the Python interpreter. diff --git a/Doc/library/reprlib.rst b/Doc/library/reprlib.rst index ee9a10d37e..0905b982cd 100644 --- a/Doc/library/reprlib.rst +++ b/Doc/library/reprlib.rst @@ -3,6 +3,7 @@ .. module:: reprlib :synopsis: Alternate repr() implementation with size limits. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> **Source code:** :source:`Lib/reprlib.py` diff --git a/Doc/library/resource.rst b/Doc/library/resource.rst index a7b229e98a..b213793a2c 100644 --- a/Doc/library/resource.rst +++ b/Doc/library/resource.rst @@ -4,9 +4,11 @@ .. module:: resource :platform: Unix :synopsis: An interface to provide resource usage information on the current process. + .. moduleauthor:: Jeremy Hylton <jeremy@alum.mit.edu> .. sectionauthor:: Jeremy Hylton <jeremy@alum.mit.edu> +-------------- This module provides basic mechanisms for measuring and controlling system resources utilized by a program. diff --git a/Doc/library/rlcompleter.rst b/Doc/library/rlcompleter.rst index 9ed01c7146..40b09ce897 100644 --- a/Doc/library/rlcompleter.rst +++ b/Doc/library/rlcompleter.rst @@ -3,6 +3,7 @@ .. module:: rlcompleter :synopsis: Python identifier completion, suitable for the GNU readline library. + .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> **Source code:** :source:`Lib/rlcompleter.py` diff --git a/Doc/library/runpy.rst b/Doc/library/runpy.rst index 78d01432a2..af35e81a2d 100644 --- a/Doc/library/runpy.rst +++ b/Doc/library/runpy.rst @@ -3,6 +3,7 @@ .. module:: runpy :synopsis: Locate and run Python modules without importing them first. + .. moduleauthor:: Nick Coghlan <ncoghlan@gmail.com> **Source code:** :source:`Lib/runpy.py` diff --git a/Doc/library/sched.rst b/Doc/library/sched.rst index 26f59c556c..4d4a616105 100644 --- a/Doc/library/sched.rst +++ b/Doc/library/sched.rst @@ -3,12 +3,13 @@ .. module:: sched :synopsis: General purpose event scheduler. -.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> -.. index:: single: event scheduling +.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> **Source code:** :source:`Lib/sched.py` +.. index:: single: event scheduling + -------------- The :mod:`sched` module defines a class which implements a general purpose event diff --git a/Doc/library/select.rst b/Doc/library/select.rst index 364b49933f..6cec9f764b 100644 --- a/Doc/library/select.rst +++ b/Doc/library/select.rst @@ -4,6 +4,7 @@ .. module:: select :synopsis: Wait for I/O completion on multiple streams. +-------------- This module provides access to the :c:func:`select` and :c:func:`poll` functions available in most operating systems, :c:func:`devpoll` available on diff --git a/Doc/library/selectors.rst b/Doc/library/selectors.rst index 3847bbd848..44b27f31c1 100644 --- a/Doc/library/selectors.rst +++ b/Doc/library/selectors.rst @@ -6,6 +6,9 @@ .. versionadded:: 3.4 +**Source code:** :source:`Lib/selectors.py` + +-------------- Introduction ------------ diff --git a/Doc/library/shelve.rst b/Doc/library/shelve.rst index f89368b1f4..1ec158ee7e 100644 --- a/Doc/library/shelve.rst +++ b/Doc/library/shelve.rst @@ -4,11 +4,10 @@ .. module:: shelve :synopsis: Python object persistence. +**Source code:** :source:`Lib/shelve.py` .. index:: module: pickle -**Source code:** :source:`Lib/shelve.py` - -------------- A "shelf" is a persistent, dictionary-like object. The difference with "dbm" diff --git a/Doc/library/shlex.rst b/Doc/library/shlex.rst index bf543185d4..e81f9822bb 100644 --- a/Doc/library/shlex.rst +++ b/Doc/library/shlex.rst @@ -3,6 +3,7 @@ .. module:: shlex :synopsis: Simple lexical analysis for Unix shell-like languages. + .. moduleauthor:: Eric S. Raymond <esr@snark.thyrsus.com> .. moduleauthor:: Gustavo Niemeyer <niemeyer@conectiva.com> .. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com> diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst index c39a19abc9..e9ba4e6219 100644 --- a/Doc/library/shutil.rst +++ b/Doc/library/shutil.rst @@ -3,15 +3,16 @@ .. module:: shutil :synopsis: High-level file operations, including copying. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. partly based on the docstrings +**Source code:** :source:`Lib/shutil.py` + .. index:: single: file; copying single: copying files -**Source code:** :source:`Lib/shutil.py` - -------------- The :mod:`shutil` module offers a number of high-level operations on files and diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index d02a0a8e3c..61252ce4e8 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -4,6 +4,7 @@ .. module:: signal :synopsis: Set handlers for asynchronous events. +-------------- This module provides mechanisms to use signal handlers in Python. diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst index 2234d51755..bdf3805106 100644 --- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -3,15 +3,15 @@ .. module:: smtplib :synopsis: SMTP protocol client (requires sockets). + .. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com> +**Source code:** :source:`Lib/smtplib.py` .. index:: pair: SMTP; protocol single: Simple Mail Transfer Protocol -**Source code:** :source:`Lib/smtplib.py` - -------------- The :mod:`smtplib` module defines an SMTP client session object that can be used diff --git a/Doc/library/sndhdr.rst b/Doc/library/sndhdr.rst index f8b5d8b246..6bfa9a9fd2 100644 --- a/Doc/library/sndhdr.rst +++ b/Doc/library/sndhdr.rst @@ -3,15 +3,16 @@ .. module:: sndhdr :synopsis: Determine type of a sound file. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. Based on comments in the module source file. +**Source code:** :source:`Lib/sndhdr.py` + .. index:: single: A-LAW single: u-LAW -**Source code:** :source:`Lib/sndhdr.py` - -------------- The :mod:`sndhdr` provides utility functions which attempt to determine the type diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst index 3aa1b138ca..48311c5820 100644 --- a/Doc/library/socket.rst +++ b/Doc/library/socket.rst @@ -4,6 +4,9 @@ .. module:: socket :synopsis: Low-level networking interface. +**Source code:** :source:`Lib/socket.py` + +-------------- This module provides access to the BSD *socket* interface. It is available on all modern Unix systems, Windows, MacOS, and probably additional platforms. diff --git a/Doc/library/spwd.rst b/Doc/library/spwd.rst index 58be78f017..fd3c9adee4 100644 --- a/Doc/library/spwd.rst +++ b/Doc/library/spwd.rst @@ -5,6 +5,7 @@ :platform: Unix :synopsis: The shadow password database (getspnam() and friends). +-------------- This module provides access to the Unix shadow password database. It is available on various Unix versions. diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index 996e93eb77..3bba935562 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -3,8 +3,12 @@ .. module:: sqlite3 :synopsis: A DB-API 2.0 implementation using SQLite 3.x. + .. sectionauthor:: Gerhard Häring <gh@ghaering.de> +**Source code:** :source:`Lib/sqlite3/` + +-------------- SQLite is a C library that provides a lightweight disk-based database that doesn't require a separate server process and allows accessing the database diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index d458d8b84e..5792d0d407 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -7,13 +7,12 @@ .. moduleauthor:: Bill Janssen <bill.janssen@gmail.com> .. sectionauthor:: Bill Janssen <bill.janssen@gmail.com> +**Source code:** :source:`Lib/ssl.py` .. index:: single: OpenSSL; (use in module ssl) .. index:: TLS, SSL, Transport Layer Security, Secure Sockets Layer -**Source code:** :source:`Lib/ssl.py` - -------------- This module provides access to Transport Layer Security (often known as "Secure diff --git a/Doc/library/stat.rst b/Doc/library/stat.rst index a2f8a57261..b256312d91 100644 --- a/Doc/library/stat.rst +++ b/Doc/library/stat.rst @@ -4,10 +4,10 @@ .. module:: stat :synopsis: Utilities for interpreting the results of os.stat(), os.lstat() and os.fstat(). + .. sectionauthor:: Skip Montanaro <skip@automatrix.com> -**Source code:** :source:`Modules/_stat.c` - :source:`Lib/stat.py` +**Source code:** :source:`Lib/stat.py` -------------- diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst index 1e1bd9b62b..ea3d7dab0f 100644 --- a/Doc/library/statistics.rst +++ b/Doc/library/statistics.rst @@ -3,18 +3,19 @@ .. module:: statistics :synopsis: mathematical statistics functions + .. moduleauthor:: Steven D'Aprano <steve+python@pearwood.info> .. sectionauthor:: Steven D'Aprano <steve+python@pearwood.info> .. versionadded:: 3.4 +**Source code:** :source:`Lib/statistics.py` + .. testsetup:: * from statistics import * __name__ = '<doctest>' -**Source code:** :source:`Lib/statistics.py` - -------------- This module provides functions for calculating mathematical statistics of diff --git a/Doc/library/stringprep.rst b/Doc/library/stringprep.rst index fc890cb232..e7fae5631d 100644 --- a/Doc/library/stringprep.rst +++ b/Doc/library/stringprep.rst @@ -3,9 +3,13 @@ .. module:: stringprep :synopsis: String preparation, as per RFC 3453 + .. moduleauthor:: Martin v. Löwis <martin@v.loewis.de> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> +**Source code:** :source:`Lib/stringprep.py` + +-------------- When identifying things (such as host names) in the internet, it is often necessary to compare such identifications for "equality". Exactly how this diff --git a/Doc/library/struct.rst b/Doc/library/struct.rst index e7570475e7..ae2e38fdc0 100644 --- a/Doc/library/struct.rst +++ b/Doc/library/struct.rst @@ -4,10 +4,14 @@ .. module:: struct :synopsis: Interpret bytes as packed binary data. +**Source code:** :source:`Lib/struct.py` + .. index:: pair: C; structures triple: packing; binary; data +-------------- + This module performs conversions between Python values and C structs represented as Python :class:`bytes` objects. This can be used in handling binary data stored in files or from network connections, among other sources. It uses diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index 67bee40acb..f469107cba 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -3,9 +3,13 @@ .. module:: subprocess :synopsis: Subprocess management. + .. moduleauthor:: Peter Åstrand <astrand@lysator.liu.se> .. sectionauthor:: Peter Åstrand <astrand@lysator.liu.se> +**Source code:** :source:`Lib/subprocess.py` + +-------------- The :mod:`subprocess` module allows you to spawn new processes, connect to their input/output/error pipes, and obtain their return codes. This module intends to diff --git a/Doc/library/sunau.rst b/Doc/library/sunau.rst index bd37ee29cc..d0fd0a3cc7 100644 --- a/Doc/library/sunau.rst +++ b/Doc/library/sunau.rst @@ -3,6 +3,7 @@ .. module:: sunau :synopsis: Provide an interface to the Sun AU sound format. + .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> **Source code:** :source:`Lib/sunau.py` diff --git a/Doc/library/symbol.rst b/Doc/library/symbol.rst index ef9ef1e129..44996936e2 100644 --- a/Doc/library/symbol.rst +++ b/Doc/library/symbol.rst @@ -3,6 +3,7 @@ .. module:: symbol :synopsis: Constants representing internal nodes of the parse tree. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> **Source code:** :source:`Lib/symbol.py` diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index 4f94124ea0..9f70a13aa9 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -4,6 +4,7 @@ .. module:: sys :synopsis: Access system-specific parameters and functions. +-------------- This module provides access to some variables used or maintained by the interpreter and to functions that interact strongly with the interpreter. It is diff --git a/Doc/library/sysconfig.rst b/Doc/library/sysconfig.rst index 535ac54b3c..0b0df9b375 100644 --- a/Doc/library/sysconfig.rst +++ b/Doc/library/sysconfig.rst @@ -3,16 +3,17 @@ .. module:: sysconfig :synopsis: Python's configuration information + .. moduleauthor:: Tarek Ziadé <tarek@ziade.org> .. sectionauthor:: Tarek Ziadé <tarek@ziade.org> -.. index:: - single: configuration information - .. versionadded:: 3.2 **Source code:** :source:`Lib/sysconfig.py` +.. index:: + single: configuration information + -------------- The :mod:`sysconfig` module provides access to Python's configuration diff --git a/Doc/library/syslog.rst b/Doc/library/syslog.rst index 6e90dc05d9..af3fb9b57f 100644 --- a/Doc/library/syslog.rst +++ b/Doc/library/syslog.rst @@ -5,6 +5,7 @@ :platform: Unix :synopsis: An interface to the Unix syslog library routines. +-------------- This module provides an interface to the Unix ``syslog`` library routines. Refer to the Unix manual pages for a detailed description of the ``syslog`` diff --git a/Doc/library/tabnanny.rst b/Doc/library/tabnanny.rst index 4f3e705cab..1edb0fbabb 100644 --- a/Doc/library/tabnanny.rst +++ b/Doc/library/tabnanny.rst @@ -4,6 +4,7 @@ .. module:: tabnanny :synopsis: Tool for detecting white space related problems in Python source files in a directory tree. + .. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net> .. sectionauthor:: Peter Funk <pf@artcom-gmbh.de> diff --git a/Doc/library/tarfile.rst b/Doc/library/tarfile.rst index b49da472af..32d69bf3ca 100644 --- a/Doc/library/tarfile.rst +++ b/Doc/library/tarfile.rst @@ -4,7 +4,6 @@ .. module:: tarfile :synopsis: Read and write tar-format archive files. - .. moduleauthor:: Lars Gustäbel <lars@gustaebel.de> .. sectionauthor:: Lars Gustäbel <lars@gustaebel.de> diff --git a/Doc/library/telnetlib.rst b/Doc/library/telnetlib.rst index 4040f72ee8..b950e41dc1 100644 --- a/Doc/library/telnetlib.rst +++ b/Doc/library/telnetlib.rst @@ -3,13 +3,13 @@ .. module:: telnetlib :synopsis: Telnet client class. + .. sectionauthor:: Skip Montanaro <skip@pobox.com> +**Source code:** :source:`Lib/telnetlib.py` .. index:: single: protocol; Telnet -**Source code:** :source:`Lib/telnetlib.py` - -------------- The :mod:`telnetlib` module provides a :class:`Telnet` class that implements the diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst index 486c18da48..665261ffb2 100644 --- a/Doc/library/tempfile.rst +++ b/Doc/library/tempfile.rst @@ -1,19 +1,17 @@ :mod:`tempfile` --- Generate temporary files and directories ============================================================ -.. sectionauthor:: Zack Weinberg <zack@codesourcery.com> - - .. module:: tempfile :synopsis: Generate temporary files and directories. +.. sectionauthor:: Zack Weinberg <zack@codesourcery.com> + +**Source code:** :source:`Lib/tempfile.py` .. index:: pair: temporary; file name pair: temporary; file -**Source code:** :source:`Lib/tempfile.py` - -------------- This module creates temporary files and directories. It works on all diff --git a/Doc/library/termios.rst b/Doc/library/termios.rst index d225d94f91..ad6a9f7c97 100644 --- a/Doc/library/termios.rst +++ b/Doc/library/termios.rst @@ -5,11 +5,12 @@ :platform: Unix :synopsis: POSIX style tty control. - .. index:: pair: POSIX; I/O control pair: tty; I/O control +-------------- + This module provides an interface to the POSIX calls for tty I/O control. For a complete description of these calls, see :manpage:`termios(2)` Unix manual page. It is only available for those Unix versions that support POSIX diff --git a/Doc/library/test.rst b/Doc/library/test.rst index a5ce2ca880..2ea9c27e49 100644 --- a/Doc/library/test.rst +++ b/Doc/library/test.rst @@ -3,6 +3,7 @@ .. module:: test :synopsis: Regression tests package containing the testing suite for Python. + .. sectionauthor:: Brett Cannon <brett@python.org> .. note:: @@ -12,6 +13,7 @@ mentioned here can change or be removed without notice between releases of Python. +-------------- The :mod:`test` package contains all regression tests for Python as well as the modules :mod:`test.support` and :mod:`test.regrtest`. diff --git a/Doc/library/textwrap.rst b/Doc/library/textwrap.rst index 9fe7a3589a..438007d002 100644 --- a/Doc/library/textwrap.rst +++ b/Doc/library/textwrap.rst @@ -3,6 +3,7 @@ .. module:: textwrap :synopsis: Text wrapping and filling + .. moduleauthor:: Greg Ward <gward@python.net> .. sectionauthor:: Greg Ward <gward@python.net> diff --git a/Doc/library/time.rst b/Doc/library/time.rst index 8b53bbb0ed..e6626f262d 100644 --- a/Doc/library/time.rst +++ b/Doc/library/time.rst @@ -4,6 +4,7 @@ .. module:: time :synopsis: Time access and conversions. +-------------- This module provides various time-related functions. For related functionality, see also the :mod:`datetime` and :mod:`calendar` modules. diff --git a/Doc/library/timeit.rst b/Doc/library/timeit.rst index 16baf912df..57a4834c90 100644 --- a/Doc/library/timeit.rst +++ b/Doc/library/timeit.rst @@ -4,13 +4,12 @@ .. module:: timeit :synopsis: Measure the execution time of small code snippets. +**Source code:** :source:`Lib/timeit.py` .. index:: single: Benchmarking single: Performance -**Source code:** :source:`Lib/timeit.py` - -------------- This module provides a simple way to time small bits of Python code. It has both diff --git a/Doc/library/tkinter.rst b/Doc/library/tkinter.rst index 5393124d90..130aafe8b9 100644 --- a/Doc/library/tkinter.rst +++ b/Doc/library/tkinter.rst @@ -3,8 +3,12 @@ .. module:: tkinter :synopsis: Interface to Tcl/Tk for graphical user interfaces + .. moduleauthor:: Guido van Rossum <guido@Python.org> +**Source code:** :source:`Lib/tkinter/__init__.py` + +-------------- The :mod:`tkinter` package ("Tk interface") is the standard Python interface to the Tk GUI toolkit. Both Tk and :mod:`tkinter` are available on most Unix diff --git a/Doc/library/tkinter.scrolledtext.rst b/Doc/library/tkinter.scrolledtext.rst index 520970f168..138720e478 100644 --- a/Doc/library/tkinter.scrolledtext.rst +++ b/Doc/library/tkinter.scrolledtext.rst @@ -4,8 +4,12 @@ .. module:: tkinter.scrolledtext :platform: Tk :synopsis: Text widget with a vertical scroll bar. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> +**Source code:** :source:`Lib/tkinter/scrolledtext.py` + +-------------- The :mod:`tkinter.scrolledtext` module provides a class of the same name which implements a basic text widget which has a vertical scroll bar configured to do diff --git a/Doc/library/tkinter.tix.rst b/Doc/library/tkinter.tix.rst index d66f595339..41f20ddf4e 100644 --- a/Doc/library/tkinter.tix.rst +++ b/Doc/library/tkinter.tix.rst @@ -3,11 +3,15 @@ .. module:: tkinter.tix :synopsis: Tk Extension Widgets for Tkinter + .. sectionauthor:: Mike Clarkson <mikeclarkson@users.sourceforge.net> +**Source code:** :source:`Lib/tkinter/tix.py` .. index:: single: Tix +-------------- + The :mod:`tkinter.tix` (Tk Interface Extension) module provides an additional rich set of widgets. Although the standard Tk library has many useful widgets, they are far from complete. The :mod:`tkinter.tix` library provides most of the diff --git a/Doc/library/tkinter.ttk.rst b/Doc/library/tkinter.ttk.rst index 7448525cde..dbb5bd2505 100644 --- a/Doc/library/tkinter.ttk.rst +++ b/Doc/library/tkinter.ttk.rst @@ -3,11 +3,15 @@ .. module:: tkinter.ttk :synopsis: Tk themed widget set + .. sectionauthor:: Guilherme Polo <ggpolo@gmail.com> +**Source code:** :source:`Lib/tkinter/ttk.py` .. index:: single: ttk +-------------- + The :mod:`tkinter.ttk` module provides access to the Tk themed widget set, introduced in Tk 8.5. If Python has not been compiled against Tk 8.5, this module can still be accessed if *Tile* has been installed. The former diff --git a/Doc/library/token.rst b/Doc/library/token.rst index c6bfa354d9..116efca715 100644 --- a/Doc/library/token.rst +++ b/Doc/library/token.rst @@ -3,6 +3,7 @@ .. module:: token :synopsis: Constants representing terminal nodes of the parse tree. + .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> **Source code:** :source:`Lib/token.py` diff --git a/Doc/library/tokenize.rst b/Doc/library/tokenize.rst index 272e370d8b..ff55aacbd4 100644 --- a/Doc/library/tokenize.rst +++ b/Doc/library/tokenize.rst @@ -3,6 +3,7 @@ .. module:: tokenize :synopsis: Lexical scanner for Python source code. + .. moduleauthor:: Ka Ping Yee .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst index 5459daa796..6ec9ada530 100644 --- a/Doc/library/traceback.rst +++ b/Doc/library/traceback.rst @@ -4,6 +4,9 @@ .. module:: traceback :synopsis: Print or retrieve a stack traceback. +**Source code:** :source:`Lib/traceback.py` + +-------------- This module provides a standard interface to extract, format and print stack traces of Python programs. It exactly mimics the behavior of the Python diff --git a/Doc/library/tracemalloc.rst b/Doc/library/tracemalloc.rst index 5feb2d9e89..3a0b1e0797 100644 --- a/Doc/library/tracemalloc.rst +++ b/Doc/library/tracemalloc.rst @@ -6,6 +6,10 @@ .. versionadded:: 3.4 +**Source code:** :source:`Lib/tracemalloc.py` + +-------------- + The tracemalloc module is a debug tool to trace memory blocks allocated by Python. It provides the following information: diff --git a/Doc/library/tty.rst b/Doc/library/tty.rst index d13c6f92d3..b30bc3c7ac 100644 --- a/Doc/library/tty.rst +++ b/Doc/library/tty.rst @@ -4,9 +4,13 @@ .. module:: tty :platform: Unix :synopsis: Utility functions that perform common terminal control operations. + .. moduleauthor:: Steen Lumholt .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> +**Source code:** :source:`Lib/tty.py` + +-------------- The :mod:`tty` module defines functions for putting the tty into cbreak and raw modes. diff --git a/Doc/library/turtle.rst b/Doc/library/turtle.rst index 30dd6eff2d..e4a82eaada 100644 --- a/Doc/library/turtle.rst +++ b/Doc/library/turtle.rst @@ -4,13 +4,18 @@ .. module:: turtle :synopsis: An educational framework for simple graphics applications + .. sectionauthor:: Gregor Lingl <gregor.lingl@aon.at> +**Source code:** :source:`Lib/turtle.py` + .. testsetup:: default from turtle import * turtle = Turtle() +-------------- + Introduction ============ diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 25d7794b58..731e2eca16 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -4,10 +4,10 @@ .. module:: typing :synopsis: Support for type hints (see PEP 484). -**Source code:** :source:`Lib/typing.py` - .. versionadded:: 3.5 +**Source code:** :source:`Lib/typing.py` + -------------- This module supports type hints as specified by :pep:`484`. The most diff --git a/Doc/library/unicodedata.rst b/Doc/library/unicodedata.rst index 1430d9b403..6cd8132f8a 100644 --- a/Doc/library/unicodedata.rst +++ b/Doc/library/unicodedata.rst @@ -3,16 +3,18 @@ .. module:: unicodedata :synopsis: Access the Unicode Database. + .. moduleauthor:: Marc-André Lemburg <mal@lemburg.com> .. sectionauthor:: Marc-André Lemburg <mal@lemburg.com> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> - .. index:: single: Unicode single: character pair: Unicode; database +-------------- + This module provides access to the Unicode Character Database (UCD) which defines character properties for all Unicode characters. The data contained in this database is compiled from the `UCD version 8.0.0 diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst index 929ceadbd7..5c9177a9c8 100644 --- a/Doc/library/unittest.mock.rst +++ b/Doc/library/unittest.mock.rst @@ -4,11 +4,16 @@ .. module:: unittest.mock :synopsis: Mock object library. + .. moduleauthor:: Michael Foord <michael@python.org> .. currentmodule:: unittest.mock .. versionadded:: 3.3 +**Source code:** :source:`Lib/unittest/mock.py` + +-------------- + :mod:`unittest.mock` is a library for testing in Python. It allows you to replace parts of your system under test with mock objects and make assertions about how they have been used. @@ -32,8 +37,6 @@ used by many mocking frameworks. There is a backport of :mod:`unittest.mock` for earlier versions of Python, available as `mock on PyPI <https://pypi.python.org/pypi/mock>`_. -**Source code:** :source:`Lib/unittest/mock.py` - Quick Guide ----------- diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index 8482f207bd..0fc02c4dbe 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -3,11 +3,16 @@ .. module:: unittest :synopsis: Unit testing framework for Python. + .. moduleauthor:: Steve Purcell <stephen_purcell@yahoo.com> .. sectionauthor:: Steve Purcell <stephen_purcell@yahoo.com> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Raymond Hettinger <python@rcn.com> +**Source code:** :source:`Lib/unittest/__init__.py` + +-------------- + (If you are already familiar with the basic concepts of testing, you might want to skip to :ref:`the list of assert methods <assert-methods>`.) diff --git a/Doc/library/urllib.error.rst b/Doc/library/urllib.error.rst index f7f0c9739d..5517b04f5d 100644 --- a/Doc/library/urllib.error.rst +++ b/Doc/library/urllib.error.rst @@ -3,9 +3,13 @@ .. module:: urllib.error :synopsis: Exception classes raised by urllib.request. + .. moduleauthor:: Jeremy Hylton <jeremy@alum.mit.edu> .. sectionauthor:: Senthil Kumaran <orsenthil@gmail.com> +**Source code:** :source:`Lib/urllib/error.py` + +-------------- The :mod:`urllib.error` module defines the exception classes for exceptions raised by :mod:`urllib.request`. The base exception class is :exc:`URLError`. diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst index 9eb0a93f3c..c6de2303c6 100644 --- a/Doc/library/urllib.parse.rst +++ b/Doc/library/urllib.parse.rst @@ -4,6 +4,7 @@ .. module:: urllib.parse :synopsis: Parse URLs into or assemble them from components. +**Source code:** :source:`Lib/urllib/parse.py` .. index:: single: WWW @@ -12,8 +13,6 @@ pair: URL; parsing pair: relative; URL -**Source code:** :source:`Lib/urllib/parse.py` - -------------- This module defines a standard interface to break Uniform Resource Locator (URL) diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index 86f4989c1b..1338906b64 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -3,10 +3,14 @@ .. module:: urllib.request :synopsis: Extensible library for opening URLs. + .. moduleauthor:: Jeremy Hylton <jeremy@alum.mit.edu> .. sectionauthor:: Moshe Zadka <moshez@users.sourceforge.net> .. sectionauthor:: Senthil Kumaran <senthil@uthcode.com> +**Source code:** :source:`Lib/urllib/request.py` + +-------------- The :mod:`urllib.request` module defines functions and classes which help in opening URLs (mostly HTTP) in a complex world --- basic and digest diff --git a/Doc/library/urllib.robotparser.rst b/Doc/library/urllib.robotparser.rst index f179de2f92..ba701c3b68 100644 --- a/Doc/library/urllib.robotparser.rst +++ b/Doc/library/urllib.robotparser.rst @@ -4,8 +4,10 @@ .. module:: urllib.robotparser :synopsis: Load a robots.txt file and answer questions about fetchability of other URLs. + .. sectionauthor:: Skip Montanaro <skip@pobox.com> +**Source code:** :source:`Lib/urllib/robotparser.py` .. index:: single: WWW @@ -13,6 +15,8 @@ single: URL single: robots.txt +-------------- + This module provides a single class, :class:`RobotFileParser`, which answers questions about whether or not a particular user agent can fetch a URL on the Web site that published the :file:`robots.txt` file. For more details on the diff --git a/Doc/library/urllib.rst b/Doc/library/urllib.rst index 8e308bc589..624e164625 100644 --- a/Doc/library/urllib.rst +++ b/Doc/library/urllib.rst @@ -3,6 +3,10 @@ .. module:: urllib +**Source code:** :source:`Lib/urllib/` + +-------------- + ``urllib`` is a package that collects several modules for working with URLs: * :mod:`urllib.request` for opening and reading URLs diff --git a/Doc/library/uu.rst b/Doc/library/uu.rst index d61c178831..33fb36d0b8 100644 --- a/Doc/library/uu.rst +++ b/Doc/library/uu.rst @@ -3,6 +3,7 @@ .. module:: uu :synopsis: Encode and decode files in uuencode format. + .. moduleauthor:: Lance Ellinghouse **Source code:** :source:`Lib/uu.py` diff --git a/Doc/library/uuid.rst b/Doc/library/uuid.rst index 7dc46acd05..53cbd6c770 100644 --- a/Doc/library/uuid.rst +++ b/Doc/library/uuid.rst @@ -6,6 +6,9 @@ .. moduleauthor:: Ka-Ping Yee <ping@zesty.ca> .. sectionauthor:: George Yoshida <quiver@users.sourceforge.net> +**Source code:** :source:`Lib/uuid.py` + +-------------- This module provides immutable :class:`UUID` objects (the :class:`UUID` class) and the functions :func:`uuid1`, :func:`uuid3`, :func:`uuid4`, :func:`uuid5` for diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index acd1443879..af4a6d1ab4 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -3,15 +3,15 @@ .. module:: venv :synopsis: Creation of virtual environments. + .. moduleauthor:: Vinay Sajip <vinay_sajip@yahoo.co.uk> .. sectionauthor:: Vinay Sajip <vinay_sajip@yahoo.co.uk> - -.. index:: pair: Environments; virtual - .. versionadded:: 3.3 -**Source code:** :source:`Lib/venv` +**Source code:** :source:`Lib/venv/` + +.. index:: pair: Environments; virtual -------------- diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst index 037f11d357..5212131764 100644 --- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -1,13 +1,13 @@ :mod:`warnings` --- Warning control =================================== -.. index:: single: warnings - .. module:: warnings :synopsis: Issue warning messages and control their disposition. **Source code:** :source:`Lib/warnings.py` +.. index:: single: warnings + -------------- Warning messages are typically issued in situations where it is useful to alert diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst index ab64978cfd..7144379784 100644 --- a/Doc/library/wave.rst +++ b/Doc/library/wave.rst @@ -3,6 +3,7 @@ .. module:: wave :synopsis: Provide an interface to the WAV sound format. + .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. Documentations stolen from comments in file. diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst index 01dabc9d13..0470bd113a 100644 --- a/Doc/library/weakref.rst +++ b/Doc/library/weakref.rst @@ -3,6 +3,7 @@ .. module:: weakref :synopsis: Support for weak references and weak dictionaries. + .. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. moduleauthor:: Neil Schemenauer <nas@arctrix.com> .. moduleauthor:: Martin von Löwis <martin@loewis.home.cs.tu-berlin.de> diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst index 17c6dc365a..85d3636722 100644 --- a/Doc/library/webbrowser.rst +++ b/Doc/library/webbrowser.rst @@ -3,6 +3,7 @@ .. module:: webbrowser :synopsis: Easy-to-use controller for Web browsers. + .. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> diff --git a/Doc/library/winreg.rst b/Doc/library/winreg.rst index 94378b21d5..52d591ad75 100644 --- a/Doc/library/winreg.rst +++ b/Doc/library/winreg.rst @@ -4,8 +4,10 @@ .. module:: winreg :platform: Windows :synopsis: Routines and objects for manipulating the Windows registry. + .. sectionauthor:: Mark Hammond <MarkH@ActiveState.com> +-------------- These functions expose the Windows registry API to Python. Instead of using an integer as the registry handle, a :ref:`handle object <handle-object>` is used diff --git a/Doc/library/winsound.rst b/Doc/library/winsound.rst index 61f34cddc1..d2c421047e 100644 --- a/Doc/library/winsound.rst +++ b/Doc/library/winsound.rst @@ -4,9 +4,11 @@ .. module:: winsound :platform: Windows :synopsis: Access to the sound-playing machinery for Windows. + .. moduleauthor:: Toby Dickenson <htrd90@zepler.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> +-------------- The :mod:`winsound` module provides access to the basic sound-playing machinery provided by Windows platforms. It includes functions and several constants. diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index 3253f48ea2..aad27a88c9 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -3,9 +3,11 @@ .. module:: wsgiref :synopsis: WSGI Utilities and Reference Implementation. + .. moduleauthor:: Phillip J. Eby <pje@telecommunity.com> .. sectionauthor:: Phillip J. Eby <pje@telecommunity.com> +-------------- The Web Server Gateway Interface (WSGI) is a standard interface between web server software and web applications written in Python. Having a standard diff --git a/Doc/library/xdrlib.rst b/Doc/library/xdrlib.rst index 5c7dfa454b..42a03a4675 100644 --- a/Doc/library/xdrlib.rst +++ b/Doc/library/xdrlib.rst @@ -4,13 +4,12 @@ .. module:: xdrlib :synopsis: Encoders and decoders for the External Data Representation (XDR). +**Source code:** :source:`Lib/xdrlib.py` .. index:: single: XDR single: External Data Representation -**Source code:** :source:`Lib/xdrlib.py` - -------------- The :mod:`xdrlib` module supports the External Data Representation Standard as diff --git a/Doc/library/xml.dom.minidom.rst b/Doc/library/xml.dom.minidom.rst index a8c1f1d582..e1042e7eea 100644 --- a/Doc/library/xml.dom.minidom.rst +++ b/Doc/library/xml.dom.minidom.rst @@ -3,6 +3,7 @@ .. module:: xml.dom.minidom :synopsis: Minimal Document Object Model (DOM) implementation. + .. moduleauthor:: Paul Prescod <paul@prescod.net> .. sectionauthor:: Paul Prescod <paul@prescod.net> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> diff --git a/Doc/library/xml.dom.pulldom.rst b/Doc/library/xml.dom.pulldom.rst index 98329a2239..c3339edd54 100644 --- a/Doc/library/xml.dom.pulldom.rst +++ b/Doc/library/xml.dom.pulldom.rst @@ -3,6 +3,7 @@ .. module:: xml.dom.pulldom :synopsis: Support for building partial DOM trees from SAX events. + .. moduleauthor:: Paul Prescod <paul@prescod.net> **Source code:** :source:`Lib/xml/dom/pulldom.py` diff --git a/Doc/library/xml.dom.rst b/Doc/library/xml.dom.rst index 13e0d1b73d..b037ff6b82 100644 --- a/Doc/library/xml.dom.rst +++ b/Doc/library/xml.dom.rst @@ -3,9 +3,13 @@ .. module:: xml.dom :synopsis: Document Object Model API for Python. + .. sectionauthor:: Paul Prescod <paul@prescod.net> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> +**Source code:** :source:`Lib/xml/dom/__init__.py` + +-------------- The Document Object Model, or "DOM," is a cross-language API from the World Wide Web Consortium (W3C) for accessing and modifying XML documents. A DOM diff --git a/Doc/library/xml.etree.elementtree.rst b/Doc/library/xml.etree.elementtree.rst index f5cdf0371e..99d7e8b7ce 100644 --- a/Doc/library/xml.etree.elementtree.rst +++ b/Doc/library/xml.etree.elementtree.rst @@ -3,8 +3,13 @@ .. module:: xml.etree.ElementTree :synopsis: Implementation of the ElementTree API. + .. moduleauthor:: Fredrik Lundh <fredrik@pythonware.com> +**Source code:** :source:`Lib/xml/etree/ElementTree.py` + +-------------- + The :mod:`xml.etree.ElementTree` module implements a simple and efficient API for parsing and creating XML data. diff --git a/Doc/library/xml.rst b/Doc/library/xml.rst index 0bcf5810a2..3c2fc89d50 100644 --- a/Doc/library/xml.rst +++ b/Doc/library/xml.rst @@ -5,9 +5,13 @@ XML Processing Modules .. module:: xml :synopsis: Package containing XML processing modules + .. sectionauthor:: Christian Heimes <christian@python.org> .. sectionauthor:: Georg Brandl <georg@python.org> +**Source code:** :source:`Lib/xml/` + +-------------- Python's interfaces for processing XML are grouped in the ``xml`` package. diff --git a/Doc/library/xml.sax.handler.rst b/Doc/library/xml.sax.handler.rst index 0fb3341c61..ae0877ca90 100644 --- a/Doc/library/xml.sax.handler.rst +++ b/Doc/library/xml.sax.handler.rst @@ -3,9 +3,13 @@ .. module:: xml.sax.handler :synopsis: Base classes for SAX event handlers. + .. moduleauthor:: Lars Marius Garshol <larsga@garshol.priv.no> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> +**Source code:** :source:`Lib/xml/sax/handler.py` + +-------------- The SAX API defines four kinds of handlers: content handlers, DTD handlers, error handlers, and entity resolvers. Applications normally only need to diff --git a/Doc/library/xml.sax.reader.rst b/Doc/library/xml.sax.reader.rst index 47d23d6b98..c368fc2e5a 100644 --- a/Doc/library/xml.sax.reader.rst +++ b/Doc/library/xml.sax.reader.rst @@ -3,9 +3,13 @@ .. module:: xml.sax.xmlreader :synopsis: Interface which SAX-compliant XML parsers must implement. + .. moduleauthor:: Lars Marius Garshol <larsga@garshol.priv.no> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> +**Source code:** :source:`Lib/xml/sax/xmlreader.py` + +-------------- SAX parsers implement the :class:`XMLReader` interface. They are implemented in a Python module, which must provide a function :func:`create_parser`. This diff --git a/Doc/library/xml.sax.rst b/Doc/library/xml.sax.rst index 55f97999de..78d6633e09 100644 --- a/Doc/library/xml.sax.rst +++ b/Doc/library/xml.sax.rst @@ -3,10 +3,14 @@ .. module:: xml.sax :synopsis: Package containing SAX2 base classes and convenience functions. + .. moduleauthor:: Lars Marius Garshol <larsga@garshol.priv.no> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> +**Source code:** :source:`Lib/xml/sax/__init__.py` + +-------------- The :mod:`xml.sax` package provides a number of modules which implement the Simple API for XML (SAX) interface for Python. The package itself provides the diff --git a/Doc/library/xml.sax.utils.rst b/Doc/library/xml.sax.utils.rst index 14cf07839b..538b7980bd 100644 --- a/Doc/library/xml.sax.utils.rst +++ b/Doc/library/xml.sax.utils.rst @@ -3,9 +3,13 @@ .. module:: xml.sax.saxutils :synopsis: Convenience functions and classes for use with SAX. + .. moduleauthor:: Lars Marius Garshol <larsga@garshol.priv.no> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> +**Source code:** :source:`Lib/xml/sax/saxutils.py` + +-------------- The module :mod:`xml.sax.saxutils` contains a number of classes and functions that are commonly useful when creating SAX applications, either in direct use, diff --git a/Doc/library/xmlrpc.client.rst b/Doc/library/xmlrpc.client.rst index c83ecae279..e7916d2bff 100644 --- a/Doc/library/xmlrpc.client.rst +++ b/Doc/library/xmlrpc.client.rst @@ -3,15 +3,15 @@ .. module:: xmlrpc.client :synopsis: XML-RPC client access. + .. moduleauthor:: Fredrik Lundh <fredrik@pythonware.com> .. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com> +**Source code:** :source:`Lib/xmlrpc/client.py` .. XXX Not everything is documented yet. It might be good to describe Marshaller, Unmarshaller, getparser and Transport. -**Source code:** :source:`Lib/xmlrpc/client.py` - -------------- XML-RPC is a Remote Procedure Call method that uses XML passed via HTTP(S) as a diff --git a/Doc/library/xmlrpc.server.rst b/Doc/library/xmlrpc.server.rst index 680db41f21..ad1e81203b 100644 --- a/Doc/library/xmlrpc.server.rst +++ b/Doc/library/xmlrpc.server.rst @@ -3,6 +3,7 @@ .. module:: xmlrpc.server :synopsis: Basic XML-RPC server implementations. + .. moduleauthor:: Brian Quinlan <brianq@activestate.com> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> diff --git a/Doc/library/zipapp.rst b/Doc/library/zipapp.rst index 265e62d4b3..7c7767f0d4 100644 --- a/Doc/library/zipapp.rst +++ b/Doc/library/zipapp.rst @@ -4,14 +4,13 @@ .. module:: zipapp :synopsis: Manage executable python zip archives - -.. index:: - single: Executable Zip Files - .. versionadded:: 3.5 **Source code:** :source:`Lib/zipapp.py` +.. index:: + single: Executable Zip Files + -------------- This module provides tools to manage the creation of zip files containing diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index 9b0d18a365..b421ea58fe 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -3,6 +3,7 @@ .. module:: zipfile :synopsis: Read and write ZIP-format archive files. + .. moduleauthor:: James C. Ahlstrom <jim@interet.com> .. sectionauthor:: James C. Ahlstrom <jim@interet.com> diff --git a/Doc/library/zipimport.rst b/Doc/library/zipimport.rst index 58e0b7cd14..0a0f17547f 100644 --- a/Doc/library/zipimport.rst +++ b/Doc/library/zipimport.rst @@ -3,8 +3,10 @@ .. module:: zipimport :synopsis: support for importing Python modules from ZIP archives. + .. moduleauthor:: Just van Rossum <just@letterror.com> +-------------- This module adds the ability to import Python modules (:file:`\*.py`, :file:`\*.py[co]`) and packages from ZIP-format archives. It is usually not diff --git a/Doc/library/zlib.rst b/Doc/library/zlib.rst index b7ca558932..1de7baee54 100644 --- a/Doc/library/zlib.rst +++ b/Doc/library/zlib.rst @@ -5,6 +5,7 @@ :synopsis: Low-level interface to compression and decompression routines compatible with gzip. +-------------- For applications that require data compression, the functions in this module allow compression and decompression, using the zlib library. The zlib library diff --git a/Lib/idlelib/help.html b/Lib/idlelib/help.html index ec0b218874..6f739c42ab 100644 --- a/Lib/idlelib/help.html +++ b/Lib/idlelib/help.html @@ -75,7 +75,9 @@ <div class="section" id="idle"> <span id="id1"></span><h1>25.5. IDLE<a class="headerlink" href="#idle" title="Permalink to this headline">¶</a></h1> -<p id="index-0">IDLE is Python’s Integrated Development and Learning Environment.</p> +<p><strong>Source code:</strong> <a class="reference external" href="https://hg.python.org/cpython/file/3.5/Lib/idlelib/">Lib/idlelib/</a></p> +<hr class="docutils" id="index-0" /> +<p>IDLE is Python’s Integrated Development and Learning Environment.</p> <p>IDLE has the following features:</p> <ul class="simple"> <li>coded in 100% pure Python, using the <a class="reference internal" href="tkinter.html#module-tkinter" title="tkinter: Interface to Tcl/Tk for graphical user interfaces"><code class="xref py py-mod docutils literal"><span class="pre">tkinter</span></code></a> GUI toolkit</li> @@ -701,7 +703,7 @@ are currently:</p> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> - Last updated on May 02, 2016. + Last updated on Jun 11, 2016. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.3.3. @@ -824,6 +824,7 @@ Soren Larsen Amos Latteier Piers Lauder Ben Laurie +Yoni Lavi Simon Law Julia Lawall Chris Lawrence @@ -1139,6 +1139,9 @@ IDLE Documentation ------------- +- Issue #22558: Add remaining doc links to source code for Python-coded modules. + Patch by Yoni Lavi. + - Issue #12067: Rewrite Comparisons section in the Expressions chapter of the language reference. Some of the details of comparing mixed types were incorrect or ambiguous. NotImplemented is only relevant at a lower level |