diff -r 3f3b3d4881f6 Doc/library/2to3.rst --- a/Doc/library/2to3.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/2to3.rst Wed Apr 20 03:13:12 2016 +0100 @@ -449,10 +449,14 @@ .. module:: lib2to3 :synopsis: the 2to3 library + .. moduleauthor:: Guido van Rossum .. moduleauthor:: Collin Winter .. moduleauthor:: Benjamin Peterson +**Source code:** :source:`Lib/lib2to3/` + +-------------- .. note:: diff -r 3f3b3d4881f6 Doc/library/__main__.rst --- a/Doc/library/__main__.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/__main__.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/_thread.rst --- a/Doc/library/_thread.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/_thread.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,7 @@ .. module:: _thread :synopsis: Low-level threading API. +**Source code:** :source:`Modules/_threadmodule.c` .. index:: single: light-weight processes @@ -11,6 +12,8 @@ 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 -r 3f3b3d4881f6 Doc/library/abc.rst --- a/Doc/library/abc.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/abc.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/aifc.rst --- a/Doc/library/aifc.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/aifc.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/argparse.rst --- a/Doc/library/argparse.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/argparse.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: argparse :synopsis: Command-line option and argument parsing library. + .. moduleauthor:: Steven Bethard .. sectionauthor:: Steven Bethard diff -r 3f3b3d4881f6 Doc/library/array.rst --- a/Doc/library/array.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/array.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: array :synopsis: Space efficient arrays of uniformly typed numeric values. +**Source code:** :source:`Modules/arraymodule.c` + +-------------- .. index:: single: arrays diff -r 3f3b3d4881f6 Doc/library/asynchat.rst --- a/Doc/library/asynchat.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/asynchat.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: asynchat :synopsis: Support for asynchronous command/response protocols. + .. moduleauthor:: Sam Rushing .. sectionauthor:: Steve Holden diff -r 3f3b3d4881f6 Doc/library/asyncio.rst --- a/Doc/library/asyncio.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/asyncio.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/asyncore.rst --- a/Doc/library/asyncore.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/asyncore.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,7 @@ .. module:: asyncore :synopsis: A base class for developing asynchronous socket handling services. + .. moduleauthor:: Sam Rushing .. sectionauthor:: Christopher Petrilli .. sectionauthor:: Steve Holden diff -r 3f3b3d4881f6 Doc/library/atexit.rst --- a/Doc/library/atexit.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/atexit.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: atexit :synopsis: Register and execute cleanup functions. + .. moduleauthor:: Skip Montanaro .. sectionauthor:: Skip Montanaro +**Source code:** :source:`Modules/atexitmodule.c` + +-------------- The :mod:`atexit` module defines functions to register and unregister cleanup functions. Functions thus registered are automatically executed upon normal diff -r 3f3b3d4881f6 Doc/library/audioop.rst --- a/Doc/library/audioop.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/audioop.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: audioop :synopsis: Manipulate raw audio data. +**Source code:** :source:`Modules/audioop.c` + +-------------- 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 -r 3f3b3d4881f6 Doc/library/base64.rst --- a/Doc/library/base64.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/base64.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/binascii.rst --- a/Doc/library/binascii.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/binascii.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,12 +5,15 @@ :synopsis: Tools for converting between binary and various ASCII-encoded binary representations. +**Source code:** :source:`Modules/binascii.c` .. 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 -r 3f3b3d4881f6 Doc/library/binhex.rst --- a/Doc/library/binhex.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/binhex.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/builtins.rst --- a/Doc/library/builtins.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/builtins.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: builtins :synopsis: The module that provides the built-in namespace. +**Source code:** :source:`Python/bltinmodule.c` + +-------------- 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 -r 3f3b3d4881f6 Doc/library/bz2.rst --- a/Doc/library/bz2.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/bz2.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,11 +3,15 @@ .. module:: bz2 :synopsis: Interfaces for bzip2 compression and decompression. + .. moduleauthor:: Gustavo Niemeyer .. moduleauthor:: Nadeem Vawda .. sectionauthor:: Gustavo Niemeyer .. sectionauthor:: Nadeem Vawda +**Source code:** :source:`Lib/bz2.py` + +-------------- This module provides a comprehensive interface for compressing and decompressing data using the bzip2 compression algorithm. diff -r 3f3b3d4881f6 Doc/library/calendar.rst --- a/Doc/library/calendar.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/calendar.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,7 @@ .. module:: calendar :synopsis: Functions for working with calendars, including some emulation of the Unix cal program. + .. sectionauthor:: Drew Csillag **Source code:** :source:`Lib/calendar.py` diff -r 3f3b3d4881f6 Doc/library/cgi.rst --- a/Doc/library/cgi.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/cgi.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/cgitb.rst --- a/Doc/library/cgitb.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/cgitb.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,11 @@ .. module:: cgitb :synopsis: Configurable traceback handler for CGI scripts. + .. moduleauthor:: Ka-Ping Yee .. sectionauthor:: Fred L. Drake, Jr. +**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 -r 3f3b3d4881f6 Doc/library/chunk.rst --- a/Doc/library/chunk.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/chunk.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,11 @@ .. module:: chunk :synopsis: Module to read IFF chunks. + .. moduleauthor:: Sjoerd Mullender .. sectionauthor:: Sjoerd Mullender +**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 -r 3f3b3d4881f6 Doc/library/cmath.rst --- a/Doc/library/cmath.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/cmath.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: cmath :synopsis: Mathematical functions for complex numbers. +**Source code:** :source:`Modules/cmathmodule.c` + +-------------- This module is always available. It provides access to mathematical functions for complex numbers. The functions in this module accept integers, diff -r 3f3b3d4881f6 Doc/library/cmd.rst --- a/Doc/library/cmd.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/cmd.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: cmd :synopsis: Build line-oriented command interpreters. + .. sectionauthor:: Eric S. Raymond **Source code:** :source:`Lib/cmd.py` diff -r 3f3b3d4881f6 Doc/library/code.rst --- a/Doc/library/code.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/code.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/codecs.rst --- a/Doc/library/codecs.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/codecs.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: codecs :synopsis: Encode and decode data and streams. + .. moduleauthor:: Marc-André Lemburg .. sectionauthor:: Marc-André Lemburg .. sectionauthor:: Martin v. Löwis @@ -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 -r 3f3b3d4881f6 Doc/library/codeop.rst --- a/Doc/library/codeop.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/codeop.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,14 @@ .. module:: codeop :synopsis: Compile (possibly incomplete) Python code. + .. sectionauthor:: Moshe Zadka .. sectionauthor:: Michael Hudson +**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 -r 3f3b3d4881f6 Doc/library/collections.abc.rst --- a/Doc/library/collections.abc.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/collections.abc.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,20 +3,21 @@ .. module:: collections.abc :synopsis: Abstract base classes for containers + .. moduleauthor:: Raymond Hettinger .. sectionauthor:: Raymond Hettinger .. 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__ = '' -**Source code:** :source:`Lib/_collections_abc.py` - -------------- This module provides :term:`abstract base classes ` that diff -r 3f3b3d4881f6 Doc/library/collections.rst --- a/Doc/library/collections.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/collections.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,17 +3,18 @@ .. module:: collections :synopsis: Container datatypes + .. moduleauthor:: Raymond Hettinger .. sectionauthor:: Raymond Hettinger +**Source code:** :source:`Lib/collections/__init__.py` + .. testsetup:: * from collections import * import itertools __name__ = '' -**Source code:** :source:`Lib/collections/__init__.py` - -------------- This module implements specialized container datatypes providing alternatives to diff -r 3f3b3d4881f6 Doc/library/colorsys.rst --- a/Doc/library/colorsys.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/colorsys.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: colorsys :synopsis: Conversion functions between RGB and other color systems. + .. sectionauthor:: David Ascher **Source code:** :source:`Lib/colorsys.py` diff -r 3f3b3d4881f6 Doc/library/compileall.rst --- a/Doc/library/compileall.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/compileall.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/configparser.rst --- a/Doc/library/configparser.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/configparser.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/copy.rst --- a/Doc/library/copy.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/copy.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/copyreg.rst --- a/Doc/library/copyreg.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/copyreg.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/crypt.rst --- a/Doc/library/crypt.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/crypt.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,15 +4,19 @@ .. module:: crypt :platform: Unix :synopsis: The crypt() function used to check Unix passwords. + .. moduleauthor:: Steven D. Majewski .. sectionauthor:: Steven D. Majewski .. sectionauthor:: Peter Funk +**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 -r 3f3b3d4881f6 Doc/library/csv.rst --- a/Doc/library/csv.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/csv.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: csv :synopsis: Write and read tabular data to and from delimited files. + .. sectionauthor:: Skip Montanaro **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 -r 3f3b3d4881f6 Doc/library/ctypes.rst --- a/Doc/library/ctypes.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/ctypes.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,8 +3,12 @@ .. module:: ctypes :synopsis: A foreign function library for Python. + .. moduleauthor:: Thomas Heller +**Source code:** :source:`Modules/_ctypes/` + +-------------- :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 -r 3f3b3d4881f6 Doc/library/curses.ascii.rst --- a/Doc/library/curses.ascii.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/curses.ascii.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: curses.ascii :synopsis: Constants and set-membership functions for ASCII characters. + .. moduleauthor:: Eric S. Raymond .. sectionauthor:: Eric S. Raymond +**Source code:** :source:`Lib/curses/ascii.py` + +-------------- The :mod:`curses.ascii` module supplies name constants for ASCII characters and functions to test membership in various ASCII character classes. The constants diff -r 3f3b3d4881f6 Doc/library/curses.panel.rst --- a/Doc/library/curses.panel.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/curses.panel.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,8 +3,13 @@ .. module:: curses.panel :synopsis: A panel stack extension that adds depth to curses windows. + .. sectionauthor:: A.M. Kuchling +**Source code:** :source:`Lib/curses/panel.py` +and :source:`Modules/_curses_panel.c` + +-------------- 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 -r 3f3b3d4881f6 Doc/library/curses.rst --- a/Doc/library/curses.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/curses.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,9 +5,14 @@ :synopsis: An interface to the curses library, providing portable terminal handling. :platform: Unix + .. sectionauthor:: Moshe Zadka .. sectionauthor:: Eric Raymond +**Source code:** :source:`Lib/curses/__init__.py` + +-------------- + The :mod:`curses` module provides an interface to the curses library, the de-facto standard for portable advanced terminal handling. diff -r 3f3b3d4881f6 Doc/library/datetime.rst --- a/Doc/library/datetime.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/datetime.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,12 +3,15 @@ .. module:: datetime :synopsis: Basic date and time types. + .. moduleauthor:: Tim Peters .. sectionauthor:: Tim Peters .. sectionauthor:: A.M. Kuchling **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 -r 3f3b3d4881f6 Doc/library/dbm.rst --- a/Doc/library/dbm.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/dbm.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/decimal.rst --- a/Doc/library/decimal.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/decimal.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/difflib.rst --- a/Doc/library/difflib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/difflib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: difflib :synopsis: Helpers for computing differences between objects. + .. moduleauthor:: Tim Peters .. sectionauthor:: Tim Peters .. Markup by Fred L. Drake, Jr. @@ -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 -r 3f3b3d4881f6 Doc/library/distutils.rst --- a/Doc/library/distutils.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/distutils.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,8 +4,12 @@ .. module:: distutils :synopsis: Support for building and installing Python modules into an existing Python installation. + .. sectionauthor:: Fred L. Drake, Jr. +**Source code:** :source:`Lib/distutils/core.py` + +-------------- The :mod:`distutils` package provides support for building and installing additional modules into a Python installation. The new modules may be either diff -r 3f3b3d4881f6 Doc/library/doctest.rst --- a/Doc/library/doctest.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/doctest.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,11 +5,15 @@ .. module:: doctest :synopsis: Test pieces of code within docstrings. + .. moduleauthor:: Tim Peters .. sectionauthor:: Tim Peters .. sectionauthor:: Moshe Zadka .. sectionauthor:: Edward Loper +**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 -r 3f3b3d4881f6 Doc/library/email.charset.rst --- a/Doc/library/email.charset.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.charset.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/email.contentmanager.rst --- a/Doc/library/email.contentmanager.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.contentmanager.rst Wed Apr 20 03:13:12 2016 +0100 @@ -7,6 +7,10 @@ .. moduleauthor:: R. David Murray .. sectionauthor:: R. David Murray +.. versionadded:: 3.4 + as a :term:`provisional module `. + +**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 `. +-------------- 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 -r 3f3b3d4881f6 Doc/library/email.encoders.rst --- a/Doc/library/email.encoders.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.encoders.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/email.errors.rst --- a/Doc/library/email.errors.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.errors.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/email.generator.rst --- a/Doc/library/email.generator.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.generator.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/email.header.rst --- a/Doc/library/email.header.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.header.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/email.headerregistry.rst --- a/Doc/library/email.headerregistry.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.headerregistry.rst Wed Apr 20 03:13:12 2016 +0100 @@ -7,6 +7,10 @@ .. moduleauthor:: R. David Murray .. sectionauthor:: R. David Murray +.. versionadded:: 3.3 + as a :term:`provisional module `. + +**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 `. +-------------- Headers are represented by customized subclasses of :class:`str`. The particular class used to represent a given header is determined by the diff -r 3f3b3d4881f6 Doc/library/email.iterators.rst --- a/Doc/library/email.iterators.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.iterators.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 ` method. The diff -r 3f3b3d4881f6 Doc/library/email.message.rst --- a/Doc/library/email.message.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.message.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/email.mime.rst --- a/Doc/library/email.mime.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.mime.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/email.parser.rst --- a/Doc/library/email.parser.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.parser.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/email.policy.rst --- a/Doc/library/email.policy.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.policy.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/email.rst --- a/Doc/library/email.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,10 +4,14 @@ .. module:: email :synopsis: Package supporting the parsing, manipulating, and generating email messages, including MIME documents. + .. moduleauthor:: Barry A. Warsaw .. sectionauthor:: Barry A. Warsaw .. 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 -r 3f3b3d4881f6 Doc/library/email.util.rst --- a/Doc/library/email.util.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/email.util.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/ensurepip.rst --- a/Doc/library/ensurepip.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/ensurepip.rst Wed Apr 20 03:13:12 2016 +0100 @@ -7,6 +7,10 @@ .. versionadded:: 3.4 +**Source code:** :source:`Lib/ensurepip/__init__.py` + +-------------- + 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 -r 3f3b3d4881f6 Doc/library/errno.rst --- a/Doc/library/errno.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/errno.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: errno :synopsis: Standard errno system symbols. +**Source code:** :source:`Modules/errnomodule.c` + +---------------- This module makes available standard ``errno`` system symbols. The value of each symbol is the corresponding integer value. The names and descriptions are diff -r 3f3b3d4881f6 Doc/library/faulthandler.rst --- a/Doc/library/faulthandler.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/faulthandler.rst Wed Apr 20 03:13:12 2016 +0100 @@ -6,6 +6,10 @@ .. versionadded:: 3.3 +**Source code:** :source:`Modules/faulthandler.c` + +---------------- + 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 -r 3f3b3d4881f6 Doc/library/fcntl.rst --- a/Doc/library/fcntl.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/fcntl.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,13 +4,17 @@ .. module:: fcntl :platform: Unix :synopsis: The fcntl() and ioctl() system calls. + .. sectionauthor:: Jaap Vermeulen +**Source code:** :source:`Modules/fcntlmodule.c` .. 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. diff -r 3f3b3d4881f6 Doc/library/filecmp.rst --- a/Doc/library/filecmp.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/filecmp.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: filecmp :synopsis: Compare files efficiently. + .. sectionauthor:: Moshe Zadka **Source code:** :source:`Lib/filecmp.py` diff -r 3f3b3d4881f6 Doc/library/fileinput.rst --- a/Doc/library/fileinput.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/fileinput.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: fileinput :synopsis: Loop over standard input or a list of files. + .. moduleauthor:: Guido van Rossum .. sectionauthor:: Fred L. Drake, Jr. diff -r 3f3b3d4881f6 Doc/library/fnmatch.rst --- a/Doc/library/fnmatch.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/fnmatch.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/formatter.rst --- a/Doc/library/formatter.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/formatter.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,9 +5,12 @@ :synopsis: Generic output formatter and device interface. :deprecated: +**Source code:** :source:`Lib/formatter.py` + .. 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 -r 3f3b3d4881f6 Doc/library/fpectl.rst --- a/Doc/library/fpectl.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/fpectl.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,9 +4,11 @@ .. module:: fpectl :platform: Unix :synopsis: Provide control for floating point exception handling. + .. moduleauthor:: Lee Busby .. sectionauthor:: Lee Busby +**Source code:** :source:`Modules/fpectlmodule.c` .. note:: @@ -16,6 +18,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 -r 3f3b3d4881f6 Doc/library/fractions.rst --- a/Doc/library/fractions.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/fractions.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: fractions :synopsis: Rational numbers. + .. moduleauthor:: Jeffrey Yasskin .. sectionauthor:: Jeffrey Yasskin diff -r 3f3b3d4881f6 Doc/library/ftplib.rst --- a/Doc/library/ftplib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/ftplib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/functools.rst --- a/Doc/library/functools.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/functools.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: functools :synopsis: Higher-order functions and operations on callable objects. + .. moduleauthor:: Peter Harris .. moduleauthor:: Raymond Hettinger .. moduleauthor:: Nick Coghlan diff -r 3f3b3d4881f6 Doc/library/gc.rst --- a/Doc/library/gc.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/gc.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: gc :synopsis: Interface to the cycle-detecting garbage collector. + .. moduleauthor:: Neil Schemenauer .. sectionauthor:: Neil Schemenauer +**Source code:** :source:`Modules/gcmodule.c` + +-------------- This module provides an interface to the optional garbage collector. It provides the ability to disable the collector, tune the collection frequency, diff -r 3f3b3d4881f6 Doc/library/getopt.rst --- a/Doc/library/getopt.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/getopt.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/getpass.rst --- a/Doc/library/getpass.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/getpass.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,10 +3,15 @@ .. module:: getpass :synopsis: Portable reading of passwords and retrieval of the userid. + .. moduleauthor:: Piers Lauder .. sectionauthor:: Fred L. Drake, Jr. .. Windows (& Mac?) support by Guido van Rossum. +**Source code:** :source:`Lib/getpass.py` + +-------------- + The :mod:`getpass` module provides two functions: diff -r 3f3b3d4881f6 Doc/library/gettext.rst --- a/Doc/library/gettext.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/gettext.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: gettext :synopsis: Multilingual internationalization services. + .. moduleauthor:: Barry A. Warsaw .. sectionauthor:: Barry A. Warsaw diff -r 3f3b3d4881f6 Doc/library/glob.rst --- a/Doc/library/glob.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/glob.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/grp.rst --- a/Doc/library/grp.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/grp.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,6 +5,9 @@ :platform: Unix :synopsis: The group database (getgrnam() and friends). +**Source code:** :source:`Modules/grpmodule.c` + +-------------- This module provides access to the Unix group database. It is available on all Unix versions. diff -r 3f3b3d4881f6 Doc/library/hashlib.rst --- a/Doc/library/hashlib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/hashlib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,16 +3,16 @@ .. module:: hashlib :synopsis: Secure hash and message digest algorithms. + .. moduleauthor:: Gregory P. Smith .. sectionauthor:: Gregory P. Smith +**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 -r 3f3b3d4881f6 Doc/library/heapq.rst --- a/Doc/library/heapq.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/heapq.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: heapq :synopsis: Heap queue algorithm (a.k.a. priority queue). + .. moduleauthor:: Kevin O'Connor .. sectionauthor:: Guido van Rossum .. sectionauthor:: François Pinard diff -r 3f3b3d4881f6 Doc/library/hmac.rst --- a/Doc/library/hmac.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/hmac.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: hmac :synopsis: Keyed-Hashing for Message Authentication (HMAC) implementation + .. moduleauthor:: Gerhard Häring .. sectionauthor:: Gerhard Häring diff -r 3f3b3d4881f6 Doc/library/html.entities.rst --- a/Doc/library/html.entities.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/html.entities.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: html.entities :synopsis: Definitions of HTML general entities. + .. sectionauthor:: Fred L. Drake, Jr. **Source code:** :source:`Lib/html/entities.py` diff -r 3f3b3d4881f6 Doc/library/html.parser.rst --- a/Doc/library/html.parser.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/html.parser.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/http.client.rst --- a/Doc/library/http.client.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/http.client.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/http.cookiejar.rst --- a/Doc/library/http.cookiejar.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/http.cookiejar.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: http.cookiejar :synopsis: Classes for automatic handling of HTTP cookies. + .. moduleauthor:: John J. Lee .. sectionauthor:: John J. Lee diff -r 3f3b3d4881f6 Doc/library/http.cookies.rst --- a/Doc/library/http.cookies.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/http.cookies.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: http.cookies :synopsis: Support for HTTP state management (cookies). + .. moduleauthor:: Timothy O'Malley .. sectionauthor:: Moshe Zadka diff -r 3f3b3d4881f6 Doc/library/http.rst --- a/Doc/library/http.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/http.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/http.server.rst --- a/Doc/library/http.server.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/http.server.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/idle.rst --- a/Doc/library/idle.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/idle.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,12 +3,16 @@ IDLE ==== +.. moduleauthor:: Guido van Rossum + +**Source code:** :source:`Lib/idlelib/` + .. index:: single: IDLE single: Python Editor single: Integrated Development Environment -.. moduleauthor:: Guido van Rossum +-------------- IDLE is Python's Integrated Development and Learning Environment. diff -r 3f3b3d4881f6 Doc/library/imaplib.rst --- a/Doc/library/imaplib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/imaplib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: imaplib :synopsis: IMAP4 protocol client (requires sockets). + .. moduleauthor:: Piers Lauder .. sectionauthor:: Piers Lauder .. revised by ESR, January 2000 @@ -10,14 +11,13 @@ .. changes for IMAP4_stream by Piers Lauder , 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 -r 3f3b3d4881f6 Doc/library/imp.rst --- a/Doc/library/imp.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/imp.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/importlib.rst --- a/Doc/library/importlib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/importlib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -9,6 +9,9 @@ .. versionadded:: 3.1 +**Source code:** :source:`Lib/importlib/__init__.py` + +-------------- Introduction ------------ diff -r 3f3b3d4881f6 Doc/library/inspect.rst --- a/Doc/library/inspect.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/inspect.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: inspect :synopsis: Extract information and source code from live objects. + .. moduleauthor:: Ka-Ping Yee .. sectionauthor:: Ka-Ping Yee diff -r 3f3b3d4881f6 Doc/library/io.rst --- a/Doc/library/io.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/io.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: io :synopsis: Core tools for working with streams. + .. moduleauthor:: Guido van Rossum .. moduleauthor:: Mike Verdone .. moduleauthor:: Mark Russell @@ -11,6 +12,10 @@ .. moduleauthor:: Benjamin Peterson .. sectionauthor:: Benjamin Peterson +**Source code:** :source:`Lib/io.py` + +-------------- + .. _io-overview: Overview diff -r 3f3b3d4881f6 Doc/library/ipaddress.rst --- a/Doc/library/ipaddress.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/ipaddress.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: ipaddress :synopsis: IPv4/IPv6 manipulation library. + .. moduleauthor:: Peter Moody **Source code:** :source:`Lib/ipaddress.py` diff -r 3f3b3d4881f6 Doc/library/itertools.rst --- a/Doc/library/itertools.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/itertools.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,14 +3,17 @@ .. module:: itertools :synopsis: Functions creating iterators for efficient looping. + .. moduleauthor:: Raymond Hettinger .. sectionauthor:: Raymond Hettinger +**Source code:** :source:`Modules/itertoolsmodule.c` .. 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 -r 3f3b3d4881f6 Doc/library/json.rst --- a/Doc/library/json.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/json.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,14 @@ .. module:: json :synopsis: Encode and decode the JSON format. + .. moduleauthor:: Bob Ippolito .. sectionauthor:: Bob Ippolito +**Source code:** :source:`Lib/json/__init__.py` + +-------------- + `JSON (JavaScript Object Notation) `_, specified by :rfc:`7159` (which obsoletes :rfc:`4627`) and by `ECMA-404 `_, diff -r 3f3b3d4881f6 Doc/library/linecache.rst --- a/Doc/library/linecache.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/linecache.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: linecache :synopsis: This module provides random access to individual lines from text files. + .. sectionauthor:: Moshe Zadka **Source code:** :source:`Lib/linecache.py` diff -r 3f3b3d4881f6 Doc/library/locale.rst --- a/Doc/library/locale.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/locale.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: locale :synopsis: Internationalization services. + .. moduleauthor:: Martin von Löwis .. sectionauthor:: Martin von Löwis +**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 -r 3f3b3d4881f6 Doc/library/logging.config.rst --- a/Doc/library/logging.config.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/logging.config.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,10 +4,11 @@ .. module:: logging.config :synopsis: Configuration of the logging module. - .. moduleauthor:: Vinay Sajip .. sectionauthor:: Vinay Sajip +**Source code:** :source:`Lib/logging/config.py` + .. sidebar:: Important This page contains only reference information. For tutorials, @@ -17,8 +18,6 @@ * :ref:`Advanced Tutorial ` * :ref:`Logging Cookbook ` -**Source code:** :source:`Lib/logging/config.py` - -------------- This section describes the API for configuring the logging module. diff -r 3f3b3d4881f6 Doc/library/logging.handlers.rst --- a/Doc/library/logging.handlers.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/logging.handlers.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,10 +4,11 @@ .. module:: logging.handlers :synopsis: Handlers for the logging module. - .. moduleauthor:: Vinay Sajip .. sectionauthor:: Vinay Sajip +**Source code:** :source:`Lib/logging/handlers.py` + .. sidebar:: Important This page contains only reference information. For tutorials, @@ -17,8 +18,6 @@ * :ref:`Advanced Tutorial ` * :ref:`Logging Cookbook ` -**Source code:** :source:`Lib/logging/handlers.py` - -------------- .. currentmodule:: logging diff -r 3f3b3d4881f6 Doc/library/logging.rst --- a/Doc/library/logging.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/logging.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,10 +4,10 @@ .. module:: logging :synopsis: Flexible event logging system for applications. - .. moduleauthor:: Vinay Sajip .. sectionauthor:: Vinay Sajip +**Source code:** :source:`Lib/logging/__init__.py` .. index:: pair: Errors; logging @@ -20,9 +20,6 @@ * :ref:`Advanced Tutorial ` * :ref:`Logging Cookbook ` - -**Source code:** :source:`Lib/logging/__init__.py` - -------------- This module defines functions and classes which implement a flexible event diff -r 3f3b3d4881f6 Doc/library/lzma.rst --- a/Doc/library/lzma.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/lzma.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,11 +3,15 @@ .. module:: lzma :synopsis: A Python wrapper for the liblzma compression library. + .. moduleauthor:: Nadeem Vawda .. sectionauthor:: Nadeem Vawda .. 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 -r 3f3b3d4881f6 Doc/library/macpath.rst --- a/Doc/library/macpath.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/macpath.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/mailbox.rst --- a/Doc/library/mailbox.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/mailbox.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: mailbox :synopsis: Manipulate mailboxes in various formats + .. moduleauthor:: Gregory K. Johnson .. sectionauthor:: Gregory K. Johnson +**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 -r 3f3b3d4881f6 Doc/library/marshal.rst --- a/Doc/library/marshal.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/marshal.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,6 +5,14 @@ :synopsis: Convert Python objects to streams of bytes and back (with different constraints). +**Source code:** :source:`Python/marshal.c` + +.. index:: + module: pickle + module: shelve + object: code + +-------------- 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 @@ -13,11 +21,6 @@ undocumented on purpose; it may change between Python versions (although it rarely does). [#]_ -.. index:: - module: pickle - module: shelve - object: code - This is not a general "persistence" module. For general persistence and transfer of Python objects through RPC calls, see the modules :mod:`pickle` and :mod:`shelve`. The :mod:`marshal` module exists mainly to support reading and diff -r 3f3b3d4881f6 Doc/library/math.rst --- a/Doc/library/math.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/math.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,10 +4,14 @@ .. module:: math :synopsis: Mathematical functions (sin() etc.). +**Source code:** :source:`Modules/mathmodule.c` + .. testsetup:: from math import fsum +-------------- + This module is always available. It provides access to the mathematical functions defined by the C standard. diff -r 3f3b3d4881f6 Doc/library/mimetypes.rst --- a/Doc/library/mimetypes.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/mimetypes.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,13 +3,13 @@ .. module:: mimetypes :synopsis: Mapping of filename extensions to MIME types. + .. sectionauthor:: Fred L. Drake, Jr. +**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 -r 3f3b3d4881f6 Doc/library/mmap.rst --- a/Doc/library/mmap.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/mmap.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: mmap :synopsis: Interface to memory-mapped files for Unix and Windows. +**Source code:** :source:`Modules/mmapmodule.c` + +-------------- Memory-mapped file objects behave like both :class:`bytearray` and like :term:`file objects `. You can use mmap objects in most places diff -r 3f3b3d4881f6 Doc/library/modulefinder.rst --- a/Doc/library/modulefinder.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/modulefinder.rst Wed Apr 20 03:13:12 2016 +0100 @@ -1,12 +1,11 @@ :mod:`modulefinder` --- Find modules used by a script ===================================================== -.. sectionauthor:: A.M. Kuchling - - .. module:: modulefinder :synopsis: Find modules used by a script. +.. sectionauthor:: A.M. Kuchling + **Source code:** :source:`Lib/modulefinder.py` -------------- diff -r 3f3b3d4881f6 Doc/library/msilib.rst --- a/Doc/library/msilib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/msilib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,12 +4,16 @@ .. module:: msilib :platform: Windows :synopsis: Creation of Microsoft Installer files, and CAB files. + .. moduleauthor:: Martin v. Löwis .. sectionauthor:: Martin v. Löwis +**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 -r 3f3b3d4881f6 Doc/library/msvcrt.rst --- a/Doc/library/msvcrt.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/msvcrt.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,8 +4,12 @@ .. module:: msvcrt :platform: Windows :synopsis: Miscellaneous useful routines from the MS VC++ runtime. + .. sectionauthor:: Fred L. Drake, Jr. +**Source code:** :source:`PC/msvcrtmodule.c` + +-------------- These functions provide access to some useful capabilities on Windows platforms. Some higher-level modules use these functions to build the Windows diff -r 3f3b3d4881f6 Doc/library/multiprocessing.rst --- a/Doc/library/multiprocessing.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/multiprocessing.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: multiprocessing :synopsis: Process-based parallelism. +**Source code:** :source:`Lib/multiprocessing/` + +-------------- Introduction ------------ diff -r 3f3b3d4881f6 Doc/library/netrc.rst --- a/Doc/library/netrc.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/netrc.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,7 @@ .. module:: netrc :synopsis: Loading of .netrc files. + .. moduleauthor:: Eric S. Raymond .. sectionauthor:: Eric S. Raymond diff -r 3f3b3d4881f6 Doc/library/nis.rst --- a/Doc/library/nis.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/nis.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,9 +5,13 @@ .. module:: nis :platform: Unix :synopsis: Interface to Sun's NIS (Yellow Pages) library. + .. moduleauthor:: Fred Gansevles .. sectionauthor:: Moshe Zadka +**Source code:** :source:`Modules/nismodule.c` + +-------------- The :mod:`nis` module gives a thin wrapper around the NIS library, useful for central administration of several hosts. diff -r 3f3b3d4881f6 Doc/library/nntplib.rst --- a/Doc/library/nntplib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/nntplib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/numbers.rst --- a/Doc/library/numbers.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/numbers.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 ` which progressively define diff -r 3f3b3d4881f6 Doc/library/operator.rst --- a/Doc/library/operator.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/operator.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,16 +3,16 @@ .. module:: operator :synopsis: Functions corresponding to the standard operators. + .. sectionauthor:: Skip Montanaro +**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 -r 3f3b3d4881f6 Doc/library/optparse.rst --- a/Doc/library/optparse.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/optparse.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,15 +4,16 @@ .. module:: optparse :synopsis: Command-line option parsing library. :deprecated: + .. moduleauthor:: Greg Ward .. sectionauthor:: Greg Ward +**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 -r 3f3b3d4881f6 Doc/library/os.path.rst --- a/Doc/library/os.path.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/os.path.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,8 +4,14 @@ .. module:: os.path :synopsis: Operations on pathnames. +**Source code:** :source:`Lib/posixpath.py` (for POSIX), +:source:`Lib/ntpath.py` (for WindowsNT), +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 -r 3f3b3d4881f6 Doc/library/os.rst --- a/Doc/library/os.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/os.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/ossaudiodev.rst --- a/Doc/library/ossaudiodev.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/ossaudiodev.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,6 +5,9 @@ :platform: Linux, FreeBSD :synopsis: Access to OSS-compatible audio devices. +**Source code:** :source:`Modules/ossaudiodev.c` + +-------------- 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 -r 3f3b3d4881f6 Doc/library/parser.rst --- a/Doc/library/parser.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/parser.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,11 @@ .. module:: parser :synopsis: Access parse trees for Python source code. + .. moduleauthor:: Fred L. Drake, Jr. .. sectionauthor:: Fred L. Drake, Jr. +**Source code:** :source:`Modules/parsermodule.c` .. Copyright 1995 Virginia Polytechnic Institute and State University and Fred L. Drake, Jr. This copyright notice must be distributed on all copies, but @@ -16,6 +18,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 -r 3f3b3d4881f6 Doc/library/pathlib.rst --- a/Doc/library/pathlib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pathlib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/pdb.rst --- a/Doc/library/pdb.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pdb.rst Wed Apr 20 03:13:12 2016 +0100 @@ -8,10 +8,10 @@ **Source code:** :source:`Lib/pdb.py` +.. index:: single: debugging + -------------- -.. 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 -r 3f3b3d4881f6 Doc/library/pickle.rst --- a/Doc/library/pickle.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pickle.rst Wed Apr 20 03:13:12 2016 +0100 @@ -1,6 +1,14 @@ :mod:`pickle` --- Python object serialization ============================================= +.. module:: pickle + :synopsis: Convert Python objects to streams of bytes and back. + +.. sectionauthor:: Jim Kerr . +.. sectionauthor:: Barry Warsaw + +**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 . -.. sectionauthor:: Barry Warsaw - +-------------- The :mod:`pickle` module implements binary protocols for serializing and de-serializing a Python object structure. *"Pickling"* is the process diff -r 3f3b3d4881f6 Doc/library/pipes.rst --- a/Doc/library/pipes.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pipes.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,7 @@ .. module:: pipes :platform: Unix :synopsis: A Python interface to Unix shell pipelines. + .. sectionauthor:: Moshe Zadka **Source code:** :source:`Lib/pipes.py` diff -r 3f3b3d4881f6 Doc/library/platform.rst --- a/Doc/library/platform.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/platform.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: platform :synopsis: Retrieves as much platform identifying data as possible. + .. moduleauthor:: Marc-André Lemburg .. sectionauthor:: Bjorn Pettersen diff -r 3f3b3d4881f6 Doc/library/plistlib.rst --- a/Doc/library/plistlib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/plistlib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,16 +3,17 @@ .. module:: plistlib :synopsis: Generate and parse Mac OS X plist files. + .. moduleauthor:: Jack Jansen .. sectionauthor:: Georg Brandl .. (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 -r 3f3b3d4881f6 Doc/library/poplib.rst --- a/Doc/library/poplib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/poplib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,13 +3,14 @@ .. module:: poplib :synopsis: POP3 protocol client (requires sockets). + .. sectionauthor:: Andrew T. Csillag .. revised by ESR, January 2000 +**Source code:** :source:`Lib/poplib.py` + .. index:: pair: POP3; protocol -**Source code:** :source:`Lib/poplib.py` - -------------- This module defines a class, :class:`POP3`, which encapsulates a connection to a diff -r 3f3b3d4881f6 Doc/library/posix.rst --- a/Doc/library/posix.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/posix.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,6 +5,9 @@ :platform: Unix :synopsis: The most common POSIX system calls (normally used via module os). +**Source code:** :source:`Modules/posixmodule.c` + +-------------- This module provides access to operating system functionality that is standardized by the C Standard and the POSIX standard (a thinly disguised Unix diff -r 3f3b3d4881f6 Doc/library/pprint.rst --- a/Doc/library/pprint.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pprint.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: pprint :synopsis: Data pretty printer. + .. moduleauthor:: Fred L. Drake, Jr. .. sectionauthor:: Fred L. Drake, Jr. diff -r 3f3b3d4881f6 Doc/library/pty.rst --- a/Doc/library/pty.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pty.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,9 +4,13 @@ .. module:: pty :platform: Linux :synopsis: Pseudo-Terminal Handling for Linux. + .. moduleauthor:: Steen Lumholt .. sectionauthor:: Moshe Zadka +**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 -r 3f3b3d4881f6 Doc/library/pwd.rst --- a/Doc/library/pwd.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pwd.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,6 +5,9 @@ :platform: Unix :synopsis: The password database (getpwnam() and friends). +**Source code:** :source:`Modules/pwdmodule.c` + +-------------- This module provides access to the Unix user account and password database. It is available on all Unix versions. diff -r 3f3b3d4881f6 Doc/library/py_compile.rst --- a/Doc/library/py_compile.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/py_compile.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,13 +3,14 @@ .. module:: py_compile :synopsis: Generate byte-code files from Python source files. + .. sectionauthor:: Fred L. Drake, Jr. .. documentation based on module docstrings +**Source code:** :source:`Lib/py_compile.py` + .. index:: pair: file; byte-code -**Source code:** :source:`Lib/py_compile.py` - -------------- The :mod:`py_compile` module provides a function to generate a byte-code file diff -r 3f3b3d4881f6 Doc/library/pyclbr.rst --- a/Doc/library/pyclbr.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pyclbr.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: pyclbr :synopsis: Supports information extraction for a Python class browser. + .. sectionauthor:: Fred L. Drake, Jr. **Source code:** :source:`Lib/pyclbr.py` diff -r 3f3b3d4881f6 Doc/library/pydoc.rst --- a/Doc/library/pydoc.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pydoc.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,17 +3,17 @@ .. module:: pydoc :synopsis: Documentation generator and online help system. + .. moduleauthor:: Ka-Ping Yee .. sectionauthor:: Ka-Ping Yee +**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 -r 3f3b3d4881f6 Doc/library/pyexpat.rst --- a/Doc/library/pyexpat.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/pyexpat.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,8 +3,12 @@ .. module:: xml.parsers.expat :synopsis: An interface to the Expat non-validating XML parser. + .. moduleauthor:: Paul Prescod +**Source code:** :source:`Modules/pyexpat.c` + +-------------- .. Markup notes: diff -r 3f3b3d4881f6 Doc/library/quopri.rst --- a/Doc/library/quopri.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/quopri.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/re.rst --- a/Doc/library/re.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/re.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: re :synopsis: Regular expression operations. + .. moduleauthor:: Fredrik Lundh .. sectionauthor:: Andrew M. Kuchling +**Source code:** :source:`Lib/re.py` + +-------------- This module provides regular expression matching operations similar to those found in Perl. diff -r 3f3b3d4881f6 Doc/library/readline.rst --- a/Doc/library/readline.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/readline.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,8 +4,12 @@ .. module:: readline :platform: Unix :synopsis: GNU readline support for Python. + .. sectionauthor:: Skip Montanaro +**Source code:** :source:`Modules/readline.c` + +-------------- The :mod:`readline` module defines a number of functions to facilitate completion and reading/writing of history files from the Python interpreter. diff -r 3f3b3d4881f6 Doc/library/reprlib.rst --- a/Doc/library/reprlib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/reprlib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: reprlib :synopsis: Alternate repr() implementation with size limits. + .. sectionauthor:: Fred L. Drake, Jr. **Source code:** :source:`Lib/reprlib.py` diff -r 3f3b3d4881f6 Doc/library/resource.rst --- a/Doc/library/resource.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/resource.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,9 +4,13 @@ .. module:: resource :platform: Unix :synopsis: An interface to provide resource usage information on the current process. + .. moduleauthor:: Jeremy Hylton .. sectionauthor:: Jeremy Hylton +**Source code:** :source:`Modules/resource.c` + +-------------- This module provides basic mechanisms for measuring and controlling system resources utilized by a program. diff -r 3f3b3d4881f6 Doc/library/rlcompleter.rst --- a/Doc/library/rlcompleter.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/rlcompleter.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: rlcompleter :synopsis: Python identifier completion, suitable for the GNU readline library. + .. sectionauthor:: Moshe Zadka **Source code:** :source:`Lib/rlcompleter.py` diff -r 3f3b3d4881f6 Doc/library/runpy.rst --- a/Doc/library/runpy.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/runpy.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: runpy :synopsis: Locate and run Python modules without importing them first. + .. moduleauthor:: Nick Coghlan **Source code:** :source:`Lib/runpy.py` diff -r 3f3b3d4881f6 Doc/library/sched.rst --- a/Doc/library/sched.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/sched.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,12 +3,13 @@ .. module:: sched :synopsis: General purpose event scheduler. + .. sectionauthor:: Moshe Zadka +**Source code:** :source:`Lib/sched.py` + .. index:: single: event scheduling -**Source code:** :source:`Lib/sched.py` - -------------- The :mod:`sched` module defines a class which implements a general purpose event diff -r 3f3b3d4881f6 Doc/library/select.rst --- a/Doc/library/select.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/select.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: select :synopsis: Wait for I/O completion on multiple streams. +**Source code:** :source:`Modules/selectmodule.c` + +-------------- 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 -r 3f3b3d4881f6 Doc/library/selectors.rst --- a/Doc/library/selectors.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/selectors.rst Wed Apr 20 03:13:12 2016 +0100 @@ -6,6 +6,9 @@ .. versionadded:: 3.4 +**Source code:** :source:`Lib/selectors.py` + +-------------- Introduction ------------ diff -r 3f3b3d4881f6 Doc/library/shelve.rst --- a/Doc/library/shelve.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/shelve.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/shlex.rst --- a/Doc/library/shlex.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/shlex.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: shlex :synopsis: Simple lexical analysis for Unix shell-like languages. + .. moduleauthor:: Eric S. Raymond .. moduleauthor:: Gustavo Niemeyer .. sectionauthor:: Eric S. Raymond diff -r 3f3b3d4881f6 Doc/library/shutil.rst --- a/Doc/library/shutil.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/shutil.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,15 +3,16 @@ .. module:: shutil :synopsis: High-level file operations, including copying. + .. sectionauthor:: Fred L. Drake, Jr. .. 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 -r 3f3b3d4881f6 Doc/library/signal.rst --- a/Doc/library/signal.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/signal.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: signal :synopsis: Set handlers for asynchronous events. +**Source code:** :source:`Modules/signalmodule.c` + +-------------- This module provides mechanisms to use signal handlers in Python. diff -r 3f3b3d4881f6 Doc/library/smtplib.rst --- a/Doc/library/smtplib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/smtplib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,15 +3,15 @@ .. module:: smtplib :synopsis: SMTP protocol client (requires sockets). + .. sectionauthor:: Eric S. Raymond +**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 -r 3f3b3d4881f6 Doc/library/sndhdr.rst --- a/Doc/library/sndhdr.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/sndhdr.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,15 +3,16 @@ .. module:: sndhdr :synopsis: Determine type of a sound file. + .. sectionauthor:: Fred L. Drake, Jr. .. 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 -r 3f3b3d4881f6 Doc/library/socket.rst --- a/Doc/library/socket.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/socket.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/spwd.rst --- a/Doc/library/spwd.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/spwd.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,6 +5,9 @@ :platform: Unix :synopsis: The shadow password database (getspnam() and friends). +**Source code:** :source:`Modules/spwdmodule.c` + +-------------- This module provides access to the Unix shadow password database. It is available on various Unix versions. diff -r 3f3b3d4881f6 Doc/library/sqlite3.rst --- a/Doc/library/sqlite3.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/sqlite3.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,8 +3,12 @@ .. module:: sqlite3 :synopsis: A DB-API 2.0 implementation using SQLite 3.x. + .. sectionauthor:: Gerhard Häring +**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 -r 3f3b3d4881f6 Doc/library/ssl.rst --- a/Doc/library/ssl.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/ssl.rst Wed Apr 20 03:13:12 2016 +0100 @@ -7,13 +7,12 @@ .. moduleauthor:: Bill Janssen .. sectionauthor:: Bill Janssen +**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 -r 3f3b3d4881f6 Doc/library/stat.rst --- a/Doc/library/stat.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/stat.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,10 +4,11 @@ .. module:: stat :synopsis: Utilities for interpreting the results of os.stat(), os.lstat() and os.fstat(). + .. sectionauthor:: Skip Montanaro **Source code:** :source:`Modules/_stat.c` - :source:`Lib/stat.py` +and :source:`Lib/stat.py` -------------- diff -r 3f3b3d4881f6 Doc/library/statistics.rst --- a/Doc/library/statistics.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/statistics.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,18 +3,19 @@ .. module:: statistics :synopsis: mathematical statistics functions + .. moduleauthor:: Steven D'Aprano .. sectionauthor:: Steven D'Aprano .. versionadded:: 3.4 +**Source code:** :source:`Lib/statistics.py` + .. testsetup:: * from statistics import * __name__ = '' -**Source code:** :source:`Lib/statistics.py` - -------------- This module provides functions for calculating mathematical statistics of diff -r 3f3b3d4881f6 Doc/library/stringprep.rst --- a/Doc/library/stringprep.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/stringprep.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: stringprep :synopsis: String preparation, as per RFC 3453 + .. moduleauthor:: Martin v. Löwis .. sectionauthor:: Martin v. Löwis +**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 -r 3f3b3d4881f6 Doc/library/struct.rst --- a/Doc/library/struct.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/struct.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/subprocess.rst --- a/Doc/library/subprocess.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/subprocess.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: subprocess :synopsis: Subprocess management. + .. moduleauthor:: Peter Åstrand .. sectionauthor:: Peter Åstrand +**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 -r 3f3b3d4881f6 Doc/library/sunau.rst --- a/Doc/library/sunau.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/sunau.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: sunau :synopsis: Provide an interface to the Sun AU sound format. + .. sectionauthor:: Moshe Zadka **Source code:** :source:`Lib/sunau.py` diff -r 3f3b3d4881f6 Doc/library/symbol.rst --- a/Doc/library/symbol.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/symbol.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: symbol :synopsis: Constants representing internal nodes of the parse tree. + .. sectionauthor:: Fred L. Drake, Jr. **Source code:** :source:`Lib/symbol.py` diff -r 3f3b3d4881f6 Doc/library/sys.rst --- a/Doc/library/sys.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/sys.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: sys :synopsis: Access system-specific parameters and functions. +**Source code:** :source:`Python/sysmodule.c` + +-------------- 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 -r 3f3b3d4881f6 Doc/library/sysconfig.rst --- a/Doc/library/sysconfig.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/sysconfig.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,16 +3,17 @@ .. module:: sysconfig :synopsis: Python's configuration information + .. moduleauthor:: Tarek Ziadé .. sectionauthor:: Tarek Ziadé -.. 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 -r 3f3b3d4881f6 Doc/library/syslog.rst --- a/Doc/library/syslog.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/syslog.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,6 +5,9 @@ :platform: Unix :synopsis: An interface to the Unix syslog library routines. +**Source code:** :source:`Modules/syslogmodule.c` + +-------------- 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 -r 3f3b3d4881f6 Doc/library/tabnanny.rst --- a/Doc/library/tabnanny.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tabnanny.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 .. sectionauthor:: Peter Funk diff -r 3f3b3d4881f6 Doc/library/tarfile.rst --- a/Doc/library/tarfile.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tarfile.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,7 +4,6 @@ .. module:: tarfile :synopsis: Read and write tar-format archive files. - .. moduleauthor:: Lars Gustäbel .. sectionauthor:: Lars Gustäbel diff -r 3f3b3d4881f6 Doc/library/telnetlib.rst --- a/Doc/library/telnetlib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/telnetlib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,13 +3,13 @@ .. module:: telnetlib :synopsis: Telnet client class. + .. sectionauthor:: Skip Montanaro +**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 -r 3f3b3d4881f6 Doc/library/tempfile.rst --- a/Doc/library/tempfile.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tempfile.rst Wed Apr 20 03:13:12 2016 +0100 @@ -1,19 +1,17 @@ :mod:`tempfile` --- Generate temporary files and directories ============================================================ -.. sectionauthor:: Zack Weinberg - - .. module:: tempfile :synopsis: Generate temporary files and directories. +.. sectionauthor:: Zack Weinberg + +**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 -r 3f3b3d4881f6 Doc/library/termios.rst --- a/Doc/library/termios.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/termios.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,11 +5,14 @@ :platform: Unix :synopsis: POSIX style tty control. +**Source code:** :source:`Modules/termios.c` .. 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 the POSIX or Unix manual pages. It is only available for those Unix versions that support POSIX *termios* style tty diff -r 3f3b3d4881f6 Doc/library/test.rst --- a/Doc/library/test.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/test.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,8 +3,11 @@ .. module:: test :synopsis: Regression tests package containing the testing suite for Python. + .. sectionauthor:: Brett Cannon +**Source code:** :source:`Lib/test/` + .. note:: The :mod:`test` package is meant for internal use by Python only. It is documented for the benefit of the core developers of Python. Any use of @@ -12,6 +15,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 -r 3f3b3d4881f6 Doc/library/textwrap.rst --- a/Doc/library/textwrap.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/textwrap.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: textwrap :synopsis: Text wrapping and filling + .. moduleauthor:: Greg Ward .. sectionauthor:: Greg Ward diff -r 3f3b3d4881f6 Doc/library/time.rst --- a/Doc/library/time.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/time.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,6 +4,9 @@ .. module:: time :synopsis: Time access and conversions. +**Source code:** :source:`Modules/timemodule.c` + +-------------- This module provides various time-related functions. For related functionality, see also the :mod:`datetime` and :mod:`calendar` modules. diff -r 3f3b3d4881f6 Doc/library/timeit.rst --- a/Doc/library/timeit.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/timeit.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/tkinter.rst --- a/Doc/library/tkinter.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tkinter.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,8 +3,12 @@ .. module:: tkinter :synopsis: Interface to Tcl/Tk for graphical user interfaces + .. moduleauthor:: Guido van Rossum +**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 -r 3f3b3d4881f6 Doc/library/tkinter.scrolledtext.rst --- a/Doc/library/tkinter.scrolledtext.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tkinter.scrolledtext.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,8 +4,12 @@ .. module:: tkinter.scrolledtext :platform: Tk :synopsis: Text widget with a vertical scroll bar. + .. sectionauthor:: Fred L. Drake, Jr. +**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 -r 3f3b3d4881f6 Doc/library/tkinter.tix.rst --- a/Doc/library/tkinter.tix.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tkinter.tix.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,11 +3,15 @@ .. module:: tkinter.tix :synopsis: Tk Extension Widgets for Tkinter + .. sectionauthor:: Mike Clarkson +**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 -r 3f3b3d4881f6 Doc/library/tkinter.ttk.rst --- a/Doc/library/tkinter.ttk.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tkinter.ttk.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,11 +3,15 @@ .. module:: tkinter.ttk :synopsis: Tk themed widget set + .. sectionauthor:: Guilherme Polo +**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 -r 3f3b3d4881f6 Doc/library/token.rst --- a/Doc/library/token.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/token.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: token :synopsis: Constants representing terminal nodes of the parse tree. + .. sectionauthor:: Fred L. Drake, Jr. **Source code:** :source:`Lib/token.py` diff -r 3f3b3d4881f6 Doc/library/tokenize.rst --- a/Doc/library/tokenize.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tokenize.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: tokenize :synopsis: Lexical scanner for Python source code. + .. moduleauthor:: Ka Ping Yee .. sectionauthor:: Fred L. Drake, Jr. diff -r 3f3b3d4881f6 Doc/library/traceback.rst --- a/Doc/library/traceback.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/traceback.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/tracemalloc.rst --- a/Doc/library/tracemalloc.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tracemalloc.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/tty.rst --- a/Doc/library/tty.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/tty.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,9 +4,13 @@ .. module:: tty :platform: Unix :synopsis: Utility functions that perform common terminal control operations. + .. moduleauthor:: Steen Lumholt .. sectionauthor:: Moshe Zadka +**Source code:** :source:`Lib/tty.py` + +-------------- The :mod:`tty` module defines functions for putting the tty into cbreak and raw modes. diff -r 3f3b3d4881f6 Doc/library/turtle.rst --- a/Doc/library/turtle.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/turtle.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,13 +4,18 @@ .. module:: turtle :synopsis: An educational framework for simple graphics applications + .. sectionauthor:: Gregor Lingl +**Source code:** :source:`Lib/turtle.py` + .. testsetup:: default from turtle import * turtle = Turtle() +-------------- + Introduction ============ diff -r 3f3b3d4881f6 Doc/library/typing.rst --- a/Doc/library/typing.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/typing.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,10 +4,10 @@ .. module:: typing :synopsis: Support for type hints (see PEP 484). +.. versionadded:: 3.5 + **Source code:** :source:`Lib/typing.py` -.. versionadded:: 3.5 - -------------- This module supports type hints as specified by :pep:`484`. The most diff -r 3f3b3d4881f6 Doc/library/unicodedata.rst --- a/Doc/library/unicodedata.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/unicodedata.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,16 +3,20 @@ .. module:: unicodedata :synopsis: Access the Unicode Database. + .. moduleauthor:: Marc-André Lemburg .. sectionauthor:: Marc-André Lemburg .. sectionauthor:: Martin v. Löwis +**Source code:** :source:`Modules/unicodedata.c` .. 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 -r 3f3b3d4881f6 Doc/library/unittest.mock-examples.rst --- a/Doc/library/unittest.mock-examples.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/unittest.mock-examples.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,9 +4,6 @@ .. moduleauthor:: Michael Foord .. currentmodule:: unittest.mock -.. versionadded:: 3.3 - - .. _getting-started: Using Mock diff -r 3f3b3d4881f6 Doc/library/unittest.mock.rst --- a/Doc/library/unittest.mock.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/unittest.mock.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,11 +4,16 @@ .. module:: unittest.mock :synopsis: Mock object library. + .. moduleauthor:: Michael Foord .. 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. diff -r 3f3b3d4881f6 Doc/library/unittest.rst --- a/Doc/library/unittest.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/unittest.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,11 +3,16 @@ .. module:: unittest :synopsis: Unit testing framework for Python. + .. moduleauthor:: Steve Purcell .. sectionauthor:: Steve Purcell .. sectionauthor:: Fred L. Drake, Jr. .. sectionauthor:: Raymond Hettinger +**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 `.) diff -r 3f3b3d4881f6 Doc/library/urllib.error.rst --- a/Doc/library/urllib.error.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/urllib.error.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: urllib.error :synopsis: Exception classes raised by urllib.request. + .. moduleauthor:: Jeremy Hylton .. sectionauthor:: Senthil Kumaran +**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 -r 3f3b3d4881f6 Doc/library/urllib.parse.rst --- a/Doc/library/urllib.parse.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/urllib.parse.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/urllib.request.rst --- a/Doc/library/urllib.request.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/urllib.request.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,10 +3,14 @@ .. module:: urllib.request :synopsis: Extensible library for opening URLs. + .. moduleauthor:: Jeremy Hylton .. sectionauthor:: Moshe Zadka .. sectionauthor:: Senthil Kumaran +**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 -r 3f3b3d4881f6 Doc/library/urllib.robotparser.rst --- a/Doc/library/urllib.robotparser.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/urllib.robotparser.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,8 +4,10 @@ .. module:: urllib.robotparser :synopsis: Load a robots.txt file and answer questions about fetchability of other URLs. + .. sectionauthor:: Skip Montanaro +**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 -r 3f3b3d4881f6 Doc/library/urllib.rst --- a/Doc/library/urllib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/urllib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/uu.rst --- a/Doc/library/uu.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/uu.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: uu :synopsis: Encode and decode files in uuencode format. + .. moduleauthor:: Lance Ellinghouse **Source code:** :source:`Lib/uu.py` diff -r 3f3b3d4881f6 Doc/library/uuid.rst --- a/Doc/library/uuid.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/uuid.rst Wed Apr 20 03:13:12 2016 +0100 @@ -6,6 +6,9 @@ .. moduleauthor:: Ka-Ping Yee .. sectionauthor:: George Yoshida +**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 -r 3f3b3d4881f6 Doc/library/venv.rst --- a/Doc/library/venv.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/venv.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,16 +3,16 @@ .. module:: venv :synopsis: Creation of virtual environments. + .. moduleauthor:: Vinay Sajip .. sectionauthor:: Vinay Sajip - -.. index:: pair: Environments; virtual - .. versionadded:: 3.3 **Source code:** :source:`Lib/venv` +.. index:: pair: Environments; virtual + -------------- The :mod:`venv` module provides support for creating lightweight "virtual diff -r 3f3b3d4881f6 Doc/library/warnings.rst --- a/Doc/library/warnings.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/warnings.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/wave.rst --- a/Doc/library/wave.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/wave.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: wave :synopsis: Provide an interface to the WAV sound format. + .. sectionauthor:: Moshe Zadka .. Documentations stolen from comments in file. diff -r 3f3b3d4881f6 Doc/library/weakref.rst --- a/Doc/library/weakref.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/weakref.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: weakref :synopsis: Support for weak references and weak dictionaries. + .. moduleauthor:: Fred L. Drake, Jr. .. moduleauthor:: Neil Schemenauer .. moduleauthor:: Martin von Löwis diff -r 3f3b3d4881f6 Doc/library/webbrowser.rst --- a/Doc/library/webbrowser.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/webbrowser.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: webbrowser :synopsis: Easy-to-use controller for Web browsers. + .. moduleauthor:: Fred L. Drake, Jr. .. sectionauthor:: Fred L. Drake, Jr. diff -r 3f3b3d4881f6 Doc/library/winreg.rst --- a/Doc/library/winreg.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/winreg.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,8 +4,12 @@ .. module:: winreg :platform: Windows :synopsis: Routines and objects for manipulating the Windows registry. + .. sectionauthor:: Mark Hammond +**Source code:** :source:`PC/winreg.c` + +-------------- These functions expose the Windows registry API to Python. Instead of using an integer as the registry handle, a :ref:`handle object ` is used diff -r 3f3b3d4881f6 Doc/library/winsound.rst --- a/Doc/library/winsound.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/winsound.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,9 +4,13 @@ .. module:: winsound :platform: Windows :synopsis: Access to the sound-playing machinery for Windows. + .. moduleauthor:: Toby Dickenson .. sectionauthor:: Fred L. Drake, Jr. +**Source code:** :source:`PC/winsound.c` + +-------------- The :mod:`winsound` module provides access to the basic sound-playing machinery provided by Windows platforms. It includes functions and several constants. diff -r 3f3b3d4881f6 Doc/library/wsgiref.rst --- a/Doc/library/wsgiref.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/wsgiref.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: wsgiref :synopsis: WSGI Utilities and Reference Implementation. + .. moduleauthor:: Phillip J. Eby .. sectionauthor:: Phillip J. Eby +**Source code:** :source:`Lib/wsgiref/` + +-------------- The Web Server Gateway Interface (WSGI) is a standard interface between web server software and web applications written in Python. Having a standard diff -r 3f3b3d4881f6 Doc/library/xdrlib.rst --- a/Doc/library/xdrlib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xdrlib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -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 -r 3f3b3d4881f6 Doc/library/xml.dom.minidom.rst --- a/Doc/library/xml.dom.minidom.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xml.dom.minidom.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: xml.dom.minidom :synopsis: Minimal Document Object Model (DOM) implementation. + .. moduleauthor:: Paul Prescod .. sectionauthor:: Paul Prescod .. sectionauthor:: Martin v. Löwis diff -r 3f3b3d4881f6 Doc/library/xml.dom.pulldom.rst --- a/Doc/library/xml.dom.pulldom.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xml.dom.pulldom.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: xml.dom.pulldom :synopsis: Support for building partial DOM trees from SAX events. + .. moduleauthor:: Paul Prescod **Source code:** :source:`Lib/xml/dom/pulldom.py` diff -r 3f3b3d4881f6 Doc/library/xml.dom.rst --- a/Doc/library/xml.dom.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xml.dom.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: xml.dom :synopsis: Document Object Model API for Python. + .. sectionauthor:: Paul Prescod .. sectionauthor:: Martin v. Löwis +**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 -r 3f3b3d4881f6 Doc/library/xml.etree.elementtree.rst --- a/Doc/library/xml.etree.elementtree.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xml.etree.elementtree.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,8 +3,13 @@ .. module:: xml.etree.ElementTree :synopsis: Implementation of the ElementTree API. + .. moduleauthor:: Fredrik Lundh +**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 -r 3f3b3d4881f6 Doc/library/xml.rst --- a/Doc/library/xml.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xml.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,9 +5,13 @@ .. module:: xml :synopsis: Package containing XML processing modules + .. sectionauthor:: Christian Heimes .. sectionauthor:: Georg Brandl +**Source code:** :source:`Lib/xml/` + +-------------- Python's interfaces for processing XML are grouped in the ``xml`` package. diff -r 3f3b3d4881f6 Doc/library/xml.sax.handler.rst --- a/Doc/library/xml.sax.handler.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xml.sax.handler.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: xml.sax.handler :synopsis: Base classes for SAX event handlers. + .. moduleauthor:: Lars Marius Garshol .. sectionauthor:: Martin v. Löwis +**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 -r 3f3b3d4881f6 Doc/library/xml.sax.reader.rst --- a/Doc/library/xml.sax.reader.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xml.sax.reader.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: xml.sax.xmlreader :synopsis: Interface which SAX-compliant XML parsers must implement. + .. moduleauthor:: Lars Marius Garshol .. sectionauthor:: Martin v. Löwis +**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 -r 3f3b3d4881f6 Doc/library/xml.sax.rst --- a/Doc/library/xml.sax.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xml.sax.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,10 +3,14 @@ .. module:: xml.sax :synopsis: Package containing SAX2 base classes and convenience functions. + .. moduleauthor:: Lars Marius Garshol .. sectionauthor:: Fred L. Drake, Jr. .. sectionauthor:: Martin v. Löwis +**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 -r 3f3b3d4881f6 Doc/library/xml.sax.utils.rst --- a/Doc/library/xml.sax.utils.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xml.sax.utils.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,9 +3,13 @@ .. module:: xml.sax.saxutils :synopsis: Convenience functions and classes for use with SAX. + .. moduleauthor:: Lars Marius Garshol .. sectionauthor:: Martin v. Löwis +**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 -r 3f3b3d4881f6 Doc/library/xmlrpc.client.rst --- a/Doc/library/xmlrpc.client.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xmlrpc.client.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,15 +3,15 @@ .. module:: xmlrpc.client :synopsis: XML-RPC client access. + .. moduleauthor:: Fredrik Lundh .. sectionauthor:: Eric S. Raymond +**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 as a diff -r 3f3b3d4881f6 Doc/library/xmlrpc.server.rst --- a/Doc/library/xmlrpc.server.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/xmlrpc.server.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: xmlrpc.server :synopsis: Basic XML-RPC server implementations. + .. moduleauthor:: Brian Quinlan .. sectionauthor:: Fred L. Drake, Jr. diff -r 3f3b3d4881f6 Doc/library/zipapp.rst --- a/Doc/library/zipapp.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/zipapp.rst Wed Apr 20 03:13:12 2016 +0100 @@ -4,14 +4,13 @@ .. module:: zipapp :synopsis: Manage executable python zip archives +.. versionadded:: 3.5 + +**Source code:** :source:`Lib/zipapp.py` .. index:: single: Executable Zip Files -.. versionadded:: 3.5 - -**Source code:** :source:`Lib/zipapp.py` - -------------- This module provides tools to manage the creation of zip files containing diff -r 3f3b3d4881f6 Doc/library/zipfile.rst --- a/Doc/library/zipfile.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/zipfile.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,6 +3,7 @@ .. module:: zipfile :synopsis: Read and write ZIP-format archive files. + .. moduleauthor:: James C. Ahlstrom .. sectionauthor:: James C. Ahlstrom diff -r 3f3b3d4881f6 Doc/library/zipimport.rst --- a/Doc/library/zipimport.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/zipimport.rst Wed Apr 20 03:13:12 2016 +0100 @@ -3,8 +3,12 @@ .. module:: zipimport :synopsis: support for importing Python modules from ZIP archives. + .. moduleauthor:: Just van Rossum +**Source code:** :source:`Modules/zipimport.c` + +-------------- 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 -r 3f3b3d4881f6 Doc/library/zlib.rst --- a/Doc/library/zlib.rst Wed Apr 13 15:37:23 2016 +0300 +++ b/Doc/library/zlib.rst Wed Apr 20 03:13:12 2016 +0100 @@ -5,6 +5,9 @@ :synopsis: Low-level interface to compression and decompression routines compatible with gzip. +**Source code:** :source:`Modules/zlibmodule.c` + +-------------- For applications that require data compression, the functions in this module allow compression and decompression, using the zlib library. The zlib library