Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-18 13:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/_modules/importlib.html
Evennia docbuilder action 243d596662 Updated HTML docs.
2025-08-15 18:14:21 +00:00

267 lines
No EOL
21 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>importlib &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head><body>
<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="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">importlib</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for importlib</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;A pure Python implementation of import.&quot;&quot;&quot;</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;__import__&#39;</span><span class="p">,</span> <span class="s1">&#39;import_module&#39;</span><span class="p">,</span> <span class="s1">&#39;invalidate_caches&#39;</span><span class="p">,</span> <span class="s1">&#39;reload&#39;</span><span class="p">]</span>
<span class="c1"># Bootstrap help #####################################################</span>
<span class="c1"># Until bootstrapping is complete, DO NOT import any modules that attempt</span>
<span class="c1"># to import importlib._bootstrap (directly or indirectly). Since this</span>
<span class="c1"># partially initialised package would be present in sys.modules, those</span>
<span class="c1"># modules would get an uninitialised copy of the source version, instead</span>
<span class="c1"># of a fully initialised version (either the frozen one or the one</span>
<span class="c1"># initialised below if the frozen one is not available).</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">_imp</span> <span class="c1"># Just the builtin component, NOT the full Python module</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">sys</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">_frozen_importlib</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">_bootstrap</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">_bootstrap</span>
<span class="n">_bootstrap</span><span class="o">.</span><span class="n">_setup</span><span class="p">(</span><span class="n">sys</span><span class="p">,</span> <span class="n">_imp</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># importlib._bootstrap is the built-in import, ensure we don&#39;t create</span>
<span class="c1"># a second copy of the module.</span>
<span class="n">_bootstrap</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">=</span> <span class="s1">&#39;importlib._bootstrap&#39;</span>
<span class="n">_bootstrap</span><span class="o">.</span><span class="n">__package__</span> <span class="o">=</span> <span class="s1">&#39;importlib&#39;</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">_bootstrap</span><span class="o">.</span><span class="vm">__file__</span> <span class="o">=</span> <span class="vm">__file__</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;__init__.py&#39;</span><span class="p">,</span> <span class="s1">&#39;_bootstrap.py&#39;</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
<span class="c1"># __file__ is not guaranteed to be defined, e.g. if this code gets</span>
<span class="c1"># frozen by a tool like cx_Freeze.</span>
<span class="k">pass</span>
<span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s1">&#39;importlib._bootstrap&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_bootstrap</span>
<span class="k">try</span><span class="p">:</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">_frozen_importlib_external</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">_bootstrap_external</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">.</span><span class="w"> </span><span class="kn">import</span> <span class="n">_bootstrap_external</span>
<span class="n">_bootstrap_external</span><span class="o">.</span><span class="n">_set_bootstrap_module</span><span class="p">(</span><span class="n">_bootstrap</span><span class="p">)</span>
<span class="n">_bootstrap</span><span class="o">.</span><span class="n">_bootstrap_external</span> <span class="o">=</span> <span class="n">_bootstrap_external</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">_bootstrap_external</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">=</span> <span class="s1">&#39;importlib._bootstrap_external&#39;</span>
<span class="n">_bootstrap_external</span><span class="o">.</span><span class="n">__package__</span> <span class="o">=</span> <span class="s1">&#39;importlib&#39;</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">_bootstrap_external</span><span class="o">.</span><span class="vm">__file__</span> <span class="o">=</span> <span class="vm">__file__</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;__init__.py&#39;</span><span class="p">,</span> <span class="s1">&#39;_bootstrap_external.py&#39;</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">NameError</span><span class="p">:</span>
<span class="c1"># __file__ is not guaranteed to be defined, e.g. if this code gets</span>
<span class="c1"># frozen by a tool like cx_Freeze.</span>
<span class="k">pass</span>
<span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="s1">&#39;importlib._bootstrap_external&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">_bootstrap_external</span>
<span class="c1"># To simplify imports in test code</span>
<span class="n">_pack_uint32</span> <span class="o">=</span> <span class="n">_bootstrap_external</span><span class="o">.</span><span class="n">_pack_uint32</span>
<span class="n">_unpack_uint32</span> <span class="o">=</span> <span class="n">_bootstrap_external</span><span class="o">.</span><span class="n">_unpack_uint32</span>
<span class="c1"># Fully bootstrapped at this point, import whatever you like, circular</span>
<span class="c1"># dependencies and startup overhead minimisation permitting :)</span>
<span class="c1"># Public API #########################################################</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">._bootstrap</span><span class="w"> </span><span class="kn">import</span> <span class="nb">__import__</span>
<span class="k">def</span><span class="w"> </span><span class="nf">invalidate_caches</span><span class="p">():</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Call the invalidate_caches() method on all meta path finders stored in</span>
<span class="sd"> sys.meta_path (where implemented).&quot;&quot;&quot;</span>
<span class="k">for</span> <span class="n">finder</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">meta_path</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">finder</span><span class="p">,</span> <span class="s1">&#39;invalidate_caches&#39;</span><span class="p">):</span>
<span class="n">finder</span><span class="o">.</span><span class="n">invalidate_caches</span><span class="p">()</span>
<div class="viewcode-block" id="import_module">
<a class="viewcode-back" href="../api/evennia.commands.cmdsethandler.html#evennia.commands.cmdsethandler.import_module">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">import_module</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">package</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Import a module.</span>
<span class="sd"> The &#39;package&#39; argument is required when performing a relative import. It</span>
<span class="sd"> specifies the package to use as the anchor point from which to resolve the</span>
<span class="sd"> relative import to an absolute import.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">level</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">name</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">package</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;the &#39;package&#39; argument is required to perform a &quot;</span>
<span class="sa">f</span><span class="s2">&quot;relative import for </span><span class="si">{</span><span class="n">name</span><span class="si">!r}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">for</span> <span class="n">character</span> <span class="ow">in</span> <span class="n">name</span><span class="p">:</span>
<span class="k">if</span> <span class="n">character</span> <span class="o">!=</span> <span class="s1">&#39;.&#39;</span><span class="p">:</span>
<span class="k">break</span>
<span class="n">level</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="n">_bootstrap</span><span class="o">.</span><span class="n">_gcd_import</span><span class="p">(</span><span class="n">name</span><span class="p">[</span><span class="n">level</span><span class="p">:],</span> <span class="n">package</span><span class="p">,</span> <span class="n">level</span><span class="p">)</span></div>
<span class="n">_RELOADING</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">def</span><span class="w"> </span><span class="nf">reload</span><span class="p">(</span><span class="n">module</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Reload the module and return it.</span>
<span class="sd"> The module must have been successfully imported before.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">module</span><span class="o">.</span><span class="n">__spec__</span><span class="o">.</span><span class="n">name</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">module</span><span class="o">.</span><span class="vm">__name__</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;reload() argument must be a module&quot;</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">module</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;module </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> not in sys.modules&quot;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">_RELOADING</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_RELOADING</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="n">_RELOADING</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">module</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">parent_name</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">rpartition</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="n">parent_name</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">parent</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">parent_name</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;parent </span><span class="si">{</span><span class="n">parent_name</span><span class="si">!r}</span><span class="s2"> not in sys.modules&quot;</span><span class="p">,</span>
<span class="n">name</span><span class="o">=</span><span class="n">parent_name</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">pkgpath</span> <span class="o">=</span> <span class="n">parent</span><span class="o">.</span><span class="n">__path__</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">pkgpath</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">target</span> <span class="o">=</span> <span class="n">module</span>
<span class="n">spec</span> <span class="o">=</span> <span class="n">module</span><span class="o">.</span><span class="n">__spec__</span> <span class="o">=</span> <span class="n">_bootstrap</span><span class="o">.</span><span class="n">_find_spec</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">pkgpath</span><span class="p">,</span> <span class="n">target</span><span class="p">)</span>
<span class="k">if</span> <span class="n">spec</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ModuleNotFoundError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;spec not found for the module </span><span class="si">{</span><span class="n">name</span><span class="si">!r}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
<span class="n">_bootstrap</span><span class="o">.</span><span class="n">_exec</span><span class="p">(</span><span class="n">spec</span><span class="p">,</span> <span class="n">module</span><span class="p">)</span>
<span class="c1"># The module may have replaced itself in sys.modules!</span>
<span class="k">return</span> <span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">finally</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">del</span> <span class="n">_RELOADING</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">pass</span>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</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="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">importlib</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink