diff options
author | Guido van Rossum <guido@python.org> | 2007-08-24 16:32:05 (GMT) |
---|---|---|
committer | Guido van Rossum <guido@python.org> | 2007-08-24 16:32:05 (GMT) |
commit | 04110fb8594c969ca187a968a35a59263ddf7209 (patch) | |
tree | e9abf7d5cfe7ac2e411c182d1c368ecca4bcca16 /Doc/library/imp.rst | |
parent | 07aec08a0134318a5ee087e61f5afbb213f77d93 (diff) | |
download | cpython-04110fb8594c969ca187a968a35a59263ddf7209.zip cpython-04110fb8594c969ca187a968a35a59263ddf7209.tar.gz cpython-04110fb8594c969ca187a968a35a59263ddf7209.tar.bz2 |
Merged revisions 57221-57391 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r57227 | facundo.batista | 2007-08-20 17:16:21 -0700 (Mon, 20 Aug 2007) | 5 lines
Catch ProtocolError exceptions and include the header information in
test output (to make it easier to debug test failures caused by
problems in the server). [GSoC - Alan McIntyre]
........
r57229 | mark.hammond | 2007-08-20 18:04:47 -0700 (Mon, 20 Aug 2007) | 5 lines
[ 1761786 ] distutils.util.get_platform() return value on 64bit Windows
As discussed on distutils-sig: Allows the generated installer name on
64bit Windows platforms to be different than the name generated for
32bit Windows platforms.
........
r57230 | mark.hammond | 2007-08-20 18:05:16 -0700 (Mon, 20 Aug 2007) | 5 lines
[ 1761786 ] distutils.util.get_platform() return value on 64bit Windows
As discussed on distutils-sig: Allows the generated installer name on
64bit Windows platforms to be different than the name generated for
32bit Windows platforms.
........
r57253 | georg.brandl | 2007-08-20 23:01:18 -0700 (Mon, 20 Aug 2007) | 2 lines
Demand version 2.5.1 since 2.5 has a bug with codecs.open context managers.
........
r57254 | georg.brandl | 2007-08-20 23:03:43 -0700 (Mon, 20 Aug 2007) | 2 lines
Revert accidental checkins from last commit.
........
r57255 | georg.brandl | 2007-08-20 23:07:08 -0700 (Mon, 20 Aug 2007) | 2 lines
Bug #1777160: mention explicitly that e.g. -1**2 is -1.
........
r57256 | georg.brandl | 2007-08-20 23:12:19 -0700 (Mon, 20 Aug 2007) | 3 lines
Bug #1777168: replace operator names "opa"... with "op1"... and mark everything up as literal,
to enhance readability.
........
r57259 | facundo.batista | 2007-08-21 09:57:18 -0700 (Tue, 21 Aug 2007) | 8 lines
Added test for behavior of operations on an unconnected SMTP object,
and tests for NOOP, RSET, and VRFY. Corrected typo in a comment for
testNonnumericPort. Added a check for constructing SMTP objects when
non-numeric ports are included in the host name. Derived a server from
SMTPServer to test various ESMTP/SMTP capabilities. Check that a
second HELO to DebuggingServer returns an error. [GSoC - Alan McIntyre]
........
r57279 | skip.montanaro | 2007-08-22 12:02:16 -0700 (Wed, 22 Aug 2007) | 2 lines
Note that BeOS is unsupported as of Python 2.6.
........
r57280 | skip.montanaro | 2007-08-22 12:05:21 -0700 (Wed, 22 Aug 2007) | 1 line
whoops - need to check in configure as well
........
r57284 | alex.martelli | 2007-08-22 14:14:17 -0700 (Wed, 22 Aug 2007) | 5 lines
Fix compile.c so that it records 0.0 and -0.0 as separate constants in a code
object's co_consts tuple; add a test to show that the previous behavior (where
these two constants were "collapsed" into one) causes serious malfunctioning.
........
r57286 | gregory.p.smith | 2007-08-22 14:32:34 -0700 (Wed, 22 Aug 2007) | 3 lines
stop leaving log.0000001 __db.00* and xxx.db turds in developer
sandboxes when bsddb3 tests are run.
........
r57301 | jeffrey.yasskin | 2007-08-22 16:14:27 -0700 (Wed, 22 Aug 2007) | 3 lines
When setup.py fails to find the necessary bits to build some modules, have it
print a slightly more informative message.
........
r57320 | brett.cannon | 2007-08-23 07:53:17 -0700 (Thu, 23 Aug 2007) | 2 lines
Make test_runpy re-entrant.
........
r57324 | georg.brandl | 2007-08-23 10:54:11 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1768121: fix wrong/missing opcode docs.
........
r57326 | georg.brandl | 2007-08-23 10:57:05 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1766421: "return code" vs. "status code".
........
r57328 | georg.brandl | 2007-08-23 11:08:06 -0700 (Thu, 23 Aug 2007) | 2 lines
Second half of #1752175: #ifdef out references to PyImport_DynLoadFiletab if HAVE_DYNAMIC_LOADING is not defined.
........
r57331 | georg.brandl | 2007-08-23 11:11:33 -0700 (Thu, 23 Aug 2007) | 2 lines
Use try-except-finally in contextlib.
........
r57343 | georg.brandl | 2007-08-23 13:35:00 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1697820: document that the old slice protocol is still used by builtin types.
........
r57345 | georg.brandl | 2007-08-23 13:40:01 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1573854: fix docs for sqlite3 cursor rowcount attr.
........
r57347 | georg.brandl | 2007-08-23 13:50:23 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1694833: fix imp.find_module() docs wrt. packages.
........
r57348 | georg.brandl | 2007-08-23 13:53:28 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1594966: fix misleading usage example
........
r57349 | georg.brandl | 2007-08-23 13:55:44 -0700 (Thu, 23 Aug 2007) | 2 lines
Clarify wording a bit.
........
r57351 | georg.brandl | 2007-08-23 14:18:44 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1752332: httplib no longer uses socket.getaddrinfo().
........
r57352 | georg.brandl | 2007-08-23 14:21:36 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1734111: document struct.Struct.size.
........
r57353 | georg.brandl | 2007-08-23 14:27:57 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1688564: document os.path.join's absolute path behavior in the docstring.
........
r57354 | georg.brandl | 2007-08-23 14:36:05 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1625381: clarify match vs search introduction.
........
r57355 | georg.brandl | 2007-08-23 14:42:54 -0700 (Thu, 23 Aug 2007) | 2 lines
Bug #1758696: more info about descriptors.
........
r57357 | georg.brandl | 2007-08-23 14:55:57 -0700 (Thu, 23 Aug 2007) | 2 lines
Patch #1779550: remove redundant code in logging.
........
r57378 | gregory.p.smith | 2007-08-23 22:11:38 -0700 (Thu, 23 Aug 2007) | 2 lines
Fix bug 1725856.
........
r57382 | georg.brandl | 2007-08-23 23:10:01 -0700 (Thu, 23 Aug 2007) | 2 lines
uuid creation is now threadsafe, backport from py3k rev. 57375.
........
r57389 | georg.brandl | 2007-08-24 04:47:37 -0700 (Fri, 24 Aug 2007) | 2 lines
Bug #1765375: fix stripping of unwanted LDFLAGS.
........
r57391 | guido.van.rossum | 2007-08-24 07:53:14 -0700 (Fri, 24 Aug 2007) | 2 lines
Fix silly typo in test name.
........
Diffstat (limited to 'Doc/library/imp.rst')
-rw-r--r-- | Doc/library/imp.rst | 96 |
1 files changed, 53 insertions, 43 deletions
diff --git a/Doc/library/imp.rst b/Doc/library/imp.rst index f80bea3..7943604 100644 --- a/Doc/library/imp.rst +++ b/Doc/library/imp.rst @@ -22,63 +22,73 @@ This module provides an interface to the mechanisms used to implement the .. function:: get_suffixes() - Return a list of triples, each describing a particular type of module. Each - triple has the form ``(suffix, mode, type)``, where *suffix* is a string to be - appended to the module name to form the filename to search for, *mode* is the - mode string to pass to the built-in :func:`open` function to open the file (this - can be ``'r'`` for text files or ``'rb'`` for binary files), and *type* is the - file type, which has one of the values :const:`PY_SOURCE`, :const:`PY_COMPILED`, - or :const:`C_EXTENSION`, described below. + Return a list of 3-element tuples, each describing a particular type of + module. Each triple has the form ``(suffix, mode, type)``, where *suffix* is + a string to be appended to the module name to form the filename to search + for, *mode* is the mode string to pass to the built-in :func:`open` function + to open the file (this can be ``'r'`` for text files or ``'rb'`` for binary + files), and *type* is the file type, which has one of the values + :const:`PY_SOURCE`, :const:`PY_COMPILED`, or :const:`C_EXTENSION`, described + below. .. function:: find_module(name[, path]) - Try to find the module *name* on the search path *path*. If *path* is a list of - directory names, each directory is searched for files with any of the suffixes - returned by :func:`get_suffixes` above. Invalid names in the list are silently - ignored (but all list items must be strings). If *path* is omitted or ``None``, - the list of directory names given by ``sys.path`` is searched, but first it - searches a few special places: it tries to find a built-in module with the given - name (:const:`C_BUILTIN`), then a frozen module (:const:`PY_FROZEN`), and on - some systems some other places are looked in as well (on the Mac, it looks for a - resource (:const:`PY_RESOURCE`); on Windows, it looks in the registry which may - point to a specific file). - - If search is successful, the return value is a triple ``(file, pathname, - description)`` where *file* is an open file object positioned at the beginning, - *pathname* is the pathname of the file found, and *description* is a triple as + Try to find the module *name* on the search path *path*. If *path* is a list + of directory names, each directory is searched for files with any of the + suffixes returned by :func:`get_suffixes` above. Invalid names in the list + are silently ignored (but all list items must be strings). If *path* is + omitted or ``None``, the list of directory names given by ``sys.path`` is + searched, but first it searches a few special places: it tries to find a + built-in module with the given name (:const:`C_BUILTIN`), then a frozen + module (:const:`PY_FROZEN`), and on some systems some other places are looked + in as well (on the Mac, it looks for a resource (:const:`PY_RESOURCE`); on + Windows, it looks in the registry which may point to a specific file). + + If search is successful, the return value is a 3-element tuple ``(file, + pathname, description)``: + + *file* is an open file object positioned at the beginning, *pathname* is the + pathname of the file found, and *description* is a 3-element tuple as contained in the list returned by :func:`get_suffixes` describing the kind of - module found. If the module does not live in a file, the returned *file* is - ``None``, *filename* is the empty string, and the *description* tuple contains - empty strings for its suffix and mode; the module type is as indicate in - parentheses above. If the search is unsuccessful, :exc:`ImportError` is raised. - Other exceptions indicate problems with the arguments or environment. - - This function does not handle hierarchical module names (names containing dots). - In order to find *P*.*M*, that is, submodule *M* of package *P*, use + module found. + + If the module does not live in a file, the returned *file* is ``None``, + *pathname* is the empty string, and the *description* tuple contains empty + strings for its suffix and mode; the module type is indicated as given in + parentheses above. If the search is unsuccessful, :exc:`ImportError` is + raised. Other exceptions indicate problems with the arguments or + environment. + + If the module is a package, *file* is ``None``, *pathname* is the package + path and the last item in the *description* tuple is :const:`PKG_DIRECTORY`. + + This function does not handle hierarchical module names (names containing + dots). In order to find *P*.*M*, that is, submodule *M* of package *P*, use :func:`find_module` and :func:`load_module` to find and load package *P*, and then use :func:`find_module` with the *path* argument set to ``P.__path__``. When *P* itself has a dotted name, apply this recipe recursively. -.. function:: load_module(name, file, filename, description) +.. function:: load_module(name, file, pathname, description) Load a module that was previously found by :func:`find_module` (or by an otherwise conducted search yielding compatible results). This function does more than importing the module: if the module was already imported, it will - reload the module! The *name* argument indicates the full module name (including - the package name, if this is a submodule of a package). The *file* argument is - an open file, and *filename* is the corresponding file name; these can be - ``None`` and ``''``, respectively, when the module is not being loaded from a - file. The *description* argument is a tuple, as would be returned by - :func:`get_suffixes`, describing what kind of module must be loaded. - - If the load is successful, the return value is the module object; otherwise, an - exception (usually :exc:`ImportError`) is raised. - - **Important:** the caller is responsible for closing the *file* argument, if it - was not ``None``, even when an exception is raised. This is best done using a - :keyword:`try` ... :keyword:`finally` statement. + reload the module! The *name* argument indicates the full + module name (including the package name, if this is a submodule of a + package). The *file* argument is an open file, and *pathname* is the + corresponding file name; these can be ``None`` and ``''``, respectively, when + the module is a package or not being loaded from a file. The *description* + argument is a tuple, as would be returned by :func:`get_suffixes`, describing + what kind of module must be loaded. + + If the load is successful, the return value is the module object; otherwise, + an exception (usually :exc:`ImportError`) is raised. + + **Important:** the caller is responsible for closing the *file* argument, if + it was not ``None``, even when an exception is raised. This is best done + using a :keyword:`try` ... :keyword:`finally` statement. .. function:: new_module(name) |