import.rst 12.4 KB
Newer Older
1 2 3 4 5 6 7 8
.. highlightlang:: c

.. _importing:

Importing Modules
=================


9
.. c:function:: PyObject* PyImport_ImportModule(const char *name)
10 11 12 13 14 15

   .. index::
      single: package variable; __all__
      single: __all__ (package variable)
      single: modules (in module sys)

16
   This is a simplified interface to :c:func:`PyImport_ImportModuleEx` below,
17 18 19 20 21 22 23 24
   leaving the *globals* and *locals* arguments set to *NULL* and *level* set
   to 0.  When the *name*
   argument contains a dot (when it specifies a submodule of a package), the
   *fromlist* argument is set to the list ``['*']`` so that the return value is the
   named module rather than the top-level package containing it as would otherwise
   be the case.  (Unfortunately, this has an additional side effect when *name* in
   fact specifies a subpackage instead of a submodule: the submodules specified in
   the package's ``__all__`` variable are  loaded.)  Return a new reference to the
25 26
   imported module, or *NULL* with an exception set on failure.  A failing
   import of a module doesn't leave the module in :data:`sys.modules`.
27

28 29
   This function always uses absolute imports.

30

31
.. c:function:: PyObject* PyImport_ImportModuleNoBlock(const char *name)
32

33 34 35 36 37 38 39
   This function is a deprecated alias of :c:func:`PyImport_ImportModule`.

   .. versionchanged:: 3.3
      This function used to fail immediately when the import lock was held
      by another thread.  In Python 3.3 though, the locking scheme switched
      to per-module locks for most purposes, so this function's special
      behaviour isn't needed anymore.
40 41


42
.. c:function:: PyObject* PyImport_ImportModuleEx(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)
43 44 45 46

   .. index:: builtin: __import__

   Import a module.  This is best described by referring to the built-in Python
47
   function :func:`__import__`.
48

49 50 51 52 53
   The return value is a new reference to the imported module or top-level
   package, or *NULL* with an exception set on failure.  Like for
   :func:`__import__`, the return value when a submodule of a package was
   requested is normally the top-level package, unless a non-empty *fromlist*
   was given.
54 55

   Failing imports remove incomplete module objects, like with
56
   :c:func:`PyImport_ImportModule`.
57 58


59
.. c:function:: PyObject* PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
60 61 62 63 64 65 66 67 68 69

   Import a module.  This is best described by referring to the built-in Python
   function :func:`__import__`, as the standard :func:`__import__` function calls
   this function directly.

   The return value is a new reference to the imported module or top-level package,
   or *NULL* with an exception set on failure.  Like for :func:`__import__`,
   the return value when a submodule of a package was requested is normally the
   top-level package, unless a non-empty *fromlist* was given.

70 71 72
   .. versionadded:: 3.3


73
.. c:function:: PyObject* PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
74

75
   Similar to :c:func:`PyImport_ImportModuleLevelObject`, but the name is a
76
   UTF-8 encoded string instead of a Unicode object.
77

78
   .. versionchanged:: 3.3
Ezio Melotti's avatar
Ezio Melotti committed
79
         Negative values for *level* are no longer accepted.
80

81
.. c:function:: PyObject* PyImport_Import(PyObject *name)
82 83 84 85 86 87 88

   This is a higher-level interface that calls the current "import hook
   function" (with an explicit *level* of 0, meaning absolute import).  It
   invokes the :func:`__import__` function from the ``__builtins__`` of the
   current globals.  This means that the import is done using whatever import
   hooks are installed in the current environment.

89 90
   This function always uses absolute imports.

91

92
.. c:function:: PyObject* PyImport_ReloadModule(PyObject *m)
93 94 95 96 97

   Reload a module.  Return a new reference to the reloaded module, or *NULL* with
   an exception set on failure (the module still exists in this case).


98
.. c:function:: PyObject* PyImport_AddModuleObject(PyObject *name)
99 100 101 102 103 104 105 106 107

   Return the module object corresponding to a module name.  The *name* argument
   may be of the form ``package.module``. First check the modules dictionary if
   there's one there, and if not, create a new one and insert it in the modules
   dictionary. Return *NULL* with an exception set on failure.

   .. note::

      This function does not load or import the module; if the module wasn't already
108
      loaded, you will get an empty module object. Use :c:func:`PyImport_ImportModule`
109 110 111
      or one of its variants to import a module.  Package structures implied by a
      dotted name for *name* are not created if not already present.

112 113 114 115 116
   .. versionadded:: 3.3


.. c:function:: PyObject* PyImport_AddModule(const char *name)

Éric Araujo's avatar
Éric Araujo committed
117
   Similar to :c:func:`PyImport_AddModuleObject`, but the name is a UTF-8
118 119
   encoded string instead of a Unicode object.

120

121
.. c:function:: PyObject* PyImport_ExecCodeModule(const char *name, PyObject *co)
122 123 124 125 126 127

   .. index:: builtin: compile

   Given a module name (possibly of the form ``package.module``) and a code object
   read from a Python bytecode file or obtained from the built-in function
   :func:`compile`, load the module.  Return a new reference to the module object,
128 129
   or *NULL* with an exception set if an error occurred.  *name*
   is removed from :attr:`sys.modules` in error cases, even if *name* was already
130
   in :attr:`sys.modules` on entry to :c:func:`PyImport_ExecCodeModule`.  Leaving
131 132 133 134
   incompletely initialized modules in :attr:`sys.modules` is dangerous, as imports of
   such modules have no way to know that the module object is an unknown (and
   probably damaged with respect to the module author's intents) state.

135 136 137 138 139
   The module's :attr:`__spec__` and :attr:`__loader__` will be set, if
   not set already, with the appropriate values.  The spec's loader will
   be set to the module's ``__loader__`` (if set) and to an instance of
   :class:`SourceFileLoader` otherwise.

Benjamin Peterson's avatar
Benjamin Peterson committed
140
   The module's :attr:`__file__` attribute will be set to the code object's
141 142
   :c:member:`co_filename`.  If applicable, :attr:`__cached__` will also
   be set.
Benjamin Peterson's avatar
Benjamin Peterson committed
143

144
   This function will reload the module if it was already imported.  See
145
   :c:func:`PyImport_ReloadModule` for the intended way to reload a module.
146 147 148 149

   If *name* points to a dotted name of the form ``package.module``, any package
   structures not already created will still not be created.

150 151
   See also :c:func:`PyImport_ExecCodeModuleEx` and
   :c:func:`PyImport_ExecCodeModuleWithPathnames`.
Barry Warsaw's avatar
Barry Warsaw committed
152

153

154
.. c:function:: PyObject* PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)
Benjamin Peterson's avatar
Benjamin Peterson committed
155

156
   Like :c:func:`PyImport_ExecCodeModule`, but the :attr:`__file__` attribute of
Benjamin Peterson's avatar
Benjamin Peterson committed
157 158
   the module object is set to *pathname* if it is non-``NULL``.

159
   See also :c:func:`PyImport_ExecCodeModuleWithPathnames`.
Barry Warsaw's avatar
Barry Warsaw committed
160 161


162
.. c:function:: PyObject* PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)
Barry Warsaw's avatar
Barry Warsaw committed
163

164
   Like :c:func:`PyImport_ExecCodeModuleEx`, but the :attr:`__cached__`
Barry Warsaw's avatar
Barry Warsaw committed
165 166 167
   attribute of the module object is set to *cpathname* if it is
   non-``NULL``.  Of the three functions, this is the preferred one to use.

168 169 170
   .. versionadded:: 3.3


171
.. c:function:: PyObject* PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co, const char *pathname, const char *cpathname)
172 173

   Like :c:func:`PyImport_ExecCodeModuleObject`, but *name*, *pathname* and
174 175 176
   *cpathname* are UTF-8 encoded strings. Attempts are also made to figure out
   what the value for *pathname* should be from *cpathname* if the former is
   set to ``NULL``.
177

178
   .. versionadded:: 3.2
179 180 181
   .. versionchanged:: 3.3
      Uses :func:`imp.source_from_cache()` in calculating the source path if
      only the bytecode path is provided.
Benjamin Peterson's avatar
Benjamin Peterson committed
182

183

184
.. c:function:: long PyImport_GetMagicNumber()
185

186 187
   Return the magic number for Python bytecode files (a.k.a. :file:`.pyc` file).
   The magic number should be present in the first four bytes of the bytecode
188
   file, in little-endian byte order. Returns ``-1`` on error.
189 190

   .. versionchanged:: 3.3
191
      Return value of ``-1`` upon failure.
192 193


194
.. c:function:: const char * PyImport_GetMagicTag()
Barry Warsaw's avatar
Barry Warsaw committed
195 196

   Return the magic tag string for :pep:`3147` format Python bytecode file
197 198
   names.  Keep in mind that the value at ``sys.implementation.cache_tag`` is
   authoritative and should be used instead of this function.
Barry Warsaw's avatar
Barry Warsaw committed
199

200 201
   .. versionadded:: 3.2

202
.. c:function:: PyObject* PyImport_GetModuleDict()
203 204 205 206 207

   Return the dictionary used for the module administration (a.k.a.
   ``sys.modules``).  Note that this is a per-interpreter variable.


208
.. c:function:: PyObject* PyImport_GetImporter(PyObject *path)
Christian Heimes's avatar
Christian Heimes committed
209

210
   Return a finder object for a :data:`sys.path`/:attr:`pkg.__path__` item
Christian Heimes's avatar
Christian Heimes committed
211 212 213
   *path*, possibly by fetching it from the :data:`sys.path_importer_cache`
   dict.  If it wasn't yet cached, traverse :data:`sys.path_hooks` until a hook
   is found that can handle the path item.  Return ``None`` if no hook could;
214 215 216
   this tells our caller that the :term:`path based finder` could not find a
   finder for this path item. Cache the result in :data:`sys.path_importer_cache`.
   Return a new reference to the finder object.
Christian Heimes's avatar
Christian Heimes committed
217 218


219
.. c:function:: void _PyImport_Init()
220 221 222 223

   Initialize the import mechanism.  For internal use only.


224
.. c:function:: void PyImport_Cleanup()
225 226 227 228

   Empty the module table.  For internal use only.


229
.. c:function:: void _PyImport_Fini()
230 231 232 233

   Finalize the import mechanism.  For internal use only.


234
.. c:function:: int PyImport_ImportFrozenModuleObject(PyObject *name)
235 236 237 238

   Load a frozen module named *name*.  Return ``1`` for success, ``0`` if the
   module is not found, and ``-1`` with an exception set if the initialization
   failed.  To access the imported module on a successful load, use
239
   :c:func:`PyImport_ImportModule`.  (Note the misnomer --- this function would
240 241
   reload the module if it was already imported.)

242 243
   .. versionadded:: 3.3

244 245 246
   .. versionchanged:: 3.4
      The ``__file__`` attribute is no longer set on the module.

247

248
.. c:function:: int PyImport_ImportFrozenModule(const char *name)
249

Éric Araujo's avatar
Éric Araujo committed
250
   Similar to :c:func:`PyImport_ImportFrozenModuleObject`, but the name is a
251 252
   UTF-8 encoded string instead of a Unicode object.

253

254
.. c:type:: struct _frozen
255 256 257 258 259 260 261 262 263

   .. index:: single: freeze utility

   This is the structure type definition for frozen module descriptors, as
   generated by the :program:`freeze` utility (see :file:`Tools/freeze/` in the
   Python source distribution).  Its definition, found in :file:`Include/import.h`,
   is::

      struct _frozen {
264 265
          const char *name;
          const unsigned char *code;
266 267 268 269
          int size;
      };


270
.. c:var:: const struct _frozen* PyImport_FrozenModules
271

272
   This pointer is initialized to point to an array of :c:type:`struct _frozen`
273 274 275 276 277
   records, terminated by one whose members are all *NULL* or zero.  When a frozen
   module is imported, it is searched in this table.  Third-party code could play
   tricks with this to provide a dynamically created collection of frozen modules.


278
.. c:function:: int PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))
279 280

   Add a single module to the existing table of built-in modules.  This is a
281
   convenience wrapper around :c:func:`PyImport_ExtendInittab`, returning ``-1`` if
282 283 284
   the table could not be extended.  The new module can be imported by the name
   *name*, and uses the function *initfunc* as the initialization function called
   on the first attempted import.  This should be called before
285
   :c:func:`Py_Initialize`.
286 287


288
.. c:type:: struct _inittab
289 290 291

   Structure describing a single entry in the list of built-in modules.  Each of
   these structures gives the name and initialization function for a module built
292 293 294 295
   into the interpreter.  The name is an ASCII encoded string.  Programs which
   embed Python may use an array of these structures in conjunction with
   :c:func:`PyImport_ExtendInittab` to provide additional built-in modules.
   The structure is defined in :file:`Include/import.h` as::
296 297

      struct _inittab {
298
          const char *name;           /* ASCII encoded string */
299
          PyObject* (*initfunc)(void);
300 301 302
      };


303
.. c:function:: int PyImport_ExtendInittab(struct _inittab *newtab)
304 305 306 307 308 309

   Add a collection of modules to the table of built-in modules.  The *newtab*
   array must end with a sentinel entry which contains *NULL* for the :attr:`name`
   field; failure to provide the sentinel value can result in a memory fault.
   Returns ``0`` on success or ``-1`` if insufficient memory could be allocated to
   extend the internal table.  In the event of failure, no modules are added to the
310
   internal table.  This should be called before :c:func:`Py_Initialize`.