importlib.rst 20.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
:mod:`importlib` -- An implementation of :keyword:`import`
==========================================================

.. module:: importlib
   :synopsis: An implementation of the import machinery.

.. moduleauthor:: Brett Cannon <brett@python.org>
.. sectionauthor:: Brett Cannon <brett@python.org>

.. versionadded:: 3.1


Introduction
------------

The purpose of the :mod:`importlib` package is two-fold. One is to provide an
implementation of the :keyword:`import` statement (and thus, by extension, the
:func:`__import__` function) in Python source code. This provides an
Tarek Ziadé's avatar
Tarek Ziadé committed
19
implementation of :keyword:`import` which is portable to any Python
20
interpreter. This also provides a reference implementation which is easier to
21
comprehend than one implemented in a programming language other than Python.
22

23
Two, the components to implement :keyword:`import` are exposed in this
24
package, making it easier for users to create their own custom objects (known
25
generically as an :term:`importer`) to participate in the import process.
26
Details on custom importers can be found in :pep:`302`.
27 28 29 30 31 32 33 34

.. seealso::

    :ref:`import`
        The language reference for the :keyword:`import` statement.

    `Packages specification <http://www.python.org/doc/essays/packages.html>`__
        Original specification of packages. Some semantics have changed since
35
        the writing of this document (e.g. redirecting based on ``None``
36 37 38
        in :data:`sys.modules`).

    The :func:`.__import__` function
39
        The :keyword:`import` statement is syntactic sugar for this function.
40 41 42 43 44 45 46 47

    :pep:`235`
        Import on Case-Insensitive Platforms

    :pep:`263`
        Defining Python Source Code Encodings

    :pep:`302`
48
        New Import Hooks
49 50 51 52 53 54 55

    :pep:`328`
        Imports: Multi-Line and Absolute/Relative

    :pep:`366`
        Main module explicit relative imports

56
    :pep:`3120`
57 58
        Using UTF-8 as the Default Source Encoding

59 60 61
    :pep:`3147`
        PYC Repository Directories

62 63 64 65

Functions
---------

66
.. function:: __import__(name, globals={}, locals={}, fromlist=list(), level=0)
67

68
    An implementation of the built-in :func:`__import__` function.
69 70 71

.. function:: import_module(name, package=None)

72
    Import a module. The *name* argument specifies what module to
73 74
    import in absolute or relative terms
    (e.g. either ``pkg.mod`` or ``..mod``). If the name is
75 76
    specified in relative terms, then the *package* argument must be set to
    the name of the package which is to act as the anchor for resolving the
77
    package name (e.g. ``import_module('..mod', 'pkg.subpkg')`` will import
78
    ``pkg.mod``).
79

80
    The :func:`import_module` function acts as a simplifying wrapper around
81 82 83 84 85 86
    :func:`importlib.__import__`. This means all semantics of the function are
    derived from :func:`importlib.__import__`, including requiring the package
    from which an import is occurring to have been previously imported
    (i.e., *package* must already be imported). The most important difference
    is that :func:`import_module` returns the most nested package or module
    that was imported (e.g. ``pkg.mod``), while :func:`__import__` returns the
87 88
    top-level package or module (e.g. ``pkg``).

89

90 91 92 93 94 95 96 97 98 99 100 101 102 103
:mod:`importlib.abc` -- Abstract base classes related to import
---------------------------------------------------------------

.. module:: importlib.abc
    :synopsis: Abstract base classes related to import

The :mod:`importlib.abc` module contains all of the core abstract base classes
used by :keyword:`import`. Some subclasses of the core abstract base classes
are also provided to help in implementing the core ABCs.


.. class:: Finder

    An abstract base class representing a :term:`finder`.
104
    See :pep:`302` for the exact definition for a finder.
105

Brett Cannon's avatar
Brett Cannon committed
106
    .. method:: find_module(fullname, path=None)
107 108 109

        An abstract method for finding a :term:`loader` for the specified
        module. If the :term:`finder` is found on :data:`sys.meta_path` and the
110 111
        module to be searched for is a subpackage or module then *path* will
        be the value of :attr:`__path__` from the parent package. If a loader
112
        cannot be found, ``None`` is returned.
113 114 115 116 117


.. class:: Loader

    An abstract base class for a :term:`loader`.
118
    See :pep:`302` for the exact definition for a loader.
119

Brett Cannon's avatar
Brett Cannon committed
120
    .. method:: load_module(fullname)
121 122 123 124 125

        An abstract method for loading a module. If the module cannot be
        loaded, :exc:`ImportError` is raised, otherwise the loaded module is
        returned.

126
        If the requested module already exists in :data:`sys.modules`, that
127
        module should be used and reloaded.
128 129 130
        Otherwise the loader should create a new module and insert it into
        :data:`sys.modules` before any loading begins, to prevent recursion
        from the import. If the loader inserted a module and the load fails, it
131 132 133 134 135
        must be removed by the loader from :data:`sys.modules`; modules already
        in :data:`sys.modules` before the loader began execution should be left
        alone. The :func:`importlib.util.module_for_loader` decorator handles
        all of these details.

136 137 138
        The loader should set several attributes on the module.
        (Note that some of these attributes can change when a module is
        reloaded.)
139 140 141 142 143 144 145 146 147

        - :attr:`__name__`
            The name of the module.

        - :attr:`__file__`
            The path to where the module data is stored (not set for built-in
            modules).

        - :attr:`__path__`
148
            A list of strings specifying the search path within a
149 150 151 152 153 154 155 156 157
            package. This attribute is not set on modules.

        - :attr:`__package__`
            The parent package for the module/package. If the module is
            top-level then it has a value of the empty string. The
            :func:`importlib.util.set_package` decorator can handle the details
            for :attr:`__package__`.

        - :attr:`__loader__`
158 159 160
            The loader used to load the module.
            (This is not set by the built-in import machinery,
            but it should be set whenever a :term:`loader` is used.)
161 162 163 164 165 166 167 168


.. class:: ResourceLoader

    An abstract base class for a :term:`loader` which implements the optional
    :pep:`302` protocol for loading arbitrary resources from the storage
    back-end.

Brett Cannon's avatar
Brett Cannon committed
169
    .. method:: get_data(path)
170 171

        An abstract method to return the bytes for the data located at *path*.
172
        Loaders that have a file-like storage back-end
173
        that allows storing arbitrary data
174
        can implement this abstract method to give direct access
175 176
        to the data stored. :exc:`IOError` is to be raised if the *path* cannot
        be found. The *path* is expected to be constructed using a module's
177
        :attr:`__file__` attribute or an item from a package's :attr:`__path__`.
178 179 180 181 182


.. class:: InspectLoader

    An abstract base class for a :term:`loader` which implements the optional
183
    :pep:`302` protocol for loaders that inspect modules.
184

185
    .. method:: get_code(fullname)
186

187
        An abstract method to return the :class:`code` object for a module.
188
        ``None`` is returned if the module does not have a code object
189 190
        (e.g. built-in module).  :exc:`ImportError` is raised if loader cannot
        find the requested module.
191

Brett Cannon's avatar
Brett Cannon committed
192
    .. method:: get_source(fullname)
193 194

        An abstract method to return the source of a module. It is returned as
195
        a text string with universal newlines. Returns ``None`` if no
196 197 198
        source is available (e.g. a built-in module). Raises :exc:`ImportError`
        if the loader cannot find the module specified.

199
    .. method:: is_package(fullname)
200

201 202 203
        An abstract method to return a true value if the module is a package, a
        false value otherwise. :exc:`ImportError` is raised if the
        :term:`loader` cannot find the module.
204 205


206 207 208
.. class:: ExecutionLoader

    An abstract base class which inherits from :class:`InspectLoader` that,
209
    when implemented, helps a module to be executed as a script. The ABC
210 211 212 213
    represents an optional :pep:`302` protocol.

    .. method:: get_filename(fullname)

214
        An abstract method that is to return the value of :attr:`__file__` for
215 216 217
        the specified module. If no path is available, :exc:`ImportError` is
        raised.

218 219 220 221 222 223 224 225 226 227 228 229 230
        If source code is available, then the method should return the path to
        the source file, regardless of whether a bytecode was used to load the
        module.


.. class:: SourceLoader

    An abstract base class for implementing source (and optionally bytecode)
    file loading. The class inherits from both :class:`ResourceLoader` and
    :class:`ExecutionLoader`, requiring the implementation of:

    * :meth:`ResourceLoader.get_data`
    * :meth:`ExecutionLoader.get_filename`
231
          Should only return the path to the source file; sourceless
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
          loading is not supported.

    The abstract methods defined by this class are to add optional bytecode
    file support. Not implementing these optional methods causes the loader to
    only work with source code. Implementing the methods allows the loader to
    work with source *and* bytecode files; it does not allow for *sourceless*
    loading where only bytecode is provided.  Bytecode files are an
    optimization to speed up loading by removing the parsing step of Python's
    compiler, and so no bytecode-specific API is exposed.

    .. method:: path_mtime(self, path)

        Optional abstract method which returns the modification time for the
        specified path.

    .. method:: set_data(self, path, data)

        Optional abstract method which writes the specified bytes to a file
250 251 252 253 254
        path. Any intermediate directories which do not exist are to be created
        automatically.

        When writing to the path fails because the path is read-only
        (:attr:`errno.EACCES`), do not propagate the exception.
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273

    .. method:: get_code(self, fullname)

        Concrete implementation of :meth:`InspectLoader.get_code`.

    .. method:: load_module(self, fullname)

        Concrete implementation of :meth:`Loader.load_module`.

    .. method:: get_source(self, fullname)

        Concrete implementation of :meth:`InspectLoader.get_source`.

    .. method:: is_package(self, fullname)

        Concrete implementation of :meth:`InspectLoader.is_package`. A module
        is determined to be a package if its file path is a file named
        ``__init__`` when the file extension is removed.

274

275 276
.. class:: PyLoader

277
    An abstract base class inheriting from
278 279
    :class:`ExecutionLoader` and
    :class:`ResourceLoader` designed to ease the loading of
280
    Python source modules (bytecode is not handled; see
281
    :class:`SourceLoader` for a source/bytecode ABC). A subclass
282 283 284 285
    implementing this ABC will only need to worry about exposing how the source
    code is stored; all other details for loading Python source code will be
    handled by the concrete implementations of key methods.

286 287 288
    .. deprecated:: 3.2
        This class has been deprecated in favor of :class:`SourceLoader` and is
        slated for removal in Python 3.4. See below for how to create a
Georg Brandl's avatar
Georg Brandl committed
289
        subclass that is compatible with Python 3.1 onwards.
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319

    If compatibility with Python 3.1 is required, then use the following idiom
    to implement a subclass that will work with Python 3.1 onwards (make sure
    to implement :meth:`ExecutionLoader.get_filename`)::

        try:
            from importlib.abc import SourceLoader
        except ImportError:
            from importlib.abc import PyLoader as SourceLoader


        class CustomLoader(SourceLoader):
            def get_filename(self, fullname):
                """Return the path to the source file."""
                # Implement ...

            def source_path(self, fullname):
                """Implement source_path in terms of get_filename."""
                try:
                    return self.get_filename(fullname)
                except ImportError:
                    return None

            def is_package(self, fullname):
                """Implement is_package by looking for an __init__ file
                name as returned by get_filename."""
                filename = os.path.basename(self.get_filename(fullname))
                return os.path.splitext(filename)[0] == '__init__'


Brett Cannon's avatar
Brett Cannon committed
320
    .. method:: source_path(fullname)
321 322

        An abstract method that returns the path to the source code for a
323
        module. Should return ``None`` if there is no source code.
Brett Cannon's avatar
Brett Cannon committed
324 325
        Raises :exc:`ImportError` if the loader knows it cannot handle the
        module.
326

327 328 329 330 331
    .. method:: get_filename(fullname)

        A concrete implementation of
        :meth:`importlib.abc.ExecutionLoader.get_filename` that
        relies on :meth:`source_path`. If :meth:`source_path` returns
332
        ``None``, then :exc:`ImportError` is raised.
333

Brett Cannon's avatar
Brett Cannon committed
334
    .. method:: load_module(fullname)
335 336

        A concrete implementation of :meth:`importlib.abc.Loader.load_module`
337 338 339 340
        that loads Python source code. All needed information comes from the
        abstract methods required by this ABC. The only pertinent assumption
        made by this method is that when loading a package
        :attr:`__path__` is set to ``[os.path.dirname(__file__)]``.
341

Brett Cannon's avatar
Brett Cannon committed
342
    .. method:: get_code(fullname)
343 344 345

        A concrete implementation of
        :meth:`importlib.abc.InspectLoader.get_code` that creates code objects
346
        from Python source code, by requesting the source code (using
Benjamin Peterson's avatar
Benjamin Peterson committed
347 348
        :meth:`source_path` and :meth:`get_data`) and compiling it with the
        built-in :func:`compile` function.
349

350 351 352 353
    .. method:: get_source(fullname)

        A concrete implementation of
        :meth:`importlib.abc.InspectLoader.get_source`. Uses
354 355
        :meth:`importlib.abc.ResourceLoader.get_data` and :meth:`source_path`
        to get the source code.  It tries to guess the source encoding using
356
        :func:`tokenize.detect_encoding`.
357

358 359 360

.. class:: PyPycLoader

361
    An abstract base class inheriting from :class:`PyLoader`.
362 363 364
    This ABC is meant to help in creating loaders that support both Python
    source and bytecode.

365 366 367 368 369 370 371 372
    .. deprecated:: 3.2
        This class has been deprecated in favor of :class:`SourceLoader` and to
        properly support :pep:`3147`. If compatibility is required with
        Python 3.1, implement both :class:`SourceLoader` and :class:`PyLoader`;
        instructions on how to do so are included in the documentation for
        :class:`PyLoader`. Do note that this solution will not support
        sourceless/bytecode-only loading; only source *and* bytecode loading.

Brett Cannon's avatar
Brett Cannon committed
373
    .. method:: source_mtime(fullname)
374 375 376

        An abstract method which returns the modification time for the source
        code of the specified module. The modification time should be an
377
        integer. If there is no source code, return ``None``. If the
378 379
        module cannot be found then :exc:`ImportError` is raised.

Brett Cannon's avatar
Brett Cannon committed
380
    .. method:: bytecode_path(fullname)
381 382

        An abstract method which returns the path to the bytecode for the
383
        specified module, if it exists. It returns ``None``
384
        if no bytecode exists (yet).
Brett Cannon's avatar
Brett Cannon committed
385 386
        Raises :exc:`ImportError` if the loader knows it cannot handle the
        module.
387

388 389 390
    .. method:: get_filename(fullname)

        A concrete implementation of
391 392
        :meth:`ExecutionLoader.get_filename` that relies on
        :meth:`PyLoader.source_path` and :meth:`bytecode_path`.
393 394 395 396 397
        If :meth:`source_path` returns a path, then that value is returned.
        Else if :meth:`bytecode_path` returns a path, that path will be
        returned. If a path is not available from both methods,
        :exc:`ImportError` is raised.

Brett Cannon's avatar
Brett Cannon committed
398
    .. method:: write_bytecode(fullname, bytecode)
399 400

        An abstract method which has the loader write *bytecode* for future
401 402
        use. If the bytecode is written, return ``True``. Return
        ``False`` if the bytecode could not be written. This method
403
        should not be called if :data:`sys.dont_write_bytecode` is true.
404
        The *bytecode* argument should be a bytes string or bytes array.
405 406


407 408 409 410 411 412 413 414 415 416 417
:mod:`importlib.machinery` -- Importers and path hooks
------------------------------------------------------

.. module:: importlib.machinery
    :synopsis: Importers and path hooks

This module contains the various objects that help :keyword:`import`
find and load modules.

.. class:: BuiltinImporter

418 419
    An :term:`importer` for built-in modules. All known built-in modules are
    listed in :data:`sys.builtin_module_names`. This class implements the
420 421
    :class:`importlib.abc.Finder` and :class:`importlib.abc.InspectLoader`
    ABCs.
422 423 424 425 426 427 428

    Only class methods are defined by this class to alleviate the need for
    instantiation.


.. class:: FrozenImporter

429
    An :term:`importer` for frozen modules. This class implements the
430 431
    :class:`importlib.abc.Finder` and :class:`importlib.abc.InspectLoader`
    ABCs.
432 433 434 435

    Only class methods are defined by this class to alleviate the need for
    instantiation.

436 437 438

.. class:: PathFinder

439 440
    :term:`Finder` for :data:`sys.path`. This class implements the
    :class:`importlib.abc.Finder` ABC.
441 442 443 444 445

    This class does not perfectly mirror the semantics of :keyword:`import` in
    terms of :data:`sys.path`. No implicit path hooks are assumed for
    simplification of the class and its semantics.

Brett Cannon's avatar
Brett Cannon committed
446
    Only class methods are defined by this class to alleviate the need for
447 448 449 450 451
    instantiation.

    .. classmethod:: find_module(fullname, path=None)

        Class method that attempts to find a :term:`loader` for the module
452
        specified by *fullname* on :data:`sys.path` or, if defined, on
453 454
        *path*. For each path entry that is searched,
        :data:`sys.path_importer_cache` is checked. If an non-false object is
455 456
        found then it is used as the :term:`finder` to look for the module
        being searched for. If no entry is found in
457 458 459
        :data:`sys.path_importer_cache`, then :data:`sys.path_hooks` is
        searched for a finder for the path entry and, if found, is stored in
        :data:`sys.path_importer_cache` along with being queried about the
460
        module. If no finder is ever found then ``None`` is returned.
461 462 463 464 465 466 467 468 469 470 471


:mod:`importlib.util` -- Utility code for importers
---------------------------------------------------

.. module:: importlib.util
    :synopsis: Importers and path hooks

This module contains the various objects that help in the construction of
an :term:`importer`.

472
.. decorator:: module_for_loader
473

474 475
    A :term:`decorator` for a :term:`loader` method,
    to handle selecting the proper
476
    module object to load with. The decorated method is expected to have a call
477 478
    signature taking two positional arguments
    (e.g. ``load_module(self, module)``) for which the second argument
479 480
    will be the module **object** to be used by the loader.
    Note that the decorator
481
    will not work on static methods because of the assumption of two
482
    arguments.
483

484 485
    The decorated method will take in the **name** of the module to be loaded
    as expected for a :term:`loader`. If the module is not found in
486 487 488
    :data:`sys.modules` then a new one is constructed with its
    :attr:`__name__` attribute set. Otherwise the module found in
    :data:`sys.modules` will be passed into the method. If an
489 490
    exception is raised by the decorated method and a module was added to
    :data:`sys.modules` it will be removed to prevent a partially initialized
491 492 493
    module from being in left in :data:`sys.modules`. If the module was already
    in :data:`sys.modules` then it is left alone.

494
    Use of this decorator handles all the details of which module object a
495 496
    loader should initialize as specified by :pep:`302`.

497
.. decorator:: set_loader
498

499 500
    A :term:`decorator` for a :term:`loader` method,
    to set the :attr:`__loader__`
501 502 503 504
    attribute on loaded modules. If the attribute is already set the decorator
    does nothing. It is assumed that the first positional argument to the
    wrapped method is what :attr:`__loader__` should be set to.

505
.. decorator:: set_package
506 507 508

    A :term:`decorator` for a :term:`loader` to set the :attr:`__package__`
    attribute on the module returned by the loader. If :attr:`__package__` is
509
    set and has a value other than ``None`` it will not be changed.
510 511
    Note that the module returned by the loader is what has the attribute
    set on and not the module found in :data:`sys.modules`.
512

513 514 515 516 517 518
    Reliance on this decorator is discouraged when it is possible to set
    :attr:`__package__` before the execution of the code is possible. By
    setting it before the code for the module is executed it allows the
    attribute to be used at the global level of the module during
    initialization.