.. module:: __future__
:synopsis: Future statement definitions
+**Source code:** :source:`Lib/__future__.py`
+
+--------------
:mod:`__future__` is a real module, and serves three purposes:
.. versionadded:: 2.6
+**Source code:** :source:`Lib/abc.py`
+
+--------------
+
This module provides the infrastructure for defining :term:`abstract base
classes <abstract base class>` (ABCs) in Python, as outlined in :pep:`3119`; see the PEP for why this
was added to Python. (See also :pep:`3141` and the :mod:`numbers` module
single: AIFF
single: AIFF-C
+**Source code:** :source:`Lib/aifc.py`
+
+--------------
+
This module provides support for reading and writing AIFF and AIFF-C files.
AIFF is Audio Interchange File Format, a format for storing digital audio
samples in a file. AIFF-C is a newer version of the format that includes the
.. module:: argparse
:synopsis: Command-line option and argument parsing library.
.. moduleauthor:: Steven Bethard <steven.bethard@gmail.com>
-.. versionadded:: 2.7
.. sectionauthor:: Steven Bethard <steven.bethard@gmail.com>
+.. versionadded:: 2.7
+
+**Source code:** :source:`Lib/argparse.py`
+
+--------------
The :mod:`argparse` module makes it easy to write user-friendly command-line
interfaces. The program defines what arguments it requires, and :mod:`argparse`
.. versionadded:: 2.6
The high-level ``ast`` module containing all helpers.
+**Source code:** :source:`Lib/ast.py`
+
+--------------
The :mod:`ast` module helps Python applications to process trees of the Python
abstract syntax grammar. The abstract syntax itself might change with each
compiled into a Python code object using the built-in :func:`compile` function.
-.. seealso::
-
- Latest version of the `ast module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/ast.py?view=markup>`_
-
Node classes
------------
-
:mod:`asynchat` --- Asynchronous socket command/response handler
================================================================
.. moduleauthor:: Sam Rushing <rushing@nightmare.com>
.. sectionauthor:: Steve Holden <sholden@holdenweb.com>
+**Source code:** :source:`Lib/asynchat.py`
+
+--------------
This module builds on the :mod:`asyncore` infrastructure, simplifying
asynchronous clients and servers and making it easier to handle protocols
-
:mod:`asyncore` --- Asynchronous socket handler
===============================================
.. sectionauthor:: Steve Holden <sholden@holdenweb.com>
.. heavily adapted from original documentation by Sam Rushing
+**Source code:** :source:`Lib/asyncore.py`
+
+--------------
This module provides the basic infrastructure for writing asynchronous socket
service clients and servers.
-
:mod:`atexit` --- Exit handlers
===============================
.. versionadded:: 2.0
+**Source code:** :source:`Lib/atexit.py`
+
+--------------
+
The :mod:`atexit` module defines a single function to register cleanup
functions. Functions thus registered are automatically executed upon normal
interpreter termination. The order in which the functions are called is not
defined; if you have cleanup operations that depend on each other, you should
wrap them in a function and register that one. This keeps :mod:`atexit` simple.
-.. seealso::
-
- Latest version of the `atexit Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/atexit.py?view=markup>`_
-
Note: the functions registered via this module are not called when the program
is killed by a signal not handled by Python, when a Python fatal internal error
is detected, or when :func:`os._exit` is called.
module: SimpleHTTPServer
module: CGIHTTPServer
+**Source code:** :source:`Lib/BaseHTTPServer.py`
+
+--------------
+
This module defines two classes for implementing HTTP servers (Web servers).
Usually, this module isn't used directly, but is used as a basis for building
functioning Web servers. See the :mod:`SimpleHTTPServer` and
.. module:: bdb
:synopsis: Debugger framework.
+**Source code:** :source:`Lib/bdb.py`
+
+--------------
+
The :mod:`bdb` module handles basic debugger functions, like setting breakpoints
or managing execution via the debugger.
.. sectionauthor:: Raymond Hettinger <python at rcn.com>
.. example based on the PyModules FAQ entry by Aaron Watters <arw@pythonpros.com>
+.. versionadded:: 2.1
+
+**Source code:** :source:`Lib/bisect.py`
+
+--------------
+
This module provides support for maintaining a list in sorted order without
having to sort the list after each insertion. For long lists of items with
expensive comparison operations, this can be an improvement over the more common
algorithm to do its work. The source code may be most useful as a working
example of the algorithm (the boundary conditions are already right!).
-.. versionadded:: 2.1
-
-.. seealso::
-
- Latest version of the `bisect module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/bisect.py?view=markup>`_
-
The following functions are provided:
-
:mod:`calendar` --- General calendar-related functions
======================================================
program.
.. sectionauthor:: Drew Csillag <drew_csillag@geocities.com>
+**Source code:** :source:`Lib/calendar.py`
+
+--------------
This module allows you to output calendars like the Unix :program:`cal` program,
and provides additional useful functions related to the calendar. By default,
calendar in Dershowitz and Reingold's book "Calendrical Calculations", where
it's the base calendar for all computations.
-.. seealso::
-
- Latest version of the `calendar module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/calendar.py?view=markup>`_
.. class:: Calendar([firstweekday])
single: URL
single: Common Gateway Interface
+**Source code:** :source:`Lib/cgi.py`
+
+--------------
+
Support module for Common Gateway Interface (CGI) scripts.
This module defines a number of utilities for use by CGI scripts written in
-
:mod:`cmd` --- Support for line-oriented command interpreters
=============================================================
:synopsis: Build line-oriented command interpreters.
.. sectionauthor:: Eric S. Raymond <esr@snark.thyrsus.com>
+**Source code:** :source:`Lib/cmd.py`
+
+--------------
The :class:`Cmd` class provides a simple framework for writing line-oriented
command interpreters. These are often useful for test harnesses, administrative
tools, and prototypes that will later be wrapped in a more sophisticated
interface.
-.. seealso::
-
- Latest version of the `cmd module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/cmd.py?view=markup>`_
-
.. class:: Cmd([completekey[, stdin[, stdout]]])
A :class:`Cmd` instance or subclass instance is a line-oriented interpreter
-
:mod:`collections` --- High-performance container datatypes
===========================================================
import itertools
__name__ = '<doctest>'
+**Source code:** :source:`Lib/collections.py` and :source:`Lib/_abcoll.py`
+
+--------------
+
This module implements specialized container datatypes providing alternatives to
Python's general purpose built-in containers, :class:`dict`, :class:`list`,
:class:`set`, and :class:`tuple`.
used to test whether a class provides a particular interface, for example,
whether it is hashable or a mapping.
-.. seealso::
-
- Latest version of the `collections module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/collections.py?view=markup>`_
:class:`Counter` objects
------------------------
.. seealso::
- * Latest version of the `Python source code for the collections abstract base classes
- <http://svn.python.org/view/python/branches/release27-maint/Lib/_abcoll.py?view=markup>`_
-
* `OrderedSet recipe <http://code.activestate.com/recipes/576694/>`_ for an
example built on :class:`MutableSet`.
:synopsis: Conversion functions between RGB and other color systems.
.. sectionauthor:: David Ascher <da@python.net>
+**Source code:** :source:`Lib/colorsys.py`
+
+--------------
The :mod:`colorsys` module defines bidirectional conversions of color values
between colors expressed in the RGB (Red Green Blue) color space used in
.. versionadded:: 2.5
+**Source code:** :source:`Lib/contextlib.py`
+
+--------------
+
This module provides utilities for common tasks involving the :keyword:`with`
statement. For more information see also :ref:`typecontextmanager` and
:ref:`context-managers`.
-.. seealso::
-
- Latest version of the `contextlib Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/contextlib.py?view=markup>`_
-
Functions provided:
3.0. The :term:`2to3` tool will automatically adapt imports when converting
your sources to 3.0.
+**Source code:** :source:`Lib/Cookie.py`
+
+--------------
The :mod:`Cookie` module defines classes for abstracting the concept of
cookies, an HTTP state management mechanism. It supports both simple string-only
Python 3.0. The :term:`2to3` tool will automatically adapt imports when
converting your sources to 3.0.
-
.. versionadded:: 2.4
+**Source code:** :source:`Lib/cookielib.py`
+--------------
The :mod:`cookielib` module defines classes for automatic handling of HTTP
cookies. It is useful for accessing web sites that require small pieces of data
-
:mod:`dis` --- Disassembler for Python bytecode
===============================================
.. module:: dis
:synopsis: Disassembler for Python bytecode.
+**Source code:** :source:`Lib/dis.py`
+
+--------------
The :mod:`dis` module supports the analysis of CPython :term:`bytecode` by
disassembling it. The CPython bytecode which this module takes as an
input is defined in the file :file:`Include/opcode.h` and used by the compiler
and the interpreter.
-.. seealso::
-
- Latest version of the `dis module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/dis.py?view=markup>`_
-
.. impl-detail::
Bytecode is an implementation detail of the CPython interpreter! No
converting your sources to 3.0; however, you should consider using the
high-lever :mod:`dummy_threading` module instead.
+**Source code:** :source:`Lib/dummy_thread.py`
+
+--------------
This module provides a duplicate interface to the :mod:`thread` module. It is
meant to be imported when the :mod:`thread` module is not provided on a
-
:mod:`dummy_threading` --- Drop-in replacement for the :mod:`threading` module
==============================================================================
.. module:: dummy_threading
:synopsis: Drop-in replacement for the threading module.
+**Source code:** :source:`Lib/dummy_threading.py`
+
+--------------
This module provides a duplicate interface to the :mod:`threading` module. It
is meant to be imported when the :mod:`thread` module is not provided on a
-
:mod:`filecmp` --- File and Directory Comparisons
=================================================
:synopsis: Compare files efficiently.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
+**Source code:** :source:`Lib/filecmp.py`
+
+--------------
The :mod:`filecmp` module defines functions to compare files and directories,
with various optional time/correctness trade-offs. For comparing files,
see also the :mod:`difflib` module.
-.. seealso::
-
- Latest version of the `filecmp Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/filecmp.py?view=markup>`_
-
The :mod:`filecmp` module defines the following functions:
.. moduleauthor:: Guido van Rossum <guido@python.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
+**Source code:** :source:`Lib/fileinput.py`
+
+--------------
This module implements a helper class and functions to quickly write a
loop over standard input or a list of files. If you just want to read or
returns an accordingly opened file-like object. Two useful hooks are already
provided by this module.
-.. seealso::
-
- Latest version of the `fileinput Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/fileinput.py?view=markup>`_
-
The following function is the primary interface of this module:
-
:mod:`fnmatch` --- Unix filename pattern matching
=================================================
.. index:: module: re
+**Source code:** :source:`Lib/fnmatch.py`
+
+--------------
+
This module provides support for Unix shell-style wildcards, which are *not* the
same as regular expressions (which are documented in the :mod:`re` module). The
special characters used in shell-style wildcards are:
a period are not special for this module, and are matched by the ``*`` and ``?``
patterns.
-.. seealso::
-
- Latest version of the `fnmatch Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/fnmatch.py?view=markup>`_
.. function:: fnmatch(filename, pattern)
Module :mod:`glob`
Unix shell-style path expansion.
-
-
:mod:`fractions` --- Rational numbers
=====================================
.. sectionauthor:: Jeffrey Yasskin <jyasskin at gmail.com>
.. versionadded:: 2.6
+**Source code:** :source:`Lib/fractions.py`
+
+--------------
The :mod:`fractions` module provides support for rational number arithmetic.
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
:class:`FTP` class implements the client side of the FTP protocol. You can use
this to write Python programs that perform a variety of automated FTP jobs, such
.. moduleauthor:: Nick Coghlan <ncoghlan@gmail.com>
.. sectionauthor:: Peter Harris <scav@blueyonder.co.uk>
-
.. versionadded:: 2.5
+**Source code:** :source:`Lib/functools.py`
+
+--------------
+
The :mod:`functools` module is for higher-order functions: functions that act on
or return other functions. In general, any callable object can be treated as a
function for the purposes of this module.
-.. seealso::
-
- Latest version of the `functools Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/functools.py?view=markup>`_
-
The :mod:`functools` module defines the following functions:
.. function:: cmp_to_key(func)
-
:mod:`getopt` --- C-style parser for command line options
=========================================================
:synopsis: Portable parser for command line options; support both short and long option
names.
+**Source code:** :source:`Lib/getopt.py`
+
+--------------
+
.. note::
The :mod:`getopt` module is a parser for command line options whose API is
designed to be familiar to users of the C :cfunc:`getopt` function. Users who
-
:mod:`gettext` --- Multilingual internationalization services
=============================================================
.. moduleauthor:: Barry A. Warsaw <barry@zope.com>
.. sectionauthor:: Barry A. Warsaw <barry@zope.com>
+**Source code:** :source:`Lib/gettext.py`
+
+--------------
The :mod:`gettext` module provides internationalization (I18N) and localization
(L10N) services for your Python modules and applications. It supports both the
-
:mod:`glob` --- Unix style pathname pattern expansion
=====================================================
.. index:: single: filenames; pathname expansion
+**Source code:** :source:`Lib/glob.py`
+
+--------------
+
The :mod:`glob` module finds all the pathnames matching a specified pattern
according to the rules used by the Unix shell. No tilde expansion is done, but
``*``, ``?``, and character ranges expressed with ``[]`` will be correctly
subshell. (For tilde and shell variable expansion, use
:func:`os.path.expanduser` and :func:`os.path.expandvars`.)
-.. seealso::
-
- Latest version of the `glob module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/glob.py?view=markup>`_
.. function:: glob(pathname)
.. module:: gzip
:synopsis: Interfaces for gzip compression and decompression using file objects.
+**Source code:** :source:`Lib/gzip.py`
+
+--------------
+
This module provides a simple interface to compress and decompress files just
like the GNU programs :program:`gzip` and :program:`gunzip` would.
-
:mod:`hashlib` --- Secure hashes and message digests
====================================================
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
message digest algorithms. Included are the FIPS secure hash algorithms SHA1,
SHA224, SHA256, SHA384, and SHA512 (defined in FIPS 180-2) as well as RSA's MD5
.. versionadded:: 2.3
-This module provides an implementation of the heap queue algorithm, also known
-as the priority queue algorithm.
+**Source code:** :source:`Lib/heapq.py`
-.. seealso::
+--------------
- Latest version of the `heapq Python source code
- <http://svn.python.org/view/*checkout*/python/branches/release27-maint/Lib/heapq.py?content-type=text%2Fplain>`_
+This module provides an implementation of the heap queue algorithm, also known
+as the priority queue algorithm.
Heaps are binary trees for which every parent node has a value less than or
equal to any of its children. This implementation uses arrays for which
-
:mod:`hmac` --- Keyed-Hashing for Message Authentication
========================================================
.. versionadded:: 2.2
+**Source code:** :source:`Lib/hmac.py`
+
+--------------
+
This module implements the HMAC algorithm as described by :rfc:`2104`.
Python 3.0. The :term:`2to3` tool will automatically adapt imports when
converting your sources to 3.0.
+**Source code:** :source:`Lib/htmlentitydefs.py`
+
+--------------
This module defines three dictionaries, ``name2codepoint``, ``codepoint2name``,
and ``entitydefs``. ``entitydefs`` is used by the :mod:`htmllib` module to
single: HTML
single: XHTML
+**Source code:** :source:`Lib/HTMLParser.py`
+
+--------------
+
This module defines a class :class:`HTMLParser` which serves as the basis for
parsing text files formatted in HTML (HyperText Mark-up Language) and XHTML.
Unlike the parser in :mod:`htmllib`, this parser is not based on the SGML parser
.. index:: module: urllib
+**Source code:** :source:`Lib/httplib.py`
+
+--------------
+
This module defines classes which implement the client side of the HTTP and
HTTPS protocols. It is normally not used directly --- the module :mod:`urllib`
uses it to handle URLs that use HTTP and HTTPS.
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
:class:`IMAP4_stream`, which encapsulate a connection to an IMAP4 server and
implement a large subset of the IMAP4rev1 client protocol as defined in
-
:mod:`imghdr` --- Determine the type of an image
================================================
.. module:: imghdr
:synopsis: Determine the type of image contained in a file or byte stream.
+**Source code:** :source:`Lib/imghdr.py`
+
+--------------
The :mod:`imghdr` module determines the type of image contained in a file or
byte stream.
-
:mod:`inspect` --- Inspect live objects
=======================================
.. versionadded:: 2.1
+**Source code:** :source:`Lib/inspect.py`
+
+--------------
+
The :mod:`inspect` module provides several useful functions to help get
information about live objects such as modules, classes, methods, functions,
tracebacks, frame objects, and code objects. For example, it can help you
-
:mod:`keyword` --- Testing for Python keywords
==============================================
.. module:: keyword
:synopsis: Test whether a string is a keyword in Python.
+**Source code:** :source:`Lib/keyword.py`
+
+--------------
This module allows a Python program to determine if a string is a keyword.
Sequence containing all the keywords defined for the interpreter. If any
keywords are defined to only be active when particular :mod:`__future__`
statements are in effect, these will be included as well.
-
-
-.. seealso::
-
- Latest version of the `keyword module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/keyword.py?view=markup>`_
: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`
+
+--------------
The :mod:`linecache` module allows one to get any line from any file, while
attempting to optimize internally, using a cache, the common case where many
lines are read from a single file. This is used by the :mod:`traceback` module
to retrieve source lines for inclusion in the formatted traceback.
-.. seealso::
-
- Latest version of the `linecache module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/linecache.py?view=markup>`_
-
The :mod:`linecache` module defines the following functions:
.. module:: mailcap
:synopsis: Mailcap file handling.
+**Source code:** :source:`Lib/mailcap.py`
+--------------
Mailcap files are used to configure how MIME-aware applications such as mail
readers and Web browsers react to files with different MIME types. (The name
.. 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
associated with the filename extension. Conversions are provided from filename
to MIME type and from MIME type to filename extension; encodings are not
-
:mod:`modulefinder` --- Find modules used by a script
=====================================================
-.. sectionauthor:: A.M. Kuchling <amk@amk.ca>
-
-
.. module:: modulefinder
:synopsis: Find modules used by a script.
+.. sectionauthor:: A.M. Kuchling <amk@amk.ca>
.. versionadded:: 2.3
+**Source code:** :source:`Lib/modulefinder.py`
+
+--------------
+
This module provides a :class:`ModuleFinder` class that can be used to determine
the set of modules imported by a script. ``modulefinder.py`` can also be run as
a script, giving the filename of a Python script as its argument, after which a
.. versionadded:: 1.5.2
+**Source code:** :source:`Lib/netrc.py`
+
+--------------
+
The :class:`netrc` class parses and encapsulates the netrc file format used by
the Unix :program:`ftp` program and other FTP clients.
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
the NNTP protocol. It can be used to implement a news reader or poster, or
automated news processors. For more information on NNTP (Network News Transfer
.. module:: optparse
:synopsis: Command-line option parsing library.
:deprecated:
+.. moduleauthor:: Greg Ward <gward@python.net>
+.. sectionauthor:: Greg Ward <gward@python.net>
+
+.. versionadded:: 2.3
.. deprecated:: 2.7
The :mod:`optparse` module is deprecated and will not be developed further;
development will continue with the :mod:`argparse` module.
-.. moduleauthor:: Greg Ward <gward@python.net>
-
-.. versionadded:: 2.3
-
-.. sectionauthor:: Greg Ward <gward@python.net>
+**Source code:** :source:`Lib/optparse.py`
+--------------
:mod:`optparse` is a more convenient, flexible, and powerful library for parsing
command-line options than the old :mod:`getopt` module. :mod:`optparse` uses a
.. versionadded:: 2.3
+**Source code:** :source:`Lib/pickletools.py`
+
+--------------
+
This module contains various constants relating to the intimate details of the
:mod:`pickle` module, some lengthy comments about the implementation, and a few
useful functions for analyzing pickled data. The contents of this module are
-
:mod:`pipes` --- Interface to shell pipelines
=============================================
:synopsis: A Python interface to Unix shell pipelines.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
+**Source code:** :source:`Lib/pipes.py`
+
+--------------
The :mod:`pipes` module defines a class to abstract the concept of a *pipeline*
--- a sequence of converters from one file to another.
-
:mod:`pkgutil` --- Package extension utility
============================================
.. module:: pkgutil
:synopsis: Utilities for the import system.
+.. versionadded:: 2.3
+
+**Source code:** :source:`Lib/pkgutil.py`
+
+--------------
+
This module provides utilities for the import system, in particular package
support.
-.. versionadded:: 2.3
-
.. function:: extend_path(path, name)
.. versionadded:: 2.3
+**Source code:** :source:`Lib/platform.py`
+
+--------------
+
.. note::
Specific platforms listed alphabetically, with Linux included in the Unix
pair: plist; file
single: property list
+**Source code:** :source:`Lib/plistlib.py`
+
+--------------
+
This module provides an interface for reading and writing the "property list"
XML files used mainly by Mac OS X.
-
:mod:`poplib` --- POP3 protocol client
======================================
.. index:: pair: POP3; protocol
+**Source code:** :source:`Lib/poplib.py`
+
+--------------
+
This module defines a class, :class:`POP3`, which encapsulates a connection to a
POP3 server and implements the protocol as defined in :rfc:`1725`. The
:class:`POP3` class supports both the minimal and optional command sets.
-
:mod:`pprint` --- Data pretty printer
=====================================
.. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
+**Source code:** :source:`Lib/pprint.py`
+
+--------------
The :mod:`pprint` module provides a capability to "pretty-print" arbitrary
Python data structures in a form which can be used as input to the interpreter.
.. versionchanged:: 2.6
Added support for :class:`set` and :class:`frozenset`.
-.. seealso::
-
- Latest version of the `pprint module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/pprint.py?view=markup>`_
The :mod:`pprint` module defines one class:
-
.. _profile:
********************
.. module:: profile
:synopsis: Python source profiler.
+**Source code:** :source:`Lib/profile.py` and :source:`Lib/pstats.py`
+
+--------------
.. _profiler-introduction:
.. 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
from a source file, and another function used when the module source file is
invoked as a script.
-
:mod:`pyclbr` --- Python class browser support
==============================================
:synopsis: Supports information extraction for a Python class browser.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
+**Source code:** :source:`Lib/pyclbr.py`
+
+--------------
The :mod:`pyclbr` module can be used to determine some limited information
about the classes, methods and top-level functions defined in a module. The
-
:mod:`pydoc` --- Documentation generator and online help system
===============================================================
single: documentation; online
single: help; online
+**Source code:** :source:`Lib/pydoc.py`
+
+--------------
+
The :mod:`pydoc` module automatically generates documentation from Python
modules. The documentation can be presented as pages of text on the console,
served to a Web browser, or saved to HTML files.
:term:`2to3` tool will automatically adapt imports when converting your
sources to 3.0.
+**Source code:** :source:`Lib/Queue.py`
+
+--------------
The :mod:`Queue` module implements multi-producer, multi-consumer queues.
It is especially useful in threaded programming when information must be
the entries are kept sorted (using the :mod:`heapq` module) and the
lowest valued entry is retrieved first.
-.. seealso::
-
- Latest version of the `Queue module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/Queue.py?view=markup>`_.
-
The :mod:`Queue` module defines the following classes and exceptions:
.. class:: Queue(maxsize=0)
-
:mod:`quopri` --- Encode and decode MIME quoted-printable data
==============================================================
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
defined in :rfc:`1521`: "MIME (Multipurpose Internet Mail Extensions) Part One:
Mechanisms for Specifying and Describing the Format of Internet Message Bodies".
:mod:`base64` module is more compact if there are many such characters, as when
sending a graphics file.
-.. seealso::
-
- Latest version of the `quopri module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/quopri.py?view=markup>`_
-
.. function:: decode(input, output[,header])
Decode the contents of the *input* file and write the resulting decoded binary
-
:mod:`random` --- Generate pseudo-random numbers
================================================
.. module:: random
:synopsis: Generate pseudo-random numbers with various common distributions.
+**Source code:** :source:`Lib/random.py`
+
+--------------
This module implements pseudo-random number generators for various
distributions.
-.. seealso::
-
- Latest version of the `random module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/random.py?view=markup>`_
-
For integers, uniform selection from a range. For sequences, uniform selection
of a random element, a function to generate a random permutation of a list
in-place, and a function for random sampling without replacement.
-
:mod:`repr` --- Alternate :func:`repr` implementation
=====================================================
:term:`2to3` tool will automatically adapt imports when converting your
sources to 3.0.
+**Source code:** :source:`Lib/repr.py`
+
+--------------
+
The :mod:`repr` module provides a means for producing object representations
with limits on the size of the resulting strings. This is used in the Python
debugger and may be useful in other contexts as well.
-.. seealso::
-
- Latest version of the `repr module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/repr.py?view=markup>`_
-
This module provides a class, an instance, and a function:
-
:mod:`rlcompleter` --- Completion function for GNU readline
===========================================================
:synopsis: Python identifier completion, suitable for the GNU readline library.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
+**Source code:** :source:`Lib/rlcompleter.py`
+
+--------------
The :mod:`rlcompleter` module defines a completion function suitable for the
:mod:`readline` module by completing valid Python identifiers and keywords.
.. versionadded:: 2.5
+**Source code:** :source:`Lib/runpy.py`
+
+--------------
+
The :mod:`runpy` module is used to locate and run Python modules without
importing them first. Its main use is to implement the :option:`-m` command
line switch that allows scripts to be located using the Python module
.. index:: single: event scheduling
-The :mod:`sched` module defines a class which implements a general purpose event
-scheduler:
+**Source code:** :source:`Lib/sched.py`
-.. seealso::
+--------------
- Latest version of the `sched module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/sched.py?view=markup>`_
+The :mod:`sched` module defines a class which implements a general purpose event
+scheduler:
.. class:: scheduler(timefunc, delayfunc)
.. index:: module: pickle
+**Source code:** :source:`Lib/shelve.py`
+
+--------------
+
A "shelf" is a persistent, dictionary-like object. The difference with "dbm"
databases is that the values (not the keys!) in a shelf can be essentially
arbitrary Python objects --- anything that the :mod:`pickle` module can handle.
This includes most class instances, recursive data types, and objects containing
lots of shared sub-objects. The keys are ordinary strings.
-.. seealso::
-
- Latest version of the `shelve module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/shelve.py?view=markup>`_
.. function:: open(filename[, flag='c'[, protocol=None[, writeback=False]]])
-
:mod:`shlex` --- Simple lexical analysis
========================================
.. versionadded:: 1.5.2
+**Source code:** :source:`Lib/shlex.py`
+
+--------------
+
+
The :class:`shlex` class makes it easy to write lexical analyzers for simple
syntaxes resembling that of the Unix shell. This will often be useful for
writing minilanguages, (for example, in run control files for Python
-
:mod:`shutil` --- High-level file operations
============================================
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
collections of files. In particular, functions are provided which support file
copying and removal. For operations on individual files, see also the
:mod:`os` module.
-.. seealso::
-
- Latest version of the `shutil module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/shutil.py?view=markup>`_
-
.. warning::
Even the higher-level file copying functions (:func:`copy`, :func:`copy2`)
.. versionadded:: 2.2
+**Source code:** :source:`Lib/SimpleXMLRPCServer.py`
+
+--------------
+
The :mod:`SimpleXMLRPCServer` module provides a basic server framework for
XML-RPC servers written in Python. Servers can either be free standing, using
:class:`SimpleXMLRPCServer`, or embedded in a CGI environment, using
-
:mod:`site` --- Site-specific configuration hook
================================================
.. module:: site
:synopsis: A standard way to reference site-specific modules.
+**Source code:** :source:`Lib/site.py`
+
+--------------
**This module is automatically imported during initialization.** The automatic
import can be suppressed using the interpreter's :option:`-S` option.
.. moduleauthor:: Barry Warsaw <barry@zope.com>
.. sectionauthor:: Moshe Zadka <moshez@moshez.org>
+**Source code:** :source:`Lib/smtpd.py`
-
+--------------
This module offers several classes to implement SMTP servers. One is a generic
do-nothing implementation, which can be overridden, while the other two offer
-
:mod:`smtplib` --- SMTP protocol client
=======================================
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
to send mail to any Internet machine with an SMTP or ESMTP listener daemon. For
details of SMTP and ESMTP operation, consult :rfc:`821` (Simple Mail Transfer
-
:mod:`sndhdr` --- Determine type of sound file
==============================================
single: A-LAW
single: u-LAW
+**Source code:** :source:`Lib/sndhdr.py`
+
+--------------
+
The :mod:`sndhdr` provides utility functions which attempt to determine the type
of sound data which is in a file. When these functions are able to determine
what type of sound data is stored in a file, they return a tuple ``(type,
-
:mod:`SocketServer` --- A framework for network servers
=======================================================
Python 3.0. The :term:`2to3` tool will automatically adapt imports when
converting your sources to 3.0.
+**Source code:** :source:`Lib/SocketServer.py`
+
+--------------
The :mod:`SocketServer` module simplifies the task of writing network servers.
:synopsis: TLS/SSL wrapper for socket objects
.. moduleauthor:: Bill Janssen <bill.janssen@gmail.com>
-
-.. versionadded:: 2.6
-
.. sectionauthor:: Bill Janssen <bill.janssen@gmail.com>
.. index:: TLS, SSL, Transport Layer Security, Secure Sockets Layer
+.. versionadded:: 2.6
+
+**Source code:** :source:`Lib/ssl.py`
+
+--------------
+
This module provides access to Transport Layer Security (often known as "Secure
Sockets Layer") encryption and peer authentication facilities for network
sockets, both client-side and server-side. This module uses the OpenSSL
-
:mod:`stat` --- Interpreting :func:`stat` results
=================================================
:synopsis: Utilities for interpreting the results of os.stat(), os.lstat() and os.fstat().
.. sectionauthor:: Skip Montanaro <skip@automatrix.com>
+**Source code:** :source:`Lib/stat.py`
+
+--------------
The :mod:`stat` module defines constants and functions for interpreting the
results of :func:`os.stat`, :func:`os.fstat` and :func:`os.lstat` (if they
.. index:: module: re
+**Source code:** :source:`Lib/string.py`
+
+--------------
+
The :mod:`string` module contains a number of useful constants and
classes, as well as some deprecated legacy functions that are also
available as methods on strings. In addition, Python's built-in string
:ref:`string-formatting` section. Also, see the :mod:`re` module for
string functions based on regular expressions.
-.. seealso::
-
- Latest version of the `string module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/string.py?view=markup>`_
-
-
String constants
----------------
-
:mod:`sunau` --- Read and write Sun AU files
============================================
:synopsis: Provide an interface to the Sun AU sound format.
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
+**Source code:** :source:`Lib/sunau.py`
+
+--------------
The :mod:`sunau` module provides a convenient interface to the Sun AU sound
format. Note that this module is interface-compatible with the modules
-
:mod:`symbol` --- Constants used with Python parse trees
========================================================
:synopsis: Constants representing internal nodes of the parse tree.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
+**Source code:** :source:`Lib/symbol.py`
+
+--------------
This module provides constants which represent the numeric values of internal
nodes of the parse tree. Unlike most Python constants, these use lower-case
:synopsis: Python's configuration information
.. moduleauthor:: Tarek Ziade <tarek@ziade.org>
.. sectionauthor:: Tarek Ziade <tarek@ziade.org>
-.. versionadded:: 2.7
.. index::
single: configuration information
+.. versionadded:: 2.7
+
+**Source code:** :source:`Lib/sysconfig.py`
+
+--------------
+
The :mod:`sysconfig` module provides access to Python's configuration
information like the list of installation paths and the configuration variables
relevant for the current platform.
.. rudimentary documentation based on module comments
+**Source code:** :source:`Lib/tabnanny.py`
+
+--------------
+
For the time being this module is intended to be called as a script. However it
is possible to import it into an IDE and use the function :func:`check`
described below.
.. moduleauthor:: Lars Gustäbel <lars@gustaebel.de>
.. sectionauthor:: Lars Gustäbel <lars@gustaebel.de>
+**Source code:** :source:`Lib/tarfile.py`
+
+--------------
The :mod:`tarfile` module makes it possible to read and write tar
archives, including those using gzip or bz2 compression.
-
:mod:`telnetlib` --- Telnet client
==================================
.. index:: single: protocol; Telnet
+**Source code:** :source:`Lib/telnetlib.py`
+
+--------------
+
The :mod:`telnetlib` module provides a :class:`Telnet` class that implements the
Telnet protocol. See :rfc:`854` for details about the protocol. In addition, it
provides symbolic constants for the protocol characters (see below), and for the
-
:mod:`tempfile` --- Generate temporary files and directories
============================================================
pair: temporary; file name
pair: temporary; file
+**Source code:** :source:`Lib/tempfile.py`
+
+--------------
+
This module generates temporary files and directories. It works on all
supported platforms.
-
:mod:`textwrap` --- Text wrapping and filling
=============================================
.. moduleauthor:: Greg Ward <gward@python.net>
.. sectionauthor:: Greg Ward <gward@python.net>
-
.. versionadded:: 2.3
+**Source code:** :source:`Lib/textwrap.py`
+
+--------------
+
The :mod:`textwrap` module provides two convenience functions, :func:`wrap` and
:func:`fill`, as well as :class:`TextWrapper`, the class that does all the work,
and a utility function :func:`dedent`. If you're just wrapping or filling one
or two text strings, the convenience functions should be good enough;
otherwise, you should use an instance of :class:`TextWrapper` for efficiency.
-.. seealso::
-
- Latest version of the `textwrap module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/textwrap.py?view=markup>`_
-
.. function:: wrap(text[, width[, ...]])
Wraps the single paragraph in *text* (a string) so every line is at most *width*
.. module:: threading
:synopsis: Higher-level threading interface.
+**Source code:** :source:`Lib/threading.py`
+
+--------------
This module constructs higher-level threading interfaces on top of the lower
level :mod:`thread` module.
:mod:`multiprocessing`. However, threading is still an appropriate model
if you want to run multiple I/O-bound tasks simultaneously.
-.. seealso::
-
- Latest version of the `threading module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/threading.py?view=markup>`_
-
This module defines the following functions and objects:
-
:mod:`timeit` --- Measure execution time of small code snippets
===============================================================
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
command line as well as callable interfaces. It avoids a number of common traps
for measuring execution times. See also Tim Peters' introduction to the
-
:mod:`token` --- Constants used with Python parse trees
=======================================================
:synopsis: Constants representing terminal nodes of the parse tree.
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
+**Source code:** :source:`Lib/token.py`
+
+--------------
This module provides constants which represent the numeric values of leaf nodes
of the parse tree (terminal tokens). Refer to the file :file:`Grammar/Grammar`
-
:mod:`tokenize` --- Tokenizer for Python source
===============================================
.. moduleauthor:: Ka Ping Yee
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
+**Source code:** :source:`Lib/tokenize.py`
+
+--------------
The :mod:`tokenize` module provides a lexical scanner for Python source code,
implemented in Python. The scanner in this module returns comments as tokens as
well, making it useful for implementing "pretty-printers," including colorizers
for on-screen displays.
-.. seealso::
-
- Latest version of the `tokenize module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/tokenize.py?view=markup>`_
-
The primary entry point is a :term:`generator`:
.. function:: generate_tokens(readline)
-
:mod:`trace` --- Trace or track Python statement execution
==========================================================
.. module:: trace
:synopsis: Trace or track Python statement execution.
+**Source code:** :source:`Lib/trace.py`
+
+--------------
The :mod:`trace` module allows you to trace program execution, generate
annotated statement coverage listings, print caller/callee relationships and
list functions executed during a program run. It can be used in another program
or from the command line.
-.. seealso::
-
- Latest version of the `trace module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/trace.py?view=markup>`_
-
.. _trace-cli:
Command-Line Usage
.. module:: types
:synopsis: Names for built-in types.
+**Source code:** :source:`Lib/types.py`
+
+--------------
This module defines names for some object types that are used by the standard
Python interpreter, but not for the types defined by various extension modules.
The :term:`2to3` tool will automatically adapt imports when converting
your sources to 3.0.
+**Source code:** :source:`Lib/urlparse.py`
+
+--------------
This module defines a standard interface to break Uniform Resource Locator (URL)
strings up in components (addressing scheme, network location, path etc.), to
.. versionadded:: 2.5
Support for the ``sftp`` and ``sips`` schemes.
-.. seealso::
-
- Latest version of the `urlparse module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/urlparse.py?view=markup>`_
-
The :mod:`urlparse` module defines the following functions:
-
:mod:`UserDict` --- Class wrapper for dictionary objects
========================================================
:synopsis: Class wrapper for dictionary objects.
+**Source code:** :source:`Lib/UserDict.py`
+
+--------------
+
The module defines a mixin, :class:`DictMixin`, defining all dictionary methods
for classes that already have a minimum mapping interface. This greatly
simplifies writing classes that need to be substitutable for dictionaries (such
sub-classes that obtained new behaviors by overriding existing methods or adding
new ones.
-.. seealso::
-
- Latest version of the `UserDict Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/UserDict.py?view=markup>`_
-
The :mod:`UserDict` module defines the :class:`UserDict` class and
:class:`DictMixin`:
-
:mod:`uu` --- Encode and decode uuencode files
==============================================
:synopsis: Encode and decode files in uuencode format.
.. moduleauthor:: Lance Ellinghouse
+**Source code:** :source:`Lib/uu.py`
+
+--------------
This module encodes and decodes files in uuencode format, allowing arbitrary
binary data to be transferred over ASCII-only connections. Wherever a file
This code was contributed by Lance Ellinghouse, and modified by Jack Jansen.
-.. seealso::
-
- Latest version of the `uu module Python source code
- <http://svn.python.org/view/python/branches/release27-maint/Lib/uu.py?view=markup>`_
-
The :mod:`uu` module defines the following functions:
Module :mod:`binascii`
Support module containing ASCII-to-binary and binary-to-ASCII conversions.
-
.. versionadded:: 2.1
+**Source code:** :source:`Lib/warnings.py`
+
+--------------
+
Warning messages are typically issued in situations where it is useful to alert
the user of some condition in a program, where that condition (normally) doesn't
warrant raising an exception and terminating the program. For example, one
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. Documentations stolen from comments in file.
+**Source code:** :source:`Lib/wave.py`
+
+--------------
+
The :mod:`wave` module provides a convenient interface to the WAV sound format.
It does not support compression/decompression, but it does support mono/stereo.
.. versionadded:: 2.1
+**Source code:** :source:`Lib/weakref.py`
+
+--------------
+
The :mod:`weakref` module allows the Python programmer to create :dfn:`weak
references` to objects.
-
:mod:`webbrowser` --- Convenient Web-browser controller
=======================================================
.. moduleauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
+**Source code:** :source:`Lib/webbrowser.py`
+
+--------------
The :mod:`webbrowser` module provides a high-level interface to allow displaying
Web-based documents to users. Under most circumstances, simply calling the
-
:mod:`xdrlib` --- Encode and decode XDR data
============================================
single: XDR
single: External Data Representation
+**Source code:** :source:`Lib/xdrlib.py`
+
+--------------
+
The :mod:`xdrlib` module supports the External Data Representation Standard as
described in :rfc:`1014`, written by Sun Microsystems, Inc. June 1987. It
supports most of the data types described in the RFC.
-
:mod:`xml.dom.minidom` --- Lightweight DOM implementation
=========================================================
.. versionadded:: 2.0
+**Source code:** :source:`Lib/xml/dom/minidom.py`
+
+--------------
+
:mod:`xml.dom.minidom` is a light-weight implementation of the Document Object
Model interface. It is intended to be simpler than the full DOM and also
significantly smaller.
-
:mod:`xml.dom.pulldom` --- Support for building partial DOM trees
=================================================================
.. versionadded:: 2.0
+**Source code:** :source:`Lib/xml/dom/pulldom.py`
+
+--------------
+
:mod:`xml.dom.pulldom` allows building only selected portions of a Document
Object Model representation of a document from SAX events.
-
:mod:`xml.etree.ElementTree` --- The ElementTree XML API
========================================================
.. versionadded:: 2.5
+**Source code:** :source:`Lib/xml/etree/ElementTree.py`
+
+--------------
+
The :class:`Element` type is a flexible container object, designed to store
hierarchical data structures in memory. The type can be described as a cross
between a list and a dictionary.
.. versionadded:: 2.2
+**Source code:** :source:`Lib/xmlrpclib.py`
+
+--------------
+
XML-RPC is a Remote Procedure Call method that uses XML passed via HTTP as a
transport. With it, a client can call methods with parameters on a remote
server (the server is named by a URI) and get back structured data. This module
-
:mod:`zipfile` --- Work with ZIP archives
=========================================
.. versionadded:: 1.6
+**Source code:** :source:`Lib/zipfile.py`
+
+--------------
+
The ZIP file format is a common archive and compression standard. This module
provides tools to create, read, write, append, and list a ZIP file. Any
advanced use of this module will require an understanding of the format, as
projects / thirdparty / Python / cpython.git / commitdiff
