Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Наблюдаван 1
Харесван 0
Уики 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Клон: master
Клонове Маркери
${ item.name }
Create branch ${ searchTerm }
от 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/importlib.metadata.html

695 lines
52KB
Директен файл Постоянна връзка Blame История 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="importlib.metadata – Accessing package metadata" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/importlib.metadata.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/importlib/metadata/__init__.py importlib.metadata is a library that provides access to the metadata of an installed Distribution Package, such as its entry points or its top-level ..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/importlib/metadata/__init__.py importlib.metadata is a library that provides access to the metadata of an installed Distribution Package, such as its entry points or its top-level ..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>importlib.metadata – Accessing package metadata &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="The initialization of the sys.path module search path" href="sys_path_init.html" />

  39.     <link rel="prev" title="importlib.resources.abc – Abstract base classes for resources" href="importlib.resources.abc.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/importlib.metadata.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <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>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.metadata</span></code> – Accessing package metadata</a><ul>

  99. <li><a class="reference internal" href="#overview">Overview</a></li>

  100. <li><a class="reference internal" href="#functional-api">Functional API</a><ul>

  101. <li><a class="reference internal" href="#entry-points">Entry points</a></li>

  102. <li><a class="reference internal" href="#distribution-metadata">Distribution metadata</a></li>

  103. <li><a class="reference internal" href="#distribution-versions">Distribution versions</a></li>

  104. <li><a class="reference internal" href="#distribution-files">Distribution files</a></li>

  105. <li><a class="reference internal" href="#distribution-requirements">Distribution requirements</a></li>

  106. <li><a class="reference internal" href="#mapping-import-to-distribution-packages">Mapping import to distribution packages</a></li>

  107. </ul>

  108. </li>

  109. <li><a class="reference internal" href="#distributions">Distributions</a></li>

  110. <li><a class="reference internal" href="#distribution-discovery">Distribution Discovery</a></li>

  111. <li><a class="reference internal" href="#extending-the-search-algorithm">Extending the search algorithm</a></li>

  112. </ul>

  113. </li>

  114. </ul>

  115. 

  116.   </div>

  117.   <div>

  118.     <h4>Previous topic</h4>

  119.     <p class="topless"><a href="importlib.resources.abc.html"

  120.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources.abc</span></code> – Abstract base classes for resources</a></p>

  121.   </div>

  122.   <div>

  123.     <h4>Next topic</h4>

  124.     <p class="topless"><a href="sys_path_init.html"

  125.                           title="next chapter">The initialization of the <code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code> module search path</a></p>

  126.   </div>

  127.   <div role="note" aria-label="source link">

  128.     <h3>This Page</h3>

  129.     <ul class="this-page-menu">

  130.       <li><a href="../bugs.html">Report a Bug</a></li>

  131.       <li>

  132.         <a href="https://github.com/python/cpython/blob/main/Doc/library/importlib.metadata.rst"

  133.             rel="nofollow">Show Source

  134.         </a>

  135.       </li>

  136.     </ul>

  137.   </div>

  138.         </nav>

  139.     </div>

  140. </div>

  141. 

  142.   

  143.     <div class="related" role="navigation" aria-label="related navigation">

  144.       <h3>Navigation</h3>

  145.       <ul>

  146.         <li class="right" style="margin-right: 10px">

  147.           <a href="../genindex.html" title="General Index"

  148.              accesskey="I">index</a></li>

  149.         <li class="right" >

  150.           <a href="../py-modindex.html" title="Python Module Index"

  151.              >modules</a> |</li>

  152.         <li class="right" >

  153.           <a href="sys_path_init.html" title="The initialization of the sys.path module search path"

  154.              accesskey="N">next</a> |</li>

  155.         <li class="right" >

  156.           <a href="importlib.resources.abc.html" title="importlib.resources.abc – Abstract base classes for resources"

  157.              accesskey="P">previous</a> |</li>

  158. 

  159.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  160.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  161.           <li class="switchers">

  162.             <div class="language_switcher_placeholder"></div>

  163.             <div class="version_switcher_placeholder"></div>

  164.           </li>

  165.           <li>

  166.               

  167.           </li>

  168.     <li id="cpython-language-and-version">

  169.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  170.     </li>

  171. 

  172.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  173.           <li class="nav-item nav-item-2"><a href="modules.html" accesskey="U">Importing Modules</a> &#187;</li>

  174.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.metadata</span></code> – Accessing package metadata</a></li>

  175.                 <li class="right">

  176.                     

  177. 

  178.     <div class="inline-search" role="search">

  179.         <form class="inline-search" action="../search.html" method="get">

  180.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  181.           <input type="submit" value="Go" />

  182.         </form>

  183.     </div>

  184.                      |

  185.                 </li>

  186.             <li class="right">

  187. <label class="theme-selector-label">

  188.     Theme

  189.     <select class="theme-selector" oninput="activateTheme(this.value)">

  190.         <option value="auto" selected>Auto</option>

  191.         <option value="light">Light</option>

  192.         <option value="dark">Dark</option>

  193.     </select>

  194. </label> |</li>

  195.             

  196.       </ul>

  197.     </div>    

  198. 

  199.     <div class="document">

  200.       <div class="documentwrapper">

  201.         <div class="bodywrapper">

  202.           <div class="body" role="main">

  203.             

  204.   <section id="module-importlib.metadata">

  205. <span id="importlib-metadata-accessing-package-metadata"></span><span id="using"></span><h1><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.metadata</span></code> – Accessing package metadata<a class="headerlink" href="#module-importlib.metadata" title="Link to this heading">¶</a></h1>

  206. <div class="versionadded">

  207. <p><span class="versionmodified added">New in version 3.8.</span></p>

  208. </div>

  209. <div class="versionchanged">

  210. <p><span class="versionmodified changed">Changed in version 3.10: </span><code class="docutils literal notranslate"><span class="pre">importlib.metadata</span></code> is no longer provisional.</p>

  211. </div>

  212. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/importlib/metadata/__init__.py">Lib/importlib/metadata/__init__.py</a></p>

  213. <p><code class="docutils literal notranslate"><span class="pre">importlib.metadata</span></code> is a library that provides access to

  214. the metadata of an installed <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a>,

  215. such as its entry points

  216. or its top-level names (<a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Import-Package">Import Package</a>s, modules, if any).

  217. Built in part on Python’s import system, this library

  218. intends to replace similar functionality in the <a class="reference external" href="https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points">entry point

  219. API</a> and <a class="reference external" href="https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api">metadata API</a> of <code class="docutils literal notranslate"><span class="pre">pkg_resources</span></code>.  Along with

  220. <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"><span class="pre">importlib.resources</span></code></a>,

  221. this package can eliminate the need to use the older and less efficient

  222. <code class="docutils literal notranslate"><span class="pre">pkg_resources</span></code> package.</p>

  223. <p><code class="docutils literal notranslate"><span class="pre">importlib.metadata</span></code> operates on third-party <em>distribution packages</em>

  224. installed into Python’s <code class="docutils literal notranslate"><span class="pre">site-packages</span></code> directory via tools such as

  225. <a class="reference external" href="https://pypi.org/project/pip/">pip</a>.

  226. Specifically, it works with distributions with discoverable

  227. <code class="docutils literal notranslate"><span class="pre">dist-info</span></code> or <code class="docutils literal notranslate"><span class="pre">egg-info</span></code> directories,

  228. and metadata defined by the <a class="reference external" href="https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata">Core metadata specifications</a>.</p>

  229. <div class="admonition important">

  230. <p class="admonition-title">Important</p>

  231. <p>These are <em>not</em> necessarily equivalent to or correspond 1:1 with

  232. the top-level <em>import package</em> names

  233. that can be imported inside Python code.

  234. One <em>distribution package</em> can contain multiple <em>import packages</em>

  235. (and single modules),

  236. and one top-level <em>import package</em>

  237. may map to multiple <em>distribution packages</em>

  238. if it is a namespace package.

  239. You can use <a class="reference internal" href="#package-distributions"><span class="std std-ref">package_distributions()</span></a>

  240. to get a mapping between them.</p>

  241. </div>

  242. <p>By default, distribution metadata can live on the file system

  243. or in zip archives on

  244. <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code></a>.  Through an extension mechanism, the metadata can live almost

  245. anywhere.</p>

  246. <div class="admonition seealso">

  247. <p class="admonition-title">See also</p>

  248. <dl class="simple">

  249. <dt><a class="reference external" href="https://importlib-metadata.readthedocs.io/">https://importlib-metadata.readthedocs.io/</a></dt><dd><p>The documentation for <code class="docutils literal notranslate"><span class="pre">importlib_metadata</span></code>, which supplies a

  250. backport of <code class="docutils literal notranslate"><span class="pre">importlib.metadata</span></code>.

  251. This includes an <a class="reference external" href="https://importlib-metadata.readthedocs.io/en/latest/api.html">API reference</a>

  252. for this module’s classes and functions,

  253. as well as a <a class="reference external" href="https://importlib-metadata.readthedocs.io/en/latest/migration.html">migration guide</a>

  254. for existing users of <code class="docutils literal notranslate"><span class="pre">pkg_resources</span></code>.</p>

  255. </dd>

  256. </dl>

  257. </div>

  258. <section id="overview">

  259. <h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h2>

  260. <p>Let’s say you wanted to get the version string for a

  261. <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a> you’ve installed

  262. using <code class="docutils literal notranslate"><span class="pre">pip</span></code>.  We start by creating a virtual environment and installing

  263. something into it:</p>

  264. <div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>example

  265. <span class="gp">$ </span><span class="nb">source</span><span class="w"> </span>example/bin/activate

  266. <span class="gp gp-VirtualEnv">(example)</span> <span class="gp">$ </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>wheel

  267. </pre></div>

  268. </div>

  269. <p>You can get the version string for <code class="docutils literal notranslate"><span class="pre">wheel</span></code> by running the following:</p>

  270. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="go">(example) $ python</span>

  271. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">importlib.metadata</span> <span class="kn">import</span> <span class="n">version</span>  

  272. <span class="gp">&gt;&gt;&gt; </span><span class="n">version</span><span class="p">(</span><span class="s1">&#39;wheel&#39;</span><span class="p">)</span>  

  273. <span class="go">&#39;0.32.3&#39;</span>

  274. </pre></div>

  275. </div>

  276. <p>You can also get a collection of entry points selectable by properties of the EntryPoint (typically ‘group’ or ‘name’), such as

  277. <code class="docutils literal notranslate"><span class="pre">console_scripts</span></code>, <code class="docutils literal notranslate"><span class="pre">distutils.commands</span></code> and others.  Each group contains a

  278. collection of <a class="reference internal" href="#entry-points"><span class="std std-ref">EntryPoint</span></a> objects.</p>

  279. <p>You can get the <a class="reference internal" href="#metadata"><span class="std std-ref">metadata for a distribution</span></a>:</p>

  280. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">metadata</span><span class="p">(</span><span class="s1">&#39;wheel&#39;</span><span class="p">))</span>  

  281. <span class="go">[&#39;Metadata-Version&#39;, &#39;Name&#39;, &#39;Version&#39;, &#39;Summary&#39;, &#39;Home-page&#39;, &#39;Author&#39;, &#39;Author-email&#39;, &#39;Maintainer&#39;, &#39;Maintainer-email&#39;, &#39;License&#39;, &#39;Project-URL&#39;, &#39;Project-URL&#39;, &#39;Project-URL&#39;, &#39;Keywords&#39;, &#39;Platform&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Classifier&#39;, &#39;Requires-Python&#39;, &#39;Provides-Extra&#39;, &#39;Requires-Dist&#39;, &#39;Requires-Dist&#39;]</span>

  282. </pre></div>

  283. </div>

  284. <p>You can also get a <a class="reference internal" href="#version"><span class="std std-ref">distribution’s version number</span></a>, list its

  285. <a class="reference internal" href="#files"><span class="std std-ref">constituent files</span></a>, and get a list of the distribution’s

  286. <a class="reference internal" href="#requirements"><span class="std std-ref">Distribution requirements</span></a>.</p>

  287. </section>

  288. <section id="functional-api">

  289. <h2>Functional API<a class="headerlink" href="#functional-api" title="Link to this heading">¶</a></h2>

  290. <p>This package provides the following functionality via its public API.</p>

  291. <section id="entry-points">

  292. <span id="id2"></span><h3>Entry points<a class="headerlink" href="#entry-points" title="Link to this heading">¶</a></h3>

  293. <p>The <code class="docutils literal notranslate"><span class="pre">entry_points()</span></code> function returns a collection of entry points.

  294. Entry points are represented by <code class="docutils literal notranslate"><span class="pre">EntryPoint</span></code> instances;

  295. each <code class="docutils literal notranslate"><span class="pre">EntryPoint</span></code> has a <code class="docutils literal notranslate"><span class="pre">.name</span></code>, <code class="docutils literal notranslate"><span class="pre">.group</span></code>, and <code class="docutils literal notranslate"><span class="pre">.value</span></code> attributes and

  296. a <code class="docutils literal notranslate"><span class="pre">.load()</span></code> method to resolve the value.  There are also <code class="docutils literal notranslate"><span class="pre">.module</span></code>,

  297. <code class="docutils literal notranslate"><span class="pre">.attr</span></code>, and <code class="docutils literal notranslate"><span class="pre">.extras</span></code> attributes for getting the components of the

  298. <code class="docutils literal notranslate"><span class="pre">.value</span></code> attribute.</p>

  299. <p>Query all entry points:</p>

  300. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">eps</span> <span class="o">=</span> <span class="n">entry_points</span><span class="p">()</span>  

  301. </pre></div>

  302. </div>

  303. <p>The <code class="docutils literal notranslate"><span class="pre">entry_points()</span></code> function returns an <code class="docutils literal notranslate"><span class="pre">EntryPoints</span></code> object,

  304. a collection of all <code class="docutils literal notranslate"><span class="pre">EntryPoint</span></code> objects with <code class="docutils literal notranslate"><span class="pre">names</span></code> and <code class="docutils literal notranslate"><span class="pre">groups</span></code>

  305. attributes for convenience:</p>

  306. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">sorted</span><span class="p">(</span><span class="n">eps</span><span class="o">.</span><span class="n">groups</span><span class="p">)</span>  

  307. <span class="go">[&#39;console_scripts&#39;, &#39;distutils.commands&#39;, &#39;distutils.setup_keywords&#39;, &#39;egg_info.writers&#39;, &#39;setuptools.installation&#39;]</span>

  308. </pre></div>

  309. </div>

  310. <p><code class="docutils literal notranslate"><span class="pre">EntryPoints</span></code> has a <code class="docutils literal notranslate"><span class="pre">select</span></code> method to select entry points

  311. matching specific properties. Select entry points in the

  312. <code class="docutils literal notranslate"><span class="pre">console_scripts</span></code> group:</p>

  313. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">scripts</span> <span class="o">=</span> <span class="n">eps</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">group</span><span class="o">=</span><span class="s1">&#39;console_scripts&#39;</span><span class="p">)</span>  

  314. </pre></div>

  315. </div>

  316. <p>Equivalently, since <code class="docutils literal notranslate"><span class="pre">entry_points</span></code> passes keyword arguments

  317. through to select:</p>

  318. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">scripts</span> <span class="o">=</span> <span class="n">entry_points</span><span class="p">(</span><span class="n">group</span><span class="o">=</span><span class="s1">&#39;console_scripts&#39;</span><span class="p">)</span>  

  319. </pre></div>

  320. </div>

  321. <p>Pick out a specific script named “wheel” (found in the wheel project):</p>

  322. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="s1">&#39;wheel&#39;</span> <span class="ow">in</span> <span class="n">scripts</span><span class="o">.</span><span class="n">names</span>  

  323. <span class="go">True</span>

  324. <span class="gp">&gt;&gt;&gt; </span><span class="n">wheel</span> <span class="o">=</span> <span class="n">scripts</span><span class="p">[</span><span class="s1">&#39;wheel&#39;</span><span class="p">]</span>  

  325. </pre></div>

  326. </div>

  327. <p>Equivalently, query for that entry point during selection:</p>

  328. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="p">(</span><span class="n">wheel</span><span class="p">,)</span> <span class="o">=</span> <span class="n">entry_points</span><span class="p">(</span><span class="n">group</span><span class="o">=</span><span class="s1">&#39;console_scripts&#39;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">&#39;wheel&#39;</span><span class="p">)</span>  

  329. <span class="gp">&gt;&gt;&gt; </span><span class="p">(</span><span class="n">wheel</span><span class="p">,)</span> <span class="o">=</span> <span class="n">entry_points</span><span class="p">()</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">group</span><span class="o">=</span><span class="s1">&#39;console_scripts&#39;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">&#39;wheel&#39;</span><span class="p">)</span>  

  330. </pre></div>

  331. </div>

  332. <p>Inspect the resolved entry point:</p>

  333. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">wheel</span>  

  334. <span class="go">EntryPoint(name=&#39;wheel&#39;, value=&#39;wheel.cli:main&#39;, group=&#39;console_scripts&#39;)</span>

  335. <span class="gp">&gt;&gt;&gt; </span><span class="n">wheel</span><span class="o">.</span><span class="n">module</span>  

  336. <span class="go">&#39;wheel.cli&#39;</span>

  337. <span class="gp">&gt;&gt;&gt; </span><span class="n">wheel</span><span class="o">.</span><span class="n">attr</span>  

  338. <span class="go">&#39;main&#39;</span>

  339. <span class="gp">&gt;&gt;&gt; </span><span class="n">wheel</span><span class="o">.</span><span class="n">extras</span>  

  340. <span class="go">[]</span>

  341. <span class="gp">&gt;&gt;&gt; </span><span class="n">main</span> <span class="o">=</span> <span class="n">wheel</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>  

  342. <span class="gp">&gt;&gt;&gt; </span><span class="n">main</span>  

  343. <span class="go">&lt;function main at 0x103528488&gt;</span>

  344. </pre></div>

  345. </div>

  346. <p>The <code class="docutils literal notranslate"><span class="pre">group</span></code> and <code class="docutils literal notranslate"><span class="pre">name</span></code> are arbitrary values defined by the package author

  347. and usually a client will wish to resolve all entry points for a particular

  348. group.  Read <a class="reference external" href="https://setuptools.pypa.io/en/latest/userguide/entry_point.html">the setuptools docs</a>

  349. for more information on entry points, their definition, and usage.</p>

  350. <p><em>Compatibility Note</em></p>

  351. <p>The “selectable” entry points were introduced in <code class="docutils literal notranslate"><span class="pre">importlib_metadata</span></code>

  352. 3.6 and Python 3.10. Prior to those changes, <code class="docutils literal notranslate"><span class="pre">entry_points</span></code> accepted

  353. no parameters and always returned a dictionary of entry points, keyed

  354. by group. With <code class="docutils literal notranslate"><span class="pre">importlib_metadata</span></code> 5.0 and Python 3.12,

  355. <code class="docutils literal notranslate"><span class="pre">entry_points</span></code> always returns an <code class="docutils literal notranslate"><span class="pre">EntryPoints</span></code> object. See

  356. <a class="reference external" href="https://pypi.org/project/backports.entry-points-selectable">backports.entry_points_selectable</a>

  357. for compatibility options.</p>

  358. </section>

  359. <section id="distribution-metadata">

  360. <span id="metadata"></span><h3>Distribution metadata<a class="headerlink" href="#distribution-metadata" title="Link to this heading">¶</a></h3>

  361. <p>Every <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a> includes some metadata,

  362. which you can extract using the

  363. <code class="docutils literal notranslate"><span class="pre">metadata()</span></code> function:</p>

  364. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">wheel_metadata</span> <span class="o">=</span> <span class="n">metadata</span><span class="p">(</span><span class="s1">&#39;wheel&#39;</span><span class="p">)</span>  

  365. </pre></div>

  366. </div>

  367. <p>The keys of the returned data structure, a <code class="docutils literal notranslate"><span class="pre">PackageMetadata</span></code>,

  368. name the metadata keywords, and

  369. the values are returned unparsed from the distribution metadata:</p>

  370. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">wheel_metadata</span><span class="p">[</span><span class="s1">&#39;Requires-Python&#39;</span><span class="p">]</span>  

  371. <span class="go">&#39;&gt;=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*&#39;</span>

  372. </pre></div>

  373. </div>

  374. <p><code class="docutils literal notranslate"><span class="pre">PackageMetadata</span></code> also presents a <code class="docutils literal notranslate"><span class="pre">json</span></code> attribute that returns

  375. all the metadata in a JSON-compatible form per <span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-0566/"><strong>PEP 566</strong></a>:</p>

  376. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">wheel_metadata</span><span class="o">.</span><span class="n">json</span><span class="p">[</span><span class="s1">&#39;requires_python&#39;</span><span class="p">]</span>

  377. <span class="go">&#39;&gt;=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*&#39;</span>

  378. </pre></div>

  379. </div>

  380. <div class="admonition note">

  381. <p class="admonition-title">Note</p>

  382. <p>The actual type of the object returned by <code class="docutils literal notranslate"><span class="pre">metadata()</span></code> is an

  383. implementation detail and should be accessed only through the interface

  384. described by the

  385. <a class="reference external" href="https://importlib-metadata.readthedocs.io/en/latest/api.html#importlib_metadata.PackageMetadata">PackageMetadata protocol</a>.</p>

  386. </div>

  387. <div class="versionchanged">

  388. <p><span class="versionmodified changed">Changed in version 3.10: </span>The <code class="docutils literal notranslate"><span class="pre">Description</span></code> is now included in the metadata when presented

  389. through the payload. Line continuation characters have been removed.</p>

  390. <p>The <code class="docutils literal notranslate"><span class="pre">json</span></code> attribute was added.</p>

  391. </div>

  392. </section>

  393. <section id="distribution-versions">

  394. <span id="version"></span><h3>Distribution versions<a class="headerlink" href="#distribution-versions" title="Link to this heading">¶</a></h3>

  395. <p>The <code class="docutils literal notranslate"><span class="pre">version()</span></code> function is the quickest way to get a

  396. <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a>’s version

  397. number, as a string:</p>

  398. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">version</span><span class="p">(</span><span class="s1">&#39;wheel&#39;</span><span class="p">)</span>  

  399. <span class="go">&#39;0.32.3&#39;</span>

  400. </pre></div>

  401. </div>

  402. </section>

  403. <section id="distribution-files">

  404. <span id="files"></span><h3>Distribution files<a class="headerlink" href="#distribution-files" title="Link to this heading">¶</a></h3>

  405. <p>You can also get the full set of files contained within a distribution.  The

  406. <code class="docutils literal notranslate"><span class="pre">files()</span></code> function takes a <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a> name

  407. and returns all of the

  408. files installed by this distribution.  Each file object returned is a

  409. <code class="docutils literal notranslate"><span class="pre">PackagePath</span></code>, a <a class="reference internal" href="pathlib.html#pathlib.PurePath" title="pathlib.PurePath"><code class="xref py py-class docutils literal notranslate"><span class="pre">pathlib.PurePath</span></code></a> derived object with additional <code class="docutils literal notranslate"><span class="pre">dist</span></code>,

  410. <code class="docutils literal notranslate"><span class="pre">size</span></code>, and <code class="docutils literal notranslate"><span class="pre">hash</span></code> properties as indicated by the metadata.  For example:</p>

  411. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">util</span> <span class="o">=</span> <span class="p">[</span><span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">files</span><span class="p">(</span><span class="s1">&#39;wheel&#39;</span><span class="p">)</span> <span class="k">if</span> <span class="s1">&#39;util.py&#39;</span> <span class="ow">in</span> <span class="nb">str</span><span class="p">(</span><span class="n">p</span><span class="p">)][</span><span class="mi">0</span><span class="p">]</span>  

  412. <span class="gp">&gt;&gt;&gt; </span><span class="n">util</span>  

  413. <span class="go">PackagePath(&#39;wheel/util.py&#39;)</span>

  414. <span class="gp">&gt;&gt;&gt; </span><span class="n">util</span><span class="o">.</span><span class="n">size</span>  

  415. <span class="go">859</span>

  416. <span class="gp">&gt;&gt;&gt; </span><span class="n">util</span><span class="o">.</span><span class="n">dist</span>  

  417. <span class="go">&lt;importlib.metadata._hooks.PathDistribution object at 0x101e0cef0&gt;</span>

  418. <span class="gp">&gt;&gt;&gt; </span><span class="n">util</span><span class="o">.</span><span class="n">hash</span>  

  419. <span class="go">&lt;FileHash mode: sha256 value: bYkw5oMccfazVCoYQwKkkemoVyMAFoR34mmKBx8R1NI&gt;</span>

  420. </pre></div>

  421. </div>

  422. <p>Once you have the file, you can also read its contents:</p>

  423. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">util</span><span class="o">.</span><span class="n">read_text</span><span class="p">())</span>  

  424. <span class="go">import base64</span>

  425. <span class="go">import sys</span>

  426. <span class="go">...</span>

  427. <span class="go">def as_bytes(s):</span>

  428. <span class="go">    if isinstance(s, text_type):</span>

  429. <span class="go">        return s.encode(&#39;utf-8&#39;)</span>

  430. <span class="go">    return s</span>

  431. </pre></div>

  432. </div>

  433. <p>You can also use the <code class="docutils literal notranslate"><span class="pre">locate</span></code> method to get a the absolute path to the

  434. file:</p>

  435. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">util</span><span class="o">.</span><span class="n">locate</span><span class="p">()</span>  

  436. <span class="go">PosixPath(&#39;/home/gustav/example/lib/site-packages/wheel/util.py&#39;)</span>

  437. </pre></div>

  438. </div>

  439. <p>In the case where the metadata file listing files

  440. (RECORD or SOURCES.txt) is missing, <code class="docutils literal notranslate"><span class="pre">files()</span></code> will

  441. return <code class="docutils literal notranslate"><span class="pre">None</span></code>. The caller may wish to wrap calls to

  442. <code class="docutils literal notranslate"><span class="pre">files()</span></code> in <a class="reference external" href="https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.always_iterable">always_iterable</a>

  443. or otherwise guard against this condition if the target

  444. distribution is not known to have the metadata present.</p>

  445. </section>

  446. <section id="distribution-requirements">

  447. <span id="requirements"></span><h3>Distribution requirements<a class="headerlink" href="#distribution-requirements" title="Link to this heading">¶</a></h3>

  448. <p>To get the full set of requirements for a <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a>,

  449. use the <code class="docutils literal notranslate"><span class="pre">requires()</span></code>

  450. function:</p>

  451. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">requires</span><span class="p">(</span><span class="s1">&#39;wheel&#39;</span><span class="p">)</span>  

  452. <span class="go">[&quot;pytest (&gt;=3.0.0) ; extra == &#39;test&#39;&quot;, &quot;pytest-cov ; extra == &#39;test&#39;&quot;]</span>

  453. </pre></div>

  454. </div>

  455. </section>

  456. <section id="mapping-import-to-distribution-packages">

  457. <span id="import-distribution-package-mapping"></span><span id="package-distributions"></span><h3>Mapping import to distribution packages<a class="headerlink" href="#mapping-import-to-distribution-packages" title="Link to this heading">¶</a></h3>

  458. <p>A convenience method to resolve the <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a>

  459. name (or names, in the case of a namespace package)

  460. that provide each importable top-level

  461. Python module or <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Import-Package">Import Package</a>:</p>

  462. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">packages_distributions</span><span class="p">()</span>

  463. <span class="go">{&#39;importlib_metadata&#39;: [&#39;importlib-metadata&#39;], &#39;yaml&#39;: [&#39;PyYAML&#39;], &#39;jaraco&#39;: [&#39;jaraco.classes&#39;, &#39;jaraco.functools&#39;], ...}</span>

  464. </pre></div>

  465. </div>

  466. <p>Some editable installs, <a class="reference external" href="https://github.com/pypa/packaging-problems/issues/609">do not supply top-level names</a>, and thus this

  467. function is not reliable with such installs.</p>

  468. <div class="versionadded">

  469. <p><span class="versionmodified added">New in version 3.10.</span></p>

  470. </div>

  471. </section>

  472. </section>

  473. <section id="distributions">

  474. <span id="id9"></span><h2>Distributions<a class="headerlink" href="#distributions" title="Link to this heading">¶</a></h2>

  475. <p>While the above API is the most common and convenient usage, you can get all

  476. of that information from the <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> class.  A <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> is an

  477. abstract object that represents the metadata for

  478. a Python <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a>.  You can

  479. get the <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> instance:</p>

  480. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">importlib.metadata</span> <span class="kn">import</span> <span class="n">distribution</span>  

  481. <span class="gp">&gt;&gt;&gt; </span><span class="n">dist</span> <span class="o">=</span> <span class="n">distribution</span><span class="p">(</span><span class="s1">&#39;wheel&#39;</span><span class="p">)</span>  

  482. </pre></div>

  483. </div>

  484. <p>Thus, an alternative way to get the version number is through the

  485. <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> instance:</p>

  486. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">dist</span><span class="o">.</span><span class="n">version</span>  

  487. <span class="go">&#39;0.32.3&#39;</span>

  488. </pre></div>

  489. </div>

  490. <p>There are all kinds of additional metadata available on the <code class="docutils literal notranslate"><span class="pre">Distribution</span></code>

  491. instance:</p>

  492. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">dist</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;Requires-Python&#39;</span><span class="p">]</span>  

  493. <span class="go">&#39;&gt;=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*&#39;</span>

  494. <span class="gp">&gt;&gt;&gt; </span><span class="n">dist</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;License&#39;</span><span class="p">]</span>  

  495. <span class="go">&#39;MIT&#39;</span>

  496. </pre></div>

  497. </div>

  498. <p>The full set of available metadata is not described here.

  499. See the <a class="reference external" href="https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata">Core metadata specifications</a> for additional details.</p>

  500. </section>

  501. <section id="distribution-discovery">

  502. <h2>Distribution Discovery<a class="headerlink" href="#distribution-discovery" title="Link to this heading">¶</a></h2>

  503. <p>By default, this package provides built-in support for discovery of metadata

  504. for file system and zip file <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a>s.

  505. This metadata finder search defaults to <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>, but varies slightly in how it interprets those values from how other import machinery does. In particular:</p>

  506. <ul class="simple">

  507. <li><p><code class="docutils literal notranslate"><span class="pre">importlib.metadata</span></code> does not honor <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> objects on <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>.</p></li>

  508. <li><p><code class="docutils literal notranslate"><span class="pre">importlib.metadata</span></code> will incidentally honor <a class="reference internal" href="pathlib.html#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">pathlib.Path</span></code></a> objects on <code class="docutils literal notranslate"><span class="pre">sys.path</span></code> even though such values will be ignored for imports.</p></li>

  509. </ul>

  510. </section>

  511. <section id="extending-the-search-algorithm">

  512. <h2>Extending the search algorithm<a class="headerlink" href="#extending-the-search-algorithm" title="Link to this heading">¶</a></h2>

  513. <p>Because <a class="reference external" href="https://packaging.python.org/en/latest/glossary/#term-Distribution-Package">Distribution Package</a> metadata

  514. is not available through <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code></a> searches, or

  515. package loaders directly,

  516. the metadata for a distribution is found through import

  517. system <a class="reference internal" href="../reference/import.html#finders-and-loaders"><span class="std std-ref">finders</span></a>.  To find a distribution package’s metadata,

  518. <code class="docutils literal notranslate"><span class="pre">importlib.metadata</span></code> queries the list of <a class="reference internal" href="../glossary.html#term-meta-path-finder"><span class="xref std std-term">meta path finders</span></a> on

  519. <a class="reference internal" href="sys.html#sys.meta_path" title="sys.meta_path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.meta_path</span></code></a>.</p>

  520. <p>By default <code class="docutils literal notranslate"><span class="pre">importlib.metadata</span></code> installs a finder for distribution packages

  521. found on the file system.

  522. This finder doesn’t actually find any <em>distributions</em>,

  523. but it can find their metadata.</p>

  524. <p>The abstract class <a class="reference internal" href="importlib.html#importlib.abc.MetaPathFinder" title="importlib.abc.MetaPathFinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">importlib.abc.MetaPathFinder</span></code></a> defines the

  525. interface expected of finders by Python’s import system.

  526. <code class="docutils literal notranslate"><span class="pre">importlib.metadata</span></code> extends this protocol by looking for an optional

  527. <code class="docutils literal notranslate"><span class="pre">find_distributions</span></code> callable on the finders from

  528. <a class="reference internal" href="sys.html#sys.meta_path" title="sys.meta_path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.meta_path</span></code></a> and presents this extended interface as the

  529. <code class="docutils literal notranslate"><span class="pre">DistributionFinder</span></code> abstract base class, which defines this abstract

  530. method:</p>

  531. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>

  532. <span class="k">def</span> <span class="nf">find_distributions</span><span class="p">(</span><span class="n">context</span><span class="o">=</span><span class="n">DistributionFinder</span><span class="o">.</span><span class="n">Context</span><span class="p">()):</span>

  533. <span class="w">    </span><span class="sd">&quot;&quot;&quot;Return an iterable of all Distribution instances capable of</span>

  534. <span class="sd">    loading the metadata for packages for the indicated ``context``.</span>

  535. <span class="sd">    &quot;&quot;&quot;</span>

  536. </pre></div>

  537. </div>

  538. <p>The <code class="docutils literal notranslate"><span class="pre">DistributionFinder.Context</span></code> object provides <code class="docutils literal notranslate"><span class="pre">.path</span></code> and <code class="docutils literal notranslate"><span class="pre">.name</span></code>

  539. properties indicating the path to search and name to match and may

  540. supply other relevant context.</p>

  541. <p>What this means in practice is that to support finding distribution package

  542. metadata in locations other than the file system, subclass

  543. <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> and implement the abstract methods. Then from

  544. a custom finder, return instances of this derived <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> in the

  545. <code class="docutils literal notranslate"><span class="pre">find_distributions()</span></code> method.</p>

  546. </section>

  547. </section>

  548. 

  549. 

  550.             <div class="clearer"></div>

  551.           </div>

  552.         </div>

  553.       </div>

  554.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  555.         <div class="sphinxsidebarwrapper">

  556.   <div>

  557.     <h3><a href="../contents.html">Table of Contents</a></h3>

  558.     <ul>

  559. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.metadata</span></code> – Accessing package metadata</a><ul>

  560. <li><a class="reference internal" href="#overview">Overview</a></li>

  561. <li><a class="reference internal" href="#functional-api">Functional API</a><ul>

  562. <li><a class="reference internal" href="#entry-points">Entry points</a></li>

  563. <li><a class="reference internal" href="#distribution-metadata">Distribution metadata</a></li>

  564. <li><a class="reference internal" href="#distribution-versions">Distribution versions</a></li>

  565. <li><a class="reference internal" href="#distribution-files">Distribution files</a></li>

  566. <li><a class="reference internal" href="#distribution-requirements">Distribution requirements</a></li>

  567. <li><a class="reference internal" href="#mapping-import-to-distribution-packages">Mapping import to distribution packages</a></li>

  568. </ul>

  569. </li>

  570. <li><a class="reference internal" href="#distributions">Distributions</a></li>

  571. <li><a class="reference internal" href="#distribution-discovery">Distribution Discovery</a></li>

  572. <li><a class="reference internal" href="#extending-the-search-algorithm">Extending the search algorithm</a></li>

  573. </ul>

  574. </li>

  575. </ul>

  576. 

  577.   </div>

  578.   <div>

  579.     <h4>Previous topic</h4>

  580.     <p class="topless"><a href="importlib.resources.abc.html"

  581.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources.abc</span></code> – Abstract base classes for resources</a></p>

  582.   </div>

  583.   <div>

  584.     <h4>Next topic</h4>

  585.     <p class="topless"><a href="sys_path_init.html"

  586.                           title="next chapter">The initialization of the <code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code> module search path</a></p>

  587.   </div>

  588.   <div role="note" aria-label="source link">

  589.     <h3>This Page</h3>

  590.     <ul class="this-page-menu">

  591.       <li><a href="../bugs.html">Report a Bug</a></li>

  592.       <li>

  593.         <a href="https://github.com/python/cpython/blob/main/Doc/library/importlib.metadata.rst"

  594.             rel="nofollow">Show Source

  595.         </a>

  596.       </li>

  597.     </ul>

  598.   </div>

  599.         </div>

  600. <div id="sidebarbutton" title="Collapse sidebar">

  601. <span>«</span>

  602. </div>

  603. 

  604.       </div>

  605.       <div class="clearer"></div>

  606.     </div>  

  607.     <div class="related" role="navigation" aria-label="related navigation">

  608.       <h3>Navigation</h3>

  609.       <ul>

  610.         <li class="right" style="margin-right: 10px">

  611.           <a href="../genindex.html" title="General Index"

  612.              >index</a></li>

  613.         <li class="right" >

  614.           <a href="../py-modindex.html" title="Python Module Index"

  615.              >modules</a> |</li>

  616.         <li class="right" >

  617.           <a href="sys_path_init.html" title="The initialization of the sys.path module search path"

  618.              >next</a> |</li>

  619.         <li class="right" >

  620.           <a href="importlib.resources.abc.html" title="importlib.resources.abc – Abstract base classes for resources"

  621.              >previous</a> |</li>

  622. 

  623.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  624.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  625.           <li class="switchers">

  626.             <div class="language_switcher_placeholder"></div>

  627.             <div class="version_switcher_placeholder"></div>

  628.           </li>

  629.           <li>

  630.               

  631.           </li>

  632.     <li id="cpython-language-and-version">

  633.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  634.     </li>

  635. 

  636.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  637.           <li class="nav-item nav-item-2"><a href="modules.html" >Importing Modules</a> &#187;</li>

  638.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.metadata</span></code> – Accessing package metadata</a></li>

  639.                 <li class="right">

  640.                     

  641. 

  642.     <div class="inline-search" role="search">

  643.         <form class="inline-search" action="../search.html" method="get">

  644.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  645.           <input type="submit" value="Go" />

  646.         </form>

  647.     </div>

  648.                      |

  649.                 </li>

  650.             <li class="right">

  651. <label class="theme-selector-label">

  652.     Theme

  653.     <select class="theme-selector" oninput="activateTheme(this.value)">

  654.         <option value="auto" selected>Auto</option>

  655.         <option value="light">Light</option>

  656.         <option value="dark">Dark</option>

  657.     </select>

  658. </label> |</li>

  659.             

  660.       </ul>

  661.     </div>  

  662.     <div class="footer">

  663.     &copy; 

  664.       <a href="../copyright.html">

  665.     

  666.     Copyright

  667.     

  668.       </a>

  669.      2001-2024, Python Software Foundation.

  670.     <br />

  671.     This page is licensed under the Python Software Foundation License Version 2.

  672.     <br />

  673.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  674.     <br />

  675.     

  676.       See <a href="/license.html">History and License</a> for more information.<br />

  677.     

  678.     

  679.     <br />

  680. 

  681.     The Python Software Foundation is a non-profit corporation.

  682. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  683. <br />

  684.     <br />

  685.       Last updated on Apr 09, 2024 (13:47 UTC).

  686.     

  687.       <a href="/bugs.html">Found a bug</a>?

  688.     

  689.     <br />

  690. 

  691.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  692.     </div>

  693. 

  694.   </body>

  695. </html>
上海开阖软件有限公司 沪ICP备12045867号-1