Commit fa089b9b authored by Terry Jan Reedy's avatar Terry Jan Reedy

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.
parent c92bf83a
...@@ -449,10 +449,14 @@ and off individually. They are described here in more detail. ...@@ -449,10 +449,14 @@ and off individually. They are described here in more detail.
.. module:: lib2to3 .. module:: lib2to3
:synopsis: the 2to3 library :synopsis: the 2to3 library
.. moduleauthor:: Guido van Rossum .. moduleauthor:: Guido van Rossum
.. moduleauthor:: Collin Winter .. moduleauthor:: Collin Winter
.. moduleauthor:: Benjamin Peterson <benjamin@python.org> .. moduleauthor:: Benjamin Peterson <benjamin@python.org>
**Source code:** :source:`Lib/lib2to3/`
--------------
.. note:: .. note::
......
...@@ -5,6 +5,8 @@ ...@@ -5,6 +5,8 @@
.. module:: __main__ .. module:: __main__
:synopsis: The environment where the top-level script is run. :synopsis: The environment where the top-level script is run.
--------------
``'__main__'`` is the name of the scope in which top-level code executes. ``'__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 A module's __name__ is set equal to ``'__main__'`` when read from
standard input, a script, or from an interactive prompt. standard input, a script, or from an interactive prompt.
......
...@@ -4,13 +4,14 @@ ...@@ -4,13 +4,14 @@
.. module:: _thread .. module:: _thread
:synopsis: Low-level threading API. :synopsis: Low-level threading API.
.. index:: .. index::
single: light-weight processes single: light-weight processes
single: processes, light-weight single: processes, light-weight
single: binary semaphores single: binary semaphores
single: semaphores, binary single: semaphores, binary
--------------
This module provides low-level primitives for working with multiple threads This module provides low-level primitives for working with multiple threads
(also called :dfn:`light-weight processes` or :dfn:`tasks`) --- multiple threads of (also called :dfn:`light-weight processes` or :dfn:`tasks`) --- multiple threads of
control sharing their global data space. For synchronization, simple locks control sharing their global data space. For synchronization, simple locks
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: abc .. module:: abc
:synopsis: Abstract base classes according to PEP 3119. :synopsis: Abstract base classes according to PEP 3119.
.. moduleauthor:: Guido van Rossum .. moduleauthor:: Guido van Rossum
.. sectionauthor:: Georg Brandl .. sectionauthor:: Georg Brandl
.. much of the content adapted from docstrings .. much of the content adapted from docstrings
......
...@@ -4,14 +4,13 @@ ...@@ -4,14 +4,13 @@
.. module:: aifc .. module:: aifc
:synopsis: Read and write audio files in AIFF or AIFC format. :synopsis: Read and write audio files in AIFF or AIFC format.
**Source code:** :source:`Lib/aifc.py`
.. index:: .. index::
single: Audio Interchange File Format single: Audio Interchange File Format
single: AIFF single: AIFF
single: AIFF-C single: AIFF-C
**Source code:** :source:`Lib/aifc.py`
-------------- --------------
This module provides support for reading and writing AIFF and AIFF-C files. This module provides support for reading and writing AIFF and AIFF-C files.
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: argparse .. module:: argparse
:synopsis: Command-line option and argument parsing library. :synopsis: Command-line option and argument parsing library.
.. moduleauthor:: Steven Bethard <steven.bethard@gmail.com> .. moduleauthor:: Steven Bethard <steven.bethard@gmail.com>
.. sectionauthor:: Steven Bethard <steven.bethard@gmail.com> .. sectionauthor:: Steven Bethard <steven.bethard@gmail.com>
......
...@@ -4,9 +4,10 @@ ...@@ -4,9 +4,10 @@
.. module:: array .. module:: array
:synopsis: Space efficient arrays of uniformly typed numeric values. :synopsis: Space efficient arrays of uniformly typed numeric values.
.. index:: single: arrays .. index:: single: arrays
--------------
This module defines an object type which can compactly represent an array of This module defines an object type which can compactly represent an array of
basic values: characters, integers, floating point numbers. Arrays are sequence 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 types and behave very much like lists, except that the type of objects stored in
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: asynchat .. module:: asynchat
:synopsis: Support for asynchronous command/response protocols. :synopsis: Support for asynchronous command/response protocols.
.. moduleauthor:: Sam Rushing <rushing@nightmare.com> .. moduleauthor:: Sam Rushing <rushing@nightmare.com>
.. sectionauthor:: Steve Holden <sholden@holdenweb.com> .. sectionauthor:: Steve Holden <sholden@holdenweb.com>
......
...@@ -4,6 +4,10 @@ ...@@ -4,6 +4,10 @@
.. module:: asyncio .. module:: asyncio
:synopsis: Asynchronous I/O, event loop, coroutines and tasks. :synopsis: Asynchronous I/O, event loop, coroutines and tasks.
.. versionadded:: 3.4
**Source code:** :source:`Lib/asyncio/`
.. note:: .. note::
The asyncio package has been included in the standard library on a The asyncio package has been included in the standard library on a
...@@ -11,10 +15,6 @@ ...@@ -11,10 +15,6 @@
changes (up to and including removal of the module) may occur if deemed changes (up to and including removal of the module) may occur if deemed
necessary by the core developers. necessary by the core developers.
.. versionadded:: 3.4
**Source code:** :source:`Lib/asyncio/`
-------------- --------------
This module provides infrastructure for writing single-threaded concurrent This module provides infrastructure for writing single-threaded concurrent
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
.. module:: asyncore .. module:: asyncore
:synopsis: A base class for developing asynchronous socket handling :synopsis: A base class for developing asynchronous socket handling
services. services.
.. moduleauthor:: Sam Rushing <rushing@nightmare.com> .. moduleauthor:: Sam Rushing <rushing@nightmare.com>
.. sectionauthor:: Christopher Petrilli <petrilli@amber.org> .. sectionauthor:: Christopher Petrilli <petrilli@amber.org>
.. sectionauthor:: Steve Holden <sholden@holdenweb.com> .. sectionauthor:: Steve Holden <sholden@holdenweb.com>
......
...@@ -3,9 +3,11 @@ ...@@ -3,9 +3,11 @@
.. module:: atexit .. module:: atexit
:synopsis: Register and execute cleanup functions. :synopsis: Register and execute cleanup functions.
.. moduleauthor:: Skip Montanaro <skip@pobox.com> .. moduleauthor:: Skip Montanaro <skip@pobox.com>
.. sectionauthor:: Skip Montanaro <skip@pobox.com> .. sectionauthor:: Skip Montanaro <skip@pobox.com>
--------------
The :mod:`atexit` module defines functions to register and unregister cleanup The :mod:`atexit` module defines functions to register and unregister cleanup
functions. Functions thus registered are automatically executed upon normal functions. Functions thus registered are automatically executed upon normal
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
.. module:: audioop .. module:: audioop
:synopsis: Manipulate raw audio data. :synopsis: Manipulate raw audio data.
--------------
The :mod:`audioop` module contains some useful operations on sound fragments. The :mod:`audioop` module contains some useful operations on sound fragments.
It operates on sound fragments consisting of signed integer samples 8, 16, 24 It operates on sound fragments consisting of signed integer samples 8, 16, 24
......
...@@ -5,11 +5,14 @@ ...@@ -5,11 +5,14 @@
:synopsis: RFC 3548: Base16, Base32, Base64 Data Encodings; :synopsis: RFC 3548: Base16, Base32, Base64 Data Encodings;
Base85 and Ascii85 Base85 and Ascii85
**Source code:** :source:`Lib/base64.py`
.. index:: .. index::
pair: base64; encoding pair: base64; encoding
single: MIME; base64 encoding single: MIME; base64 encoding
--------------
This module provides functions for encoding binary data to printable This module provides functions for encoding binary data to printable
ASCII characters and decoding such encodings back to binary data. ASCII characters and decoding such encodings back to binary data.
It provides encoding and decoding functions for the encodings specified in It provides encoding and decoding functions for the encodings specified in
......
...@@ -5,12 +5,13 @@ ...@@ -5,12 +5,13 @@
:synopsis: Tools for converting between binary and various ASCII-encoded binary :synopsis: Tools for converting between binary and various ASCII-encoded binary
representations. representations.
.. index:: .. index::
module: uu module: uu
module: base64 module: base64
module: binhex module: binhex
--------------
The :mod:`binascii` module contains a number of methods to convert between The :mod:`binascii` module contains a number of methods to convert between
binary and various ASCII-encoded binary representations. Normally, you will not binary and various ASCII-encoded binary representations. Normally, you will not
use these functions directly but use wrapper modules like :mod:`uu`, use these functions directly but use wrapper modules like :mod:`uu`,
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: binhex .. module:: binhex
:synopsis: Encode and decode files in binhex4 format. :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 This module encodes and decodes files in binhex4 format, a format allowing
representation of Macintosh files in ASCII. Only the data fork is handled. representation of Macintosh files in ASCII. Only the data fork is handled.
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
.. module:: builtins .. module:: builtins
:synopsis: The module that provides the built-in namespace. :synopsis: The module that provides the built-in namespace.
--------------
This module provides direct access to all 'built-in' identifiers of Python; for 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 example, ``builtins.open`` is the full name for the built-in function
......
...@@ -3,11 +3,15 @@ ...@@ -3,11 +3,15 @@
.. module:: bz2 .. module:: bz2
:synopsis: Interfaces for bzip2 compression and decompression. :synopsis: Interfaces for bzip2 compression and decompression.
.. moduleauthor:: Gustavo Niemeyer <niemeyer@conectiva.com> .. moduleauthor:: Gustavo Niemeyer <niemeyer@conectiva.com>
.. moduleauthor:: Nadeem Vawda <nadeem.vawda@gmail.com> .. moduleauthor:: Nadeem Vawda <nadeem.vawda@gmail.com>
.. sectionauthor:: Gustavo Niemeyer <niemeyer@conectiva.com> .. sectionauthor:: Gustavo Niemeyer <niemeyer@conectiva.com>
.. sectionauthor:: Nadeem Vawda <nadeem.vawda@gmail.com> .. sectionauthor:: Nadeem Vawda <nadeem.vawda@gmail.com>
**Source code:** :source:`Lib/bz2.py`
--------------
This module provides a comprehensive interface for compressing and This module provides a comprehensive interface for compressing and
decompressing data using the bzip2 compression algorithm. decompressing data using the bzip2 compression algorithm.
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
.. module:: calendar .. module:: calendar
:synopsis: Functions for working with calendars, including some emulation :synopsis: Functions for working with calendars, including some emulation
of the Unix cal program. of the Unix cal program.
.. sectionauthor:: Drew Csillag <drew_csillag@geocities.com> .. sectionauthor:: Drew Csillag <drew_csillag@geocities.com>
**Source code:** :source:`Lib/calendar.py` **Source code:** :source:`Lib/calendar.py`
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
.. module:: cgi .. module:: cgi
:synopsis: Helpers for running Python scripts via the Common Gateway Interface. :synopsis: Helpers for running Python scripts via the Common Gateway Interface.
**Source code:** :source:`Lib/cgi.py`
.. index:: .. index::
pair: WWW; server pair: WWW; server
...@@ -13,8 +14,6 @@ ...@@ -13,8 +14,6 @@
single: URL single: URL
single: Common Gateway Interface single: Common Gateway Interface
**Source code:** :source:`Lib/cgi.py`
-------------- --------------
Support module for Common Gateway Interface (CGI) scripts. Support module for Common Gateway Interface (CGI) scripts.
......
...@@ -3,9 +3,11 @@ ...@@ -3,9 +3,11 @@
.. module:: cgitb .. module:: cgitb
:synopsis: Configurable traceback handler for CGI scripts. :synopsis: Configurable traceback handler for CGI scripts.
.. moduleauthor:: Ka-Ping Yee <ping@lfw.org> .. moduleauthor:: Ka-Ping Yee <ping@lfw.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
**Source code:** :source:`Lib/cgitb.py`
.. index:: .. index::
single: CGI; exceptions single: CGI; exceptions
...@@ -13,6 +15,8 @@ ...@@ -13,6 +15,8 @@
single: exceptions; in CGI scripts single: exceptions; in CGI scripts
single: tracebacks; in CGI scripts single: tracebacks; in CGI scripts
--------------
The :mod:`cgitb` module provides a special exception handler for Python 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 (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 traceback information in HTML for CGI scripts. It was later generalized to also
......
...@@ -3,9 +3,11 @@ ...@@ -3,9 +3,11 @@
.. module:: chunk .. module:: chunk
:synopsis: Module to read IFF chunks. :synopsis: Module to read IFF chunks.
.. moduleauthor:: Sjoerd Mullender <sjoerd@acm.org> .. moduleauthor:: Sjoerd Mullender <sjoerd@acm.org>
.. sectionauthor:: Sjoerd Mullender <sjoerd@acm.org> .. sectionauthor:: Sjoerd Mullender <sjoerd@acm.org>
**Source code:** :source:`Lib/chunk.py`
.. index:: .. index::
single: Audio Interchange File Format single: Audio Interchange File Format
...@@ -14,6 +16,8 @@ ...@@ -14,6 +16,8 @@
single: Real Media File Format single: Real Media File Format
single: RMFF single: RMFF
--------------
This module provides an interface for reading files that use EA IFF 85 chunks. 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 [#]_ 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 (AIFF/AIFF-C) and the Real Media File Format (RMFF). The WAVE audio file format
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
.. module:: cmath .. module:: cmath
:synopsis: Mathematical functions for complex numbers. :synopsis: Mathematical functions for complex numbers.
--------------
This module is always available. It provides access to mathematical functions This module is always available. It provides access to mathematical functions
for complex numbers. The functions in this module accept integers, for complex numbers. The functions in this module accept integers,
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: cmd .. module:: cmd
:synopsis: Build line-oriented command interpreters. :synopsis: Build line-oriented command interpreters.
.. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com> .. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com>
**Source code:** :source:`Lib/cmd.py` **Source code:** :source:`Lib/cmd.py`
......
...@@ -6,6 +6,8 @@ ...@@ -6,6 +6,8 @@
**Source code:** :source:`Lib/code.py` **Source code:** :source:`Lib/code.py`
--------------
The ``code`` module provides facilities to implement read-eval-print loops in 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 Python. Two classes and convenience functions are included which can be used to
build applications which provide an interactive interpreter prompt. build applications which provide an interactive interpreter prompt.
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: codecs .. module:: codecs
:synopsis: Encode and decode data and streams. :synopsis: Encode and decode data and streams.
.. moduleauthor:: Marc-André Lemburg <mal@lemburg.com> .. moduleauthor:: Marc-André Lemburg <mal@lemburg.com>
.. sectionauthor:: Marc-André Lemburg <mal@lemburg.com> .. sectionauthor:: Marc-André Lemburg <mal@lemburg.com>
.. sectionauthor:: Martin v. Löwis <martin@v.loewis.de> .. sectionauthor:: Martin v. Löwis <martin@v.loewis.de>
...@@ -17,6 +18,8 @@ ...@@ -17,6 +18,8 @@
single: streams single: streams
pair: stackable; streams pair: stackable; streams
--------------
This module defines base classes for standard Python codecs (encoders and This module defines base classes for standard Python codecs (encoders and
decoders) and provides access to the internal Python codec registry, which decoders) and provides access to the internal Python codec registry, which
manages the codec and error handling lookup process. Most standard codecs manages the codec and error handling lookup process. Most standard codecs
......
...@@ -3,9 +3,14 @@ ...@@ -3,9 +3,14 @@
.. module:: codeop .. module:: codeop
:synopsis: Compile (possibly incomplete) Python code. :synopsis: Compile (possibly incomplete) Python code.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. sectionauthor:: Michael Hudson <mwh@python.net> .. sectionauthor:: Michael Hudson <mwh@python.net>
**Source code:** :source:`Lib/codeop.py`
--------------
The :mod:`codeop` module provides utilities upon which the Python 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 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 a result, you probably don't want to use the module directly; if you want to
......
...@@ -3,20 +3,21 @@ ...@@ -3,20 +3,21 @@
.. module:: collections.abc .. module:: collections.abc
:synopsis: Abstract base classes for containers :synopsis: Abstract base classes for containers
.. moduleauthor:: Raymond Hettinger <python at rcn.com> .. moduleauthor:: Raymond Hettinger <python at rcn.com>
.. sectionauthor:: Raymond Hettinger <python at rcn.com> .. sectionauthor:: Raymond Hettinger <python at rcn.com>
.. versionadded:: 3.3 .. versionadded:: 3.3
Formerly, this module was part of the :mod:`collections` module. Formerly, this module was part of the :mod:`collections` module.
**Source code:** :source:`Lib/_collections_abc.py`
.. testsetup:: * .. testsetup:: *
from collections import * from collections import *
import itertools import itertools
__name__ = '<doctest>' __name__ = '<doctest>'
**Source code:** :source:`Lib/_collections_abc.py`
-------------- --------------
This module provides :term:`abstract base classes <abstract base class>` that This module provides :term:`abstract base classes <abstract base class>` that
......
...@@ -3,17 +3,18 @@ ...@@ -3,17 +3,18 @@
.. module:: collections .. module:: collections
:synopsis: Container datatypes :synopsis: Container datatypes
.. moduleauthor:: Raymond Hettinger <python@rcn.com> .. moduleauthor:: Raymond Hettinger <python@rcn.com>
.. sectionauthor:: Raymond Hettinger <python@rcn.com> .. sectionauthor:: Raymond Hettinger <python@rcn.com>
**Source code:** :source:`Lib/collections/__init__.py`
.. testsetup:: * .. testsetup:: *
from collections import * from collections import *
import itertools import itertools
__name__ = '<doctest>' __name__ = '<doctest>'
**Source code:** :source:`Lib/collections/__init__.py`
-------------- --------------
This module implements specialized container datatypes providing alternatives to This module implements specialized container datatypes providing alternatives to
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: colorsys .. module:: colorsys
:synopsis: Conversion functions between RGB and other color systems. :synopsis: Conversion functions between RGB and other color systems.
.. sectionauthor:: David Ascher <da@python.net> .. sectionauthor:: David Ascher <da@python.net>
**Source code:** :source:`Lib/colorsys.py` **Source code:** :source:`Lib/colorsys.py`
......
...@@ -8,7 +8,6 @@ ...@@ -8,7 +8,6 @@
-------------- --------------
This module provides some utility functions to support installing Python This module provides some utility functions to support installing Python
libraries. These functions compile Python source files in a directory tree. 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 This module can be used to create the cached byte-code files at library
......
...@@ -19,6 +19,8 @@ ...@@ -19,6 +19,8 @@
single: ini file single: ini file
single: Windows ini file single: Windows ini file
--------------
This module provides the :class:`ConfigParser` class which implements a basic This module provides the :class:`ConfigParser` class which implements a basic
configuration language which provides a structure similar to what's found in 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 Microsoft Windows INI files. You can use this to write Python programs which
......
...@@ -4,6 +4,10 @@ ...@@ -4,6 +4,10 @@
.. module:: copy .. module:: copy
:synopsis: Shallow and deep copy operations. :synopsis: Shallow and deep copy operations.
**Source code:** :source:`Lib/copy.py`
--------------
Assignment statements in Python do not copy objects, they create bindings Assignment statements in Python do not copy objects, they create bindings
between a target and an object. For collections that are mutable or contain 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 mutable items, a copy is sometimes needed so one can change one copy without
......
...@@ -4,11 +4,14 @@ ...@@ -4,11 +4,14 @@
.. module:: copyreg .. module:: copyreg
:synopsis: Register pickle support functions. :synopsis: Register pickle support functions.
**Source code:** :source:`Lib/copyreg.py`
.. index:: .. index::
module: pickle module: pickle
module: copy module: copy
--------------
The :mod:`copyreg` module offers a way to define functions used while pickling 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 specific objects. The :mod:`pickle` and :mod:`copy` modules use those functions
when pickling/copying those objects. The module provides configuration when pickling/copying those objects. The module provides configuration
......
...@@ -4,15 +4,19 @@ ...@@ -4,15 +4,19 @@
.. module:: crypt .. module:: crypt
:platform: Unix :platform: Unix
:synopsis: The crypt() function used to check Unix passwords. :synopsis: The crypt() function used to check Unix passwords.
.. moduleauthor:: Steven D. Majewski <sdm7g@virginia.edu> .. moduleauthor:: Steven D. Majewski <sdm7g@virginia.edu>
.. sectionauthor:: Steven D. Majewski <sdm7g@virginia.edu> .. sectionauthor:: Steven D. Majewski <sdm7g@virginia.edu>
.. sectionauthor:: Peter Funk <pf@artcom-gmbh.de> .. sectionauthor:: Peter Funk <pf@artcom-gmbh.de>
**Source code:** :source:`Lib/crypt.py`
.. index:: .. index::
single: crypt(3) single: crypt(3)
pair: cipher; DES pair: cipher; DES
--------------
This module implements an interface to the :manpage:`crypt(3)` routine, which is 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 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 page for further details. Possible uses include storing hashed passwords
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: csv .. module:: csv
:synopsis: Write and read tabular data to and from delimited files. :synopsis: Write and read tabular data to and from delimited files.
.. sectionauthor:: Skip Montanaro <skip@pobox.com> .. sectionauthor:: Skip Montanaro <skip@pobox.com>
**Source code:** :source:`Lib/csv.py` **Source code:** :source:`Lib/csv.py`
...@@ -11,6 +12,8 @@ ...@@ -11,6 +12,8 @@
single: csv single: csv
pair: data; tabular pair: data; tabular
--------------
The so-called CSV (Comma Separated Values) format is the most common import and 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 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 years prior to attempts to describe the format in a standardized way in
......
...@@ -3,8 +3,10 @@ ...@@ -3,8 +3,10 @@
.. module:: ctypes .. module:: ctypes
:synopsis: A foreign function library for Python. :synopsis: A foreign function library for Python.
.. moduleauthor:: Thomas Heller <theller@python.net> .. moduleauthor:: Thomas Heller <theller@python.net>
--------------
:mod:`ctypes` is a foreign function library for Python. It provides C compatible :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 data types, and allows calling functions in DLLs or shared libraries. It can be
......
...@@ -3,9 +3,11 @@ ...@@ -3,9 +3,11 @@
.. module:: curses.ascii .. module:: curses.ascii
:synopsis: Constants and set-membership functions for ASCII characters. :synopsis: Constants and set-membership functions for ASCII characters.
.. moduleauthor:: Eric S. Raymond <esr@thyrsus.com> .. moduleauthor:: Eric S. Raymond <esr@thyrsus.com>
.. sectionauthor:: 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 The :mod:`curses.ascii` module supplies name constants for ASCII characters and
functions to test membership in various ASCII character classes. The constants functions to test membership in various ASCII character classes. The constants
......
...@@ -3,8 +3,10 @@ ...@@ -3,8 +3,10 @@
.. module:: curses.panel .. module:: curses.panel
:synopsis: A panel stack extension that adds depth to curses windows. :synopsis: A panel stack extension that adds depth to curses windows.
.. sectionauthor:: A.M. Kuchling <amk@amk.ca> .. sectionauthor:: A.M. Kuchling <amk@amk.ca>
--------------
Panels are windows with the added feature of depth, so they can be stacked on 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 top of each other, and only the visible portions of each window will be
......
...@@ -5,9 +5,12 @@ ...@@ -5,9 +5,12 @@
:synopsis: An interface to the curses library, providing portable :synopsis: An interface to the curses library, providing portable
terminal handling. terminal handling.
:platform: Unix :platform: Unix
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. sectionauthor:: Eric Raymond <esr@thyrsus.com> .. sectionauthor:: Eric Raymond <esr@thyrsus.com>
--------------
The :mod:`curses` module provides an interface to the curses library, the The :mod:`curses` module provides an interface to the curses library, the
de-facto standard for portable advanced terminal handling. de-facto standard for portable advanced terminal handling.
......
...@@ -3,12 +3,15 @@ ...@@ -3,12 +3,15 @@
.. module:: datetime .. module:: datetime
:synopsis: Basic date and time types. :synopsis: Basic date and time types.
.. moduleauthor:: Tim Peters <tim@zope.com> .. moduleauthor:: Tim Peters <tim@zope.com>
.. sectionauthor:: Tim Peters <tim@zope.com> .. sectionauthor:: Tim Peters <tim@zope.com>
.. sectionauthor:: A.M. Kuchling <amk@amk.ca> .. sectionauthor:: A.M. Kuchling <amk@amk.ca>
**Source code:** :source:`Lib/datetime.py` **Source code:** :source:`Lib/datetime.py`
--------------
.. XXX what order should the types be discussed in? .. XXX what order should the types be discussed in?
The :mod:`datetime` module supplies classes for manipulating dates and times in The :mod:`datetime` module supplies classes for manipulating dates and times in
......
...@@ -4,6 +4,10 @@ ...@@ -4,6 +4,10 @@
.. module:: dbm .. module:: dbm
:synopsis: Interfaces to various Unix "database" formats. :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` 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 :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 slow-but-simple implementation in module :mod:`dbm.dumb` will be used. There
......
...@@ -23,6 +23,8 @@ ...@@ -23,6 +23,8 @@
# make sure each group gets a fresh context # make sure each group gets a fresh context
setcontext(Context()) setcontext(Context())
--------------
The :mod:`decimal` module provides support for fast correctly-rounded The :mod:`decimal` module provides support for fast correctly-rounded
decimal floating point arithmetic. It offers several advantages over the decimal floating point arithmetic. It offers several advantages over the
:class:`float` datatype: :class:`float` datatype:
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: difflib .. module:: difflib
:synopsis: Helpers for computing differences between objects. :synopsis: Helpers for computing differences between objects.
.. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net> .. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net>
.. sectionauthor:: Tim Peters <tim_one@users.sourceforge.net> .. sectionauthor:: Tim Peters <tim_one@users.sourceforge.net>
.. Markup by Fred L. Drake, Jr. <fdrake@acm.org> .. Markup by Fred L. Drake, Jr. <fdrake@acm.org>
...@@ -14,6 +15,8 @@ ...@@ -14,6 +15,8 @@
import sys import sys
from difflib import * from difflib import *
--------------
This module provides classes and functions for comparing sequences. It This module provides classes and functions for comparing sequences. It
can be used for example, for comparing files, and can produce difference can be used for example, for comparing files, and can produce difference
information in various formats, including HTML and context and unified information in various formats, including HTML and context and unified
......
...@@ -4,8 +4,10 @@ ...@@ -4,8 +4,10 @@
.. module:: distutils .. module:: distutils
:synopsis: Support for building and installing Python modules into an :synopsis: Support for building and installing Python modules into an
existing Python installation. existing Python installation.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
--------------
The :mod:`distutils` package provides support for building and installing The :mod:`distutils` package provides support for building and installing
additional modules into a Python installation. The new modules may be either additional modules into a Python installation. The new modules may be either
......
...@@ -5,11 +5,15 @@ ...@@ -5,11 +5,15 @@
.. module:: doctest .. module:: doctest
:synopsis: Test pieces of code within docstrings. :synopsis: Test pieces of code within docstrings.
.. moduleauthor:: Tim Peters <tim@python.org> .. moduleauthor:: Tim Peters <tim@python.org>
.. sectionauthor:: Tim Peters <tim@python.org> .. sectionauthor:: Tim Peters <tim@python.org>
.. sectionauthor:: Moshe Zadka <moshez@debian.org> .. sectionauthor:: Moshe Zadka <moshez@debian.org>
.. sectionauthor:: Edward Loper <edloper@users.sourceforge.net> .. 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 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 Python sessions, and then executes those sessions to verify that they work
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.charset .. module:: email.charset
:synopsis: Character Sets :synopsis: Character Sets
**Source code:** :source:`Lib/email/charset.py`
--------------
This module provides a class :class:`Charset` for representing character sets This module provides a class :class:`Charset` for representing character sets
and character set conversions in email messages, as well as a character set and character set conversions in email messages, as well as a character set
......
...@@ -7,6 +7,10 @@ ...@@ -7,6 +7,10 @@
.. moduleauthor:: R. David Murray <rdmurray@bitdance.com> .. moduleauthor:: R. David Murray <rdmurray@bitdance.com>
.. sectionauthor:: 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:: .. note::
...@@ -15,8 +19,7 @@ ...@@ -15,8 +19,7 @@
changes (up to and including removal of the module) may occur if deemed changes (up to and including removal of the module) may occur if deemed
necessary by the core developers. 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 The :mod:`~email.message` module provides a class that can represent an
arbitrary email message. That basic message model has a useful and flexible arbitrary email message. That basic message model has a useful and flexible
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.encoders .. module:: email.encoders
:synopsis: Encoders for email message payloads. :synopsis: Encoders for email message payloads.
**Source code:** :source:`Lib/email/encoders.py`
--------------
When creating :class:`~email.message.Message` objects from scratch, you often When creating :class:`~email.message.Message` objects from scratch, you often
need to encode the payloads for transport through compliant mail servers. This need to encode the payloads for transport through compliant mail servers. This
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.errors .. module:: email.errors
:synopsis: The exception classes used by the email package. :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: The following exception classes are defined in the :mod:`email.errors` module:
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.generator .. module:: email.generator
:synopsis: Generate flat text email messages from a message structure. :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 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 represented by a message object structure. You will need to do this if you want
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.header .. module:: email.header
:synopsis: Representing non-ASCII headers :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. :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 It derives from the older :rfc:`822` standard which came into widespread use at
......
...@@ -7,6 +7,10 @@ ...@@ -7,6 +7,10 @@
.. moduleauthor:: R. David Murray <rdmurray@bitdance.com> .. moduleauthor:: R. David Murray <rdmurray@bitdance.com>
.. sectionauthor:: 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:: .. note::
...@@ -15,8 +19,7 @@ ...@@ -15,8 +19,7 @@
changes (up to and including removal of the module) may occur if deemed changes (up to and including removal of the module) may occur if deemed
necessary by the core developers. 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 Headers are represented by customized subclasses of :class:`str`. The
particular class used to represent a given header is determined by the particular class used to represent a given header is determined by the
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.iterators .. module:: email.iterators
:synopsis: Iterate over a message object tree. :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 Iterating over a message object tree is fairly easy with the
:meth:`Message.walk <email.message.Message.walk>` method. The :meth:`Message.walk <email.message.Message.walk>` method. The
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.message .. module:: email.message
:synopsis: The base class representing email messages. :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, 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 imported from the :mod:`email.message` module. It is the base class for the
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.mime .. module:: email.mime
:synopsis: Build MIME messages. :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 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 a parser, which parses the text and returns the root message object. However
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.parser .. module:: email.parser
:synopsis: Parse flat text email messages to produce a message object structure. :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 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 from whole cloth by instantiating :class:`~email.message.Message` objects and
......
...@@ -9,6 +9,9 @@ ...@@ -9,6 +9,9 @@
.. versionadded:: 3.3 .. versionadded:: 3.3
**Source code:** :source:`Lib/email/policy.py`
--------------
The :mod:`email` package's prime focus is the handling of email messages as 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 described by the various email and MIME RFCs. However, the general format of
......
...@@ -4,10 +4,14 @@ ...@@ -4,10 +4,14 @@
.. module:: email .. module:: email
:synopsis: Package supporting the parsing, manipulating, and generating :synopsis: Package supporting the parsing, manipulating, and generating
email messages, including MIME documents. email messages, including MIME documents.
.. moduleauthor:: Barry A. Warsaw <barry@python.org> .. moduleauthor:: Barry A. Warsaw <barry@python.org>
.. sectionauthor:: Barry A. Warsaw <barry@python.org> .. sectionauthor:: Barry A. Warsaw <barry@python.org>
.. Copyright (C) 2001-2010 Python Software Foundation .. 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 The :mod:`email` package is a library for managing email messages, including
MIME and other :rfc:`2822`\ -based message documents. It is specifically *not* MIME and other :rfc:`2822`\ -based message documents. It is specifically *not*
......
...@@ -4,6 +4,9 @@ ...@@ -4,6 +4,9 @@
.. module:: email.utils .. module:: email.utils
:synopsis: Miscellaneous email package utilities. :synopsis: Miscellaneous email package utilities.
**Source code:** :source:`Lib/email/utils.py`
--------------
There are several useful utilities provided in the :mod:`email.utils` module: There are several useful utilities provided in the :mod:`email.utils` module:
......
...@@ -7,6 +7,8 @@ ...@@ -7,6 +7,8 @@
.. versionadded:: 3.4 .. versionadded:: 3.4
--------------
The :mod:`ensurepip` package provides support for bootstrapping the ``pip`` The :mod:`ensurepip` package provides support for bootstrapping the ``pip``
installer into an existing Python installation or virtual environment. This installer into an existing Python installation or virtual environment. This
bootstrapping approach reflects the fact that ``pip`` is an independent bootstrapping approach reflects the fact that ``pip`` is an independent
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
.. module:: errno .. module:: errno
:synopsis: Standard errno system symbols. :synopsis: Standard errno system symbols.
----------------
This module makes available standard ``errno`` system symbols. The value of each This module makes available standard ``errno`` system symbols. The value of each
symbol is the corresponding integer value. The names and descriptions are symbol is the corresponding integer value. The names and descriptions are
......
...@@ -6,6 +6,8 @@ ...@@ -6,6 +6,8 @@
.. versionadded:: 3.3 .. versionadded:: 3.3
----------------
This module contains functions to dump Python tracebacks explicitly, on a fault, 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 after a timeout, or on a user signal. Call :func:`faulthandler.enable` to
install fault handlers for the :const:`SIGSEGV`, :const:`SIGFPE`, install fault handlers for the :const:`SIGSEGV`, :const:`SIGFPE`,
......
...@@ -4,13 +4,15 @@ ...@@ -4,13 +4,15 @@
.. module:: fcntl .. module:: fcntl
:platform: Unix :platform: Unix
:synopsis: The fcntl() and ioctl() system calls. :synopsis: The fcntl() and ioctl() system calls.
.. sectionauthor:: Jaap Vermeulen
.. sectionauthor:: Jaap Vermeulen
.. index:: .. index::
pair: UNIX; file control pair: UNIX; file control
pair: UNIX; I/O control pair: UNIX; I/O control
----------------
This module performs file control and I/O control on file descriptors. It is an 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 interface to the :c:func:`fcntl` and :c:func:`ioctl` Unix routines. For a
complete description of these calls, see :manpage:`fcntl(2)` and complete description of these calls, see :manpage:`fcntl(2)` and
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: filecmp .. module:: filecmp
:synopsis: Compare files efficiently. :synopsis: Compare files efficiently.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
**Source code:** :source:`Lib/filecmp.py` **Source code:** :source:`Lib/filecmp.py`
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: fileinput .. module:: fileinput
:synopsis: Loop over standard input or a list of files. :synopsis: Loop over standard input or a list of files.
.. moduleauthor:: Guido van Rossum <guido@python.org> .. moduleauthor:: Guido van Rossum <guido@python.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
......
...@@ -4,13 +4,12 @@ ...@@ -4,13 +4,12 @@
.. module:: fnmatch .. module:: fnmatch
:synopsis: Unix shell style filename pattern matching. :synopsis: Unix shell style filename pattern matching.
**Source code:** :source:`Lib/fnmatch.py`
.. index:: single: filenames; wildcard expansion .. index:: single: filenames; wildcard expansion
.. index:: module: re .. index:: module: re
**Source code:** :source:`Lib/fnmatch.py`
-------------- --------------
This module provides support for Unix shell-style wildcards, which are *not* the This module provides support for Unix shell-style wildcards, which are *not* the
......
...@@ -8,6 +8,7 @@ ...@@ -8,6 +8,7 @@
.. deprecated:: 3.4 .. deprecated:: 3.4
Due to lack of usage, the formatter module has been deprecated. Due to lack of usage, the formatter module has been deprecated.
--------------
This module supports two interface definitions, each with multiple This module supports two interface definitions, each with multiple
implementations: The *formatter* interface, and the *writer* interface which is implementations: The *formatter* interface, and the *writer* interface which is
......
...@@ -4,10 +4,10 @@ ...@@ -4,10 +4,10 @@
.. module:: fpectl .. module:: fpectl
:platform: Unix :platform: Unix
:synopsis: Provide control for floating point exception handling. :synopsis: Provide control for floating point exception handling.
.. moduleauthor:: Lee Busby <busby1@llnl.gov> .. moduleauthor:: Lee Busby <busby1@llnl.gov>
.. sectionauthor:: Lee Busby <busby1@llnl.gov> .. sectionauthor:: Lee Busby <busby1@llnl.gov>
.. note:: .. note::
The :mod:`fpectl` module is not built by default, and its usage is discouraged The :mod:`fpectl` module is not built by default, and its usage is discouraged
...@@ -16,6 +16,8 @@ ...@@ -16,6 +16,8 @@
.. index:: single: IEEE-754 .. index:: single: IEEE-754
--------------
Most computers carry out floating point operations in conformance with the Most computers carry out floating point operations in conformance with the
so-called IEEE-754 standard. On any real computer, some floating point so-called IEEE-754 standard. On any real computer, some floating point
operations produce results that cannot be expressed as a normal floating point operations produce results that cannot be expressed as a normal floating point
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: fractions .. module:: fractions
:synopsis: Rational numbers. :synopsis: Rational numbers.
.. moduleauthor:: Jeffrey Yasskin <jyasskin at gmail.com> .. moduleauthor:: Jeffrey Yasskin <jyasskin at gmail.com>
.. sectionauthor:: Jeffrey Yasskin <jyasskin at gmail.com> .. sectionauthor:: Jeffrey Yasskin <jyasskin at gmail.com>
......
...@@ -4,13 +4,12 @@ ...@@ -4,13 +4,12 @@
.. module:: ftplib .. module:: ftplib
:synopsis: FTP protocol client (requires sockets). :synopsis: FTP protocol client (requires sockets).
**Source code:** :source:`Lib/ftplib.py`
.. index:: .. index::
pair: FTP; protocol pair: FTP; protocol
single: FTP; ftplib (standard module) single: FTP; ftplib (standard module)
**Source code:** :source:`Lib/ftplib.py`
-------------- --------------
This module defines the class :class:`FTP` and a few related items. The This module defines the class :class:`FTP` and a few related items. The
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: functools .. module:: functools
:synopsis: Higher-order functions and operations on callable objects. :synopsis: Higher-order functions and operations on callable objects.
.. moduleauthor:: Peter Harris <scav@blueyonder.co.uk> .. moduleauthor:: Peter Harris <scav@blueyonder.co.uk>
.. moduleauthor:: Raymond Hettinger <python@rcn.com> .. moduleauthor:: Raymond Hettinger <python@rcn.com>
.. moduleauthor:: Nick Coghlan <ncoghlan@gmail.com> .. moduleauthor:: Nick Coghlan <ncoghlan@gmail.com>
......
...@@ -3,9 +3,11 @@ ...@@ -3,9 +3,11 @@
.. module:: gc .. module:: gc
:synopsis: Interface to the cycle-detecting garbage collector. :synopsis: Interface to the cycle-detecting garbage collector.
.. moduleauthor:: Neil Schemenauer <nas@arctrix.com> .. moduleauthor:: Neil Schemenauer <nas@arctrix.com>
.. sectionauthor:: Neil Schemenauer <nas@arctrix.com> .. sectionauthor:: Neil Schemenauer <nas@arctrix.com>
--------------
This module provides an interface to the optional garbage collector. It This module provides an interface to the optional garbage collector. It
provides the ability to disable the collector, tune the collection frequency, provides the ability to disable the collector, tune the collection frequency,
......
...@@ -7,8 +7,6 @@ ...@@ -7,8 +7,6 @@
**Source code:** :source:`Lib/getopt.py` **Source code:** :source:`Lib/getopt.py`
--------------
.. note:: .. note::
The :mod:`getopt` module is a parser for command line options whose API is The :mod:`getopt` module is a parser for command line options whose API is
...@@ -17,6 +15,8 @@ ...@@ -17,6 +15,8 @@
less code and get better help and error messages should consider using the less code and get better help and error messages should consider using the
:mod:`argparse` module instead. :mod:`argparse` module instead.
--------------
This module helps scripts to parse the command line arguments in ``sys.argv``. 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 It supports the same conventions as the Unix :c:func:`getopt` function (including
the special meanings of arguments of the form '``-``' and '``--``'). Long the special meanings of arguments of the form '``-``' and '``--``'). Long
......
...@@ -3,10 +3,15 @@ ...@@ -3,10 +3,15 @@
.. module:: getpass .. module:: getpass
:synopsis: Portable reading of passwords and retrieval of the userid. :synopsis: Portable reading of passwords and retrieval of the userid.
.. moduleauthor:: Piers Lauder <piers@cs.su.oz.au> .. moduleauthor:: Piers Lauder <piers@cs.su.oz.au>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. Windows (& Mac?) support by Guido van Rossum. .. Windows (& Mac?) support by Guido van Rossum.
**Source code:** :source:`Lib/getpass.py`
--------------
The :mod:`getpass` module provides two functions: The :mod:`getpass` module provides two functions:
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: gettext .. module:: gettext
:synopsis: Multilingual internationalization services. :synopsis: Multilingual internationalization services.
.. moduleauthor:: Barry A. Warsaw <barry@python.org> .. moduleauthor:: Barry A. Warsaw <barry@python.org>
.. sectionauthor:: Barry A. Warsaw <barry@python.org> .. sectionauthor:: Barry A. Warsaw <barry@python.org>
......
...@@ -4,11 +4,10 @@ ...@@ -4,11 +4,10 @@
.. module:: glob .. module:: glob
:synopsis: Unix shell style pathname pattern expansion. :synopsis: Unix shell style pathname pattern expansion.
**Source code:** :source:`Lib/glob.py`
.. index:: single: filenames; pathname expansion .. index:: single: filenames; pathname expansion
**Source code:** :source:`Lib/glob.py`
-------------- --------------
The :mod:`glob` module finds all the pathnames matching a specified pattern The :mod:`glob` module finds all the pathnames matching a specified pattern
......
...@@ -5,6 +5,7 @@ ...@@ -5,6 +5,7 @@
:platform: Unix :platform: Unix
:synopsis: The group database (getgrnam() and friends). :synopsis: The group database (getgrnam() and friends).
--------------
This module provides access to the Unix group database. It is available on all This module provides access to the Unix group database. It is available on all
Unix versions. Unix versions.
......
...@@ -3,16 +3,16 @@ ...@@ -3,16 +3,16 @@
.. module:: hashlib .. module:: hashlib
:synopsis: Secure hash and message digest algorithms. :synopsis: Secure hash and message digest algorithms.
.. moduleauthor:: Gregory P. Smith <greg@krypto.org> .. moduleauthor:: Gregory P. Smith <greg@krypto.org>
.. sectionauthor:: Gregory P. Smith <greg@krypto.org> .. sectionauthor:: Gregory P. Smith <greg@krypto.org>
**Source code:** :source:`Lib/hashlib.py`
.. index:: .. index::
single: message digest, MD5 single: message digest, MD5
single: secure hash algorithm, SHA1, SHA224, SHA256, SHA384, SHA512 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 This module implements a common interface to many different secure hash and
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: heapq .. module:: heapq
:synopsis: Heap queue algorithm (a.k.a. priority queue). :synopsis: Heap queue algorithm (a.k.a. priority queue).
.. moduleauthor:: Kevin O'Connor .. moduleauthor:: Kevin O'Connor
.. sectionauthor:: Guido van Rossum <guido@python.org> .. sectionauthor:: Guido van Rossum <guido@python.org>
.. sectionauthor:: François Pinard .. sectionauthor:: François Pinard
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: hmac .. module:: hmac
:synopsis: Keyed-Hashing for Message Authentication (HMAC) implementation :synopsis: Keyed-Hashing for Message Authentication (HMAC) implementation
.. moduleauthor:: Gerhard Häring <ghaering@users.sourceforge.net> .. moduleauthor:: Gerhard Häring <ghaering@users.sourceforge.net>
.. sectionauthor:: Gerhard Häring <ghaering@users.sourceforge.net> .. sectionauthor:: Gerhard Häring <ghaering@users.sourceforge.net>
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: html.entities .. module:: html.entities
:synopsis: Definitions of HTML general entities. :synopsis: Definitions of HTML general entities.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
**Source code:** :source:`Lib/html/entities.py` **Source code:** :source:`Lib/html/entities.py`
......
...@@ -4,13 +4,12 @@ ...@@ -4,13 +4,12 @@
.. module:: html.parser .. module:: html.parser
:synopsis: A simple parser that can handle HTML and XHTML. :synopsis: A simple parser that can handle HTML and XHTML.
**Source code:** :source:`Lib/html/parser.py`
.. index:: .. index::
single: HTML single: HTML
single: XHTML single: XHTML
**Source code:** :source:`Lib/html/parser.py`
-------------- --------------
This module defines a class :class:`HTMLParser` which serves as the basis for This module defines a class :class:`HTMLParser` which serves as the basis for
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
.. module:: http.client .. module:: http.client
:synopsis: HTTP and HTTPS protocol client (requires sockets). :synopsis: HTTP and HTTPS protocol client (requires sockets).
**Source code:** :source:`Lib/http/client.py`
.. index:: .. index::
pair: HTTP; protocol pair: HTTP; protocol
...@@ -11,8 +12,6 @@ ...@@ -11,8 +12,6 @@
.. index:: module: urllib.request .. index:: module: urllib.request
**Source code:** :source:`Lib/http/client.py`
-------------- --------------
This module defines classes which implement the client side of the HTTP and This module defines classes which implement the client side of the HTTP and
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: http.cookiejar .. module:: http.cookiejar
:synopsis: Classes for automatic handling of HTTP cookies. :synopsis: Classes for automatic handling of HTTP cookies.
.. moduleauthor:: John J. Lee <jjl@pobox.com> .. moduleauthor:: John J. Lee <jjl@pobox.com>
.. sectionauthor:: John J. Lee <jjl@pobox.com> .. sectionauthor:: John J. Lee <jjl@pobox.com>
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: http.cookies .. module:: http.cookies
:synopsis: Support for HTTP state management (cookies). :synopsis: Support for HTTP state management (cookies).
.. moduleauthor:: Timothy O'Malley <timo@alum.mit.edu> .. moduleauthor:: Timothy O'Malley <timo@alum.mit.edu>
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
......
...@@ -4,11 +4,13 @@ ...@@ -4,11 +4,13 @@
.. module:: http .. module:: http
:synopsis: HTTP status codes and messages :synopsis: HTTP status codes and messages
**Source code:** :source:`Lib/http/__init__.py`
.. index:: .. index::
pair: HTTP; protocol pair: HTTP; protocol
single: HTTP; http (standard module) 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 :mod:`http` is a package that collects several modules for working with the
HyperText Transfer Protocol: HyperText Transfer Protocol:
......
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
.. module:: http.server .. module:: http.server
:synopsis: HTTP server and request handlers. :synopsis: HTTP server and request handlers.
**Source code:** :source:`Lib/http/server.py`
.. index:: .. index::
pair: WWW; server pair: WWW; server
...@@ -11,8 +12,6 @@ ...@@ -11,8 +12,6 @@
single: URL single: URL
single: httpd single: httpd
**Source code:** :source:`Lib/http/server.py`
-------------- --------------
This module defines classes for implementing HTTP servers (Web servers). This module defines classes for implementing HTTP servers (Web servers).
......
...@@ -3,12 +3,16 @@ ...@@ -3,12 +3,16 @@
IDLE IDLE
==== ====
.. moduleauthor:: Guido van Rossum <guido@python.org>
**Source code:** :source:`Lib/idlelib/`
.. index:: .. index::
single: IDLE single: IDLE
single: Python Editor single: Python Editor
single: Integrated Development Environment single: Integrated Development Environment
.. moduleauthor:: Guido van Rossum <guido@python.org> --------------
IDLE is Python's Integrated Development and Learning Environment. IDLE is Python's Integrated Development and Learning Environment.
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: imaplib .. module:: imaplib
:synopsis: IMAP4 protocol client (requires sockets). :synopsis: IMAP4 protocol client (requires sockets).
.. moduleauthor:: Piers Lauder <piers@communitysolutions.com.au> .. moduleauthor:: Piers Lauder <piers@communitysolutions.com.au>
.. sectionauthor:: Piers Lauder <piers@communitysolutions.com.au> .. sectionauthor:: Piers Lauder <piers@communitysolutions.com.au>
.. revised by ESR, January 2000 .. revised by ESR, January 2000
...@@ -10,14 +11,13 @@ ...@@ -10,14 +11,13 @@
.. changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>, .. changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>,
November 2002 November 2002
**Source code:** :source:`Lib/imaplib.py`
.. index:: .. index::
pair: IMAP4; protocol pair: IMAP4; protocol
pair: IMAP4_SSL; protocol pair: IMAP4_SSL; protocol
pair: IMAP4_stream; protocol pair: IMAP4_stream; protocol
**Source code:** :source:`Lib/imaplib.py`
-------------- --------------
This module defines three classes, :class:`IMAP4`, :class:`IMAP4_SSL` and This module defines three classes, :class:`IMAP4`, :class:`IMAP4_SSL` and
......
...@@ -5,11 +5,15 @@ ...@@ -5,11 +5,15 @@
:synopsis: Access the implementation of the import statement. :synopsis: Access the implementation of the import statement.
:deprecated: :deprecated:
**Source code:** :source:`Lib/imp.py`
.. deprecated:: 3.4 .. deprecated:: 3.4
The :mod:`imp` package is pending deprecation in favor of :mod:`importlib`. The :mod:`imp` package is pending deprecation in favor of :mod:`importlib`.
.. index:: statement: import .. index:: statement: import
--------------
This module provides an interface to the mechanisms used to implement the This module provides an interface to the mechanisms used to implement the
:keyword:`import` statement. It defines the following constants and functions: :keyword:`import` statement. It defines the following constants and functions:
......
...@@ -9,6 +9,9 @@ ...@@ -9,6 +9,9 @@
.. versionadded:: 3.1 .. versionadded:: 3.1
**Source code:** :source:`Lib/importlib/__init__.py`
--------------
Introduction Introduction
------------ ------------
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: inspect .. module:: inspect
:synopsis: Extract information and source code from live objects. :synopsis: Extract information and source code from live objects.
.. moduleauthor:: Ka-Ping Yee <ping@lfw.org> .. moduleauthor:: Ka-Ping Yee <ping@lfw.org>
.. sectionauthor:: Ka-Ping Yee <ping@lfw.org> .. sectionauthor:: Ka-Ping Yee <ping@lfw.org>
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: io .. module:: io
:synopsis: Core tools for working with streams. :synopsis: Core tools for working with streams.
.. moduleauthor:: Guido van Rossum <guido@python.org> .. moduleauthor:: Guido van Rossum <guido@python.org>
.. moduleauthor:: Mike Verdone <mike.verdone@gmail.com> .. moduleauthor:: Mike Verdone <mike.verdone@gmail.com>
.. moduleauthor:: Mark Russell <mark.russell@zen.co.uk> .. moduleauthor:: Mark Russell <mark.russell@zen.co.uk>
...@@ -11,6 +12,10 @@ ...@@ -11,6 +12,10 @@
.. moduleauthor:: Benjamin Peterson <benjamin@python.org> .. moduleauthor:: Benjamin Peterson <benjamin@python.org>
.. sectionauthor:: Benjamin Peterson <benjamin@python.org> .. sectionauthor:: Benjamin Peterson <benjamin@python.org>
**Source code:** :source:`Lib/io.py`
--------------
.. _io-overview: .. _io-overview:
Overview Overview
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: ipaddress .. module:: ipaddress
:synopsis: IPv4/IPv6 manipulation library. :synopsis: IPv4/IPv6 manipulation library.
.. moduleauthor:: Peter Moody .. moduleauthor:: Peter Moody
**Source code:** :source:`Lib/ipaddress.py` **Source code:** :source:`Lib/ipaddress.py`
......
...@@ -3,14 +3,15 @@ ...@@ -3,14 +3,15 @@
.. module:: itertools .. module:: itertools
:synopsis: Functions creating iterators for efficient looping. :synopsis: Functions creating iterators for efficient looping.
.. moduleauthor:: Raymond Hettinger <python@rcn.com> .. moduleauthor:: Raymond Hettinger <python@rcn.com>
.. sectionauthor:: Raymond Hettinger <python@rcn.com> .. sectionauthor:: Raymond Hettinger <python@rcn.com>
.. testsetup:: .. testsetup::
from itertools import * from itertools import *
--------------
This module implements a number of :term:`iterator` building blocks inspired 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 by constructs from APL, Haskell, and SML. Each has been recast in a form
......
...@@ -3,9 +3,14 @@ ...@@ -3,9 +3,14 @@
.. module:: json .. module:: json
:synopsis: Encode and decode the JSON format. :synopsis: Encode and decode the JSON format.
.. moduleauthor:: Bob Ippolito <bob@redivi.com> .. moduleauthor:: Bob Ippolito <bob@redivi.com>
.. sectionauthor:: 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 `JSON (JavaScript Object Notation) <http://json.org>`_, specified by
:rfc:`7159` (which obsoletes :rfc:`4627`) and by :rfc:`7159` (which obsoletes :rfc:`4627`) and by
`ECMA-404 <http://www.ecma-international.org/publications/standards/Ecma-404.htm>`_, `ECMA-404 <http://www.ecma-international.org/publications/standards/Ecma-404.htm>`_,
......
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
.. module:: linecache .. module:: linecache
:synopsis: This module provides random access to individual lines from text files. :synopsis: This module provides random access to individual lines from text files.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> .. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
**Source code:** :source:`Lib/linecache.py` **Source code:** :source:`Lib/linecache.py`
......
...@@ -3,9 +3,13 @@ ...@@ -3,9 +3,13 @@
.. module:: locale .. module:: locale
:synopsis: Internationalization services. :synopsis: Internationalization services.
.. moduleauthor:: Martin von Löwis <martin@v.loewis.de> .. moduleauthor:: Martin von Löwis <martin@v.loewis.de>
.. sectionauthor:: 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 The :mod:`locale` module opens access to the POSIX locale database and
functionality. The POSIX locale mechanism allows programmers to deal with functionality. The POSIX locale mechanism allows programmers to deal with
......
...@@ -4,10 +4,11 @@ ...@@ -4,10 +4,11 @@
.. module:: logging.config .. module:: logging.config
:synopsis: Configuration of the logging module. :synopsis: Configuration of the logging module.
.. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
.. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
**Source code:** :source:`Lib/logging/config.py`
.. sidebar:: Important .. sidebar:: Important
This page contains only reference information. For tutorials, This page contains only reference information. For tutorials,
...@@ -17,8 +18,6 @@ ...@@ -17,8 +18,6 @@
* :ref:`Advanced Tutorial <logging-advanced-tutorial>` * :ref:`Advanced Tutorial <logging-advanced-tutorial>`
* :ref:`Logging Cookbook <logging-cookbook>` * :ref:`Logging Cookbook <logging-cookbook>`
**Source code:** :source:`Lib/logging/config.py`
-------------- --------------
This section describes the API for configuring the logging module. This section describes the API for configuring the logging module.
......
...@@ -4,10 +4,11 @@ ...@@ -4,10 +4,11 @@
.. module:: logging.handlers .. module:: logging.handlers
:synopsis: Handlers for the logging module. :synopsis: Handlers for the logging module.
.. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
.. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com> .. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
**Source code:** :source:`Lib/logging/handlers.py`
.. sidebar:: Important .. sidebar:: Important
This page contains only reference information. For tutorials, This page contains only reference information. For tutorials,
...@@ -17,8 +18,6 @@ ...@@ -17,8 +18,6 @@
* :ref:`Advanced Tutorial <logging-advanced-tutorial>` * :ref:`Advanced Tutorial <logging-advanced-tutorial>`
* :ref:`Logging Cookbook <logging-cookbook>` * :ref:`Logging Cookbook <logging-cookbook>`
**Source code:** :source:`Lib/logging/handlers.py`
-------------- --------------
.. currentmodule:: logging .. currentmodule:: logging
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment