Commits

Doug Hellmann committed fb205c2

change "Python Version" to "Available In" and tweak wording of example disclaimer

Comments (0)

Files changed (125)

PyMOTW/BaseHTTPServer/index.rst

     :synopsis: Provides base classes for implementing web servers.
 
 :Purpose: BaseHTTPServer includes classes that can form the basis of a web server.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 
 :mod:`BaseHTTPServer` uses classes from :mod:`SocketServer` to create

PyMOTW/ConfigParser/index.rst

     :synopsis: Read/write configuration files similar to Windows INI files
 
 :Purpose: Read/write configuration files similar to Windows INI files
-:Python Version: 1.5
+:Available In: 1.5
 
 Use the :mod:`ConfigParser` module to manage user-editable
 configuration files for an application. The configuration files are

PyMOTW/Cookie/index.rst

     :synopsis: Working with HTTP cookies from the server side.
 
 :Purpose: The Cookie module defines classes for parsing and creating HTTP cookie headers.
-:Python Version: 2.1 and later
+:Available In: 2.1 and later
 
 Cookies have been a part of the HTTP protocol for a long time. All of the
 modern web development frameworks provide easy access to cookies so a

PyMOTW/EasyDialogs/index.rst

     :synopsis: Provides simple interfaces to Carbon dialogs from Python.
 
 :Purpose: Provides simple interfaces to Carbon dialogs from Python.
-:Python Version: At least 2.0, Macintosh-only (see References below for a Windows implementation)
+:Available In: At least 2.0, Macintosh-only (see References below for a Windows implementation)
 
 The EasyDialogs module includes classes and functions for working with
 simple message and prompt dialogs, as well as stock dialogs for

PyMOTW/Queue/index.rst

     :synopsis: Provides a thread-safe FIFO implementation
 
 :Purpose: Provides a thread-safe FIFO implementation
-:Python Version: at least 1.4
+:Available In: at least 1.4
 
 The :mod:`Queue` module provides a FIFO implementation suitable for
 multi-threaded programming. It can be used to pass messages or other

PyMOTW/SimpleXMLRPCServer/index.rst

     :synopsis: Implements an XML-RPC server.
 
 :Purpose: Implements an XML-RPC server.
-:Python Version: 2.2 and later
+:Available In: 2.2 and later
 
 The :mod:`SimpleXMLRPCServer` module contains classes for creating
 your own cross-platform, language-independent server using the XML-RPC

PyMOTW/SocketServer/index.rst

     :synopsis: Creating network servers.
 
 :Purpose: Creating network servers.
-:Python Version: 1.4
+:Available In: 1.4
 
 The :mod:`SocketServer` module is a framework for creating network
 servers. It defines classes for handling synchronous network requests

PyMOTW/StringIO/index.rst

     :synopsis: Work with text buffers using file-like API
 
 :Purpose: Work with text buffers using file-like API
-:Python Version: StringIO: 1.4, cStringIO: 1.5
+:Available In: StringIO: 1.4, cStringIO: 1.5
 
 :class:`StringIO` provides a convenient means of working with text in
 memory using the file API (read, write. etc.). There are two separate

PyMOTW/abc/index.rst

     :synopsis: Abstract Base Classes
 
 :Purpose: Define and use abstract base classes for API checks in your code.
-:Python Version: 2.6
+:Available In: 2.6
 
 Why use Abstract Base Classes?
 ==============================

PyMOTW/anydbm/index.rst

     :synopsis: anydbm provides a generic dictionary-like interface to DBM-style, string-keyed databases
 
 :Purpose: anydbm provides a generic dictionary-like interface to DBM-style, string-keyed databases
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 anydbm is a front-end for DBM-style databases that use simple string
 values as keys to access records containing strings.  It uses the

PyMOTW/argparse/index.rst

     :synopsis: Command line option and argument parsing.
 
 :Purpose: Command line option and argument parsing.
-:Python Version: 2.7 and later
+:Available In: 2.7 and later
 
 The :mod:`argparse` module was added to Python 2.7 as a replacement
 for :mod:`optparse`.  The implementation of :mod:`argparse` supports

PyMOTW/array/index.rst

     :synopsis: Manage sequences of fixed-type numerical data efficiently.
 
 :Purpose: Manage sequences of fixed-type numerical data efficiently.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`array` module defines a sequence data structure that looks
 very much like a :class:`list` except that all of the members have to

PyMOTW/asynchat/index.rst

     :synopsis: Asynchronous protocol handler
 
 :Purpose: Asynchronous network communication protocol handler
-:Python Version: 1.5.2 and later
+:Available In: 1.5.2 and later
 
 The :mod:`asynchat` module builds on :mod:`asyncore` to make it easier
 to implement protocols based on passing messages back and forth

PyMOTW/asyncore/index.rst

     :synopsis: Asynchronous I/O handler
 
 :Purpose: Asynchronous I/O handler
-:Python Version: 1.5.2 and later
+:Available In: 1.5.2 and later
 
 The asyncore module includes tools for working with I/O objects such as sockets so they can be managed asynchronously (instead of, for example, using threads).  The main class provided is :class:`dispatcher`, a wrapper around a socket that provides hooks for handling events like connecting, reading, and writing when invoked from the main loop function, :func:`loop`.
 

PyMOTW/atexit/index.rst

     :synopsis: Register function(s) to be called when a program is closing down.
 
 :Purpose: Register function(s) to be called when a program is closing down.
-:Python Version: 2.1.3 and later
+:Available In: 2.1.3 and later
 
 The atexit module provides a simple interface to register functions to be
 called when a program closes down normally. The sys module also provides a

PyMOTW/base64/index.rst

     :synopsis: Encode binary data into ASCII characters.
 
 :Purpose: The base64 module contains functions for translating binary data into a subset of ASCII suitable for transmission using plaintext protocols.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The base64, base32, and base16 encodings convert 8 bit bytes to values with 6, 5, or 4 bits of useful data per byte, allowing non-ASCII bytes to be encoded as ASCII characters for transmission over protocols that require plain ASCII, such as SMTP.  The *base* values correspond to the length of the alphabet used in each encoding.  There are also URL-safe variations of the original encodings that use slightly different results.
 

PyMOTW/bisect/index.rst

     :synopsis: Maintains a list in sorted order without having to call sort each time an item is added to the list.
 
 :Purpose: Maintains a list in sorted order without having to call sort each time an item is added to the list.
-:Python Version: 1.4
+:Available In: 1.4
 
 The bisect module implements an algorithm for inserting elements into a list
 while maintaining the list in sorted order. This can be much more efficient

PyMOTW/bz2/index.rst

     :synopsis: bzip2 compression
 
 :Purpose: bzip2 compression
-:Python Version: 2.3 and later
+:Available In: 2.3 and later
 
 The :mod:`bz2` module is an interface for the bzip2 library, used to
 compress data for storage or transmission.  There are three APIs

PyMOTW/calendar/index.rst

     :synopsis: The calendar module implements classes for working with dates to manage year/month/week oriented values.
 
 :Purpose: The calendar module implements classes for working with dates to manage year/month/week oriented values.
-:Python Version: 1.4, with updates in 2.5
+:Available In: 1.4, with updates in 2.5
 
 The calendar module defines the Calendar class, which encapsulates
 calculations for values such as the dates of the weeks in a given month or

PyMOTW/cgitb/index.rst

     :synopsis: Mis-named module that provides extended traceback information.
 
 :Purpose: cgitb provides more detailed traceback information than :mod:`traceback`.
-:Python Version: 2.2 and later
+:Available In: 2.2 and later
 
 :mod:`cgitb` was originally designed for showing errors and debugging
 information in web applications.  It was later updated to include

PyMOTW/cmd/index.rst

     :synopsis: Create line-oriented command processors.
 
 :Purpose: Create line-oriented command processors.
-:Python Version: 1.4 and later, with some additions in 2.3
+:Available In: 1.4 and later, with some additions in 2.3
 
 The :mod:`cmd` module contains one public class, :class:`Cmd`,
 designed to be used as a base class for command processors such as

PyMOTW/codecs/index.rst

     :synopsis: String encoding and decoding.
 
 :Purpose: Encoders and decoders for converting text between different representations.
-:Python Version: 2.1 and later
+:Available In: 2.1 and later
 
 The :mod:`codecs` module provides stream and file interfaces for
 transcoding data in your program.  It is most commonly used to work

PyMOTW/collections/index.rst

     :synopsis: Container data types.
 
 :Purpose: Container data types.
-:Python Version: 2.4 and later
+:Available In: 2.4 and later
 
 The :mod:`collections` module includes container data types beyond the
 built-in types :class:`list`, :class:`dict`, and :class:`tuple`.

PyMOTW/commands/index.rst

     :synopsis: Run external shell commands and capture the status code and output.
 
 :Purpose: The commands module contains utility functions for working with shell command output under Unix.
-:Python Version: 1.4
+:Available In: 1.4
 
 
 .. warning::

PyMOTW/compileall/index.rst

     :synopsis: Byte-compile Source Files
 
 :Purpose: Convert source files to byte-compiled version.
-:Python Version: 1.4
+:Available In: 1.4
 
 The :mod:`compileall` module finds Python source files and compiles
 them to the byte-code representation, saving the results in ``.pyc``

PyMOTW/contextlib/index.rst

     :synopsis: Utilities for creating and working with context managers.
 
 :Purpose: Utilities for creating and working with context managers.
-:Python Version: 2.5 and later
+:Available In: 2.5 and later
 
 The :mod:`contextlib` module contains utilities for working with
 context managers and the :command:`with` statement.

PyMOTW/copy/index.rst

     :synopsis: Provides functions for duplicating objects using shallow or deep copy semantics.
 
 :Purpose: Provides functions for duplicating objects using shallow or deep copy semantics.
-:Python Version: 1.4
+:Available In: 1.4
 
 
 The copy module includes 2 functions, copy() and deepcopy(), for duplicating

PyMOTW/csv/index.rst

     :synopsis: Read and write comma separated value files.
 
 :Purpose: Read and write comma separated value files.
-:Python Version: 2.3 and later
+:Available In: 2.3 and later
 
 The :mod:`csv` module is useful for working with data exported from
 spreadsheets and databases into text files formatted with fields and

PyMOTW/datetime/index.rst

     :synopsis: Date/time value manipulation.
 
 :Purpose: The datetime module includes functions and classes for doing date and time parsing, formatting, and arithmetic.
-:Python Version: 2.3 and later
+:Available In: 2.3 and later
 
 :mod:`datetime` contains functions and classes for working with dates
 and times, separatley and together.

PyMOTW/dbhash/index.rst

     :synopsis: DBM-style API for the BSD database library
 
 :Purpose: Provides a dictionary-like API for accessing BSD ``db`` files.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`dbhash` module is the primary backend for :mod:`anydbm`.  It uses the :mod:`bsddb` library to manage database files.  The semantics are the same as :mod:`anydbm`, so refer to the examples on that page for details.
 

PyMOTW/dbm/index.rst

     :synopsis: Simple database interface
 
 :Purpose: Provides an interface to the Unix (n)dbm library.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`dbm` module provides an interface to one of the dbm
 libraries, depending on how the module was configured during

PyMOTW/decimal/index.rst

     :synopsis: Fixed and floating point math
 
 :Purpose: Decimal arithmetic using fixed and floating point numbers
-:Python Version: 2.4 and later
+:Available In: 2.4 and later
 
 The :mod:`decimal` module implements fixed and floating point
 arithmetic using the model familiar to most people, rather than the

PyMOTW/difflib/index.rst

     :synopsis: Compare sequences, especially lines of text.
 
 :Purpose: Compare sequences, especially lines of text.
-:Python Version: 2.1 and later
+:Available In: 2.1 and later
 
 The :mod:`difflib` module contains tools for computing and working
 with differences between sequences.  It is especially useful for

PyMOTW/dircache/index.rst

     :synopsis: Cache directory listings
 
 :Purpose: Cache directory listings, updating when the modification time of a directory changes.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 Listing Directory Contents
 ==========================

PyMOTW/dis/index.rst

     :synopsis: Python Bytecode Disassembler
 
 :Purpose: Convert code objects to a human-readable representation of the bytecodes for analysis.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`dis` module includes functions for working with Python
 bytecode by "disassembling" it into a more human-readable form.

PyMOTW/doctest/index.rst

     :synopsis: Write automated tests as part of the documentation for a module.
 
 :Purpose: Write automated tests as part of the documentation for a module.
-:Python Version: 2.1
+:Available In: 2.1
 
 :mod:`doctest` lets you test your code by running examples embedded in
 the documentation and verifying that they produce the expected

PyMOTW/dumbdbm/index.rst

     :synopsis: Portable DBM Implementation
 
 :Purpose: Last-resort backend implementation for :mod:`anydbm`.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`dumbdbm` module is a portable fallback implementation of the DBM API when no other implementations are available.  No external dependencies are required to use :mod:`dumbdbm`, but it is slower than most other implementations.
 

PyMOTW/exceptions/index.rst

     :synopsis: Built-in error classes
 
 :Purpose: The exceptions module defines the built-in errors used throughout the standard library and by the interpreter.
-:Python Version: 1.5 and later
+:Available In: 1.5 and later
 
 
 Description

PyMOTW/filecmp/index.rst

     :synopsis: Compare files and directories on the filesystem.
 
 :Purpose: Compare files and directories on the filesystem.
-:Python Version: 2.1 and later
+:Available In: 2.1 and later
 
 Example Data
 ============

PyMOTW/fileinput/index.rst

     :synopsis: Process lines from input streams.
 
 :Purpose: Create command-line filter programs to process lines from input streams.
-:Python Version: 1.5.2 and later
+:Available In: 1.5.2 and later
 
 The fileinput module is a framework for creating command line programs
 for processing text files in a filter-ish manner. 

PyMOTW/fnmatch/index.rst

     :synopsis: Compare filenames against Unix-style glob patterns.
 
 :Purpose: Handle Unix-style filename comparison with the fnmatch module.
-:Python Version: 1.4 and later.
+:Available In: 1.4 and later.
 
 The fnmatch module is used to compare filenames against glob-style patterns
 such as used by Unix shells.

PyMOTW/fractions/index.rst

     :synopsis: Implements a class for working with rational numbers.
 
 :Purpose: Implements a class for working with rational numbers.
-:Python Version: 2.6 and later
+:Available In: 2.6 and later
 
 The Fraction class implements numerical operations for rational numbers based on the API defined by :class:`Rational` in :mod:`numbers`.
 
         The decimal module provides an API for fixed and floating point math.
 
     :mod:`numbers`
-        Numeric abstract base classes.
+        Numeric abstract base classes.

PyMOTW/functools/index.rst

     :synopsis: Tools for working with functions.
 
 :Purpose: Functions that operate on other functions.
-:Python Version: 2.5 and later
+:Available In: 2.5 and later
 
 The :mod:`functools` module provides tools for working with functions
 and other callable objects, to adapt or extend them for new purposes

PyMOTW/gc/index.rst

     :synopsis: Garbage Collector
 
 :Purpose: Manages memory used by Python objects
-:Python Version: 2.1+
+:Available In: 2.1+
 
 :mod:`gc` exposes the underlying memory management mechanism of
 Python, the automatic garbage collector.  The module includes

PyMOTW/gdbm/index.rst

     :synopsis: GNU's version of the dbm library
 
 :Purpose: GNU's version of the dbm library
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 :mod:`gdbm` is GNU's updated version of the :mod:`dbm` library.  It follows the same semantics as the other DBM implementations described under :mod:`anydbm`, with a few changes to the *flags* supported by ``open()``.
 

PyMOTW/getopt/index.rst

     :synopsis: Command line option parsing
 
 :Purpose: Command line option parsing
-:Python Version: 1.4
+:Available In: 1.4
 
 The getopt module is the *old-school* command line option parser that
 supports the conventions established by the Unix function

PyMOTW/getpass/index.rst

     :synopsis: Prompt the user for a value, usually a password, without echoing what they type to the console.
 
 :Purpose: Prompt the user for a value, usually a password, without echoing what they type to the console.
-:Python Version: 1.5.2
+:Available In: 1.5.2
 
 Many programs that interact with the user via the terminal need to ask
 the user for password values without showing what the user types on

PyMOTW/gettext/index.rst

     :synopsis: Message Catalogs
 
 :Purpose: Message catalog API for internationalization.
-:Python Version: 2.1.3 and later
+:Available In: 2.1.3 and later
 
 The :mod:`gettext` module provides a pure-Python implementation
 compatible with the `GNU gettext`_ library for message translation and

PyMOTW/glob/index.rst

     :synopsis: Use Unix shell rules to fine filenames matching a pattern.
 
 :Purpose: Use Unix shell rules to fine filenames matching a pattern.
-:Python Version: 1.4
+:Available In: 1.4
 
 Even though the glob API is very simple, the module packs a lot of
 power. It is useful in any situation where your program needs to look

PyMOTW/grp/index.rst

     :synopsis: Unix Group Database
 
 :Purpose: Read group data from Unix group database.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The grp module can be used to read information about Unix groups from
 the group database (usually ``/etc/group``).  The read-only interface

PyMOTW/gzip/index.rst

     :synopsis: Read and write gzip files
 
 :Purpose: Read and write gzip files.
-:Python Version: 1.5.2 and later
+:Available In: 1.5.2 and later
 
 The gzip module provides a file-like interface to GNU zip files, using
 :mod:`zlib` to compress and uncompress the data.

PyMOTW/hashlib/index.rst

     :synopsis: Cryptographic hashes and message digests
 
 :Purpose: Cryptographic hashes and message digests
-:Python Version: 2.5
+:Available In: 2.5
 
 The :mod:`hashlib` module deprecates the separate :mod:`md5` and
 :mod:`sha` modules and makes their API consistent. To work with a

PyMOTW/heapq/index.rst

 :Purpose:
     The heapq implements a min-heap sort algorithm suitable for use with
     Python's lists.
-:Python Version: New in 2.3 with additions in 2.5
+:Available In: New in 2.3 with additions in 2.5
 
 A *heap* is a tree-like data structure where the child nodes have a
 sort-order relationship with the parents. *Binary heaps* can be

PyMOTW/hmac/index.rst

 :Purpose: 
     The hmac module implements keyed-hashing for message authentication, as
     described in :rfc:`2104`.
-:Python Version: 2.2
+:Available In: 2.2
 
 The HMAC algorithm can be used to verify the integrity of information
 passed between applications or stored in a potentially vulnerable

PyMOTW/imaplib/index.rst

     :synopsis: IMAP4 client library
 
 :Purpose: Client library for IMAP4 communication.
-:Python Version: 1.5.2 and later
+:Available In: 1.5.2 and later
 
 :mod:`imaplib` implements a client for communicating with Internet
 Message Access Protocol (IMAP) version 4 servers.  The IMAP protocol

PyMOTW/imp/index.rst

 
 :Purpose: 
     The imp module exposes the implementation of Python's import statement.
-:Python Version: At least 2.2.1
+:Available In: At least 2.2.1
 
 The imp module includes functions that expose part of the underlying
 implementation of Python's import mechanism for loading code in packages and

PyMOTW/inspect/index.rst

 :Purpose:
     The inspect module provides functions for introspecting on live
     objects and their source code.
-:Python Version: added in 2.1, with updates in 2.3 and 2.5
+:Available In: added in 2.1, with updates in 2.3 and 2.5
 
 The :mod:`inspect` module provides functions for learning about live
 objects, including modules, classes, instances, functions, and

PyMOTW/itertools/index.rst

 :Purpose:
     The itertools module includes a set of functions for working with iterable
     (sequence-like) data sets. 
-:Python Version: 2.3
+:Available In: 2.3
 
 The functions provided are inspired by similar features of the "lazy
 functional programming language" Haskell and SML. They are intended to

PyMOTW/json/index.rst

     :synopsis: JavaScript Object Notation Serializer
 
 :Purpose: Encode Python objects as JSON strings, and decode JSON strings into Python objects.
-:Python Version: 2.6
+:Available In: 2.6
 
 The :mod:`json` module provides an API similar to :mod:`pickle` for
 converting in-memory Python objects to a serialized representation

PyMOTW/linecache/index.rst

     :synopsis: Retrieve lines of text from files or imported python modules, holding a cache of the results to make reading many lines from the same file more efficient.
 
 :Purpose: Retrieve lines of text from files or imported python modules, holding a cache of the results to make reading many lines from the same file more efficient.
-:Python Version: 1.4
+:Available In: 1.4
 
 The linecache module is used extensively throughout the Python standard
 library when dealing with Python source files. The implementation of the cache

PyMOTW/locale/index.rst

     :synopsis: POSIX cultural localization API
 
 :Purpose: Format and parse values that depend on location or language.
-:Python Version: 1.5 and later
+:Available In: 1.5 and later
 
 The :mod:`locale` module is part of Python's internationalization and
 localization support library. It provides a standard way to handle

PyMOTW/logging/index.rst

     :synopsis: Report status, error, and informational messages.
 
 :Purpose: Report status, error, and informational messages.
-:Python Version: 2.3
+:Available In: 2.3
 
 The :mod:`logging` module defines a standard API for reporting errors
 and status information from applications and libraries. The key

PyMOTW/mailbox/index.rst

     :synopsis: Access and manipulate email archives.
 
 :Purpose: Work with email messages in various local file formats.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`mailbox` module defines a common API for accessing email
 messages stored in local disk formats, including:

PyMOTW/math/index.rst

     :synopsis: Mathematical functions
 
 :Purpose: Provides functions for specialized mathematical operations.
-:Python Version: 1.4
+:Available In: 1.4
 
 The :mod:`math` module implements many of the IEEE functions that would
 normally be found in the native platform C libraries for complex

PyMOTW/mhlib/index.rst

     :synopsis: Work with MH mailboxes
 
 :Purpose: Manipulate the contents of MH mailboxes.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 .. note::
     This module is superseded by :mod:`mailbox`.

PyMOTW/mmap/index.rst

     :synopsis: Memory-map files
 
 :Purpose: Memory-map files instead of reading the contents directly.
-:Python Version: 2.1 and later
+:Available In: 2.1 and later
 
 Memory-mapping a file uses the operating system virtual memory system
 to access the data on the filesystem directly, instead of using normal

PyMOTW/multiprocessing/index.rst

     :synopsis: Manage processes like threads.
 
 :Purpose: Provides an API for managing processes.
-:Python Version: 2.6
+:Available In: 2.6
 
 The :mod:`multiprocessing` module includes a relatively simple API for
 dividing work up between multiple processes.  It is based on the API

PyMOTW/operator/index.rst

     :synopsis: Functional interface to built-in operators
 
 :Purpose: Functional interface to built-in operators.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 Functional programming using iterators occasionally requires creating
 small functions for simple expressions. Sometimes these can be

PyMOTW/optparse/index.rst

     :synopsis: Command line option parser to replace :mod:`getopt`.
 
 :Purpose: Command line option parser to replace :mod:`getopt`.
-:Python Version: 2.3
+:Available In: 2.3
 
 The :mod:`optparse` module is a modern alternative for command line
 option parsing that offers several features not available in

PyMOTW/os/index.rst

     :synopsis: Portable access to operating system specific features.
 
 :Purpose: Portable access to operating system specific features.
-:Python Version: 1.4 (or earlier)
+:Available In: 1.4 (or earlier)
 
 The :mod:`os` module provides a wrapper for platform specific modules
 such as :mod:`posix`, :mod:`nt`, and :mod:`mac`. The API for functions

PyMOTW/ospath/index.rst

     :synopsis: Platform-independent manipulation of file names.
 
 :Purpose: Parse, build, test, and otherwise work on file names and paths.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 Writing code to work with files on multiple platforms is easy using
 the functions included in the :mod:`os.path` module. Even programs not

PyMOTW/pdb/index.rst

     :synopsis: Interactive Debugger
 
 :Purpose: Python's Interactive Debugger
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 :mod:`pdb` implements an interactive debugging environment for Python
 programs.  It includes features to let you pause your program, look at

PyMOTW/pickle/index.rst

     :synopsis: Python object serialization
 
 :Purpose: Python object serialization
-:Python Version: pickle at least 1.4, cPickle 1.5
+:Available In: pickle at least 1.4, cPickle 1.5
 
 The :mod:`pickle` module implements an algorithm for turning an
 arbitrary Python object into a series of bytes.  This process is also

PyMOTW/pipes/index.rst

     :synopsis: Unix shell command pipeline templates
 
 :Purpose: Create repeatable Unix shell command pipelines.
-:Python Version: Python 1.4
+:Available In: Python 1.4
 
 The :mod:`pipes` module implements a class to create arbitrarily
 complex Unix command pipelines.  Inputs and outputs of the commands

PyMOTW/pkgutil/index.rst

     :synopsis: Package utilities
 
 :Purpose: Add to the module search path for a specific package and work with resources included in a package.
-:Python Version: 2.3 and later
+:Available In: 2.3 and later
 
 The :mod:`pkgutil` module includes functions for working with Python
 packages.  :func:`extend_path` changes the import path for sub-modules

PyMOTW/platform/index.rst

     :synopsis: Access system hardware, OS, and interpreter version information.
 
 :Purpose: Probe the underlying platform's hardware, operating system, and interpreter version information.
-:Python Version: 2.3 and later
+:Available In: 2.3 and later
 
 Although Python is often used as a cross-platform language, it is
 occasionally necessary to know what sort of system a program is

PyMOTW/plistlib/index.rst

     :synopsis: Manipulate OS X property list files
 
 :Purpose: Read and write OS X property list files
-:Python Version: 2.6
+:Available In: 2.6
 
 :mod:`plistlib` provides an interface for working with property list
 files used under OS X.  plist files are typically XML, sometimes

PyMOTW/pprint/index.rst

     :synopsis: Pretty-print data structures
 
 :Purpose: Pretty-print data structures
-:Python Version: 1.4
+:Available In: 1.4
 
 :mod:`pprint` contains a "pretty printer" for producing aesthetically
 pleasing representations of your data structures.  The formatter

PyMOTW/profile/index.rst

     :synopsis: Performance analysis of Python programs.
 
 :Purpose: Performance analysis of Python programs.
-:Python Version: 1.4 and later, these examples are for Python 2.5
+:Available In: 1.4 and later, these examples are for Python 2.5
 
 The :mod:`profile` and :mod:`cProfile` modules provide APIs for
 collecting and analyzing statistics about how Python source consumes

PyMOTW/pwd/index.rst

     :synopsis: Unix Password Database
 
 :Purpose: Read user data from Unix password database.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The pwd module can be used to read user information from the Unix
 password database (usually ``/etc/passwd``).  The read-only interface

PyMOTW/pyclbr/index.rst

     :synopsis: Python class browser support
 
 :Purpose: Implements an API suitable for use in a source code editor for making a class browser.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 :mod:`pyclbr` can scan Python source to find classes and stand-alone functions.  The information about class, method, and function names and line numbers is gathered using :mod:`tokenize` *without* importing the code.
 

PyMOTW/pydoc/index.rst

     :synopsis: Online help for Python modules
 
 :Purpose: Generates help for Python modules and classes from the code.
-:Python Version: 2.1 and later
+:Available In: 2.1 and later
 
 The :mod:`pydoc` module imports a Python module and uses the contents
 to generate help text at runtime. The output includes docstrings for

PyMOTW/random/index.rst

     :synopsis: Pseudorandom number generators
 
 :Purpose: Implements several types of pseudorandom number generators.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`random` module provides a fast pseudorandom number generator
 based on the *Mersenne Twister* algorithm.  Originally developed to

PyMOTW/re/index.rst

     :synopsis: Searching within and changing text using formal patterns.
 
 :Purpose: Searching within and changing text using formal patterns.
-:Python Version: 1.5 and later
+:Available In: 1.5 and later
 
 *Regular expressions* are text matching patterns described with a
 formal syntax.  The patterns are interpreted as a set of instructions,

PyMOTW/readline/index.rst

     :synopsis: Interface to the GNU readline library
 
 :Purpose: Provides an interface to the GNU readline library for interacting with the user at a command prompt.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`readline` module can be used to enhance interactive command
 line programs to make them easier to use.  It is primarily used to

PyMOTW/resource/index.rst

     :synopsis: System resource management
 
 :Purpose: Manage the system resource limits for a Unix program.
-:Python Version: 1.5.2
+:Available In: 1.5.2
 
 The functions in :mod:`resource` probe the current system resources
 consumed by a process, and place limits on them to control how much

PyMOTW/rlcompleter/index.rst

     :synopsis: Adds tab-completion to the interactive interpreter
 
 :Purpose: Adds tab-completion to the interactive interpreter
-:Python Version: 1.5 and later
+:Available In: 1.5 and later
 
 :mod:`rlcompleter` adds tab-completion for Python symbols to the
 interactive interpreter.  Importing the module causes it to configure

PyMOTW/robotparser/index.rst

     :synopsis: Internet spider access control
 
 :Purpose: Parse robots.txt file used to control Internet spiders
-:Python Version: 2.1.3 and later
+:Available In: 2.1.3 and later
 
 :mod:`robotparser` implements a parser for the ``robots.txt`` file format, including a simple function for checking if a given user agent can access a resource.  It is intended for use in well-behaved spiders or other crawler applications that need to either be throttled or otherwise restricted.
 
     `The Web Robots Page`_
         Description of robots.txt format.
 
-.. _The Web Robots Page: http://www.robotstxt.org/orig.html
+.. _The Web Robots Page: http://www.robotstxt.org/orig.html

PyMOTW/sched/index.rst

     :synopsis: Generic event scheduler.
 
 :Purpose: Generic event scheduler.
-:Python Version: 1.4
+:Available In: 1.4
 
 The :mod:`sched` module implements a generic event scheduler for
 running tasks at specific times. The scheduler class uses a *time*

PyMOTW/select/index.rst

     :synopsis: Wait for I/O Efficiently
 
 :Purpose: Wait for notification that an input or output channel is ready.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`select` module provides access to platform-specific I/O
 monitoring functions.  The most portable interface is the POSIX

PyMOTW/shlex/index.rst

     :synopsis: Lexical analysis of shell-style syntaxes.
 
 :Purpose: Lexical analysis of shell-style syntaxes.
-:Python Version: 1.5.2, with additions in later versions
+:Available In: 1.5.2, with additions in later versions
 
 The shlex module implements a class for parsing simple shell-like syntaxes. It
 can be used for writing your own domain specific language, or for parsing

PyMOTW/shutil/index.rst

     :synopsis: High-level file operations.
 
 :Purpose: High-level file operations.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`shutil` module includes high-level file operations such as
 copying, setting permissions, etc.

PyMOTW/signal/index.rst

     :synopsis: Receive notification of asynchronous system events
 
 :Purpose: Receive notification of asynchronous system events
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 .. note::
 

PyMOTW/smtpd/index.rst

     :synopsis: Includes classes for implementing SMTP servers.
 
 :Purpose: Includes classes for implementing SMTP servers.
-:Python Version: 2.1 and later
+:Available In: 2.1 and later
 
 The :mod:`smtpd` module includes classes for building simple mail
 transport protocol servers.  It is the server-side of the protocol

PyMOTW/smtplib/index.rst

     :synopsis: Simple mail transfer protocol client.
 
 :Purpose: Interact with SMTP servers, including sending email.
-:Python Version: 1.5.2 and later
+:Available In: 1.5.2 and later
 
 :mod:`smtplib` includes the class :class:`SMTP`, which is useful for communicating with mail servers to send mail.  
 

PyMOTW/socket/index.rst

     :synopsis: Network communication
 
 :Purpose: Provides access to network communication
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`socket` module exposes the low-level C API for communicating
 over a network using the BSD socket interface.  It includes the

PyMOTW/sqlite3/index.rst

     :synopsis: Embedded relational database
 
 :Purpose: Implements an embedded relational database with SQL support.
-:Python Version: 2.5 and later
+:Available In: 2.5 and later
 
 
 The :mod:`sqlite3` module provides a DB-API 2.0 compliant interface to

PyMOTW/string/index.rst

     :synopsis: Contains constants and classes for working with text.
 
 :Purpose: Contains constants and classes for working with text.
-:Python Version: 2.5
+:Available In: 2.5
 
 The :mod:`string` module dates from the earliest versions of
 Python. In version 2.0, many of the functions previously implemented

PyMOTW/struct/index.rst

     :synopsis: Convert between strings and binary data.
 
 :Purpose: Convert between strings and binary data.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`struct` module includes functions for converting between
 strings of bytes and native Python data types such as numbers and

PyMOTW/subprocess/index.rst

     :synopsis: Work with additional processes
 
 :Purpose: Spawn and communicate with additional processes.
-:Python Version: 2.4 and later
+:Available In: 2.4 and later
 
 The :mod:`subprocess` module provides a consistent interface to
 creating and working with additional processes. It offers a

PyMOTW/sys/index.rst

     :synopsis: System-specific configuration
 
 :Purpose: Provides system-specific configuration and operations.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`sys` module includes a collection of services for probing or
 changing the configuration of the interpreter at runtime and resources

PyMOTW/sysconfig/index.rst

     :synopsis: Interpreter Compile-time Configuration
 
 :Purpose: Access the configuration settings used to build Python.
-:Python Version: 2.7 and later
+:Available In: 2.7 and later
 
 In Python 2.7 :mod:`sysconfig` has been extracted from
 :mod:`distutils` to become a stand-alone module.  It includes

PyMOTW/tabnanny/index.rst

     :synopsis: Scan Python source code looking for suspicious indentation.
 
 :Purpose: Scan Python source code looking for suspicious indentation.
-:Python Version: 2.1.3 and later
+:Available In: 2.1.3 and later
 
 Consistent use of indentation is important in a langauge like Python,
 where white-space is significant.  The :mod:`tabnanny` module provides

PyMOTW/tarfile/index.rst

     :synopsis: Tar archive access
 
 :Purpose: Tar archive access.
-:Python Version: 2.3 and later
+:Available In: 2.3 and later
 
 The :mod:`tarfile` module provides read and write access to UNIX tar
 archives, including compressed files.  In addition to the POSIX

PyMOTW/tempfile/index.rst

     :synopsis: Create temporary filesystem resources.
 
 :Purpose: Create temporary filesystem resources.
-:Python Version: Since 1.4 with major security revisions in 2.3
+:Available In: Since 1.4 with major security revisions in 2.3
 
 Many programs need to create files to write intermediate
 data. Creating files with unique names securely, so they cannot be

PyMOTW/textwrap/index.rst

     :synopsis: Formatting text by adjusting where line breaks occur in a paragraph.
 
 :Purpose: Formatting text by adjusting where line breaks occur in a paragraph.
-:Python Version: 2.5
+:Available In: 2.5
 
 The :mod:`textwrap` module can be used to format text for output in
 situations where pretty-printing is desired. It offers programmatic

PyMOTW/threading/index.rst

     :synopsis: Manage several concurrent threads of execution.
 
 :Purpose: Builds on the :mod:`thread` module to more easily manage several threads of execution.
-:Python Version: 1.5.2 and later
+:Available In: 1.5.2 and later
 
 The :mod:`threading` module builds on the low-level features of
 :mod:`thread` to make working with threads even easier and more

PyMOTW/time/index.rst

     :synopsis: Functions for manipulating clock time
 
 :Purpose: Functions for manipulating clock time.
-:Python Version: 1.4 or earlier
+:Available In: 1.4 or earlier
 
 The :mod:`time` module exposes C library functions for manipulating
 dates and times.  Since it is tied to the underlying C implementation,

PyMOTW/timeit/index.rst

     :synopsis: Time the execution of small bits of Python code.
 
 :Purpose: Time the execution of small bits of Python code.
-:Python Version: 2.3
+:Available In: 2.3
 
 The :mod:`timeit` module provides a simple interface for determining
 the execution time of small bits of Python code. It uses a

PyMOTW/trace/index.rst

     :synopsis: Follow Python statements as they are executed.
 
 :Purpose: Monitor which statements and functions are executed as a program runs to produce coverage and call-graph information.
-:Python Version: 2.3 and later
+:Available In: 2.3 and later
 
 The :mod:`trace` module helps you understand the way your program
 runs.  You can trace the statements executed, produce coverage

PyMOTW/traceback/index.rst

     :synopsis: Extract, format, and print exceptions and stack traces.
 
 :Purpose: Extract, format, and print exceptions and stack traces.
-:Python Version: 1.4 and later, with modifications over time
+:Available In: 1.4 and later, with modifications over time
 
 The :mod:`traceback` module works with the call stack to produce error
 messages. A traceback is a stack trace from the point of an exception

PyMOTW/unittest/index.rst

     :synopsis: Automated testing framework
 
 :Purpose: Automated testing framework
-:Python Version: 2.1
+:Available In: 2.1
 
 Python's :mod:`unittest` module, sometimes referred to as PyUnit, is
 based on the XUnit framework design by Kent Beck and Erich Gamma. The

PyMOTW/urllib/index.rst

     :synopsis: Accessing remote resources that don't need authentication, cookies, etc.
 
 :Purpose: Accessing remote resources that don't need authentication, cookies, etc.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`urllib` module provides a simple interface for network
 resource access. Although :mod:`urllib` can be used with gopher and

PyMOTW/urllib2/index.rst

     :synopsis: Library for opening URLs.
 
 :Purpose: A library for opening URLs that can be extended by defining custom protocol handlers.
-:Python Version: 2.1
+:Available In: 2.1
 
 The :mod:`urllib2` module provides an updated API for using internet
 resources identified by URLs.  It is designed to be extended by

PyMOTW/urlparse/index.rst

     :synopsis: Split URL into component pieces.
 
 :Purpose: Split URL into component pieces.
-:Python Version: since 1.4
+:Available In: since 1.4
 
 The :mod:`urlparse` module provides functions for breaking URLs down
 into their component parts, as defined by the relevant RFCs.

PyMOTW/uuid/index.rst

     :synopsis: Universally unique identifiers
 
 :Purpose: The :mod:`uuid` module implements Universally Unique Identifiers as described in :rfc:`4122`.
-:Python Version: 2.5 and later
+:Available In: 2.5 and later
 
 :rfc:`4122` defines a system for creating universally unique
 identifiers for resources in a way that does not require a central

PyMOTW/warnings/index.rst

     :synopsis: Deliver non-fatal alerts to the user about issues encountered when running a program.
 
 :Purpose: Deliver non-fatal alerts to the user about issues encountered when running a program.
-:Python Version: 2.1 and later
+:Available In: 2.1 and later
 
 The :mod:`warnings` module was introduced in :pep:`230` as a way to
 warn programmers about changes in language or library features in

PyMOTW/weakref/index.rst

     :synopsis: Refer to an "expensive" object, but allow it to be garbage collected if there are no other non-weak references.
 
 :Purpose: Refer to an "expensive" object, but allow it to be garbage collected if there are no other non-weak references.
-:Python Version: Since 2.1
+:Available In: Since 2.1
 
 The :mod:`weakref` module supports weak references to objects. A
 normal reference increments the reference count on the object and

PyMOTW/webbrowser/index.rst

     :synopsis: Displays web pages
 
 :Purpose: Use the `webbrowser` module to display web pages to your users.
-:Python Version: 2.1.3 and later
+:Available In: 2.1.3 and later
 
 The :mod:`webbrowser` module includes functions to open URLs in interactive
 browser applications. The module includes a registry of available

PyMOTW/whichdb/index.rst

     :synopsis: Identify DBM-style database formats
 
 :Purpose: Examine existing DBM-style database file to determine what library should be used to open it.
-:Python Version: 1.4 and later
+:Available In: 1.4 and later
 
 The :mod:`whichdb` module contains one function, ``whichdb()``.  It can be used to examine an existing database file to determine which dbm library should be used to open it.  It returns ``None`` if there is a problem opening the file, or the string name of the module to use to open the file.  If it can open the file but cannot determine the library to use, it returns the empty string.
 

PyMOTW/xmlrpclib/index.rst

     :synopsis: Client-side library for XML-RPC communication.
 
 :Purpose: Client-side library for XML-RPC communication.
-:Python Version: 2.2 and later
+:Available In: 2.2 and later
 
 We have already looked at :mod:`SimpleXMLRPCServer`, the library for
 creating an XML-RPC server. The :mod:`xmlrpclib` module lets you

PyMOTW/zipfile/index.rst

     :synopsis: Read and write ZIP archive files.
 
 :Purpose: Read and write ZIP archive files.
-:Python Version: 1.6 and later
+:Available In: 1.6 and later
 
 The :mod:`zipfile` module can be used to manipulate ZIP archive files.
 

PyMOTW/zipimport/index.rst

     :synopsis: Load Python code from inside ZIP archives.
 
 :Purpose: Load Python code from inside ZIP archives.
-:Python Version: 2.3 and later
+:Available In: 2.3 and later
 
 The :mod:`zipimport` module implements the :class:`zipimporter` class,
 which can be used to find and load Python modules inside ZIP

PyMOTW/zlib/index.rst

     :synopsis: Low-level access to GNU zlib compression library
 
 :Purpose: Low-level access to GNU zlib compression library
-:Python Version: 2.5 and later
+:Available In: 2.5 and later
 
 The :mod:`zlib` module provides a lower-level interface to many of the
 functions in the :mod:`zlib` compression library from GNU.

sphinx/templates/web/sidebar_examples.html

 <h3>Examples</h3>
 
-<p>The output from all of the example programs from PyMOTW has been
+<p>The output from all the example programs from PyMOTW has been
 generated with Python {{python_version}}, unless otherwise noted. Some
 of the features described here may not be available in earlier
 versions of Python.</p>