Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Следить 1
В избранное 0
Вики 捐赠
gooderp18绿色标准版
Вы не можете выбрать более 25 тем Темы должны начинаться с буквы или цифры, могут содержать дефисы(-) и должны содержать не более 35 символов.
Дерево: 0f75e31513
Ветки Теги
${ item.name }
Создать ветку ${ searchTerm }
из '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/importlib.resources.html

574 lines
42KB
Исходник 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.resources – Package resource reading, opening and access" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/importlib/resources/__init__.py This module leverages Python’s import system to provide access to resources within packages. “Resources” are file-like resources associated with a m..." />

  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/resources/__init__.py This module leverages Python’s import system to provide access to resources within packages. “Resources” are file-like resources associated with a m..." />

  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.resources – Package resource reading, opening and access &#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="importlib.resources.abc – Abstract base classes for resources" href="importlib.resources.abc.html" />

  39.     <link rel="prev" title="importlib — The implementation of import" href="importlib.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/importlib.resources.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.resources</span></code> – Package resource reading, opening and access</a><ul>

  99. <li><a class="reference internal" href="#deprecated-functions">Deprecated functions</a></li>

  100. </ul>

  101. </li>

  102. </ul>

  103. 

  104.   </div>

  105.   <div>

  106.     <h4>Previous topic</h4>

  107.     <p class="topless"><a href="importlib.html"

  108.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code> — The implementation of <code class="xref std std-keyword docutils literal notranslate"><span class="pre">import</span></code></a></p>

  109.   </div>

  110.   <div>

  111.     <h4>Next topic</h4>

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

  113.                           title="next 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>

  114.   </div>

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

  116.     <h3>This Page</h3>

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

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

  119.       <li>

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

  121.             rel="nofollow">Show Source

  122.         </a>

  123.       </li>

  124.     </ul>

  125.   </div>

  126.         </nav>

  127.     </div>

  128. </div>

  129. 

  130.   

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

  132.       <h3>Navigation</h3>

  133.       <ul>

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

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

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

  137.         <li class="right" >

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

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

  140.         <li class="right" >

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

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

  143.         <li class="right" >

  144.           <a href="importlib.html" title="importlib — The implementation of import"

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

  146. 

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

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

  149.           <li class="switchers">

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

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

  152.           </li>

  153.           <li>

  154.               

  155.           </li>

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

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

  158.     </li>

  159. 

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

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

  162.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources</span></code> – Package resource reading, opening and access</a></li>

  163.                 <li class="right">

  164.                     

  165. 

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

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

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

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

  170.         </form>

  171.     </div>

  172.                      |

  173.                 </li>

  174.             <li class="right">

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

  176.     Theme

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

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

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

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

  181.     </select>

  182. </label> |</li>

  183.             

  184.       </ul>

  185.     </div>    

  186. 

  187.     <div class="document">

  188.       <div class="documentwrapper">

  189.         <div class="bodywrapper">

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

  191.             

  192.   <section id="module-importlib.resources">

  193. <span id="importlib-resources-package-resource-reading-opening-and-access"></span><h1><a class="reference internal" href="#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> – Package resource reading, opening and access<a class="headerlink" href="#module-importlib.resources" title="Link to this heading">¶</a></h1>

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

  195. <hr class="docutils" />

  196. <div class="versionadded">

  197. <p><span class="versionmodified added">New in version 3.7.</span></p>

  198. </div>

  199. <p>This module leverages Python’s import system to provide access to <em>resources</em>

  200. within <em>packages</em>.</p>

  201. <p>“Resources” are file-like resources associated with a module or package in

  202. Python. The resources may be contained directly in a package, within a

  203. subdirectory contained in that package, or adjacent to modules outside a

  204. package. Resources may be text or binary. As a result, Python module sources

  205. (.py) of a package and compilation artifacts (pycache) are technically

  206. de-facto resources of that package. In practice, however, resources are

  207. primarily those non-Python artifacts exposed specifically by the package

  208. author.</p>

  209. <p>Resources can be opened or read in either binary or text mode.</p>

  210. <p>Resources are roughly akin to files inside directories, though it’s important

  211. to keep in mind that this is just a metaphor.  Resources and packages <strong>do

  212. not</strong> have to exist as physical files and directories on the file system:

  213. for example, a package and its resources can be imported from a zip file using

  214. <a class="reference internal" href="zipimport.html#module-zipimport" title="zipimport: Support for importing Python modules from ZIP archives."><code class="xref py py-mod docutils literal notranslate"><span class="pre">zipimport</span></code></a>.</p>

  215. <div class="admonition note">

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

  217. <p>This module provides functionality similar to <a class="reference external" href="https://setuptools.readthedocs.io/en/latest/pkg_resources.html">pkg_resources</a> <a class="reference external" href="https://setuptools.readthedocs.io/en/latest/pkg_resources.html#basic-resource-access">Basic

  218. Resource Access</a>

  219. without the performance overhead of that package.  This makes reading

  220. resources included in packages easier, with more stable and consistent

  221. semantics.</p>

  222. <p>The standalone backport of this module provides more information

  223. on <a class="reference external" href="https://importlib-resources.readthedocs.io/en/latest/using.html">using importlib.resources</a> and

  224. <a class="reference external" href="https://importlib-resources.readthedocs.io/en/latest/migration.html">migrating from pkg_resources to importlib.resources</a>.</p>

  225. </div>

  226. <p><a class="reference internal" href="importlib.html#importlib.abc.Loader" title="importlib.abc.Loader"><code class="xref py py-class docutils literal notranslate"><span class="pre">Loaders</span></code></a> that wish to support resource reading should implement a

  227. <code class="docutils literal notranslate"><span class="pre">get_resource_reader(fullname)</span></code> method as specified by

  228. <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"><span class="pre">importlib.resources.abc.ResourceReader</span></code></a>.</p>

  229. <dl class="py class">

  230. <dt class="sig sig-object py" id="importlib.resources.Anchor">

  231. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">Anchor</span></span><a class="headerlink" href="#importlib.resources.Anchor" title="Link to this definition">¶</a></dt>

  232. <dd><p>Represents an anchor for resources, either a <a class="reference internal" href="types.html#types.ModuleType" title="types.ModuleType"><code class="xref py py-class docutils literal notranslate"><span class="pre">module</span> <span class="pre">object</span></code></a> or a module name as a string. Defined as

  233. <code class="docutils literal notranslate"><span class="pre">Union[str,</span> <span class="pre">ModuleType]</span></code>.</p>

  234. </dd></dl>

  235. 

  236. <dl class="py function">

  237. <dt class="sig sig-object py" id="importlib.resources.files">

  238. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">files</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">anchor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#importlib.resources.Anchor" title="importlib.resources.Anchor"><span class="pre">Anchor</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="constants.html#None" title="None"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.files" title="Link to this definition">¶</a></dt>

  239. <dd><p>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"><span class="pre">Traversable</span></code></a> object

  240. representing the resource container (think directory) and its resources

  241. (think files). A Traversable may contain other containers (think

  242. subdirectories).</p>

  243. <p><em>anchor</em> is an optional <a class="reference internal" href="#importlib.resources.Anchor" title="importlib.resources.Anchor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Anchor</span></code></a>. If the anchor is a

  244. package, resources are resolved from that package. If a module,

  245. resources are resolved adjacent to that module (in the same package

  246. or the package root). If the anchor is omitted, the caller’s module

  247. is used.</p>

  248. <div class="versionadded">

  249. <p><span class="versionmodified added">New in version 3.9.</span></p>

  250. </div>

  251. <div class="versionchanged">

  252. <p><span class="versionmodified changed">Changed in version 3.12: </span><em>package</em> parameter was renamed to <em>anchor</em>. <em>anchor</em> can now

  253. be a non-package module and if omitted will default to the caller’s

  254. module. <em>package</em> is still accepted for compatibility but will raise

  255. a <a class="reference internal" href="exceptions.html#DeprecationWarning" title="DeprecationWarning"><code class="xref py py-exc docutils literal notranslate"><span class="pre">DeprecationWarning</span></code></a>. Consider passing the anchor positionally or

  256. using <code class="docutils literal notranslate"><span class="pre">importlib_resources</span> <span class="pre">&gt;=</span> <span class="pre">5.10</span></code> for a compatible interface

  257. on older Pythons.</p>

  258. </div>

  259. </dd></dl>

  260. 

  261. <dl class="py function">

  262. <dt class="sig sig-object py" id="importlib.resources.as_file">

  263. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">as_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">traversable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.as_file" title="Link to this definition">¶</a></dt>

  264. <dd><p>Given 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"><span class="pre">Traversable</span></code></a> object representing

  265. a file or directory, typically from <a class="reference internal" href="#importlib.resources.files" title="importlib.resources.files"><code class="xref py py-func docutils literal notranslate"><span class="pre">importlib.resources.files()</span></code></a>,

  266. return a context manager for use in a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement.

  267. The context manager provides a <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> object.</p>

  268. <p>Exiting the context manager cleans up any temporary file or directory

  269. created when the resource was extracted from e.g. a zip file.</p>

  270. <p>Use <code class="docutils literal notranslate"><span class="pre">as_file</span></code> when the Traversable methods

  271. (<code class="docutils literal notranslate"><span class="pre">read_text</span></code>, etc) are insufficient and an actual file or directory on

  272. the file system is required.</p>

  273. <div class="versionadded">

  274. <p><span class="versionmodified added">New in version 3.9.</span></p>

  275. </div>

  276. <div class="versionchanged">

  277. <p><span class="versionmodified changed">Changed in version 3.12: </span>Added support for <em>traversable</em> representing a directory.</p>

  278. </div>

  279. </dd></dl>

  280. 

  281. <section id="deprecated-functions">

  282. <h2>Deprecated functions<a class="headerlink" href="#deprecated-functions" title="Link to this heading">¶</a></h2>

  283. <p>An older, deprecated set of functions is still available, but is

  284. scheduled for removal in a future version of Python.

  285. The main drawback of these functions is that they do not support

  286. directories: they assume all resources are located directly within a <em>package</em>.</p>

  287. <dl class="py data">

  288. <dt class="sig sig-object py" id="importlib.resources.Package">

  289. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">Package</span></span><a class="headerlink" href="#importlib.resources.Package" title="Link to this definition">¶</a></dt>

  290. <dd><blockquote>

  291. <div><p>Whenever a function accepts a <code class="docutils literal notranslate"><span class="pre">Package</span></code> argument, you can pass in

  292. either a <a class="reference internal" href="types.html#types.ModuleType" title="types.ModuleType"><code class="xref py py-class docutils literal notranslate"><span class="pre">module</span> <span class="pre">object</span></code></a> or a module name

  293. as a string.  You can only pass module objects whose

  294. <code class="docutils literal notranslate"><span class="pre">__spec__.submodule_search_locations</span></code> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  295. <p>The <code class="docutils literal notranslate"><span class="pre">Package</span></code> type is defined as <code class="docutils literal notranslate"><span class="pre">Union[str,</span> <span class="pre">ModuleType]</span></code>.</p>

  296. </div></blockquote>

  297. <div class="deprecated">

  298. <p><span class="versionmodified deprecated">Deprecated since version 3.12.</span></p>

  299. </div>

  300. </dd></dl>

  301. 

  302. <dl class="py data">

  303. <dt class="sig sig-object py" id="importlib.resources.Resource">

  304. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">Resource</span></span><a class="headerlink" href="#importlib.resources.Resource" title="Link to this definition">¶</a></dt>

  305. <dd><p>For <em>resource</em> arguments of the functions below, you can pass in

  306. the name of a resource as a string or

  307. a <a class="reference internal" href="os.html#os.PathLike" title="os.PathLike"><code class="xref py py-class docutils literal notranslate"><span class="pre">path-like</span> <span class="pre">object</span></code></a>.</p>

  308. <p>The <code class="docutils literal notranslate"><span class="pre">Resource</span></code> type is defined as <code class="docutils literal notranslate"><span class="pre">Union[str,</span> <span class="pre">os.PathLike]</span></code>.</p>

  309. </dd></dl>

  310. 

  311. <dl class="py function">

  312. <dt class="sig sig-object py" id="importlib.resources.open_binary">

  313. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">open_binary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.open_binary" title="Link to this definition">¶</a></dt>

  314. <dd><p>Open for binary reading the <em>resource</em> within <em>package</em>.</p>

  315. <p><em>package</em> is either a name or a module object which conforms to the

  316. <code class="docutils literal notranslate"><span class="pre">Package</span></code> requirements.  <em>resource</em> is the name of the resource to open

  317. within <em>package</em>; it may not contain path separators and it may not have

  318. sub-resources (i.e. it cannot be a directory).  This function returns a

  319. <code class="docutils literal notranslate"><span class="pre">typing.BinaryIO</span></code> instance, a binary I/O stream open for reading.</p>

  320. <div class="deprecated">

  321. <p><span class="versionmodified deprecated">Deprecated since version 3.11: </span>Calls to this function can be replaced by:</p>

  322. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">files</span><span class="p">(</span><span class="n">package</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="n">resource</span><span class="p">)</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;rb&#39;</span><span class="p">)</span>

  323. </pre></div>

  324. </div>

  325. </div>

  326. </dd></dl>

  327. 

  328. <dl class="py function">

  329. <dt class="sig sig-object py" id="importlib.resources.open_text">

  330. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">open_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf-8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strict'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.open_text" title="Link to this definition">¶</a></dt>

  331. <dd><p>Open for text reading the <em>resource</em> within <em>package</em>.  By default, the

  332. resource is opened for reading as UTF-8.</p>

  333. <p><em>package</em> is either a name or a module object which conforms to the

  334. <code class="docutils literal notranslate"><span class="pre">Package</span></code> requirements.  <em>resource</em> is the name of the resource to open

  335. within <em>package</em>; it may not contain path separators and it may not have

  336. sub-resources (i.e. it cannot be a directory).  <em>encoding</em> and <em>errors</em>

  337. have the same meaning as with built-in <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>.</p>

  338. <p>This function returns a <code class="docutils literal notranslate"><span class="pre">typing.TextIO</span></code> instance, a text I/O stream open

  339. for reading.</p>

  340. <div class="deprecated">

  341. <p><span class="versionmodified deprecated">Deprecated since version 3.11: </span>Calls to this function can be replaced by:</p>

  342. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">files</span><span class="p">(</span><span class="n">package</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="n">resource</span><span class="p">)</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s1">&#39;r&#39;</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="n">encoding</span><span class="p">)</span>

  343. </pre></div>

  344. </div>

  345. </div>

  346. </dd></dl>

  347. 

  348. <dl class="py function">

  349. <dt class="sig sig-object py" id="importlib.resources.read_binary">

  350. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">read_binary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.read_binary" title="Link to this definition">¶</a></dt>

  351. <dd><p>Read and return the contents of the <em>resource</em> within <em>package</em> as

  352. <code class="docutils literal notranslate"><span class="pre">bytes</span></code>.</p>

  353. <p><em>package</em> is either a name or a module object which conforms to the

  354. <code class="docutils literal notranslate"><span class="pre">Package</span></code> requirements.  <em>resource</em> is the name of the resource to open

  355. within <em>package</em>; it may not contain path separators and it may not have

  356. sub-resources (i.e. it cannot be a directory).  This function returns the

  357. contents of the resource as <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>.</p>

  358. <div class="deprecated">

  359. <p><span class="versionmodified deprecated">Deprecated since version 3.11: </span>Calls to this function can be replaced by:</p>

  360. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">files</span><span class="p">(</span><span class="n">package</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="n">resource</span><span class="p">)</span><span class="o">.</span><span class="n">read_bytes</span><span class="p">()</span>

  361. </pre></div>

  362. </div>

  363. </div>

  364. </dd></dl>

  365. 

  366. <dl class="py function">

  367. <dt class="sig sig-object py" id="importlib.resources.read_text">

  368. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">read_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'utf-8'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strict'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.read_text" title="Link to this definition">¶</a></dt>

  369. <dd><p>Read and return the contents of <em>resource</em> within <em>package</em> as a <code class="docutils literal notranslate"><span class="pre">str</span></code>.

  370. By default, the contents are read as strict UTF-8.</p>

  371. <p><em>package</em> is either a name or a module object which conforms to the

  372. <code class="docutils literal notranslate"><span class="pre">Package</span></code> requirements.  <em>resource</em> is the name of the resource to open

  373. within <em>package</em>; it may not contain path separators and it may not have

  374. sub-resources (i.e. it cannot be a directory).  <em>encoding</em> and <em>errors</em>

  375. have the same meaning as with built-in <a class="reference internal" href="functions.html#open" title="open"><code class="xref py py-func docutils literal notranslate"><span class="pre">open()</span></code></a>.  This function

  376. returns the contents of the resource as <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>.</p>

  377. <div class="deprecated">

  378. <p><span class="versionmodified deprecated">Deprecated since version 3.11: </span>Calls to this function can be replaced by:</p>

  379. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">files</span><span class="p">(</span><span class="n">package</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="n">resource</span><span class="p">)</span><span class="o">.</span><span class="n">read_text</span><span class="p">(</span><span class="n">encoding</span><span class="o">=</span><span class="n">encoding</span><span class="p">)</span>

  380. </pre></div>

  381. </div>

  382. </div>

  383. </dd></dl>

  384. 

  385. <dl class="py function">

  386. <dt class="sig sig-object py" id="importlib.resources.path">

  387. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.path" title="Link to this definition">¶</a></dt>

  388. <dd><p>Return the path to the <em>resource</em> as an actual file system path.  This

  389. function returns a context manager for use in a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate"><span class="pre">with</span></code></a> statement.

  390. The context manager provides a <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> object.</p>

  391. <p>Exiting the context manager cleans up any temporary file created when the

  392. resource needs to be extracted from e.g. a zip file.</p>

  393. <p><em>package</em> is either a name or a module object which conforms to the

  394. <code class="docutils literal notranslate"><span class="pre">Package</span></code> requirements.  <em>resource</em> is the name of the resource to open

  395. within <em>package</em>; it may not contain path separators and it may not have

  396. sub-resources (i.e. it cannot be a directory).</p>

  397. <div class="deprecated">

  398. <p><span class="versionmodified deprecated">Deprecated since version 3.11: </span>Calls to this function can be replaced using <a class="reference internal" href="#importlib.resources.as_file" title="importlib.resources.as_file"><code class="xref py py-func docutils literal notranslate"><span class="pre">as_file()</span></code></a>:</p>

  399. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">as_file</span><span class="p">(</span><span class="n">files</span><span class="p">(</span><span class="n">package</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="n">resource</span><span class="p">))</span>

  400. </pre></div>

  401. </div>

  402. </div>

  403. </dd></dl>

  404. 

  405. <dl class="py function">

  406. <dt class="sig sig-object py" id="importlib.resources.is_resource">

  407. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">is_resource</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.is_resource" title="Link to this definition">¶</a></dt>

  408. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if there is a resource named <em>name</em> in the package,

  409. otherwise <code class="docutils literal notranslate"><span class="pre">False</span></code>.

  410. This function does not consider directories to be resources.

  411. <em>package</em> is either a name or a module object which conforms to the

  412. <code class="docutils literal notranslate"><span class="pre">Package</span></code> requirements.</p>

  413. <div class="deprecated">

  414. <p><span class="versionmodified deprecated">Deprecated since version 3.11: </span>Calls to this function can be replaced by:</p>

  415. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">files</span><span class="p">(</span><span class="n">package</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="n">resource</span><span class="p">)</span><span class="o">.</span><span class="n">is_file</span><span class="p">()</span>

  416. </pre></div>

  417. </div>

  418. </div>

  419. </dd></dl>

  420. 

  421. <dl class="py function">

  422. <dt class="sig sig-object py" id="importlib.resources.contents">

  423. <span class="sig-prename descclassname"><span class="pre">importlib.resources.</span></span><span class="sig-name descname"><span class="pre">contents</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">package</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.contents" title="Link to this definition">¶</a></dt>

  424. <dd><p>Return an iterable over the named items within the package.  The iterable

  425. returns <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> resources (e.g. files) and non-resources

  426. (e.g. directories).  The iterable does not recurse into subdirectories.</p>

  427. <p><em>package</em> is either a name or a module object which conforms to the

  428. <code class="docutils literal notranslate"><span class="pre">Package</span></code> requirements.</p>

  429. <div class="deprecated">

  430. <p><span class="versionmodified deprecated">Deprecated since version 3.11: </span>Calls to this function can be replaced by:</p>

  431. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">resource</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">resource</span> <span class="ow">in</span> <span class="n">files</span><span class="p">(</span><span class="n">package</span><span class="p">)</span><span class="o">.</span><span class="n">iterdir</span><span class="p">()</span> <span class="k">if</span> <span class="n">resource</span><span class="o">.</span><span class="n">is_file</span><span class="p">())</span>

  432. </pre></div>

  433. </div>

  434. </div>

  435. </dd></dl>

  436. 

  437. </section>

  438. </section>

  439. 

  440. 

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

  442.           </div>

  443.         </div>

  444.       </div>

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

  446.         <div class="sphinxsidebarwrapper">

  447.   <div>

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

  449.     <ul>

  450. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources</span></code> – Package resource reading, opening and access</a><ul>

  451. <li><a class="reference internal" href="#deprecated-functions">Deprecated functions</a></li>

  452. </ul>

  453. </li>

  454. </ul>

  455. 

  456.   </div>

  457.   <div>

  458.     <h4>Previous topic</h4>

  459.     <p class="topless"><a href="importlib.html"

  460.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code> — The implementation of <code class="xref std std-keyword docutils literal notranslate"><span class="pre">import</span></code></a></p>

  461.   </div>

  462.   <div>

  463.     <h4>Next topic</h4>

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

  465.                           title="next 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>

  466.   </div>

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

  468.     <h3>This Page</h3>

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

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

  471.       <li>

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

  473.             rel="nofollow">Show Source

  474.         </a>

  475.       </li>

  476.     </ul>

  477.   </div>

  478.         </div>

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

  480. <span>«</span>

  481. </div>

  482. 

  483.       </div>

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

  485.     </div>  

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

  487.       <h3>Navigation</h3>

  488.       <ul>

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

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

  491.              >index</a></li>

  492.         <li class="right" >

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

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

  495.         <li class="right" >

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

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

  498.         <li class="right" >

  499.           <a href="importlib.html" title="importlib — The implementation of import"

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

  501. 

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

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

  504.           <li class="switchers">

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

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

  507.           </li>

  508.           <li>

  509.               

  510.           </li>

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

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

  513.     </li>

  514. 

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

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

  517.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources</span></code> – Package resource reading, opening and access</a></li>

  518.                 <li class="right">

  519.                     

  520. 

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

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

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

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

  525.         </form>

  526.     </div>

  527.                      |

  528.                 </li>

  529.             <li class="right">

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

  531.     Theme

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

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

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

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

  536.     </select>

  537. </label> |</li>

  538.             

  539.       </ul>

  540.     </div>  

  541.     <div class="footer">

  542.     &copy; 

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

  544.     

  545.     Copyright

  546.     

  547.       </a>

  548.      2001-2024, Python Software Foundation.

  549.     <br />

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

  551.     <br />

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

  553.     <br />

  554.     

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

  556.     

  557.     

  558.     <br />

  559. 

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

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

  562. <br />

  563.     <br />

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

  565.     

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

  567.     

  568.     <br />

  569. 

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

  571.     </div>

  572. 

  573.   </body>

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