Lines Matching +full:is +full:- +full:module
2 :mod:`imp` --- Access the :keyword:`import` internals
5 .. module:: imp
11 This module provides an interface to the mechanisms used to implement the
17 .. index:: pair: file; byte-code
19 Return the magic string value used to recognize byte-compiled code files
25 Return a list of 3-element tuples, each describing a particular type of
26 module. Each triple has the form ``(suffix, mode, type)``, where *suffix* is
27 a string to be appended to the module name to form the filename to search
28 for, *mode* is the mode string to pass to the built-in :func:`open` function
30 files), and *type* is the file type, which has one of the values
37 Try to find the module *name*. If *path* is omitted or ``None``, the list of
38 directory names given by ``sys.path`` is searched, but first a few special
39 places are searched: the function tries to find a built-in module with the
40 given name (:const:`C_BUILTIN`), then a frozen module (:const:`PY_FROZEN`),
44 Otherwise, *path* must be a list of directory names; each directory is
49 If search is successful, the return value is a 3-element tuple ``(file,
52 *file* is an open file object positioned at the beginning, *pathname* is the
53 pathname of the file found, and *description* is a 3-element tuple as
55 module found.
57 If the module does not live in a file, the returned *file* is ``None``,
58 *pathname* is the empty string, and the *description* tuple contains empty
59 strings for its suffix and mode; the module type is indicated as given in
60 parentheses above. If the search is unsuccessful, :exc:`ImportError` is
64 If the module is a package, *file* is ``None``, *pathname* is the package
65 path and the last item in the *description* tuple is :const:`PKG_DIRECTORY`.
67 This function does not handle hierarchical module names (names containing
68 dots). In order to find *P.M*, that is, submodule *M* of package *P*, use
78 Load a module that was previously found by :func:`find_module` (or by an
80 more than importing the module: if the module was already imported, it is
82 module name (including the package name, if this is a submodule of a
83 package). The *file* argument is an open file, and *pathname* is the
85 the module is a package or not being loaded from a file. The *description*
86 argument is a tuple, as would be returned by :func:`get_suffixes`, describing
87 what kind of module must be loaded.
89 If the load is successful, the return value is the module object; otherwise,
90 an exception (usually :exc:`ImportError`) is raised.
92 **Important:** the caller is responsible for closing the *file* argument, if
93 it was not ``None``, even when an exception is raised. This is best done
99 Return a new empty module object called *name*. This object is *not* inserted
105 Return ``True`` if the import lock is currently held, else ``False``. On
109 until the import is complete. This lock blocks other threads from doing an
111 from seeing incomplete module objects constructed by the original thread while
119 be used by import hooks to ensure thread-safety when importing modules.
137 The following constants with integer values, defined in this module, are used to
143 The module was found as a source file.
148 The module was found as a compiled code object file.
153 The module was found as dynamically loadable shared library.
158 The module was found as a package directory.
163 The module was found as a built-in module.
168 The module was found as a frozen module (see :func:`init_frozen`).
170 The following constant and functions are obsolete; their functionality is
182 Initialize the built-in module called *name* and return its module object along
183 with storing it in ``sys.modules``. If the module was already initialized, it
184 will be initialized *again*. Re-initialization involves the copying of the
185 built-in module's ``__dict__`` from the cached module over the module's entry in
186 ``sys.modules``. If there is no built-in module called *name*, ``None`` is
192 Initialize the frozen module called *name* and return its module object. If
193 the module was already initialized, it will be initialized *again*. If there
194 is no frozen module called *name*, ``None`` is returned. (Frozen modules are
195 modules written in Python whose compiled byte-code object is incorporated
196 into a custom-built Python interpreter by Python's :program:`freeze`
202 Return ``1`` if there is a built-in module called *name* which can be
203 initialized again. Return ``-1`` if there is a built-in module called *name*
205 there is no built-in module called *name*.
210 Return ``True`` if there is a frozen module (see :func:`init_frozen`) called
211 *name*, or ``False`` if there is no such module.
216 .. index:: pair: file; byte-code
218 Load and initialize a module implemented as a byte-compiled code file and return
219 its module object. If the module was already initialized, it will be
220 initialized *again*. The *name* argument is used to create or access a module
221 object. The *pathname* argument points to the byte-compiled code file. The
222 *file* argument is the byte-compiled code file, open for reading in binary mode,
223 from the beginning. It must currently be a real file object, not a user-defined
229 Load and initialize a module implemented as a dynamically loadable shared
230 library and return its module object. If the module was already initialized, it
231 will be initialized *again*. Re-initialization involves copying the ``__dict__``
232 attribute of the cached instance of the module over the value used in the module
234 library. The *name* argument is used to construct the name of the
236 shared library is called. The optional *file* argument is ignored. (Note:
237 using shared libraries is highly system dependent, and not all systems support
240 .. impl-detail::
245 referring to the same module, regardless of whether or not
248 the same shared library, as each reference to the module will use
254 Load and initialize a module implemented as a Python source file and return its
255 module object. If the module was already initialized, it will be initialized
256 *again*. The *name* argument is used to create or access a module object. The
257 *pathname* argument points to the source file. The *file* argument is the
259 a real file object, not a user-defined class emulating a file. Note that if a
260 properly matching byte-compiled file (with suffix :file:`.pyc` or :file:`.pyo`)
266 The :class:`NullImporter` type is a :pep:`302` import hook that handles
267 non-directory path strings by failing to find any modules. Calling this type
269 Otherwise, a :class:`NullImporter` instance is returned.
278 This method always returns ``None``, indicating that the requested module could
284 .. _examples-imp:
287 --------
290 Python 1.4 (no hierarchical module names). (This *implementation* wouldn't work
298 # Fast path: see if the module has already been imported.
305 # there's a problem we can't handle -- let the caller handle it.
318 module: knee
320 A more complete example that implements hierarchical module names and includes a
321 :func:`reload` function can be found in the module :mod:`knee`. The :mod:`knee`
322 module can be found in :file:`Demo/imputil/` in the Python source distribution.