diff --git a/Doc/library/dummy_threading.rst b/Doc/library/dummy_threading.rst index 0658df2d27f..b5783248736 100644 --- a/Doc/library/dummy_threading.rst +++ b/Doc/library/dummy_threading.rst @@ -4,6 +4,9 @@ .. 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 diff --git a/Doc/library/fractions.rst b/Doc/library/fractions.rst index f08cfafaee4..a3ad44a6552 100644 --- a/Doc/library/fractions.rst +++ b/Doc/library/fractions.rst @@ -6,6 +6,9 @@ .. moduleauthor:: Jeffrey Yasskin .. sectionauthor:: Jeffrey Yasskin +**Source code:** :source:`Lib/fractions.py` + +-------------- The :mod:`fractions` module provides support for rational number arithmetic. diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst index a1874030e19..aee8f662a10 100644 --- a/Doc/library/ftplib.rst +++ b/Doc/library/ftplib.rst @@ -9,6 +9,10 @@ pair: FTP; protocol single: FTP; ftplib (standard module) +**Source code:** :source:`Lib/ftp.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 diff --git a/Doc/library/getopt.rst b/Doc/library/getopt.rst index 28e1cdbf334..bcfc4b59c47 100644 --- a/Doc/library/getopt.rst +++ b/Doc/library/getopt.rst @@ -5,6 +5,10 @@ :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 :c:func:`getopt` function. Users who diff --git a/Doc/library/gettext.rst b/Doc/library/gettext.rst index 9e1528ba622..bc825cc8223 100644 --- a/Doc/library/gettext.rst +++ b/Doc/library/gettext.rst @@ -6,6 +6,9 @@ .. moduleauthor:: Barry A. Warsaw .. sectionauthor:: Barry A. Warsaw +**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 diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index 82f10b9ecde..a2fa3fa07a5 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -4,6 +4,10 @@ .. 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. diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst index 6810b4ec4f2..bc8ab2ca6d3 100644 --- a/Doc/library/hashlib.rst +++ b/Doc/library/hashlib.rst @@ -11,6 +11,10 @@ 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 diff --git a/Doc/library/hmac.rst b/Doc/library/hmac.rst index b2bd98dfc7c..0ca3eda083d 100644 --- a/Doc/library/hmac.rst +++ b/Doc/library/hmac.rst @@ -7,6 +7,9 @@ .. moduleauthor:: Gerhard Häring .. sectionauthor:: Gerhard Häring +**Source code:** :source:`Lib/hmac.py` + +-------------- This module implements the HMAC algorithm as described by :rfc:`2104`. diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst index d6ff2c775b4..4e4b9348d1e 100644 --- a/Doc/library/http.client.rst +++ b/Doc/library/http.client.rst @@ -11,6 +11,10 @@ .. index:: module: urllib.request +**Source code:** :source:`Lib/http/client.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.request` uses it to handle URLs that use HTTP and HTTPS. diff --git a/Doc/library/http.cookiejar.rst b/Doc/library/http.cookiejar.rst index 1aafec91e9f..e3af41f55ea 100644 --- a/Doc/library/http.cookiejar.rst +++ b/Doc/library/http.cookiejar.rst @@ -6,6 +6,9 @@ .. moduleauthor:: John J. Lee .. sectionauthor:: John J. Lee +**Source code:** :source:`Lib/http/cookiejar.py` + +-------------- The :mod:`http.cookiejar` module defines classes for automatic handling of HTTP cookies. It is useful for accessing web sites that require small pieces of data diff --git a/Doc/library/http.cookies.rst b/Doc/library/http.cookies.rst index 472ddcf5b78..d8a437b362b 100644 --- a/Doc/library/http.cookies.rst +++ b/Doc/library/http.cookies.rst @@ -6,6 +6,9 @@ .. moduleauthor:: Timothy O'Malley .. sectionauthor:: Moshe Zadka +**Source code:** :source:`Lib/http/cookies.py` + +-------------- The :mod:`http.cookies` module defines classes for abstracting the concept of cookies, an HTTP state management mechanism. It supports both simple string-only diff --git a/Doc/library/http.server.rst b/Doc/library/http.server.rst index f68d2207d44..e3a3a10dd18 100644 --- a/Doc/library/http.server.rst +++ b/Doc/library/http.server.rst @@ -11,6 +11,10 @@ single: URL single: httpd +**Source code:** :source:`Lib/http/server.py` + +-------------- + This module defines classes for implementing HTTP servers (Web servers). One class, :class:`HTTPServer`, is a :class:`socketserver.TCPServer` subclass. diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst index 632baa3c461..78adcf8a5a4 100644 --- a/Doc/library/imaplib.rst +++ b/Doc/library/imaplib.rst @@ -16,6 +16,10 @@ 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 diff --git a/Doc/library/imghdr.rst b/Doc/library/imghdr.rst index 0c0722df17e..32ec9cfc2f6 100644 --- a/Doc/library/imghdr.rst +++ b/Doc/library/imghdr.rst @@ -4,6 +4,9 @@ .. 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. diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index e290d735bf1..754f7289bf6 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -6,6 +6,9 @@ .. moduleauthor:: Ka-Ping Yee .. sectionauthor:: Ka-Ping Yee +**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, diff --git a/Doc/library/mailcap.rst b/Doc/library/mailcap.rst index 0a0a79088e8..4bb31bfc05b 100644 --- a/Doc/library/mailcap.rst +++ b/Doc/library/mailcap.rst @@ -4,6 +4,9 @@ .. 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 diff --git a/Doc/library/mimetypes.rst b/Doc/library/mimetypes.rst index d2d20d2ec31..17b0c07ae54 100644 --- a/Doc/library/mimetypes.rst +++ b/Doc/library/mimetypes.rst @@ -8,6 +8,10 @@ .. 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 diff --git a/Doc/library/modulefinder.rst b/Doc/library/modulefinder.rst index 41b387bb993..d42c6ab7837 100644 --- a/Doc/library/modulefinder.rst +++ b/Doc/library/modulefinder.rst @@ -7,6 +7,9 @@ .. module:: modulefinder :synopsis: Find modules used by a script. +**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 diff --git a/Doc/library/netrc.rst b/Doc/library/netrc.rst index 91990df0293..3f38cbce7ad 100644 --- a/Doc/library/netrc.rst +++ b/Doc/library/netrc.rst @@ -7,6 +7,9 @@ .. moduleauthor:: Eric S. Raymond .. sectionauthor:: Eric S. Raymond +**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. diff --git a/Doc/library/nntplib.rst b/Doc/library/nntplib.rst index 0f978067349..164f149096c 100644 --- a/Doc/library/nntplib.rst +++ b/Doc/library/nntplib.rst @@ -10,6 +10,10 @@ 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 Network News Transfer Protocol. It can be used to implement a news reader or poster, or automated news processors. It is compatible with :rfc:`3977` diff --git a/Doc/library/optparse.rst b/Doc/library/optparse.rst index 2a7d51325c4..58fb7cd7322 100644 --- a/Doc/library/optparse.rst +++ b/Doc/library/optparse.rst @@ -4,14 +4,16 @@ .. module:: optparse :synopsis: Command-line option parsing library. :deprecated: - -.. 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 .. sectionauthor:: Greg Ward +**Source code:** :source:`Lib/optparse.py` + +-------------- + +.. deprecated:: 2.7 + The :mod:`optparse` module is deprecated and will not be developed further; + development will continue with the :mod:`argparse` module. :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 diff --git a/Doc/library/pipes.rst b/Doc/library/pipes.rst index 7e1ff9e1195..016a720470f 100644 --- a/Doc/library/pipes.rst +++ b/Doc/library/pipes.rst @@ -6,6 +6,9 @@ :synopsis: A Python interface to Unix shell pipelines. .. sectionauthor:: Moshe Zadka +**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. diff --git a/Doc/library/pkgutil.rst b/Doc/library/pkgutil.rst index fb79aeff9cd..3118ff20478 100644 --- a/Doc/library/pkgutil.rst +++ b/Doc/library/pkgutil.rst @@ -4,6 +4,10 @@ .. module:: pkgutil :synopsis: Utilities for the import system. +**Source code:** :source:`Lib/pkgutil.py` + +-------------- + This module provides utilities for the import system, in particular package support. diff --git a/Doc/library/platform.rst b/Doc/library/platform.rst index ee0dc31d362..99a46fad060 100644 --- a/Doc/library/platform.rst +++ b/Doc/library/platform.rst @@ -6,6 +6,9 @@ .. moduleauthor:: Marc-Andre Lemburg .. sectionauthor:: Bjorn Pettersen +**Source code:** :source:`Lib/platform.py` + +-------------- .. note:: diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index 36c9eb30873..ae5e94d1a90 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -11,6 +11,10 @@ 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. diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst index b60ad0ea4b0..d11d937b1f0 100644 --- a/Doc/library/poplib.rst +++ b/Doc/library/poplib.rst @@ -8,6 +8,10 @@ .. 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. diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst index 0100cc92b30..9c2b8de0cc1 100644 --- a/Doc/library/profile.rst +++ b/Doc/library/profile.rst @@ -9,6 +9,9 @@ The Python Profilers .. module:: profile :synopsis: Python source profiler. +**Source code:** :source:`Lib/profile.py` and :source:`Lib/pstats.py` + +-------------- .. _profiler-introduction: diff --git a/Doc/library/py_compile.rst b/Doc/library/py_compile.rst index d2e3208a656..07ddc25422c 100644 --- a/Doc/library/py_compile.rst +++ b/Doc/library/py_compile.rst @@ -8,6 +8,10 @@ .. 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. diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index 14dc58b50df..e1008655154 100644 --- a/Doc/library/pydoc.rst +++ b/Doc/library/pydoc.rst @@ -12,6 +12,10 @@ 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. diff --git a/Doc/library/rlcompleter.rst b/Doc/library/rlcompleter.rst index 48ca50ebaaf..633088d8976 100644 --- a/Doc/library/rlcompleter.rst +++ b/Doc/library/rlcompleter.rst @@ -5,6 +5,9 @@ :synopsis: Python identifier completion, suitable for the GNU readline library. .. sectionauthor:: Moshe Zadka +**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. diff --git a/Doc/library/site.rst b/Doc/library/site.rst index b347ee8a740..b77f3cf02d3 100644 --- a/Doc/library/site.rst +++ b/Doc/library/site.rst @@ -4,6 +4,9 @@ .. 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. diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst index df67de94339..c391f710dfa 100644 --- a/Doc/library/smtpd.rst +++ b/Doc/library/smtpd.rst @@ -7,8 +7,9 @@ .. moduleauthor:: Barry Warsaw .. sectionauthor:: Moshe Zadka +**Source code:** :source:`Lib/smtpd.py` - +-------------- This module offers several classes to implement SMTP (email) servers. @@ -166,4 +167,4 @@ SMTPChannel Objects DATA Sets the internal state to :attr:`DATA` and stores remaining lines from the client in :attr:`received_data` until the terminator "\r\n.\r\n" is received. - ======== =================================================================== \ No newline at end of file + ======== =================================================================== diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst index 858301d2852..531a64d73f2 100644 --- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -10,6 +10,10 @@ 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 diff --git a/Doc/library/sndhdr.rst b/Doc/library/sndhdr.rst index 8535193e73f..f36df687034 100644 --- a/Doc/library/sndhdr.rst +++ b/Doc/library/sndhdr.rst @@ -10,6 +10,10 @@ 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, diff --git a/Doc/library/socketserver.rst b/Doc/library/socketserver.rst index 0d03d8ebcc4..ed547f5ea28 100644 --- a/Doc/library/socketserver.rst +++ b/Doc/library/socketserver.rst @@ -4,6 +4,10 @@ .. module:: socketserver :synopsis: A framework for network servers. +**Source code:** :source:`Lib/socketserver.py` + +-------------- + The :mod:`socketserver` module simplifies the task of writing network servers. There are four basic server classes: :class:`TCPServer` uses the Internet TCP diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 107b31d4139..011d37806fe 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -12,6 +12,10 @@ .. index:: TLS, SSL, Transport Layer Security, Secure Sockets Layer +**Source code:** :source:`Lib/ssl.py` + +-------------- + This module provides access to Transport Layer Security (often known as "Secure Sockets Layer") encryption and peer authentication facilities for network sockets, both client-side and server-side. This module uses the OpenSSL diff --git a/Doc/library/stat.rst b/Doc/library/stat.rst index b2aec43d4d1..d8a27afc80a 100644 --- a/Doc/library/stat.rst +++ b/Doc/library/stat.rst @@ -6,6 +6,9 @@ os.lstat() and os.fstat(). .. sectionauthor:: Skip Montanaro +**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 diff --git a/Doc/library/sunau.rst b/Doc/library/sunau.rst index fc141e9eeb8..4bdb99bea61 100644 --- a/Doc/library/sunau.rst +++ b/Doc/library/sunau.rst @@ -5,6 +5,9 @@ :synopsis: Provide an interface to the Sun AU sound format. .. sectionauthor:: Moshe Zadka +**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 diff --git a/Doc/library/telnetlib.rst b/Doc/library/telnetlib.rst index 6e3abdea4d1..646634db7c7 100644 --- a/Doc/library/telnetlib.rst +++ b/Doc/library/telnetlib.rst @@ -8,6 +8,10 @@ .. 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 diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst index 03140aaef90..274840b342a 100644 --- a/Doc/library/warnings.rst +++ b/Doc/library/warnings.rst @@ -6,6 +6,9 @@ .. module:: warnings :synopsis: Issue warning messages and control their disposition. +**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 diff --git a/Doc/library/wave.rst b/Doc/library/wave.rst index bfb4e02caca..afafb45c55c 100644 --- a/Doc/library/wave.rst +++ b/Doc/library/wave.rst @@ -6,6 +6,10 @@ .. sectionauthor:: Moshe Zadka .. 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. diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst index dec415c9aa1..63545abf3af 100644 --- a/Doc/library/weakref.rst +++ b/Doc/library/weakref.rst @@ -8,6 +8,9 @@ .. moduleauthor:: Martin von Löwis .. sectionauthor:: Fred L. Drake, Jr. +**Source code:** :source:`Lib/weakref.py` + +-------------- The :mod:`weakref` module allows the Python programmer to create :dfn:`weak references` to objects. diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst index 20c091399f3..23ba6c54719 100644 --- a/Doc/library/webbrowser.rst +++ b/Doc/library/webbrowser.rst @@ -6,6 +6,9 @@ .. moduleauthor:: Fred L. Drake, Jr. .. sectionauthor:: Fred L. Drake, Jr. +**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 diff --git a/Doc/library/xdrlib.rst b/Doc/library/xdrlib.rst index 4fcb9cdfb6f..1d3da0adbd7 100644 --- a/Doc/library/xdrlib.rst +++ b/Doc/library/xdrlib.rst @@ -9,6 +9,10 @@ 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. diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index 0646994908c..3282054485d 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -6,6 +6,10 @@ .. moduleauthor:: James C. Ahlstrom .. sectionauthor:: James C. Ahlstrom +**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