Merge Issue #22558.

This commit is contained in:
Terry Jan Reedy 2016-06-11 15:06:08 -04:00
commit 4da945f361
224 changed files with 542 additions and 136 deletions

View File

@ -449,10 +449,14 @@ and off individually. They are described here in more detail.
.. module:: lib2to3
:synopsis: the 2to3 library
.. moduleauthor:: Guido van Rossum
.. moduleauthor:: Collin Winter
.. moduleauthor:: Benjamin Peterson <benjamin@python.org>
**Source code:** :source:`Lib/lib2to3/`
--------------
.. note::

View File

@ -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.

View File

@ -4,13 +4,14 @@
.. module:: _thread
:synopsis: Low-level threading API.
.. index::
single: light-weight processes
single: processes, light-weight
single: binary semaphores
single: semaphores, binary
--------------
This module provides low-level primitives for working with multiple threads
(also called :dfn:`light-weight processes` or :dfn:`tasks`) --- multiple threads of
control sharing their global data space. For synchronization, simple locks

View File

@ -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

View File

@ -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.

View File

@ -3,6 +3,7 @@
.. module:: argparse
:synopsis: Command-line option and argument parsing library.
.. moduleauthor:: Steven Bethard <steven.bethard@gmail.com>
.. sectionauthor:: Steven Bethard <steven.bethard@gmail.com>

View File

@ -4,9 +4,10 @@
.. module:: array
:synopsis: Space efficient arrays of uniformly typed numeric values.
.. index:: single: arrays
--------------
This module defines an object type which can compactly represent an array of
basic values: characters, integers, floating point numbers. Arrays are sequence
types and behave very much like lists, except that the type of objects stored in

View File

@ -3,6 +3,7 @@
.. module:: asynchat
:synopsis: Support for asynchronous command/response protocols.
.. moduleauthor:: Sam Rushing <rushing@nightmare.com>
.. sectionauthor:: Steve Holden <sholden@holdenweb.com>

View File

@ -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

View File

@ -4,6 +4,7 @@
.. module:: asyncore
:synopsis: A base class for developing asynchronous socket handling
services.
.. moduleauthor:: Sam Rushing <rushing@nightmare.com>
.. sectionauthor:: Christopher Petrilli <petrilli@amber.org>
.. sectionauthor:: Steve Holden <sholden@holdenweb.com>

View File

@ -3,9 +3,11 @@
.. module:: atexit
:synopsis: Register and execute cleanup functions.
.. moduleauthor:: Skip Montanaro <skip@pobox.com>
.. sectionauthor:: Skip Montanaro <skip@pobox.com>
--------------
The :mod:`atexit` module defines functions to register and unregister cleanup
functions. Functions thus registered are automatically executed upon normal

View File

@ -4,6 +4,7 @@
.. module:: audioop
:synopsis: Manipulate raw audio data.
--------------
The :mod:`audioop` module contains some useful operations on sound fragments.
It operates on sound fragments consisting of signed integer samples 8, 16, 24

View File

@ -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

View File

@ -5,12 +5,13 @@
:synopsis: Tools for converting between binary and various ASCII-encoded binary
representations.
.. index::
module: uu
module: base64
module: binhex
--------------
The :mod:`binascii` module contains a number of methods to convert between
binary and various ASCII-encoded binary representations. Normally, you will not
use these functions directly but use wrapper modules like :mod:`uu`,

View File

@ -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.

View File

@ -4,6 +4,7 @@
.. module:: builtins
:synopsis: The module that provides the built-in namespace.
--------------
This module provides direct access to all 'built-in' identifiers of Python; for
example, ``builtins.open`` is the full name for the built-in function

View File

@ -3,11 +3,15 @@
.. module:: bz2
:synopsis: Interfaces for bzip2 compression and decompression.
.. moduleauthor:: Gustavo Niemeyer <niemeyer@conectiva.com>
.. moduleauthor:: Nadeem Vawda <nadeem.vawda@gmail.com>
.. sectionauthor:: Gustavo Niemeyer <niemeyer@conectiva.com>
.. sectionauthor:: Nadeem Vawda <nadeem.vawda@gmail.com>
**Source code:** :source:`Lib/bz2.py`
--------------
This module provides a comprehensive interface for compressing and
decompressing data using the bzip2 compression algorithm.

View File

@ -4,6 +4,7 @@
.. module:: calendar
:synopsis: Functions for working with calendars, including some emulation
of the Unix cal program.
.. sectionauthor:: Drew Csillag <drew_csillag@geocities.com>
**Source code:** :source:`Lib/calendar.py`

View File

@ -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.

View File

@ -3,9 +3,11 @@
.. module:: cgitb
:synopsis: Configurable traceback handler for CGI scripts.
.. moduleauthor:: Ka-Ping Yee <ping@lfw.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
**Source code:** :source:`Lib/cgitb.py`
.. index::
single: CGI; exceptions
@ -13,6 +15,8 @@
single: exceptions; in CGI scripts
single: tracebacks; in CGI scripts
--------------
The :mod:`cgitb` module provides a special exception handler for Python scripts.
(Its name is a bit misleading. It was originally designed to display extensive
traceback information in HTML for CGI scripts. It was later generalized to also

View File

@ -3,9 +3,11 @@
.. module:: chunk
:synopsis: Module to read IFF chunks.
.. moduleauthor:: Sjoerd Mullender <sjoerd@acm.org>
.. sectionauthor:: Sjoerd Mullender <sjoerd@acm.org>
**Source code:** :source:`Lib/chunk.py`
.. index::
single: Audio Interchange File Format
@ -14,6 +16,8 @@
single: Real Media File Format
single: RMFF
--------------
This module provides an interface for reading files that use EA IFF 85 chunks.
[#]_ This format is used in at least the Audio Interchange File Format
(AIFF/AIFF-C) and the Real Media File Format (RMFF). The WAVE audio file format

View File

@ -4,6 +4,7 @@
.. module:: cmath
:synopsis: Mathematical functions for complex numbers.
--------------
This module is always available. It provides access to mathematical functions
for complex numbers. The functions in this module accept integers,

View File

@ -3,6 +3,7 @@
.. module:: cmd
:synopsis: Build line-oriented command interpreters.
.. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com>
**Source code:** :source:`Lib/cmd.py`

View File

@ -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.

View File

@ -3,6 +3,7 @@
.. module:: codecs
:synopsis: Encode and decode data and streams.
.. moduleauthor:: Marc-André Lemburg <mal@lemburg.com>
.. sectionauthor:: Marc-André Lemburg <mal@lemburg.com>
.. sectionauthor:: Martin v. Löwis <martin@v.loewis.de>
@ -17,6 +18,8 @@
single: streams
pair: stackable; streams
--------------
This module defines base classes for standard Python codecs (encoders and
decoders) and provides access to the internal Python codec registry, which
manages the codec and error handling lookup process. Most standard codecs

View File

@ -3,9 +3,14 @@
.. module:: codeop
:synopsis: Compile (possibly incomplete) Python code.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. sectionauthor:: Michael Hudson <mwh@python.net>
**Source code:** :source:`Lib/codeop.py`
--------------
The :mod:`codeop` module provides utilities upon which the Python
read-eval-print loop can be emulated, as is done in the :mod:`code` module. As
a result, you probably don't want to use the module directly; if you want to

View File

@ -3,20 +3,21 @@
.. module:: collections.abc
:synopsis: Abstract base classes for containers
.. moduleauthor:: Raymond Hettinger <python at rcn.com>
.. sectionauthor:: Raymond Hettinger <python at rcn.com>
.. versionadded:: 3.3
Formerly, this module was part of the :mod:`collections` module.
**Source code:** :source:`Lib/_collections_abc.py`
.. testsetup:: *
from collections import *
import itertools
__name__ = '<doctest>'
**Source code:** :source:`Lib/_collections_abc.py`
--------------
This module provides :term:`abstract base classes <abstract base class>` that

View File

@ -3,17 +3,18 @@
.. module:: collections
:synopsis: Container datatypes
.. moduleauthor:: Raymond Hettinger <python@rcn.com>
.. sectionauthor:: Raymond Hettinger <python@rcn.com>
**Source code:** :source:`Lib/collections/__init__.py`
.. testsetup:: *
from collections import *
import itertools
__name__ = '<doctest>'
**Source code:** :source:`Lib/collections/__init__.py`
--------------
This module implements specialized container datatypes providing alternatives to

View File

@ -3,6 +3,7 @@
.. module:: colorsys
:synopsis: Conversion functions between RGB and other color systems.
.. sectionauthor:: David Ascher <da@python.net>
**Source code:** :source:`Lib/colorsys.py`

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -4,15 +4,19 @@
.. module:: crypt
:platform: Unix
:synopsis: The crypt() function used to check Unix passwords.
.. moduleauthor:: Steven D. Majewski <sdm7g@virginia.edu>
.. sectionauthor:: Steven D. Majewski <sdm7g@virginia.edu>
.. sectionauthor:: Peter Funk <pf@artcom-gmbh.de>
**Source code:** :source:`Lib/crypt.py`
.. index::
single: crypt(3)
pair: cipher; DES
--------------
This module implements an interface to the :manpage:`crypt(3)` routine, which is
a one-way hash function based upon a modified DES algorithm; see the Unix man
page for further details. Possible uses include storing hashed passwords

View File

@ -3,6 +3,7 @@
.. module:: csv
:synopsis: Write and read tabular data to and from delimited files.
.. sectionauthor:: Skip Montanaro <skip@pobox.com>
**Source code:** :source:`Lib/csv.py`
@ -11,6 +12,8 @@
single: csv
pair: data; tabular
--------------
The so-called CSV (Comma Separated Values) format is the most common import and
export format for spreadsheets and databases. CSV format was used for many
years prior to attempts to describe the format in a standardized way in

View File

@ -3,8 +3,10 @@
.. module:: ctypes
:synopsis: A foreign function library for Python.
.. moduleauthor:: Thomas Heller <theller@python.net>
--------------
:mod:`ctypes` is a foreign function library for Python. It provides C compatible
data types, and allows calling functions in DLLs or shared libraries. It can be

View File

@ -3,9 +3,11 @@
.. module:: curses.ascii
:synopsis: Constants and set-membership functions for ASCII characters.
.. moduleauthor:: Eric S. Raymond <esr@thyrsus.com>
.. sectionauthor:: Eric S. Raymond <esr@thyrsus.com>
--------------
The :mod:`curses.ascii` module supplies name constants for ASCII characters and
functions to test membership in various ASCII character classes. The constants

View File

@ -3,8 +3,10 @@
.. module:: curses.panel
:synopsis: A panel stack extension that adds depth to curses windows.
.. sectionauthor:: A.M. Kuchling <amk@amk.ca>
--------------
Panels are windows with the added feature of depth, so they can be stacked on
top of each other, and only the visible portions of each window will be

View File

@ -5,9 +5,12 @@
:synopsis: An interface to the curses library, providing portable
terminal handling.
:platform: Unix
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. sectionauthor:: Eric Raymond <esr@thyrsus.com>
--------------
The :mod:`curses` module provides an interface to the curses library, the
de-facto standard for portable advanced terminal handling.

View File

@ -3,12 +3,15 @@
.. module:: datetime
:synopsis: Basic date and time types.
.. moduleauthor:: Tim Peters <tim@zope.com>
.. sectionauthor:: Tim Peters <tim@zope.com>
.. sectionauthor:: A.M. Kuchling <amk@amk.ca>
**Source code:** :source:`Lib/datetime.py`
--------------
.. XXX what order should the types be discussed in?
The :mod:`datetime` module supplies classes for manipulating dates and times in

View File

@ -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

View File

@ -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:

View File

@ -3,6 +3,7 @@
.. module:: difflib
:synopsis: Helpers for computing differences between objects.
.. moduleauthor:: Tim Peters <tim_one@users.sourceforge.net>
.. sectionauthor:: Tim Peters <tim_one@users.sourceforge.net>
.. Markup by Fred L. Drake, Jr. <fdrake@acm.org>
@ -14,6 +15,8 @@
import sys
from difflib import *
--------------
This module provides classes and functions for comparing sequences. It
can be used for example, for comparing files, and can produce difference
information in various formats, including HTML and context and unified

View File

@ -4,8 +4,10 @@
.. module:: distutils
:synopsis: Support for building and installing Python modules into an
existing Python installation.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
--------------
The :mod:`distutils` package provides support for building and installing
additional modules into a Python installation. The new modules may be either

View File

@ -5,11 +5,15 @@
.. module:: doctest
:synopsis: Test pieces of code within docstrings.
.. moduleauthor:: Tim Peters <tim@python.org>
.. sectionauthor:: Tim Peters <tim@python.org>
.. sectionauthor:: Moshe Zadka <moshez@debian.org>
.. sectionauthor:: Edward Loper <edloper@users.sourceforge.net>
**Source code:** :source:`Lib/doctest.py`
--------------
The :mod:`doctest` module searches for pieces of text that look like interactive
Python sessions, and then executes those sessions to verify that they work

View File

@ -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

View File

@ -7,6 +7,10 @@
.. moduleauthor:: R. David Murray <rdmurray@bitdance.com>
.. sectionauthor:: R. David Murray <rdmurray@bitdance.com>
.. versionadded:: 3.4
as a :term:`provisional module <provisional package>`.
**Source code:** :source:`Lib/email/contentmanager.py`
.. note::
@ -15,8 +19,7 @@
changes (up to and including removal of the module) may occur if deemed
necessary by the core developers.
.. versionadded:: 3.4
as a :term:`provisional module <provisional package>`.
--------------
The :mod:`~email.message` module provides a class that can represent an
arbitrary email message. That basic message model has a useful and flexible

View File

@ -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

View File

@ -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:

View File

@ -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

View File

@ -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

View File

@ -7,6 +7,10 @@
.. moduleauthor:: R. David Murray <rdmurray@bitdance.com>
.. sectionauthor:: R. David Murray <rdmurray@bitdance.com>
.. versionadded:: 3.3
as a :term:`provisional module <provisional package>`.
**Source code:** :source:`Lib/email/headerregistry.py`
.. note::
@ -15,8 +19,7 @@
changes (up to and including removal of the module) may occur if deemed
necessary by the core developers.
.. versionadded:: 3.3
as a :term:`provisional module <provisional package>`.
--------------
Headers are represented by customized subclasses of :class:`str`. The
particular class used to represent a given header is determined by the

View File

@ -4,6 +4,9 @@
.. module:: email.iterators
:synopsis: Iterate over a message object tree.
**Source code:** :source:`Lib/email/iterators.py`
--------------
Iterating over a message object tree is fairly easy with the
:meth:`Message.walk <email.message.Message.walk>` method. The

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -4,10 +4,14 @@
.. module:: email
:synopsis: Package supporting the parsing, manipulating, and generating
email messages, including MIME documents.
.. moduleauthor:: Barry A. Warsaw <barry@python.org>
.. sectionauthor:: Barry A. Warsaw <barry@python.org>
.. Copyright (C) 2001-2010 Python Software Foundation
**Source code:** :source:`Lib/email/__init__.py`
--------------
The :mod:`email` package is a library for managing email messages, including
MIME and other :rfc:`2822`\ -based message documents. It is specifically *not*

View File

@ -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:

View File

@ -7,6 +7,8 @@
.. versionadded:: 3.4
--------------
The :mod:`ensurepip` package provides support for bootstrapping the ``pip``
installer into an existing Python installation or virtual environment. This
bootstrapping approach reflects the fact that ``pip`` is an independent

View File

@ -4,6 +4,7 @@
.. module:: errno
:synopsis: Standard errno system symbols.
----------------
This module makes available standard ``errno`` system symbols. The value of each
symbol is the corresponding integer value. The names and descriptions are

View File

@ -6,6 +6,8 @@
.. versionadded:: 3.3
----------------
This module contains functions to dump Python tracebacks explicitly, on a fault,
after a timeout, or on a user signal. Call :func:`faulthandler.enable` to
install fault handlers for the :const:`SIGSEGV`, :const:`SIGFPE`,

View File

@ -4,13 +4,15 @@
.. module:: fcntl
:platform: Unix
:synopsis: The fcntl() and ioctl() system calls.
.. sectionauthor:: Jaap Vermeulen
.. sectionauthor:: Jaap Vermeulen
.. index::
pair: UNIX; file control
pair: UNIX; I/O control
----------------
This module performs file control and I/O control on file descriptors. It is an
interface to the :c:func:`fcntl` and :c:func:`ioctl` Unix routines. For a
complete description of these calls, see :manpage:`fcntl(2)` and

View File

@ -3,6 +3,7 @@
.. module:: filecmp
:synopsis: Compare files efficiently.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
**Source code:** :source:`Lib/filecmp.py`

View File

@ -3,6 +3,7 @@
.. module:: fileinput
:synopsis: Loop over standard input or a list of files.
.. moduleauthor:: Guido van Rossum <guido@python.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>

View File

@ -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

View File

@ -8,6 +8,7 @@
.. deprecated:: 3.4
Due to lack of usage, the formatter module has been deprecated.
--------------
This module supports two interface definitions, each with multiple
implementations: The *formatter* interface, and the *writer* interface which is

View File

@ -4,10 +4,10 @@
.. module:: fpectl
:platform: Unix
:synopsis: Provide control for floating point exception handling.
.. moduleauthor:: Lee Busby <busby1@llnl.gov>
.. sectionauthor:: Lee Busby <busby1@llnl.gov>
.. note::
The :mod:`fpectl` module is not built by default, and its usage is discouraged
@ -16,6 +16,8 @@
.. index:: single: IEEE-754
--------------
Most computers carry out floating point operations in conformance with the
so-called IEEE-754 standard. On any real computer, some floating point
operations produce results that cannot be expressed as a normal floating point

View File

@ -3,6 +3,7 @@
.. module:: fractions
:synopsis: Rational numbers.
.. moduleauthor:: Jeffrey Yasskin <jyasskin at gmail.com>
.. sectionauthor:: Jeffrey Yasskin <jyasskin at gmail.com>

View File

@ -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

View File

@ -3,6 +3,7 @@
.. module:: functools
:synopsis: Higher-order functions and operations on callable objects.
.. moduleauthor:: Peter Harris <scav@blueyonder.co.uk>
.. moduleauthor:: Raymond Hettinger <python@rcn.com>
.. moduleauthor:: Nick Coghlan <ncoghlan@gmail.com>

View File

@ -3,9 +3,11 @@
.. module:: gc
:synopsis: Interface to the cycle-detecting garbage collector.
.. moduleauthor:: Neil Schemenauer <nas@arctrix.com>
.. sectionauthor:: Neil Schemenauer <nas@arctrix.com>
--------------
This module provides an interface to the optional garbage collector. It
provides the ability to disable the collector, tune the collection frequency,

View File

@ -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

View File

@ -3,10 +3,15 @@
.. module:: getpass
:synopsis: Portable reading of passwords and retrieval of the userid.
.. moduleauthor:: Piers Lauder <piers@cs.su.oz.au>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. Windows (& Mac?) support by Guido van Rossum.
**Source code:** :source:`Lib/getpass.py`
--------------
The :mod:`getpass` module provides two functions:

View File

@ -3,6 +3,7 @@
.. module:: gettext
:synopsis: Multilingual internationalization services.
.. moduleauthor:: Barry A. Warsaw <barry@python.org>
.. sectionauthor:: Barry A. Warsaw <barry@python.org>

View File

@ -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

View File

@ -5,6 +5,7 @@
:platform: Unix
:synopsis: The group database (getgrnam() and friends).
--------------
This module provides access to the Unix group database. It is available on all
Unix versions.

View File

@ -3,16 +3,16 @@
.. module:: hashlib
:synopsis: Secure hash and message digest algorithms.
.. moduleauthor:: Gregory P. Smith <greg@krypto.org>
.. sectionauthor:: Gregory P. Smith <greg@krypto.org>
**Source code:** :source:`Lib/hashlib.py`
.. index::
single: message digest, MD5
single: secure hash algorithm, SHA1, SHA224, SHA256, SHA384, SHA512
**Source code:** :source:`Lib/hashlib.py`
--------------
This module implements a common interface to many different secure hash and

View File

@ -3,6 +3,7 @@
.. module:: heapq
:synopsis: Heap queue algorithm (a.k.a. priority queue).
.. moduleauthor:: Kevin O'Connor
.. sectionauthor:: Guido van Rossum <guido@python.org>
.. sectionauthor:: François Pinard

View File

@ -3,6 +3,7 @@
.. module:: hmac
:synopsis: Keyed-Hashing for Message Authentication (HMAC) implementation
.. moduleauthor:: Gerhard Häring <ghaering@users.sourceforge.net>
.. sectionauthor:: Gerhard Häring <ghaering@users.sourceforge.net>

View File

@ -3,6 +3,7 @@
.. module:: html.entities
:synopsis: Definitions of HTML general entities.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
**Source code:** :source:`Lib/html/entities.py`

View File

@ -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

View File

@ -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

View File

@ -3,6 +3,7 @@
.. module:: http.cookiejar
:synopsis: Classes for automatic handling of HTTP cookies.
.. moduleauthor:: John J. Lee <jjl@pobox.com>
.. sectionauthor:: John J. Lee <jjl@pobox.com>

View File

@ -3,6 +3,7 @@
.. module:: http.cookies
:synopsis: Support for HTTP state management (cookies).
.. moduleauthor:: Timothy O'Malley <timo@alum.mit.edu>
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>

View File

@ -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:

View File

@ -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).

View File

@ -3,12 +3,16 @@
IDLE
====
.. moduleauthor:: Guido van Rossum <guido@python.org>
**Source code:** :source:`Lib/idlelib/`
.. index::
single: IDLE
single: Python Editor
single: Integrated Development Environment
.. moduleauthor:: Guido van Rossum <guido@python.org>
--------------
IDLE is Python's Integrated Development and Learning Environment.

View File

@ -3,6 +3,7 @@
.. module:: imaplib
:synopsis: IMAP4 protocol client (requires sockets).
.. moduleauthor:: Piers Lauder <piers@communitysolutions.com.au>
.. sectionauthor:: Piers Lauder <piers@communitysolutions.com.au>
.. revised by ESR, January 2000
@ -10,14 +11,13 @@
.. changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>,
November 2002
**Source code:** :source:`Lib/imaplib.py`
.. index::
pair: IMAP4; protocol
pair: IMAP4_SSL; protocol
pair: IMAP4_stream; protocol
**Source code:** :source:`Lib/imaplib.py`
--------------
This module defines three classes, :class:`IMAP4`, :class:`IMAP4_SSL` and

View File

@ -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:

View File

@ -9,6 +9,9 @@
.. versionadded:: 3.1
**Source code:** :source:`Lib/importlib/__init__.py`
--------------
Introduction
------------

View File

@ -3,6 +3,7 @@
.. module:: inspect
:synopsis: Extract information and source code from live objects.
.. moduleauthor:: Ka-Ping Yee <ping@lfw.org>
.. sectionauthor:: Ka-Ping Yee <ping@lfw.org>

View File

@ -3,6 +3,7 @@
.. module:: io
:synopsis: Core tools for working with streams.
.. moduleauthor:: Guido van Rossum <guido@python.org>
.. moduleauthor:: Mike Verdone <mike.verdone@gmail.com>
.. moduleauthor:: Mark Russell <mark.russell@zen.co.uk>
@ -11,6 +12,10 @@
.. moduleauthor:: Benjamin Peterson <benjamin@python.org>
.. sectionauthor:: Benjamin Peterson <benjamin@python.org>
**Source code:** :source:`Lib/io.py`
--------------
.. _io-overview:
Overview

View File

@ -3,6 +3,7 @@
.. module:: ipaddress
:synopsis: IPv4/IPv6 manipulation library.
.. moduleauthor:: Peter Moody
**Source code:** :source:`Lib/ipaddress.py`

View File

@ -3,14 +3,15 @@
.. module:: itertools
:synopsis: Functions creating iterators for efficient looping.
.. moduleauthor:: Raymond Hettinger <python@rcn.com>
.. sectionauthor:: Raymond Hettinger <python@rcn.com>
.. testsetup::
from itertools import *
--------------
This module implements a number of :term:`iterator` building blocks inspired
by constructs from APL, Haskell, and SML. Each has been recast in a form

View File

@ -3,9 +3,14 @@
.. module:: json
:synopsis: Encode and decode the JSON format.
.. moduleauthor:: Bob Ippolito <bob@redivi.com>
.. sectionauthor:: Bob Ippolito <bob@redivi.com>
**Source code:** :source:`Lib/json/__init__.py`
--------------
`JSON (JavaScript Object Notation) <http://json.org>`_, specified by
:rfc:`7159` (which obsoletes :rfc:`4627`) and by
`ECMA-404 <http://www.ecma-international.org/publications/standards/Ecma-404.htm>`_,

View File

@ -3,6 +3,7 @@
.. module:: linecache
:synopsis: This module provides random access to individual lines from text files.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
**Source code:** :source:`Lib/linecache.py`

View File

@ -3,9 +3,13 @@
.. module:: locale
:synopsis: Internationalization services.
.. moduleauthor:: Martin von Löwis <martin@v.loewis.de>
.. sectionauthor:: Martin von Löwis <martin@v.loewis.de>
**Source code:** :source:`Lib/locale.py`
--------------
The :mod:`locale` module opens access to the POSIX locale database and
functionality. The POSIX locale mechanism allows programmers to deal with

View File

@ -4,10 +4,11 @@
.. module:: logging.config
:synopsis: Configuration of the logging module.
.. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
.. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
**Source code:** :source:`Lib/logging/config.py`
.. sidebar:: Important
This page contains only reference information. For tutorials,
@ -17,8 +18,6 @@
* :ref:`Advanced Tutorial <logging-advanced-tutorial>`
* :ref:`Logging Cookbook <logging-cookbook>`
**Source code:** :source:`Lib/logging/config.py`
--------------
This section describes the API for configuring the logging module.

View File

@ -4,10 +4,11 @@
.. module:: logging.handlers
:synopsis: Handlers for the logging module.
.. moduleauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
.. sectionauthor:: Vinay Sajip <vinay_sajip@red-dove.com>
**Source code:** :source:`Lib/logging/handlers.py`
.. sidebar:: Important
This page contains only reference information. For tutorials,
@ -17,8 +18,6 @@
* :ref:`Advanced Tutorial <logging-advanced-tutorial>`
* :ref:`Logging Cookbook <logging-cookbook>`
**Source code:** :source:`Lib/logging/handlers.py`
--------------
.. currentmodule:: logging

Some files were not shown because too many files have changed in this diff Show More