CINXE.COM

<!DOCTYPE html> <html lang="en" data-content_root="../"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta property="og:title" content="importlib — The implementation of import" /> <meta property="og:type" content="website" /> <meta property="og:url" content="https://docs.python.org/3/library/importlib.html" /> <meta property="og:site_name" content="Python documentation" /> <meta property="og:description" content="Source code: Lib/importlib/__init__.py Introduction: The purpose of the importlib package is three-fold. One is to provide the implementation of the import statement (and thus, by extension, the__i..." /> <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" /> <meta property="og:image:alt" content="Python documentation" /> <meta name="description" content="Source code: Lib/importlib/__init__.py Introduction: The purpose of the importlib package is three-fold. One is to provide the implementation of the import statement (and thus, by extension, the__i..." /> <meta property="og:image:width" content="200" /> <meta property="og:image:height" content="200" /> <meta name="theme-color" content="#3776ab" /> <title>importlib — The implementation of import — Python 3.13.0 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0"> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" /> <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=41b4f12d" /> <link rel="stylesheet" type="text/css" href="../_static/sidebar-wrap.css?v=65806c5a" /> <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" /> <script src="../_static/documentation_options.js?v=6aaf4047"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 3.13.0 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="next" title="importlib.resources – Package resource reading, opening and access" href="importlib.resources.html" /> <link rel="prev" title="runpy — Locating and executing Python modules" href="runpy.html" /> <script defer data-domain="docs.python.org" src="https://plausible.io/js/script.js"></script> <link rel="canonical" href="https://docs.python.org/3/library/importlib.html" /> <style> @media only screen { table.full-width-table { width: 100%; } } </style> <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css"> <link rel="shortcut icon" type="image/png" href="../_static/py.svg" /> <script type="text/javascript" src="../_static/copybutton.js"></script> <script type="text/javascript" src="../_static/menu.js"></script> <script type="text/javascript" src="../_static/search-focus.js"></script> <script type="text/javascript" src="../_static/themetoggle.js"></script> <script type="text/javascript" src="../_static/rtd_switcher.js"></script> <meta name="readthedocs-addons-api-version" content="1"> </head> <body> <div class="mobile-nav"> <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation" aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" /> <nav class="nav-content" role="navigation"> <label for="menuToggler" class="toggler__label"> </label> <a href="https://www.python.org/" class="nav-logo"> <img src="../_static/py.svg" alt="Python logo"/> </a> <form role="search" class="search" action="../search.html" method="get"> <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon"> <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path> </svg> <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" /> <input type="submit" value="Go"/> </form> </nav> <div class="menu-wrapper"> <nav class="menu" role="navigation" aria-label="main navigation"> <div class="language_switcher_placeholder"></div> <label class="theme-selector-label"> Theme <select class="theme-selector" oninput="activateTheme(this.value)"> <option value="auto" selected>Auto</option> <option value="light">Light</option> <option value="dark">Dark</option> </select> </label> <div> <h3><a href="../contents.html">Table of Contents</a></h3> <ul> <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">importlib</code> — The implementation of <code class="xref std std-keyword docutils literal notranslate">import</code></a><ul> <li><a class="reference internal" href="#introduction">Introduction</a></li> <li><a class="reference internal" href="#functions">Functions</a><ul> <li><a class="reference internal" href="#importlib.__import__"><code class="docutils literal notranslate">__import__()</code></a></li> <li><a class="reference internal" href="#importlib.import_module"><code class="docutils literal notranslate">import_module()</code></a></li> <li><a class="reference internal" href="#importlib.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> <li><a class="reference internal" href="#importlib.reload"><code class="docutils literal notranslate">reload()</code></a></li> </ul> </li> <li><a class="reference internal" href="#module-importlib.abc"><code class="xref py py-mod docutils literal notranslate">importlib.abc</code> – Abstract base classes related to import</a><ul> <li><a class="reference internal" href="#importlib.abc.MetaPathFinder"><code class="docutils literal notranslate">MetaPathFinder</code></a><ul> <li><a class="reference internal" href="#importlib.abc.MetaPathFinder.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.abc.MetaPathFinder.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.PathEntryFinder"><code class="docutils literal notranslate">PathEntryFinder</code></a><ul> <li><a class="reference internal" href="#importlib.abc.PathEntryFinder.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.abc.PathEntryFinder.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.Loader"><code class="docutils literal notranslate">Loader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.Loader.create_module"><code class="docutils literal notranslate">create_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Loader.exec_module"><code class="docutils literal notranslate">exec_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Loader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.ResourceLoader"><code class="docutils literal notranslate">ResourceLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.ResourceLoader.get_data"><code class="docutils literal notranslate">get_data()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.InspectLoader"><code class="docutils literal notranslate">InspectLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.InspectLoader.get_code"><code class="docutils literal notranslate">get_code()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.get_source"><code class="docutils literal notranslate">get_source()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.source_to_code"><code class="docutils literal notranslate">source_to_code()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.exec_module"><code class="docutils literal notranslate">exec_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.ExecutionLoader"><code class="docutils literal notranslate">ExecutionLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.ExecutionLoader.get_filename"><code class="docutils literal notranslate">get_filename()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.FileLoader"><code class="docutils literal notranslate">FileLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.FileLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.abc.FileLoader.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.abc.FileLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.FileLoader.get_filename"><code class="docutils literal notranslate">get_filename()</code></a></li> <li><a class="reference internal" href="#importlib.abc.FileLoader.get_data"><code class="docutils literal notranslate">get_data()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.SourceLoader"><code class="docutils literal notranslate">SourceLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.SourceLoader.path_stats"><code class="docutils literal notranslate">path_stats()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.path_mtime"><code class="docutils literal notranslate">path_mtime()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.set_data"><code class="docutils literal notranslate">set_data()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.get_code"><code class="docutils literal notranslate">get_code()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.exec_module"><code class="docutils literal notranslate">exec_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.get_source"><code class="docutils literal notranslate">get_source()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.ResourceReader"><code class="docutils literal notranslate">ResourceReader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.ResourceReader.open_resource"><code class="docutils literal notranslate">open_resource()</code></a></li> <li><a class="reference internal" href="#importlib.abc.ResourceReader.resource_path"><code class="docutils literal notranslate">resource_path()</code></a></li> <li><a class="reference internal" href="#importlib.abc.ResourceReader.is_resource"><code class="docutils literal notranslate">is_resource()</code></a></li> <li><a class="reference internal" href="#importlib.abc.ResourceReader.contents"><code class="docutils literal notranslate">contents()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.Traversable"><code class="docutils literal notranslate">Traversable</code></a><ul> <li><a class="reference internal" href="#importlib.abc.Traversable.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.iterdir"><code class="docutils literal notranslate">iterdir()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.is_dir"><code class="docutils literal notranslate">is_dir()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.is_file"><code class="docutils literal notranslate">is_file()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.joinpath"><code class="docutils literal notranslate">joinpath()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.__truediv__"><code class="docutils literal notranslate">__truediv__()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.open"><code class="docutils literal notranslate">open()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.read_bytes"><code class="docutils literal notranslate">read_bytes()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.read_text"><code class="docutils literal notranslate">read_text()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.TraversableResources"><code class="docutils literal notranslate">TraversableResources</code></a><ul> <li><a class="reference internal" href="#importlib.abc.TraversableResources.files"><code class="docutils literal notranslate">files()</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#module-importlib.machinery"><code class="xref py py-mod docutils literal notranslate">importlib.machinery</code> – Importers and path hooks</a><ul> <li><a class="reference internal" href="#importlib.machinery.SOURCE_SUFFIXES"><code class="docutils literal notranslate">SOURCE_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.DEBUG_BYTECODE_SUFFIXES"><code class="docutils literal notranslate">DEBUG_BYTECODE_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES"><code class="docutils literal notranslate">OPTIMIZED_BYTECODE_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.BYTECODE_SUFFIXES"><code class="docutils literal notranslate">BYTECODE_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.EXTENSION_SUFFIXES"><code class="docutils literal notranslate">EXTENSION_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.all_suffixes"><code class="docutils literal notranslate">all_suffixes()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.BuiltinImporter"><code class="docutils literal notranslate">BuiltinImporter</code></a></li> <li><a class="reference internal" href="#importlib.machinery.FrozenImporter"><code class="docutils literal notranslate">FrozenImporter</code></a></li> <li><a class="reference internal" href="#importlib.machinery.WindowsRegistryFinder"><code class="docutils literal notranslate">WindowsRegistryFinder</code></a></li> <li><a class="reference internal" href="#importlib.machinery.PathFinder"><code class="docutils literal notranslate">PathFinder</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.PathFinder.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.PathFinder.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.FileFinder"><code class="docutils literal notranslate">FileFinder</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.FileFinder.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.machinery.FileFinder.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.FileFinder.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.FileFinder.path_hook"><code class="docutils literal notranslate">path_hook()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader"><code class="docutils literal notranslate">SourceFileLoader</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.path_stats"><code class="docutils literal notranslate">path_stats()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.set_data"><code class="docutils literal notranslate">set_data()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader"><code class="docutils literal notranslate">SourcelessFileLoader</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.get_code"><code class="docutils literal notranslate">get_code()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.get_source"><code class="docutils literal notranslate">get_source()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader"><code class="docutils literal notranslate">ExtensionFileLoader</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.create_module"><code class="docutils literal notranslate">create_module()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.exec_module"><code class="docutils literal notranslate">exec_module()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.get_code"><code class="docutils literal notranslate">get_code()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.get_source"><code class="docutils literal notranslate">get_source()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.get_filename"><code class="docutils literal notranslate">get_filename()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.NamespaceLoader"><code class="docutils literal notranslate">NamespaceLoader</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec"><code class="docutils literal notranslate">ModuleSpec</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.loader"><code class="docutils literal notranslate">loader</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.origin"><code class="docutils literal notranslate">origin</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.submodule_search_locations"><code class="docutils literal notranslate">submodule_search_locations</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.loader_state"><code class="docutils literal notranslate">loader_state</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.cached"><code class="docutils literal notranslate">cached</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.parent"><code class="docutils literal notranslate">parent</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.has_location"><code class="docutils literal notranslate">has_location</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.AppleFrameworkLoader"><code class="docutils literal notranslate">AppleFrameworkLoader</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.AppleFrameworkLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.AppleFrameworkLoader.path"><code class="docutils literal notranslate">path</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#module-importlib.util"><code class="xref py py-mod docutils literal notranslate">importlib.util</code> – Utility code for importers</a><ul> <li><a class="reference internal" href="#importlib.util.MAGIC_NUMBER"><code class="docutils literal notranslate">MAGIC_NUMBER</code></a></li> <li><a class="reference internal" href="#importlib.util.cache_from_source"><code class="docutils literal notranslate">cache_from_source()</code></a></li> <li><a class="reference internal" href="#importlib.util.source_from_cache"><code class="docutils literal notranslate">source_from_cache()</code></a></li> <li><a class="reference internal" href="#importlib.util.decode_source"><code class="docutils literal notranslate">decode_source()</code></a></li> <li><a class="reference internal" href="#importlib.util.resolve_name"><code class="docutils literal notranslate">resolve_name()</code></a></li> <li><a class="reference internal" href="#importlib.util.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.util.module_from_spec"><code class="docutils literal notranslate">module_from_spec()</code></a></li> <li><a class="reference internal" href="#importlib.util.spec_from_loader"><code class="docutils literal notranslate">spec_from_loader()</code></a></li> <li><a class="reference internal" href="#importlib.util.spec_from_file_location"><code class="docutils literal notranslate">spec_from_file_location()</code></a></li> <li><a class="reference internal" href="#importlib.util.source_hash"><code class="docutils literal notranslate">source_hash()</code></a></li> <li><a class="reference internal" href="#importlib.util._incompatible_extension_module_restrictions"><code class="docutils literal notranslate">_incompatible_extension_module_restrictions()</code></a></li> <li><a class="reference internal" href="#importlib.util.LazyLoader"><code class="docutils literal notranslate">LazyLoader</code></a><ul> <li><a class="reference internal" href="#importlib.util.LazyLoader.factory"><code class="docutils literal notranslate">factory()</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#examples">Examples</a><ul> <li><a class="reference internal" href="#importing-programmatically">Importing programmatically</a></li> <li><a class="reference internal" href="#checking-if-a-module-can-be-imported">Checking if a module can be imported</a></li> <li><a class="reference internal" href="#importing-a-source-file-directly">Importing a source file directly</a></li> <li><a class="reference internal" href="#implementing-lazy-imports">Implementing lazy imports</a></li> <li><a class="reference internal" href="#setting-up-an-importer">Setting up an importer</a></li> <li><a class="reference internal" href="#approximating-importlib-import-module">Approximating <code class="xref py py-func docutils literal notranslate">importlib.import_module()</code></a></li> </ul> </li> </ul> </li> </ul> </div> <div> <h4>Previous topic</h4> <a href="runpy.html" title="previous chapter"><code class="xref py py-mod docutils literal notranslate">runpy</code> — Locating and executing Python modules</a> </div> <div> <h4>Next topic</h4> <a href="importlib.resources.html" title="next chapter"><code class="xref py py-mod docutils literal notranslate">importlib.resources</code> – Package resource reading, opening and access</a> </div> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li> <a href="https://github.com/python/cpython/blob/main/Doc/library/importlib.rst" rel="nofollow">Show Source </a> </li> </ul> </div> </nav> </div> </div> <div class="related" role="navigation" aria-label="Related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="importlib.resources.html" title="importlib.resources – Package resource reading, opening and access" accesskey="N">next</a> |</li> <li class="right" > <a href="runpy.html" title="runpy — Locating and executing Python modules" accesskey="P">previous</a> |</li> <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li class="switchers"> <div class="language_switcher_placeholder"></div> <div class="version_switcher_placeholder"></div> </li> <li> </li> <li id="cpython-language-and-version"> <a href="../index.html">3.13.0 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="modules.html" accesskey="U">Importing Modules</a> »</li> <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">importlib</code> — The implementation of <code class="xref std std-keyword docutils literal notranslate">import</code></a></li> <li class="right"> <div class="inline-search" role="search"> <form class="inline-search" action="../search.html" method="get"> <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" /> <input type="submit" value="Go" /> </form> </div> | </li> <li class="right"> <label class="theme-selector-label"> Theme <select class="theme-selector" oninput="activateTheme(this.value)"> <option value="auto" selected>Auto</option> <option value="light">Light</option> <option value="dark">Dark</option> </select> </label> |</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <section id="module-importlib"> <h1><code class="xref py py-mod docutils literal notranslate">importlib</code> — The implementation of <code class="xref std std-keyword docutils literal notranslate">import</code><a class="headerlink" href="#module-importlib" title="Link to this heading">¶</a></h1> <div class="versionadded"> Added in version 3.1. </div> Source code: <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/3.13/Lib/importlib/__init__.py">Lib/importlib/__init__.py</a> <hr class="docutils" /> <section id="introduction"> <h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h2> The purpose of the <a class="reference internal" href="#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate">importlib</code></a> package is three-fold. One is to provide the implementation of the <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> statement (and thus, by extension, the <a class="reference internal" href="functions.html#import__" title="__import__"><code class="xref py py-func docutils literal notranslate">__import__()</code></a> function) in Python source code. This provides an implementation of <code class="xref std std-keyword docutils literal notranslate">import</code> which is portable to any Python interpreter. This also provides an implementation which is easier to comprehend than one implemented in a programming language other than Python. Two, the components to implement <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> are exposed in this package, making it easier for users to create their own custom objects (known generically as an <a class="reference internal" href="../glossary.html#term-importer">importer</a>) to participate in the import process. Three, the package contains modules exposing additional functionality for managing aspects of Python packages: <ul class="simple"> <li><a class="reference internal" href="importlib.metadata.html#module-importlib.metadata" title="importlib.metadata: Accessing package metadata"><code class="xref py py-mod docutils literal notranslate">importlib.metadata</code></a> presents access to metadata from third-party distributions.</li> <li><a class="reference internal" href="importlib.resources.html#module-importlib.resources" title="importlib.resources: Package resource reading, opening, and access"><code class="xref py py-mod docutils literal notranslate">importlib.resources</code></a> provides routines for accessing non-code “resources” from Python packages.</li> </ul> <div class="admonition seealso"> See also <dl class="simple"> <dt><a class="reference internal" href="../reference/simple_stmts.html#import">The import statement</a></dt><dd>The language reference for the <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> statement. </dd> <dt><a class="reference external" href="https://www.python.org/doc/essays/packages/">Packages specification</a></dt><dd>Original specification of packages. Some semantics have changed since the writing of this document (e.g. redirecting based on <code class="docutils literal notranslate">None</code> in <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a>). </dd> <dt>The <a class="reference internal" href="#importlib.__import__" title="importlib.__import__"><code class="xref py py-func docutils literal notranslate">__import__()</code></a> function</dt><dd>The <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> statement is syntactic sugar for this function. </dd> <dt><a class="reference internal" href="sys_path_init.html#sys-path-init">The initialization of the sys.path module search path</a></dt><dd>The initialization of <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a>. </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0235/">PEP 235</a></dt><dd>Import on Case-Insensitive Platforms </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0263/">PEP 263</a></dt><dd>Defining Python Source Code Encodings </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0302/">PEP 302</a></dt><dd>New Import Hooks </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0328/">PEP 328</a></dt><dd>Imports: Multi-Line and Absolute/Relative </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0366/">PEP 366</a></dt><dd>Main module explicit relative imports </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0420/">PEP 420</a></dt><dd>Implicit namespace packages </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0451/">PEP 451</a></dt><dd>A ModuleSpec Type for the Import System </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0488/">PEP 488</a></dt><dd>Elimination of PYO files </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0489/">PEP 489</a></dt><dd>Multi-phase extension module initialization </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-0552/">PEP 552</a></dt><dd>Deterministic pycs </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-3120/">PEP 3120</a></dt><dd>Using UTF-8 as the Default Source Encoding </dd> <dt><a class="pep reference external" href="https://peps.python.org/pep-3147/">PEP 3147</a></dt><dd>PYC Repository Directories </dd> </dl> </div> </section> <section id="functions"> <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading">¶</a></h2> <dl class="py function"> <dt class="sig sig-object py" id="importlib.__import__"> importlib.__import__(name, globals=None, locals=None, fromlist=(), level=0)<a class="headerlink" href="#importlib.__import__" title="Link to this definition">¶</a></dt> <dd>An implementation of the built-in <a class="reference internal" href="functions.html#import__" title="__import__"><code class="xref py py-func docutils literal notranslate">__import__()</code></a> function. <div class="admonition note"> Note Programmatic importing of modules should use <a class="reference internal" href="#importlib.import_module" title="importlib.import_module"><code class="xref py py-func docutils literal notranslate">import_module()</code></a> instead of this function. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.import_module"> importlib.import_module(name, package=None)<a class="headerlink" href="#importlib.import_module" title="Link to this definition">¶</a></dt> <dd>Import a module. The name argument specifies what module to import in absolute or relative terms (e.g. either <code class="docutils literal notranslate">pkg.mod</code> or <code class="docutils literal notranslate">..mod</code>). If the name is 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 package name (e.g. <code class="docutils literal notranslate">import_module('..mod', 'pkg.subpkg')</code> will import <code class="docutils literal notranslate">pkg.mod</code>). The <a class="reference internal" href="#importlib.import_module" title="importlib.import_module"><code class="xref py py-func docutils literal notranslate">import_module()</code></a> function acts as a simplifying wrapper around <a class="reference internal" href="#importlib.__import__" title="importlib.__import__"><code class="xref py py-func docutils literal notranslate">importlib.__import__()</code></a>. This means all semantics of the function are derived from <a class="reference internal" href="#importlib.__import__" title="importlib.__import__"><code class="xref py py-func docutils literal notranslate">importlib.__import__()</code></a>. The most important difference between these two functions is that <a class="reference internal" href="#importlib.import_module" title="importlib.import_module"><code class="xref py py-func docutils literal notranslate">import_module()</code></a> returns the specified package or module (e.g. <code class="docutils literal notranslate">pkg.mod</code>), while <a class="reference internal" href="functions.html#import__" title="__import__"><code class="xref py py-func docutils literal notranslate">__import__()</code></a> returns the top-level package or module (e.g. <code class="docutils literal notranslate">pkg</code>). If you are dynamically importing a module that was created since the interpreter began execution (e.g., created a Python source file), you may need to call <a class="reference internal" href="#importlib.invalidate_caches" title="importlib.invalidate_caches"><code class="xref py py-func docutils literal notranslate">invalidate_caches()</code></a> in order for the new module to be noticed by the import system. <div class="versionchanged"> Changed in version 3.3: Parent packages are automatically imported. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.invalidate_caches"> importlib.invalidate_caches()<a class="headerlink" href="#importlib.invalidate_caches" title="Link to this definition">¶</a></dt> <dd>Invalidate the internal caches of finders stored at <a class="reference internal" href="sys.html#sys.meta_path" title="sys.meta_path"><code class="xref py py-data docutils literal notranslate">sys.meta_path</code></a>. If a finder implements <code class="docutils literal notranslate">invalidate_caches()</code> then it will be called to perform the invalidation. This function should be called if any modules are created/installed while your program is running to guarantee all finders will notice the new module’s existence. <div class="versionadded"> Added in version 3.3. </div> <div class="versionchanged"> Changed in version 3.10: Namespace packages created/installed in a different <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> location after the same namespace was already imported are noticed. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.reload"> importlib.reload(module)<a class="headerlink" href="#importlib.reload" title="Link to this definition">¶</a></dt> <dd>Reload a previously imported module. The argument must be a module object, so it must have been successfully imported before. This is useful if you have edited the module source file using an external editor and want to try out the new version without leaving the Python interpreter. The return value is the module object (which can be different if re-importing causes a different object to be placed in <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a>). When <a class="reference internal" href="#importlib.reload" title="importlib.reload"><code class="xref py py-func docutils literal notranslate">reload()</code></a> is executed: <ul class="simple"> <li>Python module’s code is recompiled and the module-level code re-executed, defining a new set of objects which are bound to names in the module’s dictionary by reusing the <a class="reference internal" href="../glossary.html#term-loader">loader</a> which originally loaded the module. The <code class="docutils literal notranslate">init</code> function of extension modules is not called a second time.</li> <li>As with all other objects in Python the old objects are only reclaimed after their reference counts drop to zero.</li> <li>The names in the module namespace are updated to point to any new or changed objects.</li> <li>Other references to the old objects (such as names external to the module) are not rebound to refer to the new objects and must be updated in each namespace where they occur if that is desired.</li> </ul> There are a number of other caveats: When a module is reloaded, its dictionary (containing the module’s global variables) is retained. Redefinitions of names will override the old definitions, so this is generally not a problem. If the new version of a module does not define a name that was defined by the old version, the old definition remains. This feature can be used to the module’s advantage if it maintains a global table or cache of objects — with a <a class="reference internal" href="../reference/compound_stmts.html#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a> statement it can test for the table’s presence and skip its initialization if desired: <div class="highlight-python3 notranslate"><div class="highlight"><pre>try: cache except NameError: cache = {} </pre></div> </div> It is generally not very useful to reload built-in or dynamically loaded modules. Reloading <a class="reference internal" href="sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate">sys</code></a>, <a class="reference internal" href="__main__.html#module-__main__" title="__main__: The environment where top-level code is run. Covers command-line interfaces, import-time behavior, and ``__name__ == '__main__'``."><code class="xref py py-mod docutils literal notranslate">__main__</code></a>, <a class="reference internal" href="builtins.html#module-builtins" title="builtins: The module that provides the built-in namespace."><code class="xref py py-mod docutils literal notranslate">builtins</code></a> and other key modules is not recommended. In many cases extension modules are not designed to be initialized more than once, and may fail in arbitrary ways when reloaded. If a module imports objects from another module using <a class="reference internal" href="../reference/simple_stmts.html#from"><code class="xref std std-keyword docutils literal notranslate">from</code></a> … <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> …, calling <a class="reference internal" href="#importlib.reload" title="importlib.reload"><code class="xref py py-func docutils literal notranslate">reload()</code></a> for the other module does not redefine the objects imported from it — one way around this is to re-execute the <code class="xref std std-keyword docutils literal notranslate">from</code> statement, another is to use <code class="xref std std-keyword docutils literal notranslate">import</code> and qualified names (module.name) instead. If a module instantiates instances of a class, reloading the module that defines the class does not affect the method definitions of the instances — they continue to use the old class definition. The same is true for derived classes. <div class="versionadded"> Added in version 3.4. </div> <div class="versionchanged"> Changed in version 3.7: <a class="reference internal" href="exceptions.html#ModuleNotFoundError" title="ModuleNotFoundError"><code class="xref py py-exc docutils literal notranslate">ModuleNotFoundError</code></a> is raised when the module being reloaded lacks a <a class="reference internal" href="#importlib.machinery.ModuleSpec" title="importlib.machinery.ModuleSpec"><code class="xref py py-class docutils literal notranslate">ModuleSpec</code></a>. </div> </dd></dl> </section> <section id="module-importlib.abc"> <h2><a class="reference internal" href="#module-importlib.abc" title="importlib.abc: Abstract base classes related to import"><code class="xref py py-mod docutils literal notranslate">importlib.abc</code></a> – Abstract base classes related to import<a class="headerlink" href="#module-importlib.abc" title="Link to this heading">¶</a></h2> Source code: <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/3.13/Lib/importlib/abc.py">Lib/importlib/abc.py</a> <hr class="docutils" /> The <a class="reference internal" href="#module-importlib.abc" title="importlib.abc: Abstract base classes related to import"><code class="xref py py-mod docutils literal notranslate">importlib.abc</code></a> module contains all of the core abstract base classes used by <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a>. Some subclasses of the core abstract base classes are also provided to help in implementing the core ABCs. ABC hierarchy: <div class="highlight-python3 notranslate"><div class="highlight"><pre>object +-- MetaPathFinder +-- PathEntryFinder +-- Loader +-- ResourceLoader --------+ +-- InspectLoader | +-- ExecutionLoader --+ +-- FileLoader +-- SourceLoader </pre></div> </div> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.MetaPathFinder"> class importlib.abc.MetaPathFinder<a class="headerlink" href="#importlib.abc.MetaPathFinder" title="Link to this definition">¶</a></dt> <dd>An abstract base class representing a <a class="reference internal" href="../glossary.html#term-meta-path-finder">meta path finder</a>. <div class="versionadded"> Added in version 3.3. </div> <div class="versionchanged"> Changed in version 3.10: No longer a subclass of <code class="xref py py-class docutils literal notranslate">Finder</code>. </div> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.MetaPathFinder.find_spec"> find_spec(fullname, path, target=None)<a class="headerlink" href="#importlib.abc.MetaPathFinder.find_spec" title="Link to this definition">¶</a></dt> <dd>An abstract method for finding a <a class="reference internal" href="../glossary.html#term-module-spec">spec</a> for the specified module. If this is a top-level import, path will be <code class="docutils literal notranslate">None</code>. Otherwise, this is a search for a subpackage or module and path will be the value of <a class="reference internal" href="../reference/datamodel.html#module.__path__" title="module.__path__"><code class="xref py py-attr docutils literal notranslate">__path__</code></a> from the parent package. If a spec cannot be found, <code class="docutils literal notranslate">None</code> is returned. When passed in, <code class="docutils literal notranslate">target</code> is a module object that the finder may use to make a more educated guess about what spec to return. <a class="reference internal" href="#importlib.util.spec_from_loader" title="importlib.util.spec_from_loader"><code class="xref py py-func docutils literal notranslate">importlib.util.spec_from_loader()</code></a> may be useful for implementing concrete <code class="docutils literal notranslate">MetaPathFinders</code>. <div class="versionadded"> Added in version 3.4. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.MetaPathFinder.invalidate_caches"> invalidate_caches()<a class="headerlink" href="#importlib.abc.MetaPathFinder.invalidate_caches" title="Link to this definition">¶</a></dt> <dd>An optional method which, when called, should invalidate any internal cache used by the finder. Used by <a class="reference internal" href="#importlib.invalidate_caches" title="importlib.invalidate_caches"><code class="xref py py-func docutils literal notranslate">importlib.invalidate_caches()</code></a> when invalidating the caches of all finders on <a class="reference internal" href="sys.html#sys.meta_path" title="sys.meta_path"><code class="xref py py-data docutils literal notranslate">sys.meta_path</code></a>. <div class="versionchanged"> Changed in version 3.4: Returns <code class="docutils literal notranslate">None</code> when called instead of <a class="reference internal" href="constants.html#NotImplemented" title="NotImplemented"><code class="xref py py-data docutils literal notranslate">NotImplemented</code></a>. </div> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.PathEntryFinder"> class importlib.abc.PathEntryFinder<a class="headerlink" href="#importlib.abc.PathEntryFinder" title="Link to this definition">¶</a></dt> <dd>An abstract base class representing a <a class="reference internal" href="../glossary.html#term-path-entry-finder">path entry finder</a>. Though it bears some similarities to <a class="reference internal" href="#importlib.abc.MetaPathFinder" title="importlib.abc.MetaPathFinder"><code class="xref py py-class docutils literal notranslate">MetaPathFinder</code></a>, <code class="docutils literal notranslate">PathEntryFinder</code> is meant for use only within the path-based import subsystem provided by <a class="reference internal" href="#importlib.machinery.PathFinder" title="importlib.machinery.PathFinder"><code class="xref py py-class docutils literal notranslate">importlib.machinery.PathFinder</code></a>. <div class="versionadded"> Added in version 3.3. </div> <div class="versionchanged"> Changed in version 3.10: No longer a subclass of <code class="xref py py-class docutils literal notranslate">Finder</code>. </div> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.PathEntryFinder.find_spec"> find_spec(fullname, target=None)<a class="headerlink" href="#importlib.abc.PathEntryFinder.find_spec" title="Link to this definition">¶</a></dt> <dd>An abstract method for finding a <a class="reference internal" href="../glossary.html#term-module-spec">spec</a> for the specified module. The finder will search for the module only within the <a class="reference internal" href="../glossary.html#term-path-entry">path entry</a> to which it is assigned. If a spec cannot be found, <code class="docutils literal notranslate">None</code> is returned. When passed in, <code class="docutils literal notranslate">target</code> is a module object that the finder may use to make a more educated guess about what spec to return. <a class="reference internal" href="#importlib.util.spec_from_loader" title="importlib.util.spec_from_loader"><code class="xref py py-func docutils literal notranslate">importlib.util.spec_from_loader()</code></a> may be useful for implementing concrete <code class="docutils literal notranslate">PathEntryFinders</code>. <div class="versionadded"> Added in version 3.4. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.PathEntryFinder.invalidate_caches"> invalidate_caches()<a class="headerlink" href="#importlib.abc.PathEntryFinder.invalidate_caches" title="Link to this definition">¶</a></dt> <dd>An optional method which, when called, should invalidate any internal cache used by the finder. Used by <a class="reference internal" href="#importlib.machinery.PathFinder.invalidate_caches" title="importlib.machinery.PathFinder.invalidate_caches"><code class="xref py py-meth docutils literal notranslate">importlib.machinery.PathFinder.invalidate_caches()</code></a> when invalidating the caches of all cached finders. </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.Loader"> class importlib.abc.Loader<a class="headerlink" href="#importlib.abc.Loader" title="Link to this definition">¶</a></dt> <dd>An abstract base class for a <a class="reference internal" href="../glossary.html#term-loader">loader</a>. See <a class="pep reference external" href="https://peps.python.org/pep-0302/">PEP 302</a> for the exact definition for a loader. Loaders that wish to support resource reading should implement a <code class="xref py py-meth docutils literal notranslate">get_resource_reader()</code> method as specified by <a class="reference internal" href="importlib.resources.abc.html#importlib.resources.abc.ResourceReader" title="importlib.resources.abc.ResourceReader"><code class="xref py py-class docutils literal notranslate">importlib.resources.abc.ResourceReader</code></a>. <div class="versionchanged"> Changed in version 3.7: Introduced the optional <code class="xref py py-meth docutils literal notranslate">get_resource_reader()</code> method. </div> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Loader.create_module"> create_module(spec)<a class="headerlink" href="#importlib.abc.Loader.create_module" title="Link to this definition">¶</a></dt> <dd>A method that returns the module object to use when importing a module. This method may return <code class="docutils literal notranslate">None</code>, indicating that default module creation semantics should take place. <div class="versionadded"> Added in version 3.4. </div> <div class="versionchanged"> Changed in version 3.6: This method is no longer optional when <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">exec_module()</code></a> is defined. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Loader.exec_module"> exec_module(module)<a class="headerlink" href="#importlib.abc.Loader.exec_module" title="Link to this definition">¶</a></dt> <dd>An abstract method that executes the module in its own namespace when a module is imported or reloaded. The module should already be initialized when <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">exec_module()</code></a> is called. When this method exists, <a class="reference internal" href="#importlib.abc.Loader.create_module" title="importlib.abc.Loader.create_module"><code class="xref py py-meth docutils literal notranslate">create_module()</code></a> must be defined. <div class="versionadded"> Added in version 3.4. </div> <div class="versionchanged"> Changed in version 3.6: <a class="reference internal" href="#importlib.abc.Loader.create_module" title="importlib.abc.Loader.create_module"><code class="xref py py-meth docutils literal notranslate">create_module()</code></a> must also be defined. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Loader.load_module"> load_module(fullname)<a class="headerlink" href="#importlib.abc.Loader.load_module" title="Link to this definition">¶</a></dt> <dd>A legacy method for loading a module. If the module cannot be loaded, <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> is raised, otherwise the loaded module is returned. If the requested module already exists in <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a>, that module should be used and reloaded. Otherwise the loader should create a new module and insert it into <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a> before any loading begins, to prevent recursion from the import. If the loader inserted a module and the load fails, it must be removed by the loader from <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a>; modules already in <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a> before the loader began execution should be left alone. The loader should set several attributes on the module (note that some of these attributes can change when a module is reloaded): <ul class="simple"> <li><a class="reference internal" href="../reference/datamodel.html#module.__name__" title="module.__name__"><code class="xref py py-attr docutils literal notranslate">module.__name__</code></a></li> <li><a class="reference internal" href="../reference/datamodel.html#module.__file__" title="module.__file__"><code class="xref py py-attr docutils literal notranslate">module.__file__</code></a></li> <li><a class="reference internal" href="../reference/datamodel.html#module.__cached__" title="module.__cached__"><code class="xref py py-attr docutils literal notranslate">module.__cached__</code></a> (deprecated)</li> <li><a class="reference internal" href="../reference/datamodel.html#module.__path__" title="module.__path__"><code class="xref py py-attr docutils literal notranslate">module.__path__</code></a></li> <li><a class="reference internal" href="../reference/datamodel.html#module.__package__" title="module.__package__"><code class="xref py py-attr docutils literal notranslate">module.__package__</code></a> (deprecated)</li> <li><a class="reference internal" href="../reference/datamodel.html#module.__loader__" title="module.__loader__"><code class="xref py py-attr docutils literal notranslate">module.__loader__</code></a> (deprecated)</li> </ul> When <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">exec_module()</code></a> is available then backwards-compatible functionality is provided. <div class="versionchanged"> Changed in version 3.4: Raise <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> when called instead of <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>. Functionality provided when <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">exec_module()</code></a> is available. </div> <div class="deprecated"> Deprecated since version 3.4: The recommended API for loading a module is <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">exec_module()</code></a> (and <a class="reference internal" href="#importlib.abc.Loader.create_module" title="importlib.abc.Loader.create_module"><code class="xref py py-meth docutils literal notranslate">create_module()</code></a>). Loaders should implement it instead of <a class="reference internal" href="#importlib.abc.Loader.load_module" title="importlib.abc.Loader.load_module"><code class="xref py py-meth docutils literal notranslate">load_module()</code></a>. The import machinery takes care of all the other responsibilities of <a class="reference internal" href="#importlib.abc.Loader.load_module" title="importlib.abc.Loader.load_module"><code class="xref py py-meth docutils literal notranslate">load_module()</code></a> when <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">exec_module()</code></a> is implemented. </div> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.ResourceLoader"> class importlib.abc.ResourceLoader<a class="headerlink" href="#importlib.abc.ResourceLoader" title="Link to this definition">¶</a></dt> <dd>An abstract base class for a <a class="reference internal" href="../glossary.html#term-loader">loader</a> which implements the optional <a class="pep reference external" href="https://peps.python.org/pep-0302/">PEP 302</a> protocol for loading arbitrary resources from the storage back-end. <div class="deprecated"> Deprecated since version 3.7: This ABC is deprecated in favour of supporting resource loading through <a class="reference internal" href="importlib.resources.abc.html#importlib.resources.abc.ResourceReader" title="importlib.resources.abc.ResourceReader"><code class="xref py py-class docutils literal notranslate">importlib.resources.abc.ResourceReader</code></a>. </div> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.ResourceLoader.get_data"> abstractmethod get_data(path)<a class="headerlink" href="#importlib.abc.ResourceLoader.get_data" title="Link to this definition">¶</a></dt> <dd>An abstract method to return the bytes for the data located at path. Loaders that have a file-like storage back-end that allows storing arbitrary data can implement this abstract method to give direct access to the data stored. <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> is to be raised if the path cannot be found. The path is expected to be constructed using a module’s <a class="reference internal" href="../reference/datamodel.html#module.__file__" title="module.__file__"><code class="xref py py-attr docutils literal notranslate">__file__</code></a> attribute or an item from a package’s <a class="reference internal" href="../reference/datamodel.html#module.__path__" title="module.__path__"><code class="xref py py-attr docutils literal notranslate">__path__</code></a>. <div class="versionchanged"> Changed in version 3.4: Raises <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> instead of <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>. </div> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.InspectLoader"> class importlib.abc.InspectLoader<a class="headerlink" href="#importlib.abc.InspectLoader" title="Link to this definition">¶</a></dt> <dd>An abstract base class for a <a class="reference internal" href="../glossary.html#term-loader">loader</a> which implements the optional <a class="pep reference external" href="https://peps.python.org/pep-0302/">PEP 302</a> protocol for loaders that inspect modules. <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.InspectLoader.get_code"> get_code(fullname)<a class="headerlink" href="#importlib.abc.InspectLoader.get_code" title="Link to this definition">¶</a></dt> <dd>Return the code object for a module, or <code class="docutils literal notranslate">None</code> if the module does not have a code object (as would be the case, for example, for a built-in module). Raise an <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> if loader cannot find the requested module. <div class="admonition note"> Note While the method has a default implementation, it is suggested that it be overridden if possible for performance. </div> <div class="versionchanged" id="index-15"> Changed in version 3.4: No longer abstract and a concrete implementation is provided. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.InspectLoader.get_source"> abstractmethod get_source(fullname)<a class="headerlink" href="#importlib.abc.InspectLoader.get_source" title="Link to this definition">¶</a></dt> <dd>An abstract method to return the source of a module. It is returned as a text string using <a class="reference internal" href="../glossary.html#term-universal-newlines">universal newlines</a>, translating all recognized line separators into <code class="docutils literal notranslate">'\n'</code> characters. Returns <code class="docutils literal notranslate">None</code> if no source is available (e.g. a built-in module). Raises <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> if the loader cannot find the module specified. <div class="versionchanged"> Changed in version 3.4: Raises <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> instead of <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.InspectLoader.is_package"> is_package(fullname)<a class="headerlink" href="#importlib.abc.InspectLoader.is_package" title="Link to this definition">¶</a></dt> <dd>An optional method to return a true value if the module is a package, a false value otherwise. <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> is raised if the <a class="reference internal" href="../glossary.html#term-loader">loader</a> cannot find the module. <div class="versionchanged"> Changed in version 3.4: Raises <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> instead of <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.InspectLoader.source_to_code"> static source_to_code(data, path='<string>')<a class="headerlink" href="#importlib.abc.InspectLoader.source_to_code" title="Link to this definition">¶</a></dt> <dd>Create a code object from Python source. The data argument can be whatever the <a class="reference internal" href="functions.html#compile" title="compile"><code class="xref py py-func docutils literal notranslate">compile()</code></a> function supports (i.e. string or bytes). The path argument should be the “path” to where the source code originated from, which can be an abstract concept (e.g. location in a zip file). With the subsequent code object one can execute it in a module by running <code class="docutils literal notranslate">exec(code, module.__dict__)</code>. <div class="versionadded"> Added in version 3.4. </div> <div class="versionchanged"> Changed in version 3.5: Made the method static. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.InspectLoader.exec_module"> exec_module(module)<a class="headerlink" href="#importlib.abc.InspectLoader.exec_module" title="Link to this definition">¶</a></dt> <dd>Implementation of <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">Loader.exec_module()</code></a>. <div class="versionadded"> Added in version 3.4. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.InspectLoader.load_module"> load_module(fullname)<a class="headerlink" href="#importlib.abc.InspectLoader.load_module" title="Link to this definition">¶</a></dt> <dd>Implementation of <a class="reference internal" href="#importlib.abc.Loader.load_module" title="importlib.abc.Loader.load_module"><code class="xref py py-meth docutils literal notranslate">Loader.load_module()</code></a>. <div class="deprecated"> Deprecated since version 3.4: use <a class="reference internal" href="#importlib.abc.InspectLoader.exec_module" title="importlib.abc.InspectLoader.exec_module"><code class="xref py py-meth docutils literal notranslate">exec_module()</code></a> instead. </div> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.ExecutionLoader"> class importlib.abc.ExecutionLoader<a class="headerlink" href="#importlib.abc.ExecutionLoader" title="Link to this definition">¶</a></dt> <dd>An abstract base class which inherits from <a class="reference internal" href="#importlib.abc.InspectLoader" title="importlib.abc.InspectLoader"><code class="xref py py-class docutils literal notranslate">InspectLoader</code></a> that, when implemented, helps a module to be executed as a script. The ABC represents an optional <a class="pep reference external" href="https://peps.python.org/pep-0302/">PEP 302</a> protocol. <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.ExecutionLoader.get_filename"> abstractmethod get_filename(fullname)<a class="headerlink" href="#importlib.abc.ExecutionLoader.get_filename" title="Link to this definition">¶</a></dt> <dd>An abstract method that is to return the value of <a class="reference internal" href="../reference/datamodel.html#module.__file__" title="module.__file__"><code class="xref py py-attr docutils literal notranslate">__file__</code></a> for the specified module. If no path is available, <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> is raised. 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. <div class="versionchanged"> Changed in version 3.4: Raises <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> instead of <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>. </div> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.FileLoader"> class importlib.abc.FileLoader(fullname, path)<a class="headerlink" href="#importlib.abc.FileLoader" title="Link to this definition">¶</a></dt> <dd>An abstract base class which inherits from <a class="reference internal" href="#importlib.abc.ResourceLoader" title="importlib.abc.ResourceLoader"><code class="xref py py-class docutils literal notranslate">ResourceLoader</code></a> and <a class="reference internal" href="#importlib.abc.ExecutionLoader" title="importlib.abc.ExecutionLoader"><code class="xref py py-class docutils literal notranslate">ExecutionLoader</code></a>, providing concrete implementations of <a class="reference internal" href="#importlib.abc.ResourceLoader.get_data" title="importlib.abc.ResourceLoader.get_data"><code class="xref py py-meth docutils literal notranslate">ResourceLoader.get_data()</code></a> and <a class="reference internal" href="#importlib.abc.ExecutionLoader.get_filename" title="importlib.abc.ExecutionLoader.get_filename"><code class="xref py py-meth docutils literal notranslate">ExecutionLoader.get_filename()</code></a>. The fullname argument is a fully resolved name of the module the loader is to handle. The path argument is the path to the file for the module. <div class="versionadded"> Added in version 3.3. </div> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.abc.FileLoader.name"> name<a class="headerlink" href="#importlib.abc.FileLoader.name" title="Link to this definition">¶</a></dt> <dd>The name of the module the loader can handle. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.abc.FileLoader.path"> path<a class="headerlink" href="#importlib.abc.FileLoader.path" title="Link to this definition">¶</a></dt> <dd>Path to the file of the module. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.FileLoader.load_module"> load_module(fullname)<a class="headerlink" href="#importlib.abc.FileLoader.load_module" title="Link to this definition">¶</a></dt> <dd>Calls super’s <code class="docutils literal notranslate">load_module()</code>. <div class="deprecated"> Deprecated since version 3.4: Use <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">Loader.exec_module()</code></a> instead. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.FileLoader.get_filename"> abstractmethod get_filename(fullname)<a class="headerlink" href="#importlib.abc.FileLoader.get_filename" title="Link to this definition">¶</a></dt> <dd>Returns <a class="reference internal" href="#importlib.abc.FileLoader.path" title="importlib.abc.FileLoader.path"><code class="xref py py-attr docutils literal notranslate">path</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.FileLoader.get_data"> abstractmethod get_data(path)<a class="headerlink" href="#importlib.abc.FileLoader.get_data" title="Link to this definition">¶</a></dt> <dd>Reads path as a binary file and returns the bytes from it. </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.SourceLoader"> class importlib.abc.SourceLoader<a class="headerlink" href="#importlib.abc.SourceLoader" title="Link to this definition">¶</a></dt> <dd>An abstract base class for implementing source (and optionally bytecode) file loading. The class inherits from both <a class="reference internal" href="#importlib.abc.ResourceLoader" title="importlib.abc.ResourceLoader"><code class="xref py py-class docutils literal notranslate">ResourceLoader</code></a> and <a class="reference internal" href="#importlib.abc.ExecutionLoader" title="importlib.abc.ExecutionLoader"><code class="xref py py-class docutils literal notranslate">ExecutionLoader</code></a>, requiring the implementation of: <ul class="simple"> <li><a class="reference internal" href="#importlib.abc.ResourceLoader.get_data" title="importlib.abc.ResourceLoader.get_data"><code class="xref py py-meth docutils literal notranslate">ResourceLoader.get_data()</code></a></li> <li><dl class="simple"> <dt><a class="reference internal" href="#importlib.abc.ExecutionLoader.get_filename" title="importlib.abc.ExecutionLoader.get_filename"><code class="xref py py-meth docutils literal notranslate">ExecutionLoader.get_filename()</code></a></dt><dd>Should only return the path to the source file; sourceless loading is not supported. </dd> </dl> </li> </ul> The abstract methods defined by this class are to add optional bytecode file support. Not implementing these optional methods (or causing them to raise <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>) 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. <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.SourceLoader.path_stats"> path_stats(path)<a class="headerlink" href="#importlib.abc.SourceLoader.path_stats" title="Link to this definition">¶</a></dt> <dd>Optional abstract method which returns a <a class="reference internal" href="stdtypes.html#dict" title="dict"><code class="xref py py-class docutils literal notranslate">dict</code></a> containing metadata about the specified path. Supported dictionary keys are: <ul class="simple"> <li><code class="docutils literal notranslate">'mtime'</code> (mandatory): an integer or floating-point number representing the modification time of the source code;</li> <li><code class="docutils literal notranslate">'size'</code> (optional): the size in bytes of the source code.</li> </ul> Any other keys in the dictionary are ignored, to allow for future extensions. If the path cannot be handled, <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> is raised. <div class="versionadded"> Added in version 3.3. </div> <div class="versionchanged"> Changed in version 3.4: Raise <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> instead of <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.SourceLoader.path_mtime"> path_mtime(path)<a class="headerlink" href="#importlib.abc.SourceLoader.path_mtime" title="Link to this definition">¶</a></dt> <dd>Optional abstract method which returns the modification time for the specified path. <div class="deprecated"> Deprecated since version 3.3: This method is deprecated in favour of <a class="reference internal" href="#importlib.abc.SourceLoader.path_stats" title="importlib.abc.SourceLoader.path_stats"><code class="xref py py-meth docutils literal notranslate">path_stats()</code></a>. You don’t have to implement it, but it is still available for compatibility purposes. Raise <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> if the path cannot be handled. </div> <div class="versionchanged"> Changed in version 3.4: Raise <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate">OSError</code></a> instead of <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a>. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.SourceLoader.set_data"> set_data(path, data)<a class="headerlink" href="#importlib.abc.SourceLoader.set_data" title="Link to this definition">¶</a></dt> <dd>Optional abstract method which writes the specified bytes to a file 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 (<a class="reference internal" href="errno.html#errno.EACCES" title="errno.EACCES"><code class="xref py py-const docutils literal notranslate">errno.EACCES</code></a>/<a class="reference internal" href="exceptions.html#PermissionError" title="PermissionError"><code class="xref py py-exc docutils literal notranslate">PermissionError</code></a>), do not propagate the exception. <div class="versionchanged"> Changed in version 3.4: No longer raises <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a> when called. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.SourceLoader.get_code"> get_code(fullname)<a class="headerlink" href="#importlib.abc.SourceLoader.get_code" title="Link to this definition">¶</a></dt> <dd>Concrete implementation of <a class="reference internal" href="#importlib.abc.InspectLoader.get_code" title="importlib.abc.InspectLoader.get_code"><code class="xref py py-meth docutils literal notranslate">InspectLoader.get_code()</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.SourceLoader.exec_module"> exec_module(module)<a class="headerlink" href="#importlib.abc.SourceLoader.exec_module" title="Link to this definition">¶</a></dt> <dd>Concrete implementation of <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">Loader.exec_module()</code></a>. <div class="versionadded"> Added in version 3.4. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.SourceLoader.load_module"> load_module(fullname)<a class="headerlink" href="#importlib.abc.SourceLoader.load_module" title="Link to this definition">¶</a></dt> <dd>Concrete implementation of <a class="reference internal" href="#importlib.abc.Loader.load_module" title="importlib.abc.Loader.load_module"><code class="xref py py-meth docutils literal notranslate">Loader.load_module()</code></a>. <div class="deprecated"> Deprecated since version 3.4: Use <a class="reference internal" href="#importlib.abc.SourceLoader.exec_module" title="importlib.abc.SourceLoader.exec_module"><code class="xref py py-meth docutils literal notranslate">exec_module()</code></a> instead. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.SourceLoader.get_source"> get_source(fullname)<a class="headerlink" href="#importlib.abc.SourceLoader.get_source" title="Link to this definition">¶</a></dt> <dd>Concrete implementation of <a class="reference internal" href="#importlib.abc.InspectLoader.get_source" title="importlib.abc.InspectLoader.get_source"><code class="xref py py-meth docutils literal notranslate">InspectLoader.get_source()</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.SourceLoader.is_package"> is_package(fullname)<a class="headerlink" href="#importlib.abc.SourceLoader.is_package" title="Link to this definition">¶</a></dt> <dd>Concrete implementation of <a class="reference internal" href="#importlib.abc.InspectLoader.is_package" title="importlib.abc.InspectLoader.is_package"><code class="xref py py-meth docutils literal notranslate">InspectLoader.is_package()</code></a>. A module is determined to be a package if its file path (as provided by <a class="reference internal" href="#importlib.abc.ExecutionLoader.get_filename" title="importlib.abc.ExecutionLoader.get_filename"><code class="xref py py-meth docutils literal notranslate">ExecutionLoader.get_filename()</code></a>) is a file named <code class="docutils literal notranslate">__init__</code> when the file extension is removed and the module name itself does not end in <code class="docutils literal notranslate">__init__</code>. </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.ResourceReader"> class importlib.abc.ResourceReader<a class="headerlink" href="#importlib.abc.ResourceReader" title="Link to this definition">¶</a></dt> <dd>Superseded by TraversableResources An <a class="reference internal" href="../glossary.html#term-abstract-base-class">abstract base class</a> to provide the ability to read resources. From the perspective of this ABC, a resource is a binary artifact that is shipped within a package. Typically this is something like a data file that lives next to the <code class="docutils literal notranslate">__init__.py</code> file of the package. The purpose of this class is to help abstract out the accessing of such data files so that it does not matter if the package and its data file(s) are stored e.g. in a zip file versus on the file system. For any of methods of this class, a resource argument is expected to be a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a> which represents conceptually just a file name. This means that no subdirectory paths should be included in the resource argument. This is because the location of the package the reader is for, acts as the “directory”. Hence the metaphor for directories and file names is packages and resources, respectively. This is also why instances of this class are expected to directly correlate to a specific package (instead of potentially representing multiple packages or a module). Loaders that wish to support resource reading are expected to provide a method called <code class="docutils literal notranslate">get_resource_reader(fullname)</code> which returns an object implementing this ABC’s interface. If the module specified by fullname is not a package, this method should return <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a>. An object compatible with this ABC should only be returned when the specified module is a package. <div class="versionadded"> Added in version 3.7. </div> <div class="deprecated-removed"> Deprecated since version 3.12, will be removed in version 3.14: Use <a class="reference internal" href="importlib.resources.abc.html#importlib.resources.abc.TraversableResources" title="importlib.resources.abc.TraversableResources"><code class="xref py py-class docutils literal notranslate">importlib.resources.abc.TraversableResources</code></a> instead. </div> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.ResourceReader.open_resource"> abstractmethod open_resource(resource)<a class="headerlink" href="#importlib.abc.ResourceReader.open_resource" title="Link to this definition">¶</a></dt> <dd>Returns an opened, <a class="reference internal" href="../glossary.html#term-file-like-object">file-like object</a> for binary reading of the resource. If the resource cannot be found, <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate">FileNotFoundError</code></a> is raised. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.ResourceReader.resource_path"> abstractmethod resource_path(resource)<a class="headerlink" href="#importlib.abc.ResourceReader.resource_path" title="Link to this definition">¶</a></dt> <dd>Returns the file system path to the resource. If the resource does not concretely exist on the file system, raise <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate">FileNotFoundError</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.ResourceReader.is_resource"> abstractmethod is_resource(name)<a class="headerlink" href="#importlib.abc.ResourceReader.is_resource" title="Link to this definition">¶</a></dt> <dd>Returns <code class="docutils literal notranslate">True</code> if the named name is considered a resource. <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate">FileNotFoundError</code></a> is raised if name does not exist. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.ResourceReader.contents"> abstractmethod contents()<a class="headerlink" href="#importlib.abc.ResourceReader.contents" title="Link to this definition">¶</a></dt> <dd>Returns an <a class="reference internal" href="../glossary.html#term-iterable">iterable</a> of strings over the contents of the package. Do note that it is not required that all names returned by the iterator be actual resources, e.g. it is acceptable to return names for which <a class="reference internal" href="#importlib.abc.ResourceReader.is_resource" title="importlib.abc.ResourceReader.is_resource"><code class="xref py py-meth docutils literal notranslate">is_resource()</code></a> would be false. Allowing non-resource names to be returned is to allow for situations where how a package and its resources are stored are known a priori and the non-resource names would be useful. For instance, returning subdirectory names is allowed so that when it is known that the package and resources are stored on the file system then those subdirectory names can be used directly. The abstract method returns an iterable of no items. </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.Traversable"> class importlib.abc.Traversable<a class="headerlink" href="#importlib.abc.Traversable" title="Link to this definition">¶</a></dt> <dd>An object with a subset of <a class="reference internal" href="pathlib.html#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal notranslate">pathlib.Path</code></a> methods suitable for traversing directories and opening files. For a representation of the object on the file-system, use <a class="reference internal" href="importlib.resources.html#importlib.resources.as_file" title="importlib.resources.as_file"><code class="xref py py-meth docutils literal notranslate">importlib.resources.as_file()</code></a>. <div class="versionadded"> Added in version 3.9. </div> <div class="deprecated-removed"> Deprecated since version 3.12, will be removed in version 3.14: Use <a class="reference internal" href="importlib.resources.abc.html#importlib.resources.abc.Traversable" title="importlib.resources.abc.Traversable"><code class="xref py py-class docutils literal notranslate">importlib.resources.abc.Traversable</code></a> instead. </div> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.abc.Traversable.name"> name<a class="headerlink" href="#importlib.abc.Traversable.name" title="Link to this definition">¶</a></dt> <dd>Abstract. The base name of this object without any parent references. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Traversable.iterdir"> abstractmethod iterdir()<a class="headerlink" href="#importlib.abc.Traversable.iterdir" title="Link to this definition">¶</a></dt> <dd>Yield <code class="docutils literal notranslate">Traversable</code> objects in <code class="docutils literal notranslate">self</code>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Traversable.is_dir"> abstractmethod is_dir()<a class="headerlink" href="#importlib.abc.Traversable.is_dir" title="Link to this definition">¶</a></dt> <dd>Return <code class="docutils literal notranslate">True</code> if <code class="docutils literal notranslate">self</code> is a directory. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Traversable.is_file"> abstractmethod is_file()<a class="headerlink" href="#importlib.abc.Traversable.is_file" title="Link to this definition">¶</a></dt> <dd>Return <code class="docutils literal notranslate">True</code> if <code class="docutils literal notranslate">self</code> is a file. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Traversable.joinpath"> abstractmethod joinpath(child)<a class="headerlink" href="#importlib.abc.Traversable.joinpath" title="Link to this definition">¶</a></dt> <dd>Return Traversable child in <code class="docutils literal notranslate">self</code>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Traversable.__truediv__"> abstractmethod __truediv__(child)<a class="headerlink" href="#importlib.abc.Traversable.__truediv__" title="Link to this definition">¶</a></dt> <dd>Return <code class="docutils literal notranslate">Traversable</code> child in <code class="docutils literal notranslate">self</code>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Traversable.open"> abstractmethod open(mode='r', *args, **kwargs)<a class="headerlink" href="#importlib.abc.Traversable.open" title="Link to this definition">¶</a></dt> <dd>mode may be ‘r’ or ‘rb’ to open as text or binary. Return a handle suitable for reading (same as <a class="reference internal" href="pathlib.html#pathlib.Path.open" title="pathlib.Path.open"><code class="xref py py-attr docutils literal notranslate">pathlib.Path.open</code></a>). When opening as text, accepts encoding parameters such as those accepted by <a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-attr docutils literal notranslate">io.TextIOWrapper</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Traversable.read_bytes"> read_bytes()<a class="headerlink" href="#importlib.abc.Traversable.read_bytes" title="Link to this definition">¶</a></dt> <dd>Read contents of <code class="docutils literal notranslate">self</code> as bytes. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.Traversable.read_text"> read_text(encoding=None)<a class="headerlink" href="#importlib.abc.Traversable.read_text" title="Link to this definition">¶</a></dt> <dd>Read contents of <code class="docutils literal notranslate">self</code> as text. </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.abc.TraversableResources"> class importlib.abc.TraversableResources<a class="headerlink" href="#importlib.abc.TraversableResources" title="Link to this definition">¶</a></dt> <dd>An abstract base class for resource readers capable of serving the <a class="reference internal" href="importlib.resources.html#importlib.resources.files" title="importlib.resources.files"><code class="xref py py-meth docutils literal notranslate">importlib.resources.files()</code></a> interface. Subclasses <a class="reference internal" href="importlib.resources.abc.html#importlib.resources.abc.ResourceReader" title="importlib.resources.abc.ResourceReader"><code class="xref py py-class docutils literal notranslate">importlib.resources.abc.ResourceReader</code></a> and provides concrete implementations of the <a class="reference internal" href="importlib.resources.abc.html#importlib.resources.abc.ResourceReader" title="importlib.resources.abc.ResourceReader"><code class="xref py py-class docutils literal notranslate">importlib.resources.abc.ResourceReader</code></a>’s abstract methods. Therefore, any loader supplying <a class="reference internal" href="#importlib.abc.TraversableResources" title="importlib.abc.TraversableResources"><code class="xref py py-class docutils literal notranslate">importlib.abc.TraversableResources</code></a> also supplies ResourceReader. Loaders that wish to support resource reading are expected to implement this interface. <div class="versionadded"> Added in version 3.9. </div> <div class="deprecated-removed"> Deprecated since version 3.12, will be removed in version 3.14: Use <a class="reference internal" href="importlib.resources.abc.html#importlib.resources.abc.TraversableResources" title="importlib.resources.abc.TraversableResources"><code class="xref py py-class docutils literal notranslate">importlib.resources.abc.TraversableResources</code></a> instead. </div> <dl class="py method"> <dt class="sig sig-object py" id="importlib.abc.TraversableResources.files"> abstractmethod files()<a class="headerlink" href="#importlib.abc.TraversableResources.files" title="Link to this definition">¶</a></dt> <dd>Returns a <a class="reference internal" href="importlib.resources.abc.html#importlib.resources.abc.Traversable" title="importlib.resources.abc.Traversable"><code class="xref py py-class docutils literal notranslate">importlib.resources.abc.Traversable</code></a> object for the loaded package. </dd></dl> </dd></dl> </section> <section id="module-importlib.machinery"> <h2><a class="reference internal" href="#module-importlib.machinery" title="importlib.machinery: Importers and path hooks"><code class="xref py py-mod docutils literal notranslate">importlib.machinery</code></a> – Importers and path hooks<a class="headerlink" href="#module-importlib.machinery" title="Link to this heading">¶</a></h2> Source code: <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/3.13/Lib/importlib/machinery.py">Lib/importlib/machinery.py</a> <hr class="docutils" /> This module contains the various objects that help <a class="reference internal" href="../reference/simple_stmts.html#import"><code class="xref std std-keyword docutils literal notranslate">import</code></a> find and load modules. <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.SOURCE_SUFFIXES"> importlib.machinery.SOURCE_SUFFIXES<a class="headerlink" href="#importlib.machinery.SOURCE_SUFFIXES" title="Link to this definition">¶</a></dt> <dd>A list of strings representing the recognized file suffixes for source modules. <div class="versionadded"> Added in version 3.3. </div> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.DEBUG_BYTECODE_SUFFIXES"> importlib.machinery.DEBUG_BYTECODE_SUFFIXES<a class="headerlink" href="#importlib.machinery.DEBUG_BYTECODE_SUFFIXES" title="Link to this definition">¶</a></dt> <dd>A list of strings representing the file suffixes for non-optimized bytecode modules. <div class="versionadded"> Added in version 3.3. </div> <div class="deprecated"> Deprecated since version 3.5: Use <a class="reference internal" href="#importlib.machinery.BYTECODE_SUFFIXES" title="importlib.machinery.BYTECODE_SUFFIXES"><code class="xref py py-attr docutils literal notranslate">BYTECODE_SUFFIXES</code></a> instead. </div> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES"> importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES<a class="headerlink" href="#importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES" title="Link to this definition">¶</a></dt> <dd>A list of strings representing the file suffixes for optimized bytecode modules. <div class="versionadded"> Added in version 3.3. </div> <div class="deprecated"> Deprecated since version 3.5: Use <a class="reference internal" href="#importlib.machinery.BYTECODE_SUFFIXES" title="importlib.machinery.BYTECODE_SUFFIXES"><code class="xref py py-attr docutils literal notranslate">BYTECODE_SUFFIXES</code></a> instead. </div> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.BYTECODE_SUFFIXES"> importlib.machinery.BYTECODE_SUFFIXES<a class="headerlink" href="#importlib.machinery.BYTECODE_SUFFIXES" title="Link to this definition">¶</a></dt> <dd>A list of strings representing the recognized file suffixes for bytecode modules (including the leading dot). <div class="versionadded"> Added in version 3.3. </div> <div class="versionchanged"> Changed in version 3.5: The value is no longer dependent on <code class="docutils literal notranslate">__debug__</code>. </div> </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.EXTENSION_SUFFIXES"> importlib.machinery.EXTENSION_SUFFIXES<a class="headerlink" href="#importlib.machinery.EXTENSION_SUFFIXES" title="Link to this definition">¶</a></dt> <dd>A list of strings representing the recognized file suffixes for extension modules. <div class="versionadded"> Added in version 3.3. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.machinery.all_suffixes"> importlib.machinery.all_suffixes()<a class="headerlink" href="#importlib.machinery.all_suffixes" title="Link to this definition">¶</a></dt> <dd>Returns a combined list of strings representing all file suffixes for modules recognized by the standard import machinery. This is a helper for code which simply needs to know if a filesystem path potentially refers to a module without needing any details on the kind of module (for example, <a class="reference internal" href="inspect.html#inspect.getmodulename" title="inspect.getmodulename"><code class="xref py py-func docutils literal notranslate">inspect.getmodulename()</code></a>). <div class="versionadded"> Added in version 3.3. </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.BuiltinImporter"> class importlib.machinery.BuiltinImporter<a class="headerlink" href="#importlib.machinery.BuiltinImporter" title="Link to this definition">¶</a></dt> <dd>An <a class="reference internal" href="../glossary.html#term-importer">importer</a> for built-in modules. All known built-in modules are listed in <a class="reference internal" href="sys.html#sys.builtin_module_names" title="sys.builtin_module_names"><code class="xref py py-data docutils literal notranslate">sys.builtin_module_names</code></a>. This class implements the <a class="reference internal" href="#importlib.abc.MetaPathFinder" title="importlib.abc.MetaPathFinder"><code class="xref py py-class docutils literal notranslate">importlib.abc.MetaPathFinder</code></a> and <a class="reference internal" href="#importlib.abc.InspectLoader" title="importlib.abc.InspectLoader"><code class="xref py py-class docutils literal notranslate">importlib.abc.InspectLoader</code></a> ABCs. Only class methods are defined by this class to alleviate the need for instantiation. <div class="versionchanged"> Changed in version 3.5: As part of <a class="pep reference external" href="https://peps.python.org/pep-0489/">PEP 489</a>, the builtin importer now implements <code class="xref py py-meth docutils literal notranslate">Loader.create_module()</code> and <code class="xref py py-meth docutils literal notranslate">Loader.exec_module()</code> </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.FrozenImporter"> class importlib.machinery.FrozenImporter<a class="headerlink" href="#importlib.machinery.FrozenImporter" title="Link to this definition">¶</a></dt> <dd>An <a class="reference internal" href="../glossary.html#term-importer">importer</a> for frozen modules. This class implements the <a class="reference internal" href="#importlib.abc.MetaPathFinder" title="importlib.abc.MetaPathFinder"><code class="xref py py-class docutils literal notranslate">importlib.abc.MetaPathFinder</code></a> and <a class="reference internal" href="#importlib.abc.InspectLoader" title="importlib.abc.InspectLoader"><code class="xref py py-class docutils literal notranslate">importlib.abc.InspectLoader</code></a> ABCs. Only class methods are defined by this class to alleviate the need for instantiation. <div class="versionchanged"> Changed in version 3.4: Gained <code class="xref py py-meth docutils literal notranslate">create_module()</code> and <code class="xref py py-meth docutils literal notranslate">exec_module()</code> methods. </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.WindowsRegistryFinder"> class importlib.machinery.WindowsRegistryFinder<a class="headerlink" href="#importlib.machinery.WindowsRegistryFinder" title="Link to this definition">¶</a></dt> <dd><a class="reference internal" href="../glossary.html#term-finder">Finder</a> for modules declared in the Windows registry. This class implements the <a class="reference internal" href="#importlib.abc.MetaPathFinder" title="importlib.abc.MetaPathFinder"><code class="xref py py-class docutils literal notranslate">importlib.abc.MetaPathFinder</code></a> ABC. Only class methods are defined by this class to alleviate the need for instantiation. <div class="versionadded"> Added in version 3.3. </div> <div class="deprecated"> Deprecated since version 3.6: Use <a class="reference internal" href="site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate">site</code></a> configuration instead. Future versions of Python may not enable this finder by default. </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.PathFinder"> class importlib.machinery.PathFinder<a class="headerlink" href="#importlib.machinery.PathFinder" title="Link to this definition">¶</a></dt> <dd>A <a class="reference internal" href="../glossary.html#term-finder">Finder</a> for <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> and package <code class="docutils literal notranslate">__path__</code> attributes. This class implements the <a class="reference internal" href="#importlib.abc.MetaPathFinder" title="importlib.abc.MetaPathFinder"><code class="xref py py-class docutils literal notranslate">importlib.abc.MetaPathFinder</code></a> ABC. Only class methods are defined by this class to alleviate the need for instantiation. <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.PathFinder.find_spec"> classmethod find_spec(fullname, path=None, target=None)<a class="headerlink" href="#importlib.machinery.PathFinder.find_spec" title="Link to this definition">¶</a></dt> <dd>Class method that attempts to find a <a class="reference internal" href="../glossary.html#term-module-spec">spec</a> for the module specified by fullname on <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> or, if defined, on path. For each path entry that is searched, <a class="reference internal" href="sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate">sys.path_importer_cache</code></a> is checked. If a non-false object is found then it is used as the <a class="reference internal" href="../glossary.html#term-path-entry-finder">path entry finder</a> to look for the module being searched for. If no entry is found in <a class="reference internal" href="sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate">sys.path_importer_cache</code></a>, then <a class="reference internal" href="sys.html#sys.path_hooks" title="sys.path_hooks"><code class="xref py py-data docutils literal notranslate">sys.path_hooks</code></a> is searched for a finder for the path entry and, if found, is stored in <a class="reference internal" href="sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate">sys.path_importer_cache</code></a> along with being queried about the module. If no finder is ever found then <code class="docutils literal notranslate">None</code> is both stored in the cache and returned. <div class="versionadded"> Added in version 3.4. </div> <div class="versionchanged"> Changed in version 3.5: If the current working directory – represented by an empty string – is no longer valid then <code class="docutils literal notranslate">None</code> is returned but no value is cached in <a class="reference internal" href="sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate">sys.path_importer_cache</code></a>. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.PathFinder.invalidate_caches"> classmethod invalidate_caches()<a class="headerlink" href="#importlib.machinery.PathFinder.invalidate_caches" title="Link to this definition">¶</a></dt> <dd>Calls <a class="reference internal" href="#importlib.abc.PathEntryFinder.invalidate_caches" title="importlib.abc.PathEntryFinder.invalidate_caches"><code class="xref py py-meth docutils literal notranslate">importlib.abc.PathEntryFinder.invalidate_caches()</code></a> on all finders stored in <a class="reference internal" href="sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate">sys.path_importer_cache</code></a> that define the method. Otherwise entries in <a class="reference internal" href="sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate">sys.path_importer_cache</code></a> set to <code class="docutils literal notranslate">None</code> are deleted. <div class="versionchanged"> Changed in version 3.7: Entries of <code class="docutils literal notranslate">None</code> in <a class="reference internal" href="sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate">sys.path_importer_cache</code></a> are deleted. </div> </dd></dl> <div class="versionchanged"> Changed in version 3.4: Calls objects in <a class="reference internal" href="sys.html#sys.path_hooks" title="sys.path_hooks"><code class="xref py py-data docutils literal notranslate">sys.path_hooks</code></a> with the current working directory for <code class="docutils literal notranslate">''</code> (i.e. the empty string). </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.FileFinder"> class importlib.machinery.FileFinder(path, *loader_details)<a class="headerlink" href="#importlib.machinery.FileFinder" title="Link to this definition">¶</a></dt> <dd>A concrete implementation of <a class="reference internal" href="#importlib.abc.PathEntryFinder" title="importlib.abc.PathEntryFinder"><code class="xref py py-class docutils literal notranslate">importlib.abc.PathEntryFinder</code></a> which caches results from the file system. The path argument is the directory for which the finder is in charge of searching. The loader_details argument is a variable number of 2-item tuples each containing a loader and a sequence of file suffixes the loader recognizes. The loaders are expected to be callables which accept two arguments of the module’s name and the path to the file found. The finder will cache the directory contents as necessary, making stat calls for each module search to verify the cache is not outdated. Because cache staleness relies upon the granularity of the operating system’s state information of the file system, there is a potential race condition of searching for a module, creating a new file, and then searching for the module the new file represents. If the operations happen fast enough to fit within the granularity of stat calls, then the module search will fail. To prevent this from happening, when you create a module dynamically, make sure to call <a class="reference internal" href="#importlib.invalidate_caches" title="importlib.invalidate_caches"><code class="xref py py-func docutils literal notranslate">importlib.invalidate_caches()</code></a>. <div class="versionadded"> Added in version 3.3. </div> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.FileFinder.path"> path<a class="headerlink" href="#importlib.machinery.FileFinder.path" title="Link to this definition">¶</a></dt> <dd>The path the finder will search in. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.FileFinder.find_spec"> find_spec(fullname, target=None)<a class="headerlink" href="#importlib.machinery.FileFinder.find_spec" title="Link to this definition">¶</a></dt> <dd>Attempt to find the spec to handle fullname within <a class="reference internal" href="#importlib.machinery.FileFinder.path" title="importlib.machinery.FileFinder.path"><code class="xref py py-attr docutils literal notranslate">path</code></a>. <div class="versionadded"> Added in version 3.4. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.FileFinder.invalidate_caches"> invalidate_caches()<a class="headerlink" href="#importlib.machinery.FileFinder.invalidate_caches" title="Link to this definition">¶</a></dt> <dd>Clear out the internal cache. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.FileFinder.path_hook"> classmethod path_hook(*loader_details)<a class="headerlink" href="#importlib.machinery.FileFinder.path_hook" title="Link to this definition">¶</a></dt> <dd>A class method which returns a closure for use on <a class="reference internal" href="sys.html#sys.path_hooks" title="sys.path_hooks"><code class="xref py py-data docutils literal notranslate">sys.path_hooks</code></a>. An instance of <a class="reference internal" href="#importlib.machinery.FileFinder" title="importlib.machinery.FileFinder"><code class="xref py py-class docutils literal notranslate">FileFinder</code></a> is returned by the closure using the path argument given to the closure directly and loader_details indirectly. If the argument to the closure is not an existing directory, <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> is raised. </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.SourceFileLoader"> class importlib.machinery.SourceFileLoader(fullname, path)<a class="headerlink" href="#importlib.machinery.SourceFileLoader" title="Link to this definition">¶</a></dt> <dd>A concrete implementation of <a class="reference internal" href="#importlib.abc.SourceLoader" title="importlib.abc.SourceLoader"><code class="xref py py-class docutils literal notranslate">importlib.abc.SourceLoader</code></a> by subclassing <a class="reference internal" href="#importlib.abc.FileLoader" title="importlib.abc.FileLoader"><code class="xref py py-class docutils literal notranslate">importlib.abc.FileLoader</code></a> and providing some concrete implementations of other methods. <div class="versionadded"> Added in version 3.3. </div> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.SourceFileLoader.name"> name<a class="headerlink" href="#importlib.machinery.SourceFileLoader.name" title="Link to this definition">¶</a></dt> <dd>The name of the module that this loader will handle. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.SourceFileLoader.path"> path<a class="headerlink" href="#importlib.machinery.SourceFileLoader.path" title="Link to this definition">¶</a></dt> <dd>The path to the source file. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.SourceFileLoader.is_package"> is_package(fullname)<a class="headerlink" href="#importlib.machinery.SourceFileLoader.is_package" title="Link to this definition">¶</a></dt> <dd>Return <code class="docutils literal notranslate">True</code> if <a class="reference internal" href="#importlib.machinery.SourceFileLoader.path" title="importlib.machinery.SourceFileLoader.path"><code class="xref py py-attr docutils literal notranslate">path</code></a> appears to be for a package. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.SourceFileLoader.path_stats"> path_stats(path)<a class="headerlink" href="#importlib.machinery.SourceFileLoader.path_stats" title="Link to this definition">¶</a></dt> <dd>Concrete implementation of <a class="reference internal" href="#importlib.abc.SourceLoader.path_stats" title="importlib.abc.SourceLoader.path_stats"><code class="xref py py-meth docutils literal notranslate">importlib.abc.SourceLoader.path_stats()</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.SourceFileLoader.set_data"> set_data(path, data)<a class="headerlink" href="#importlib.machinery.SourceFileLoader.set_data" title="Link to this definition">¶</a></dt> <dd>Concrete implementation of <a class="reference internal" href="#importlib.abc.SourceLoader.set_data" title="importlib.abc.SourceLoader.set_data"><code class="xref py py-meth docutils literal notranslate">importlib.abc.SourceLoader.set_data()</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.SourceFileLoader.load_module"> load_module(name=None)<a class="headerlink" href="#importlib.machinery.SourceFileLoader.load_module" title="Link to this definition">¶</a></dt> <dd>Concrete implementation of <a class="reference internal" href="#importlib.abc.Loader.load_module" title="importlib.abc.Loader.load_module"><code class="xref py py-meth docutils literal notranslate">importlib.abc.Loader.load_module()</code></a> where specifying the name of the module to load is optional. <div class="deprecated"> Deprecated since version 3.6: Use <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">importlib.abc.Loader.exec_module()</code></a> instead. </div> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.SourcelessFileLoader"> class importlib.machinery.SourcelessFileLoader(fullname, path)<a class="headerlink" href="#importlib.machinery.SourcelessFileLoader" title="Link to this definition">¶</a></dt> <dd>A concrete implementation of <a class="reference internal" href="#importlib.abc.FileLoader" title="importlib.abc.FileLoader"><code class="xref py py-class docutils literal notranslate">importlib.abc.FileLoader</code></a> which can import bytecode files (i.e. no source code files exist). Please note that direct use of bytecode files (and thus not source code files) inhibits your modules from being usable by all Python implementations or new versions of Python which change the bytecode format. <div class="versionadded"> Added in version 3.3. </div> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.SourcelessFileLoader.name"> name<a class="headerlink" href="#importlib.machinery.SourcelessFileLoader.name" title="Link to this definition">¶</a></dt> <dd>The name of the module the loader will handle. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.SourcelessFileLoader.path"> path<a class="headerlink" href="#importlib.machinery.SourcelessFileLoader.path" title="Link to this definition">¶</a></dt> <dd>The path to the bytecode file. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.SourcelessFileLoader.is_package"> is_package(fullname)<a class="headerlink" href="#importlib.machinery.SourcelessFileLoader.is_package" title="Link to this definition">¶</a></dt> <dd>Determines if the module is a package based on <a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.path" title="importlib.machinery.SourcelessFileLoader.path"><code class="xref py py-attr docutils literal notranslate">path</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.SourcelessFileLoader.get_code"> get_code(fullname)<a class="headerlink" href="#importlib.machinery.SourcelessFileLoader.get_code" title="Link to this definition">¶</a></dt> <dd>Returns the code object for <a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.name" title="importlib.machinery.SourcelessFileLoader.name"><code class="xref py py-attr docutils literal notranslate">name</code></a> created from <a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.path" title="importlib.machinery.SourcelessFileLoader.path"><code class="xref py py-attr docutils literal notranslate">path</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.SourcelessFileLoader.get_source"> get_source(fullname)<a class="headerlink" href="#importlib.machinery.SourcelessFileLoader.get_source" title="Link to this definition">¶</a></dt> <dd>Returns <code class="docutils literal notranslate">None</code> as bytecode files have no source when this loader is used. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.SourcelessFileLoader.load_module"> load_module(name=None)<a class="headerlink" href="#importlib.machinery.SourcelessFileLoader.load_module" title="Link to this definition">¶</a></dt> <dd></dd></dl> Concrete implementation of <a class="reference internal" href="#importlib.abc.Loader.load_module" title="importlib.abc.Loader.load_module"><code class="xref py py-meth docutils literal notranslate">importlib.abc.Loader.load_module()</code></a> where specifying the name of the module to load is optional. <div class="deprecated"> Deprecated since version 3.6: Use <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">importlib.abc.Loader.exec_module()</code></a> instead. </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.ExtensionFileLoader"> class importlib.machinery.ExtensionFileLoader(fullname, path)<a class="headerlink" href="#importlib.machinery.ExtensionFileLoader" title="Link to this definition">¶</a></dt> <dd>A concrete implementation of <a class="reference internal" href="#importlib.abc.ExecutionLoader" title="importlib.abc.ExecutionLoader"><code class="xref py py-class docutils literal notranslate">importlib.abc.ExecutionLoader</code></a> for extension modules. The fullname argument specifies the name of the module the loader is to support. The path argument is the path to the extension module’s file. Note that, by default, importing an extension module will fail in subinterpreters if it doesn’t implement multi-phase init (see <a class="pep reference external" href="https://peps.python.org/pep-0489/">PEP 489</a>), even if it would otherwise import successfully. <div class="versionadded"> Added in version 3.3. </div> <div class="versionchanged"> Changed in version 3.12: Multi-phase init is now required for use in subinterpreters. </div> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ExtensionFileLoader.name"> name<a class="headerlink" href="#importlib.machinery.ExtensionFileLoader.name" title="Link to this definition">¶</a></dt> <dd>Name of the module the loader supports. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ExtensionFileLoader.path"> path<a class="headerlink" href="#importlib.machinery.ExtensionFileLoader.path" title="Link to this definition">¶</a></dt> <dd>Path to the extension module. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.ExtensionFileLoader.create_module"> create_module(spec)<a class="headerlink" href="#importlib.machinery.ExtensionFileLoader.create_module" title="Link to this definition">¶</a></dt> <dd>Creates the module object from the given specification in accordance with <a class="pep reference external" href="https://peps.python.org/pep-0489/">PEP 489</a>. <div class="versionadded"> Added in version 3.5. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.ExtensionFileLoader.exec_module"> exec_module(module)<a class="headerlink" href="#importlib.machinery.ExtensionFileLoader.exec_module" title="Link to this definition">¶</a></dt> <dd>Initializes the given module object in accordance with <a class="pep reference external" href="https://peps.python.org/pep-0489/">PEP 489</a>. <div class="versionadded"> Added in version 3.5. </div> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.ExtensionFileLoader.is_package"> is_package(fullname)<a class="headerlink" href="#importlib.machinery.ExtensionFileLoader.is_package" title="Link to this definition">¶</a></dt> <dd>Returns <code class="docutils literal notranslate">True</code> if the file path points to a package’s <code class="docutils literal notranslate">__init__</code> module based on <a class="reference internal" href="#importlib.machinery.EXTENSION_SUFFIXES" title="importlib.machinery.EXTENSION_SUFFIXES"><code class="xref py py-attr docutils literal notranslate">EXTENSION_SUFFIXES</code></a>. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.ExtensionFileLoader.get_code"> get_code(fullname)<a class="headerlink" href="#importlib.machinery.ExtensionFileLoader.get_code" title="Link to this definition">¶</a></dt> <dd>Returns <code class="docutils literal notranslate">None</code> as extension modules lack a code object. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.ExtensionFileLoader.get_source"> get_source(fullname)<a class="headerlink" href="#importlib.machinery.ExtensionFileLoader.get_source" title="Link to this definition">¶</a></dt> <dd>Returns <code class="docutils literal notranslate">None</code> as extension modules do not have source code. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="importlib.machinery.ExtensionFileLoader.get_filename"> get_filename(fullname)<a class="headerlink" href="#importlib.machinery.ExtensionFileLoader.get_filename" title="Link to this definition">¶</a></dt> <dd>Returns <a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.path" title="importlib.machinery.ExtensionFileLoader.path"><code class="xref py py-attr docutils literal notranslate">path</code></a>. <div class="versionadded"> Added in version 3.4. </div> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.NamespaceLoader"> class importlib.machinery.NamespaceLoader(name, path, path_finder)<a class="headerlink" href="#importlib.machinery.NamespaceLoader" title="Link to this definition">¶</a></dt> <dd>A concrete implementation of <a class="reference internal" href="#importlib.abc.InspectLoader" title="importlib.abc.InspectLoader"><code class="xref py py-class docutils literal notranslate">importlib.abc.InspectLoader</code></a> for namespace packages. This is an alias for a private class and is only made public for introspecting the <code class="docutils literal notranslate">__loader__</code> attribute on namespace packages: <div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> from importlib.machinery import NamespaceLoader >>> import my_namespace >>> isinstance(my_namespace.__loader__, NamespaceLoader) True >>> import importlib.abc >>> isinstance(my_namespace.__loader__, importlib.abc.Loader) True </pre></div> </div> <div class="versionadded"> Added in version 3.11. </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.ModuleSpec"> class importlib.machinery.ModuleSpec(name, loader, *, origin=None, loader_state=None, is_package=None)<a class="headerlink" href="#importlib.machinery.ModuleSpec" title="Link to this definition">¶</a></dt> <dd>A specification for a module’s import-system-related state. This is typically exposed as the module’s <a class="reference internal" href="../reference/datamodel.html#module.__spec__" title="module.__spec__"><code class="xref py py-attr docutils literal notranslate">__spec__</code></a> attribute. Many of these attributes are also available directly on a module: for example, <code class="docutils literal notranslate">module.__spec__.origin == module.__file__</code>. Note, however, that while the values are usually equivalent, they can differ since there is no synchronization between the two objects. For example, it is possible to update the module’s <a class="reference internal" href="../reference/datamodel.html#module.__file__" title="module.__file__"><code class="xref py py-attr docutils literal notranslate">__file__</code></a> at runtime and this will not be automatically reflected in the module’s <a class="reference internal" href="#importlib.machinery.ModuleSpec.origin" title="importlib.machinery.ModuleSpec.origin"><code class="xref py py-attr docutils literal notranslate">__spec__.origin</code></a>, and vice versa. <div class="versionadded"> Added in version 3.4. </div> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ModuleSpec.name"> name<a class="headerlink" href="#importlib.machinery.ModuleSpec.name" title="Link to this definition">¶</a></dt> <dd>The module’s fully qualified name (see <a class="reference internal" href="../reference/datamodel.html#module.__name__" title="module.__name__"><code class="xref py py-attr docutils literal notranslate">module.__name__</code></a>). The <a class="reference internal" href="../glossary.html#term-finder">finder</a> should always set this attribute to a non-empty string. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ModuleSpec.loader"> loader<a class="headerlink" href="#importlib.machinery.ModuleSpec.loader" title="Link to this definition">¶</a></dt> <dd>The <a class="reference internal" href="../glossary.html#term-loader">loader</a> used to load the module (see <a class="reference internal" href="../reference/datamodel.html#module.__loader__" title="module.__loader__"><code class="xref py py-attr docutils literal notranslate">module.__loader__</code></a>). The <a class="reference internal" href="../glossary.html#term-finder">finder</a> should always set this attribute. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ModuleSpec.origin"> origin<a class="headerlink" href="#importlib.machinery.ModuleSpec.origin" title="Link to this definition">¶</a></dt> <dd>The location the <a class="reference internal" href="../glossary.html#term-loader">loader</a> should use to load the module (see <a class="reference internal" href="../reference/datamodel.html#module.__file__" title="module.__file__"><code class="xref py py-attr docutils literal notranslate">module.__file__</code></a>). For example, for modules loaded from a <code class="docutils literal notranslate">.py</code> file this is the filename. The <a class="reference internal" href="../glossary.html#term-finder">finder</a> should always set this attribute to a meaningful value for the <a class="reference internal" href="../glossary.html#term-loader">loader</a> to use. In the uncommon case that there is not one (like for namespace packages), it should be set to <code class="docutils literal notranslate">None</code>. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ModuleSpec.submodule_search_locations"> submodule_search_locations<a class="headerlink" href="#importlib.machinery.ModuleSpec.submodule_search_locations" title="Link to this definition">¶</a></dt> <dd>A (possibly empty) <a class="reference internal" href="../glossary.html#term-sequence">sequence</a> of strings enumerating the locations in which a package’s submodules will be found (see <a class="reference internal" href="../reference/datamodel.html#module.__path__" title="module.__path__"><code class="xref py py-attr docutils literal notranslate">module.__path__</code></a>). Most of the time there will only be a single directory in this list. The <a class="reference internal" href="../glossary.html#term-finder">finder</a> should set this attribute to a sequence, even an empty one, to indicate to the import system that the module is a package. It should be set to <code class="docutils literal notranslate">None</code> for non-package modules. It is set automatically later to a special object for namespace packages. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ModuleSpec.loader_state"> loader_state<a class="headerlink" href="#importlib.machinery.ModuleSpec.loader_state" title="Link to this definition">¶</a></dt> <dd>The <a class="reference internal" href="../glossary.html#term-finder">finder</a> may set this attribute to an object containing additional, module-specific data to use when loading the module. Otherwise it should be set to <code class="docutils literal notranslate">None</code>. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ModuleSpec.cached"> cached<a class="headerlink" href="#importlib.machinery.ModuleSpec.cached" title="Link to this definition">¶</a></dt> <dd>The filename of a compiled version of the module’s code (see <a class="reference internal" href="../reference/datamodel.html#module.__cached__" title="module.__cached__"><code class="xref py py-attr docutils literal notranslate">module.__cached__</code></a>). The <a class="reference internal" href="../glossary.html#term-finder">finder</a> should always set this attribute but it may be <code class="docutils literal notranslate">None</code> for modules that do not need compiled code stored. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ModuleSpec.parent"> parent<a class="headerlink" href="#importlib.machinery.ModuleSpec.parent" title="Link to this definition">¶</a></dt> <dd>(Read-only) The fully qualified name of the package the module is in (or the empty string for a top-level module). See <a class="reference internal" href="../reference/datamodel.html#module.__package__" title="module.__package__"><code class="xref py py-attr docutils literal notranslate">module.__package__</code></a>. If the module is a package then this is the same as <a class="reference internal" href="#importlib.machinery.ModuleSpec.name" title="importlib.machinery.ModuleSpec.name"><code class="xref py py-attr docutils literal notranslate">name</code></a>. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.ModuleSpec.has_location"> has_location<a class="headerlink" href="#importlib.machinery.ModuleSpec.has_location" title="Link to this definition">¶</a></dt> <dd><code class="docutils literal notranslate">True</code> if the spec’s <a class="reference internal" href="#importlib.machinery.ModuleSpec.origin" title="importlib.machinery.ModuleSpec.origin"><code class="xref py py-attr docutils literal notranslate">origin</code></a> refers to a loadable location, <code class="docutils literal notranslate">False</code> otherwise. This value impacts how <code class="xref py py-attr docutils literal notranslate">origin</code> is interpreted and how the module’s <a class="reference internal" href="../reference/datamodel.html#module.__file__" title="module.__file__"><code class="xref py py-attr docutils literal notranslate">__file__</code></a> is populated. </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.machinery.AppleFrameworkLoader"> class importlib.machinery.AppleFrameworkLoader(name, path)<a class="headerlink" href="#importlib.machinery.AppleFrameworkLoader" title="Link to this definition">¶</a></dt> <dd>A specialization of <a class="reference internal" href="#importlib.machinery.ExtensionFileLoader" title="importlib.machinery.ExtensionFileLoader"><code class="xref py py-class docutils literal notranslate">importlib.machinery.ExtensionFileLoader</code></a> that is able to load extension modules in Framework format. For compatibility with the iOS App Store, all binary modules in an iOS app must be dynamic libraries, contained in a framework with appropriate metadata, stored in the <code class="docutils literal notranslate">Frameworks</code> folder of the packaged app. There can be only a single binary per framework, and there can be no executable binary material outside the Frameworks folder. To accommodate this requirement, when running on iOS, extension module binaries are not packaged as <code class="docutils literal notranslate">.so</code> files on <code class="docutils literal notranslate">sys.path</code>, but as individual standalone frameworks. To discover those frameworks, this loader is be registered against the <code class="docutils literal notranslate">.fwork</code> file extension, with a <code class="docutils literal notranslate">.fwork</code> file acting as a placeholder in the original location of the binary on <code class="docutils literal notranslate">sys.path</code>. The <code class="docutils literal notranslate">.fwork</code> file contains the path of the actual binary in the <code class="docutils literal notranslate">Frameworks</code> folder, relative to the app bundle. To allow for resolving a framework-packaged binary back to the original location, the framework is expected to contain a <code class="docutils literal notranslate">.origin</code> file that contains the location of the <code class="docutils literal notranslate">.fwork</code> file, relative to the app bundle. For example, consider the case of an import <code class="docutils literal notranslate">from foo.bar import _whiz</code>, where <code class="docutils literal notranslate">_whiz</code> is implemented with the binary module <code class="docutils literal notranslate">sources/foo/bar/_whiz.abi3.so</code>, with <code class="docutils literal notranslate">sources</code> being the location registered on <code class="docutils literal notranslate">sys.path</code>, relative to the application bundle. This module must be distributed as <code class="docutils literal notranslate">Frameworks/foo.bar._whiz.framework/foo.bar._whiz</code> (creating the framework name from the full import path of the module), with an <code class="docutils literal notranslate">Info.plist</code> file in the <code class="docutils literal notranslate">.framework</code> directory identifying the binary as a framework. The <code class="docutils literal notranslate">foo.bar._whiz</code> module would be represented in the original location with a <code class="docutils literal notranslate">sources/foo/bar/_whiz.abi3.fwork</code> marker file, containing the path <code class="docutils literal notranslate">Frameworks/foo.bar._whiz/foo.bar._whiz</code>. The framework would also contain <code class="docutils literal notranslate">Frameworks/foo.bar._whiz.framework/foo.bar._whiz.origin</code>, containing the path to the <code class="docutils literal notranslate">.fwork</code> file. When a module is loaded with this loader, the <code class="docutils literal notranslate">__file__</code> for the module will report as the location of the <code class="docutils literal notranslate">.fwork</code> file. This allows code to use the <code class="docutils literal notranslate">__file__</code> of a module as an anchor for file system traveral. However, the spec origin will reference the location of the actual binary in the <code class="docutils literal notranslate">.framework</code> folder. The Xcode project building the app is responsible for converting any <code class="docutils literal notranslate">.so</code> files from wherever they exist in the <code class="docutils literal notranslate">PYTHONPATH</code> into frameworks in the <code class="docutils literal notranslate">Frameworks</code> folder (including stripping extensions from the module file, the addition of framework metadata, and signing the resulting framework), and creating the <code class="docutils literal notranslate">.fwork</code> and <code class="docutils literal notranslate">.origin</code> files. This will usually be done with a build step in the Xcode project; see the iOS documentation for details on how to construct this build step. <div class="versionadded"> Added in version 3.13. </div> <div class="availability docutils container"> <a class="reference internal" href="intro.html#availability">Availability</a>: iOS. </div> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.AppleFrameworkLoader.name"> name<a class="headerlink" href="#importlib.machinery.AppleFrameworkLoader.name" title="Link to this definition">¶</a></dt> <dd>Name of the module the loader supports. </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.machinery.AppleFrameworkLoader.path"> path<a class="headerlink" href="#importlib.machinery.AppleFrameworkLoader.path" title="Link to this definition">¶</a></dt> <dd>Path to the <code class="docutils literal notranslate">.fwork</code> file for the extension module. </dd></dl> </dd></dl> </section> <section id="module-importlib.util"> <h2><a class="reference internal" href="#module-importlib.util" title="importlib.util: Utility code for importers"><code class="xref py py-mod docutils literal notranslate">importlib.util</code></a> – Utility code for importers<a class="headerlink" href="#module-importlib.util" title="Link to this heading">¶</a></h2> Source code: <a class="extlink-source reference external" href="https://github.com/python/cpython/tree/3.13/Lib/importlib/util.py">Lib/importlib/util.py</a> <hr class="docutils" /> This module contains the various objects that help in the construction of an <a class="reference internal" href="../glossary.html#term-importer">importer</a>. <dl class="py attribute"> <dt class="sig sig-object py" id="importlib.util.MAGIC_NUMBER"> importlib.util.MAGIC_NUMBER<a class="headerlink" href="#importlib.util.MAGIC_NUMBER" title="Link to this definition">¶</a></dt> <dd>The bytes which represent the bytecode version number. If you need help with loading/writing bytecode then consider <a class="reference internal" href="#importlib.abc.SourceLoader" title="importlib.abc.SourceLoader"><code class="xref py py-class docutils literal notranslate">importlib.abc.SourceLoader</code></a>. <div class="versionadded"> Added in version 3.4. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util.cache_from_source"> importlib.util.cache_from_source(path, debug_override=None, *, optimization=None)<a class="headerlink" href="#importlib.util.cache_from_source" title="Link to this definition">¶</a></dt> <dd>Return the <a class="pep reference external" href="https://peps.python.org/pep-3147/">PEP 3147</a>/<a class="pep reference external" href="https://peps.python.org/pep-0488/">PEP 488</a> path to the byte-compiled file associated with the source path. For example, if path is <code class="docutils literal notranslate">/foo/bar/baz.py</code> the return value would be <code class="docutils literal notranslate">/foo/bar/__pycache__/baz.cpython-32.pyc</code> for Python 3.2. The <code class="docutils literal notranslate">cpython-32</code> string comes from the current magic tag (see <code class="xref py py-func docutils literal notranslate">get_tag()</code>; if <code class="xref py py-attr docutils literal notranslate">sys.implementation.cache_tag</code> is not defined then <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a> will be raised). The optimization parameter is used to specify the optimization level of the bytecode file. An empty string represents no optimization, so <code class="docutils literal notranslate">/foo/bar/baz.py</code> with an optimization of <code class="docutils literal notranslate">''</code> will result in a bytecode path of <code class="docutils literal notranslate">/foo/bar/__pycache__/baz.cpython-32.pyc</code>. <code class="docutils literal notranslate">None</code> causes the interpreter’s optimization level to be used. Any other value’s string representation is used, so <code class="docutils literal notranslate">/foo/bar/baz.py</code> with an optimization of <code class="docutils literal notranslate">2</code> will lead to the bytecode path of <code class="docutils literal notranslate">/foo/bar/__pycache__/baz.cpython-32.opt-2.pyc</code>. The string representation of optimization can only be alphanumeric, else <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised. The debug_override parameter is deprecated and can be used to override the system’s value for <code class="docutils literal notranslate">__debug__</code>. A <code class="docutils literal notranslate">True</code> value is the equivalent of setting optimization to the empty string. A <code class="docutils literal notranslate">False</code> value is the same as setting optimization to <code class="docutils literal notranslate">1</code>. If both debug_override an optimization are not <code class="docutils literal notranslate">None</code> then <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> is raised. <div class="versionadded"> Added in version 3.4. </div> <div class="versionchanged"> Changed in version 3.5: The optimization parameter was added and the debug_override parameter was deprecated. </div> <div class="versionchanged"> Changed in version 3.6: Accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util.source_from_cache"> importlib.util.source_from_cache(path)<a class="headerlink" href="#importlib.util.source_from_cache" title="Link to this definition">¶</a></dt> <dd>Given the path to a <a class="pep reference external" href="https://peps.python.org/pep-3147/">PEP 3147</a> file name, return the associated source code file path. For example, if path is <code class="docutils literal notranslate">/foo/bar/__pycache__/baz.cpython-32.pyc</code> the returned path would be <code class="docutils literal notranslate">/foo/bar/baz.py</code>. path need not exist, however if it does not conform to <a class="pep reference external" href="https://peps.python.org/pep-3147/">PEP 3147</a> or <a class="pep reference external" href="https://peps.python.org/pep-0488/">PEP 488</a> format, a <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised. If <code class="xref py py-attr docutils literal notranslate">sys.implementation.cache_tag</code> is not defined, <a class="reference internal" href="exceptions.html#NotImplementedError" title="NotImplementedError"><code class="xref py py-exc docutils literal notranslate">NotImplementedError</code></a> is raised. <div class="versionadded"> Added in version 3.4. </div> <div class="versionchanged"> Changed in version 3.6: Accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util.decode_source"> importlib.util.decode_source(source_bytes)<a class="headerlink" href="#importlib.util.decode_source" title="Link to this definition">¶</a></dt> <dd>Decode the given bytes representing source code and return it as a string with universal newlines (as required by <a class="reference internal" href="#importlib.abc.InspectLoader.get_source" title="importlib.abc.InspectLoader.get_source"><code class="xref py py-meth docutils literal notranslate">importlib.abc.InspectLoader.get_source()</code></a>). <div class="versionadded"> Added in version 3.4. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util.resolve_name"> importlib.util.resolve_name(name, package)<a class="headerlink" href="#importlib.util.resolve_name" title="Link to this definition">¶</a></dt> <dd>Resolve a relative module name to an absolute one. If name has no leading dots, then name is simply returned. This allows for usage such as <code class="docutils literal notranslate">importlib.util.resolve_name('sys', __spec__.parent)</code> without doing a check to see if the package argument is needed. <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> is raised if name is a relative module name but package is a false value (e.g. <code class="docutils literal notranslate">None</code> or the empty string). <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> is also raised if a relative name would escape its containing package (e.g. requesting <code class="docutils literal notranslate">..bacon</code> from within the <code class="docutils literal notranslate">spam</code> package). <div class="versionadded"> Added in version 3.3. </div> <div class="versionchanged"> Changed in version 3.9: To improve consistency with import statements, raise <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate">ImportError</code></a> instead of <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> for invalid relative import attempts. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util.find_spec"> importlib.util.find_spec(name, package=None)<a class="headerlink" href="#importlib.util.find_spec" title="Link to this definition">¶</a></dt> <dd>Find the <a class="reference internal" href="../glossary.html#term-module-spec">spec</a> for a module, optionally relative to the specified package name. If the module is in <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a>, then <code class="docutils literal notranslate">sys.modules[name].__spec__</code> is returned (unless the spec would be <code class="docutils literal notranslate">None</code> or is not set, in which case <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised). Otherwise a search using <a class="reference internal" href="sys.html#sys.meta_path" title="sys.meta_path"><code class="xref py py-data docutils literal notranslate">sys.meta_path</code></a> is done. <code class="docutils literal notranslate">None</code> is returned if no spec is found. If name is for a submodule (contains a dot), the parent module is automatically imported. name and package work the same as for <code class="xref py py-func docutils literal notranslate">import_module()</code>. <div class="versionadded"> Added in version 3.4. </div> <div class="versionchanged"> Changed in version 3.7: Raises <a class="reference internal" href="exceptions.html#ModuleNotFoundError" title="ModuleNotFoundError"><code class="xref py py-exc docutils literal notranslate">ModuleNotFoundError</code></a> instead of <a class="reference internal" href="exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate">AttributeError</code></a> if package is in fact not a package (i.e. lacks a <a class="reference internal" href="../reference/datamodel.html#module.__path__" title="module.__path__"><code class="xref py py-attr docutils literal notranslate">__path__</code></a> attribute). </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util.module_from_spec"> importlib.util.module_from_spec(spec)<a class="headerlink" href="#importlib.util.module_from_spec" title="Link to this definition">¶</a></dt> <dd>Create a new module based on spec and <a class="reference internal" href="#importlib.abc.Loader.create_module" title="importlib.abc.Loader.create_module"><code class="xref py py-meth docutils literal notranslate">spec.loader.create_module</code></a>. If <a class="reference internal" href="#importlib.abc.Loader.create_module" title="importlib.abc.Loader.create_module"><code class="xref py py-meth docutils literal notranslate">spec.loader.create_module</code></a> does not return <code class="docutils literal notranslate">None</code>, then any pre-existing attributes will not be reset. Also, no <a class="reference internal" href="exceptions.html#AttributeError" title="AttributeError"><code class="xref py py-exc docutils literal notranslate">AttributeError</code></a> will be raised if triggered while accessing spec or setting an attribute on the module. This function is preferred over using <a class="reference internal" href="types.html#types.ModuleType" title="types.ModuleType"><code class="xref py py-class docutils literal notranslate">types.ModuleType</code></a> to create a new module as spec is used to set as many import-controlled attributes on the module as possible. <div class="versionadded"> Added in version 3.5. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util.spec_from_loader"> importlib.util.spec_from_loader(name, loader, *, origin=None, is_package=None)<a class="headerlink" href="#importlib.util.spec_from_loader" title="Link to this definition">¶</a></dt> <dd>A factory function for creating a <a class="reference internal" href="#importlib.machinery.ModuleSpec" title="importlib.machinery.ModuleSpec"><code class="xref py py-class docutils literal notranslate">ModuleSpec</code></a> instance based on a loader. The parameters have the same meaning as they do for ModuleSpec. The function uses available <a class="reference internal" href="../glossary.html#term-loader">loader</a> APIs, such as <code class="xref py py-meth docutils literal notranslate">InspectLoader.is_package()</code>, to fill in any missing information on the spec. <div class="versionadded"> Added in version 3.4. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util.spec_from_file_location"> importlib.util.spec_from_file_location(name, location, *, loader=None, submodule_search_locations=None)<a class="headerlink" href="#importlib.util.spec_from_file_location" title="Link to this definition">¶</a></dt> <dd>A factory function for creating a <a class="reference internal" href="#importlib.machinery.ModuleSpec" title="importlib.machinery.ModuleSpec"><code class="xref py py-class docutils literal notranslate">ModuleSpec</code></a> instance based on the path to a file. Missing information will be filled in on the spec by making use of loader APIs and by the implication that the module will be file-based. <div class="versionadded"> Added in version 3.4. </div> <div class="versionchanged"> Changed in version 3.6: Accepts a <a class="reference internal" href="../glossary.html#term-path-like-object">path-like object</a>. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util.source_hash"> importlib.util.source_hash(source_bytes)<a class="headerlink" href="#importlib.util.source_hash" title="Link to this definition">¶</a></dt> <dd>Return the hash of source_bytes as bytes. A hash-based <code class="docutils literal notranslate">.pyc</code> file embeds the <a class="reference internal" href="#importlib.util.source_hash" title="importlib.util.source_hash"><code class="xref py py-func docutils literal notranslate">source_hash()</code></a> of the corresponding source file’s contents in its header. <div class="versionadded"> Added in version 3.7. </div> </dd></dl> <dl class="py function"> <dt class="sig sig-object py" id="importlib.util._incompatible_extension_module_restrictions"> importlib.util._incompatible_extension_module_restrictions(*, disable_check)<a class="headerlink" href="#importlib.util._incompatible_extension_module_restrictions" title="Link to this definition">¶</a></dt> <dd>A context manager that can temporarily skip the compatibility check for extension modules. By default the check is enabled and will fail when a single-phase init module is imported in a subinterpreter. It will also fail for a multi-phase init module that doesn’t explicitly support a per-interpreter GIL, when imported in an interpreter with its own GIL. Note that this function is meant to accommodate an unusual case; one which is likely to eventually go away. There’s is a pretty good chance this is not what you were looking for. You can get the same effect as this function by implementing the basic interface of multi-phase init (<a class="pep reference external" href="https://peps.python.org/pep-0489/">PEP 489</a>) and lying about support for multiple interpreters (or per-interpreter GIL). <div class="admonition warning"> Warning Using this function to disable the check can lead to unexpected behavior and even crashes. It should only be used during extension module development. </div> <div class="versionadded"> Added in version 3.12. </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="importlib.util.LazyLoader"> class importlib.util.LazyLoader(loader)<a class="headerlink" href="#importlib.util.LazyLoader" title="Link to this definition">¶</a></dt> <dd>A class which postpones the execution of the loader of a module until the module has an attribute accessed. This class only works with loaders that define <a class="reference internal" href="#importlib.abc.Loader.exec_module" title="importlib.abc.Loader.exec_module"><code class="xref py py-meth docutils literal notranslate">exec_module()</code></a> as control over what module type is used for the module is required. For those same reasons, the loader’s <a class="reference internal" href="#importlib.abc.Loader.create_module" title="importlib.abc.Loader.create_module"><code class="xref py py-meth docutils literal notranslate">create_module()</code></a> method must return <code class="docutils literal notranslate">None</code> or a type for which its <code class="docutils literal notranslate">__class__</code> attribute can be mutated along with not using <a class="reference internal" href="../glossary.html#term-__slots__">slots</a>. Finally, modules which substitute the object placed into <a class="reference internal" href="sys.html#sys.modules" title="sys.modules"><code class="xref py py-data docutils literal notranslate">sys.modules</code></a> will not work as there is no way to properly replace the module references throughout the interpreter safely; <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised if such a substitution is detected. <div class="admonition note"> Note For projects where startup time is critical, this class allows for potentially minimizing the cost of loading a module if it is never used. For projects where startup time is not essential then use of this class is heavily discouraged due to error messages created during loading being postponed and thus occurring out of context. </div> <div class="versionadded"> Added in version 3.5. </div> <div class="versionchanged"> Changed in version 3.6: Began calling <a class="reference internal" href="#importlib.abc.Loader.create_module" title="importlib.abc.Loader.create_module"><code class="xref py py-meth docutils literal notranslate">create_module()</code></a>, removing the compatibility warning for <a class="reference internal" href="#importlib.machinery.BuiltinImporter" title="importlib.machinery.BuiltinImporter"><code class="xref py py-class docutils literal notranslate">importlib.machinery.BuiltinImporter</code></a> and <a class="reference internal" href="#importlib.machinery.ExtensionFileLoader" title="importlib.machinery.ExtensionFileLoader"><code class="xref py py-class docutils literal notranslate">importlib.machinery.ExtensionFileLoader</code></a>. </div> <dl class="py method"> <dt class="sig sig-object py" id="importlib.util.LazyLoader.factory"> classmethod factory(loader)<a class="headerlink" href="#importlib.util.LazyLoader.factory" title="Link to this definition">¶</a></dt> <dd>A class method which returns a callable that creates a lazy loader. This is meant to be used in situations where the loader is passed by class instead of by instance. <div class="highlight-python3 notranslate"><div class="highlight"><pre>suffixes = importlib.machinery.SOURCE_SUFFIXES loader = importlib.machinery.SourceFileLoader lazy_loader = importlib.util.LazyLoader.factory(loader) finder = importlib.machinery.FileFinder(path, (lazy_loader, suffixes)) </pre></div> </div> </dd></dl> </dd></dl> </section> <section id="examples"> <h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2> <section id="importing-programmatically"> <h3>Importing programmatically<a class="headerlink" href="#importing-programmatically" title="Link to this heading">¶</a></h3> To programmatically import a module, use <a class="reference internal" href="#importlib.import_module" title="importlib.import_module"><code class="xref py py-func docutils literal notranslate">importlib.import_module()</code></a>. <div class="highlight-python3 notranslate"><div class="highlight"><pre>import importlib itertools = importlib.import_module('itertools') </pre></div> </div> </section> <section id="checking-if-a-module-can-be-imported"> <h3>Checking if a module can be imported<a class="headerlink" href="#checking-if-a-module-can-be-imported" title="Link to this heading">¶</a></h3> If you need to find out if a module can be imported without actually doing the import, then you should use <a class="reference internal" href="#importlib.util.find_spec" title="importlib.util.find_spec"><code class="xref py py-func docutils literal notranslate">importlib.util.find_spec()</code></a>. Note that if <code class="docutils literal notranslate">name</code> is a submodule (contains a dot), <a class="reference internal" href="#importlib.util.find_spec" title="importlib.util.find_spec"><code class="xref py py-func docutils literal notranslate">importlib.util.find_spec()</code></a> will import the parent module. <div class="highlight-python3 notranslate"><div class="highlight"><pre>import importlib.util import sys # For illustrative purposes. name = 'itertools' if name in sys.modules: print(f"{name!r} already in sys.modules") elif (spec := importlib.util.find_spec(name)) is not None: # If you chose to perform the actual import ... module = importlib.util.module_from_spec(spec) sys.modules[name] = module spec.loader.exec_module(module) print(f"{name!r} has been imported") else: print(f"can't find the {name!r} module") </pre></div> </div> </section> <section id="importing-a-source-file-directly"> <h3>Importing a source file directly<a class="headerlink" href="#importing-a-source-file-directly" title="Link to this heading">¶</a></h3> This recipe should be used with caution: it is an approximation of an import statement where the file path is specified directly, rather than <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> being searched. Alternatives should first be considered first, such as modifying <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> when a proper module is required, or using <a class="reference internal" href="runpy.html#runpy.run_path" title="runpy.run_path"><code class="xref py py-func docutils literal notranslate">runpy.run_path()</code></a> when the global namespace resulting from running a Python file is appropriate. To import a Python source file directly from a path, use the following recipe: <div class="highlight-python3 notranslate"><div class="highlight"><pre>import importlib.util import sys def import_from_path(module_name, file_path): spec = importlib.util.spec_from_file_location(module_name, file_path) module = importlib.util.module_from_spec(spec) sys.modules[module_name] = module spec.loader.exec_module(module) return module # For illustrative purposes only (use of `json` is arbitrary). import json file_path = json.__file__ module_name = json.__name__ # Similar outcome as `import json`. json = import_from_path(module_name, file_path) </pre></div> </div> </section> <section id="implementing-lazy-imports"> <h3>Implementing lazy imports<a class="headerlink" href="#implementing-lazy-imports" title="Link to this heading">¶</a></h3> The example below shows how to implement lazy imports: <div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> import importlib.util >>> import sys >>> def lazy_import(name): ... spec = importlib.util.find_spec(name) ... loader = importlib.util.LazyLoader(spec.loader) ... spec.loader = loader ... module = importlib.util.module_from_spec(spec) ... sys.modules[name] = module ... loader.exec_module(module) ... return module ... >>> lazy_typing = lazy_import("typing") >>> #lazy_typing is a real module object, >>> #but it is not loaded in memory yet. >>> lazy_typing.TYPE_CHECKING False </pre></div> </div> </section> <section id="setting-up-an-importer"> <h3>Setting up an importer<a class="headerlink" href="#setting-up-an-importer" title="Link to this heading">¶</a></h3> For deep customizations of import, you typically want to implement an <a class="reference internal" href="../glossary.html#term-importer">importer</a>. This means managing both the <a class="reference internal" href="../glossary.html#term-finder">finder</a> and <a class="reference internal" href="../glossary.html#term-loader">loader</a> side of things. For finders there are two flavours to choose from depending on your needs: a <a class="reference internal" href="../glossary.html#term-meta-path-finder">meta path finder</a> or a <a class="reference internal" href="../glossary.html#term-path-entry-finder">path entry finder</a>. The former is what you would put on <a class="reference internal" href="sys.html#sys.meta_path" title="sys.meta_path"><code class="xref py py-data docutils literal notranslate">sys.meta_path</code></a> while the latter is what you create using a <a class="reference internal" href="../glossary.html#term-path-entry-hook">path entry hook</a> on <a class="reference internal" href="sys.html#sys.path_hooks" title="sys.path_hooks"><code class="xref py py-data docutils literal notranslate">sys.path_hooks</code></a> which works with <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate">sys.path</code></a> entries to potentially create a finder. This example will show you how to register your own importers so that import will use them (for creating an importer for yourself, read the documentation for the appropriate classes defined within this package): <div class="highlight-python3 notranslate"><div class="highlight"><pre>import importlib.machinery import sys # For illustrative purposes only. SpamMetaPathFinder = importlib.machinery.PathFinder SpamPathEntryFinder = importlib.machinery.FileFinder loader_details = (importlib.machinery.SourceFileLoader, importlib.machinery.SOURCE_SUFFIXES) # Setting up a meta path finder. # Make sure to put the finder in the proper location in the list in terms of # priority. sys.meta_path.append(SpamMetaPathFinder) # Setting up a path entry finder. # Make sure to put the path hook in the proper location in the list in terms # of priority. sys.path_hooks.append(SpamPathEntryFinder.path_hook(loader_details)) </pre></div> </div> </section> <section id="approximating-importlib-import-module"> <h3>Approximating <a class="reference internal" href="#importlib.import_module" title="importlib.import_module"><code class="xref py py-func docutils literal notranslate">importlib.import_module()</code></a><a class="headerlink" href="#approximating-importlib-import-module" title="Link to this heading">¶</a></h3> Import itself is implemented in Python code, making it possible to expose most of the import machinery through importlib. The following helps illustrate the various APIs that importlib exposes by providing an approximate implementation of <a class="reference internal" href="#importlib.import_module" title="importlib.import_module"><code class="xref py py-func docutils literal notranslate">importlib.import_module()</code></a>: <div class="highlight-python3 notranslate"><div class="highlight"><pre>import importlib.util import sys def import_module(name, package=None): """An approximate implementation of import.""" absolute_name = importlib.util.resolve_name(name, package) try: return sys.modules[absolute_name] except KeyError: pass path = None if '.' in absolute_name: parent_name, _, child_name = absolute_name.rpartition('.') parent_module = import_module(parent_name) path = parent_module.__spec__.submodule_search_locations for finder in sys.meta_path: spec = finder.find_spec(absolute_name, path) if spec is not None: break else: msg = f'No module named {absolute_name!r}' raise ModuleNotFoundError(msg, name=absolute_name) module = importlib.util.module_from_spec(spec) sys.modules[absolute_name] = module spec.loader.exec_module(module) if path is not None: setattr(parent_module, child_name, module) return module </pre></div> </div> </section> </section> </section> <div class="clearer"></div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="Main"> <div class="sphinxsidebarwrapper"> <div> <h3><a href="../contents.html">Table of Contents</a></h3> <ul> <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">importlib</code> — The implementation of <code class="xref std std-keyword docutils literal notranslate">import</code></a><ul> <li><a class="reference internal" href="#introduction">Introduction</a></li> <li><a class="reference internal" href="#functions">Functions</a><ul> <li><a class="reference internal" href="#importlib.__import__"><code class="docutils literal notranslate">__import__()</code></a></li> <li><a class="reference internal" href="#importlib.import_module"><code class="docutils literal notranslate">import_module()</code></a></li> <li><a class="reference internal" href="#importlib.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> <li><a class="reference internal" href="#importlib.reload"><code class="docutils literal notranslate">reload()</code></a></li> </ul> </li> <li><a class="reference internal" href="#module-importlib.abc"><code class="xref py py-mod docutils literal notranslate">importlib.abc</code> – Abstract base classes related to import</a><ul> <li><a class="reference internal" href="#importlib.abc.MetaPathFinder"><code class="docutils literal notranslate">MetaPathFinder</code></a><ul> <li><a class="reference internal" href="#importlib.abc.MetaPathFinder.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.abc.MetaPathFinder.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.PathEntryFinder"><code class="docutils literal notranslate">PathEntryFinder</code></a><ul> <li><a class="reference internal" href="#importlib.abc.PathEntryFinder.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.abc.PathEntryFinder.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.Loader"><code class="docutils literal notranslate">Loader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.Loader.create_module"><code class="docutils literal notranslate">create_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Loader.exec_module"><code class="docutils literal notranslate">exec_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Loader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.ResourceLoader"><code class="docutils literal notranslate">ResourceLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.ResourceLoader.get_data"><code class="docutils literal notranslate">get_data()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.InspectLoader"><code class="docutils literal notranslate">InspectLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.InspectLoader.get_code"><code class="docutils literal notranslate">get_code()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.get_source"><code class="docutils literal notranslate">get_source()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.source_to_code"><code class="docutils literal notranslate">source_to_code()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.exec_module"><code class="docutils literal notranslate">exec_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.InspectLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.ExecutionLoader"><code class="docutils literal notranslate">ExecutionLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.ExecutionLoader.get_filename"><code class="docutils literal notranslate">get_filename()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.FileLoader"><code class="docutils literal notranslate">FileLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.FileLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.abc.FileLoader.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.abc.FileLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.FileLoader.get_filename"><code class="docutils literal notranslate">get_filename()</code></a></li> <li><a class="reference internal" href="#importlib.abc.FileLoader.get_data"><code class="docutils literal notranslate">get_data()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.SourceLoader"><code class="docutils literal notranslate">SourceLoader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.SourceLoader.path_stats"><code class="docutils literal notranslate">path_stats()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.path_mtime"><code class="docutils literal notranslate">path_mtime()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.set_data"><code class="docutils literal notranslate">set_data()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.get_code"><code class="docutils literal notranslate">get_code()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.exec_module"><code class="docutils literal notranslate">exec_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.get_source"><code class="docutils literal notranslate">get_source()</code></a></li> <li><a class="reference internal" href="#importlib.abc.SourceLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.ResourceReader"><code class="docutils literal notranslate">ResourceReader</code></a><ul> <li><a class="reference internal" href="#importlib.abc.ResourceReader.open_resource"><code class="docutils literal notranslate">open_resource()</code></a></li> <li><a class="reference internal" href="#importlib.abc.ResourceReader.resource_path"><code class="docutils literal notranslate">resource_path()</code></a></li> <li><a class="reference internal" href="#importlib.abc.ResourceReader.is_resource"><code class="docutils literal notranslate">is_resource()</code></a></li> <li><a class="reference internal" href="#importlib.abc.ResourceReader.contents"><code class="docutils literal notranslate">contents()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.Traversable"><code class="docutils literal notranslate">Traversable</code></a><ul> <li><a class="reference internal" href="#importlib.abc.Traversable.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.iterdir"><code class="docutils literal notranslate">iterdir()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.is_dir"><code class="docutils literal notranslate">is_dir()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.is_file"><code class="docutils literal notranslate">is_file()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.joinpath"><code class="docutils literal notranslate">joinpath()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.__truediv__"><code class="docutils literal notranslate">__truediv__()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.open"><code class="docutils literal notranslate">open()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.read_bytes"><code class="docutils literal notranslate">read_bytes()</code></a></li> <li><a class="reference internal" href="#importlib.abc.Traversable.read_text"><code class="docutils literal notranslate">read_text()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.abc.TraversableResources"><code class="docutils literal notranslate">TraversableResources</code></a><ul> <li><a class="reference internal" href="#importlib.abc.TraversableResources.files"><code class="docutils literal notranslate">files()</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#module-importlib.machinery"><code class="xref py py-mod docutils literal notranslate">importlib.machinery</code> – Importers and path hooks</a><ul> <li><a class="reference internal" href="#importlib.machinery.SOURCE_SUFFIXES"><code class="docutils literal notranslate">SOURCE_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.DEBUG_BYTECODE_SUFFIXES"><code class="docutils literal notranslate">DEBUG_BYTECODE_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES"><code class="docutils literal notranslate">OPTIMIZED_BYTECODE_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.BYTECODE_SUFFIXES"><code class="docutils literal notranslate">BYTECODE_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.EXTENSION_SUFFIXES"><code class="docutils literal notranslate">EXTENSION_SUFFIXES</code></a></li> <li><a class="reference internal" href="#importlib.machinery.all_suffixes"><code class="docutils literal notranslate">all_suffixes()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.BuiltinImporter"><code class="docutils literal notranslate">BuiltinImporter</code></a></li> <li><a class="reference internal" href="#importlib.machinery.FrozenImporter"><code class="docutils literal notranslate">FrozenImporter</code></a></li> <li><a class="reference internal" href="#importlib.machinery.WindowsRegistryFinder"><code class="docutils literal notranslate">WindowsRegistryFinder</code></a></li> <li><a class="reference internal" href="#importlib.machinery.PathFinder"><code class="docutils literal notranslate">PathFinder</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.PathFinder.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.PathFinder.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.FileFinder"><code class="docutils literal notranslate">FileFinder</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.FileFinder.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.machinery.FileFinder.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.FileFinder.invalidate_caches"><code class="docutils literal notranslate">invalidate_caches()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.FileFinder.path_hook"><code class="docutils literal notranslate">path_hook()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader"><code class="docutils literal notranslate">SourceFileLoader</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.path_stats"><code class="docutils literal notranslate">path_stats()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.set_data"><code class="docutils literal notranslate">set_data()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourceFileLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader"><code class="docutils literal notranslate">SourcelessFileLoader</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.get_code"><code class="docutils literal notranslate">get_code()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.get_source"><code class="docutils literal notranslate">get_source()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.SourcelessFileLoader.load_module"><code class="docutils literal notranslate">load_module()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader"><code class="docutils literal notranslate">ExtensionFileLoader</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.path"><code class="docutils literal notranslate">path</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.create_module"><code class="docutils literal notranslate">create_module()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.exec_module"><code class="docutils literal notranslate">exec_module()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.is_package"><code class="docutils literal notranslate">is_package()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.get_code"><code class="docutils literal notranslate">get_code()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.get_source"><code class="docutils literal notranslate">get_source()</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ExtensionFileLoader.get_filename"><code class="docutils literal notranslate">get_filename()</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.NamespaceLoader"><code class="docutils literal notranslate">NamespaceLoader</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec"><code class="docutils literal notranslate">ModuleSpec</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.loader"><code class="docutils literal notranslate">loader</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.origin"><code class="docutils literal notranslate">origin</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.submodule_search_locations"><code class="docutils literal notranslate">submodule_search_locations</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.loader_state"><code class="docutils literal notranslate">loader_state</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.cached"><code class="docutils literal notranslate">cached</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.parent"><code class="docutils literal notranslate">parent</code></a></li> <li><a class="reference internal" href="#importlib.machinery.ModuleSpec.has_location"><code class="docutils literal notranslate">has_location</code></a></li> </ul> </li> <li><a class="reference internal" href="#importlib.machinery.AppleFrameworkLoader"><code class="docutils literal notranslate">AppleFrameworkLoader</code></a><ul> <li><a class="reference internal" href="#importlib.machinery.AppleFrameworkLoader.name"><code class="docutils literal notranslate">name</code></a></li> <li><a class="reference internal" href="#importlib.machinery.AppleFrameworkLoader.path"><code class="docutils literal notranslate">path</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#module-importlib.util"><code class="xref py py-mod docutils literal notranslate">importlib.util</code> – Utility code for importers</a><ul> <li><a class="reference internal" href="#importlib.util.MAGIC_NUMBER"><code class="docutils literal notranslate">MAGIC_NUMBER</code></a></li> <li><a class="reference internal" href="#importlib.util.cache_from_source"><code class="docutils literal notranslate">cache_from_source()</code></a></li> <li><a class="reference internal" href="#importlib.util.source_from_cache"><code class="docutils literal notranslate">source_from_cache()</code></a></li> <li><a class="reference internal" href="#importlib.util.decode_source"><code class="docutils literal notranslate">decode_source()</code></a></li> <li><a class="reference internal" href="#importlib.util.resolve_name"><code class="docutils literal notranslate">resolve_name()</code></a></li> <li><a class="reference internal" href="#importlib.util.find_spec"><code class="docutils literal notranslate">find_spec()</code></a></li> <li><a class="reference internal" href="#importlib.util.module_from_spec"><code class="docutils literal notranslate">module_from_spec()</code></a></li> <li><a class="reference internal" href="#importlib.util.spec_from_loader"><code class="docutils literal notranslate">spec_from_loader()</code></a></li> <li><a class="reference internal" href="#importlib.util.spec_from_file_location"><code class="docutils literal notranslate">spec_from_file_location()</code></a></li> <li><a class="reference internal" href="#importlib.util.source_hash"><code class="docutils literal notranslate">source_hash()</code></a></li> <li><a class="reference internal" href="#importlib.util._incompatible_extension_module_restrictions"><code class="docutils literal notranslate">_incompatible_extension_module_restrictions()</code></a></li> <li><a class="reference internal" href="#importlib.util.LazyLoader"><code class="docutils literal notranslate">LazyLoader</code></a><ul> <li><a class="reference internal" href="#importlib.util.LazyLoader.factory"><code class="docutils literal notranslate">factory()</code></a></li> </ul> </li> </ul> </li> <li><a class="reference internal" href="#examples">Examples</a><ul> <li><a class="reference internal" href="#importing-programmatically">Importing programmatically</a></li> <li><a class="reference internal" href="#checking-if-a-module-can-be-imported">Checking if a module can be imported</a></li> <li><a class="reference internal" href="#importing-a-source-file-directly">Importing a source file directly</a></li> <li><a class="reference internal" href="#implementing-lazy-imports">Implementing lazy imports</a></li> <li><a class="reference internal" href="#setting-up-an-importer">Setting up an importer</a></li> <li><a class="reference internal" href="#approximating-importlib-import-module">Approximating <code class="xref py py-func docutils literal notranslate">importlib.import_module()</code></a></li> </ul> </li> </ul> </li> </ul> </div> <div> <h4>Previous topic</h4> <a href="runpy.html" title="previous chapter"><code class="xref py py-mod docutils literal notranslate">runpy</code> — Locating and executing Python modules</a> </div> <div> <h4>Next topic</h4> <a href="importlib.resources.html" title="next chapter"><code class="xref py py-mod docutils literal notranslate">importlib.resources</code> – Package resource reading, opening and access</a> </div> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li> <a href="https://github.com/python/cpython/blob/main/Doc/library/importlib.rst" rel="nofollow">Show Source </a> </li> </ul> </div> </div> <div id="sidebarbutton" title="Collapse sidebar"> « </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="Related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="importlib.resources.html" title="importlib.resources – Package resource reading, opening and access" >next</a> |</li> <li class="right" > <a href="runpy.html" title="runpy — Locating and executing Python modules" >previous</a> |</li> <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li class="switchers"> <div class="language_switcher_placeholder"></div> <div class="version_switcher_placeholder"></div> </li> <li> </li> <li id="cpython-language-and-version"> <a href="../index.html">3.13.0 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="modules.html" >Importing Modules</a> »</li> <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">importlib</code> — The implementation of <code class="xref std std-keyword docutils literal notranslate">import</code></a></li> <li class="right"> <div class="inline-search" role="search"> <form class="inline-search" action="../search.html" method="get"> <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" /> <input type="submit" value="Go" /> </form> </div> | </li> <li class="right"> <label class="theme-selector-label"> Theme <select class="theme-selector" oninput="activateTheme(this.value)"> <option value="auto" selected>Auto</option> <option value="light">Light</option> <option value="dark">Dark</option> </select> </label> |</li> </ul> </div> <div class="footer"> © <a href="../copyright.html"> Copyright </a> 2001-2024, Python Software Foundation. This page is licensed under the Python Software Foundation License Version 2. Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License. See <a href="/license.html">History and License</a> for more information. The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> Last updated on Nov 24, 2024 (17:50 UTC). <a href="/bugs.html">Found a bug</a>? Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3. </div> <script type="text/javascript" src="../_static/switchers.js"></script> </body> </html>