Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Watch 1
Star 0
Wiki 捐赠
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.
Tree: 0f75e31513
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/importlib.resources.abc.html

498 lines
32KB
Raw Blame History 

  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.abc – Abstract base classes for resources" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/importlib/resources/abc.py" />

  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/abc.py" />

  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.abc – Abstract base classes for resources &#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.metadata – Accessing package metadata" href="importlib.metadata.html" />

  39.     <link rel="prev" title="importlib.resources – Package resource reading, opening and access" href="importlib.resources.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/importlib.resources.abc.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.     <h4>Previous topic</h4>

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

  98.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources</span></code> – Package resource reading, opening and access</a></p>

  99.   </div>

  100.   <div>

  101.     <h4>Next topic</h4>

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

  103.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.metadata</span></code> – Accessing package metadata</a></p>

  104.   </div>

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

  106.     <h3>This Page</h3>

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

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

  109.       <li>

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

  111.             rel="nofollow">Show Source

  112.         </a>

  113.       </li>

  114.     </ul>

  115.   </div>

  116.         </nav>

  117.     </div>

  118. </div>

  119. 

  120.   

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

  122.       <h3>Navigation</h3>

  123.       <ul>

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

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

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

  127.         <li class="right" >

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

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

  130.         <li class="right" >

  131.           <a href="importlib.metadata.html" title="importlib.metadata – Accessing package metadata"

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

  133.         <li class="right" >

  134.           <a href="importlib.resources.html" title="importlib.resources – Package resource reading, opening and access"

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

  136. 

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

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

  139.           <li class="switchers">

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

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

  142.           </li>

  143.           <li>

  144.               

  145.           </li>

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

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

  148.     </li>

  149. 

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

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

  152.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources.abc</span></code> – Abstract base classes for resources</a></li>

  153.                 <li class="right">

  154.                     

  155. 

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

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

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

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

  160.         </form>

  161.     </div>

  162.                      |

  163.                 </li>

  164.             <li class="right">

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

  166.     Theme

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

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

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

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

  171.     </select>

  172. </label> |</li>

  173.             

  174.       </ul>

  175.     </div>    

  176. 

  177.     <div class="document">

  178.       <div class="documentwrapper">

  179.         <div class="bodywrapper">

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

  181.             

  182.   <section id="module-importlib.resources.abc">

  183. <span id="importlib-resources-abc-abstract-base-classes-for-resources"></span><h1><a class="reference internal" href="#module-importlib.resources.abc" title="importlib.resources.abc: Abstract base classes for resources"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources.abc</span></code></a> – Abstract base classes for resources<a class="headerlink" href="#module-importlib.resources.abc" title="Link to this heading">¶</a></h1>

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

  185. <hr class="docutils" />

  186. <div class="versionadded">

  187. <p><span class="versionmodified added">New in version 3.11.</span></p>

  188. </div>

  189. <dl class="py class">

  190. <dt class="sig sig-object py" id="importlib.resources.abc.ResourceReader">

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

  192. <dd><p><em>Superseded by TraversableResources</em></p>

  193. <p>An <a class="reference internal" href="../glossary.html#term-abstract-base-class"><span class="xref std std-term">abstract base class</span></a> to provide the ability to read

  194. <em>resources</em>.</p>

  195. <p>From the perspective of this ABC, a <em>resource</em> is a binary

  196. artifact that is shipped within a package. Typically this is

  197. something like a data file that lives next to the <code class="docutils literal notranslate"><span class="pre">__init__.py</span></code>

  198. file of the package. The purpose of this class is to help abstract

  199. out the accessing of such data files so that it does not matter if

  200. the package and its data file(s) are stored in a e.g. zip file

  201. versus on the file system.</p>

  202. <p>For any of methods of this class, a <em>resource</em> argument is

  203. expected to be a <a class="reference internal" href="../glossary.html#term-path-like-object"><span class="xref std std-term">path-like object</span></a> which represents

  204. conceptually just a file name. This means that no subdirectory

  205. paths should be included in the <em>resource</em> argument. This is

  206. because the location of the package the reader is for, acts as the

  207. “directory”. Hence the metaphor for directories and file

  208. names is packages and resources, respectively. This is also why

  209. instances of this class are expected to directly correlate to

  210. a specific package (instead of potentially representing multiple

  211. packages or a module).</p>

  212. <p>Loaders that wish to support resource reading are expected to

  213. provide a method called <code class="docutils literal notranslate"><span class="pre">get_resource_reader(fullname)</span></code> which

  214. returns an object implementing this ABC’s interface. If the module

  215. specified by fullname is not a package, this method should return

  216. <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate"><span class="pre">None</span></code></a>. An object compatible with this ABC should only be

  217. returned when the specified module is a package.</p>

  218. <div class="deprecated-removed">

  219. <p><span class="versionmodified">Deprecated since version 3.12, will be removed in version 3.14: </span>Use <a class="reference internal" href="#importlib.resources.abc.TraversableResources" title="importlib.resources.abc.TraversableResources"><code class="xref py py-class docutils literal notranslate"><span class="pre">importlib.resources.abc.TraversableResources</span></code></a> instead.</p>

  220. </div>

  221. <dl class="py method">

  222. <dt class="sig sig-object py" id="importlib.resources.abc.ResourceReader.open_resource">

  223. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">open_resource</span></span><span class="sig-paren">(</span><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.abc.ResourceReader.open_resource" title="Link to this definition">¶</a></dt>

  224. <dd><p>Returns an opened, <a class="reference internal" href="../glossary.html#term-file-like-object"><span class="xref std std-term">file-like object</span></a> for binary reading

  225. of the <em>resource</em>.</p>

  226. <p>If the resource cannot be found, <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileNotFoundError</span></code></a> is

  227. raised.</p>

  228. </dd></dl>

  229. 

  230. <dl class="py method">

  231. <dt class="sig sig-object py" id="importlib.resources.abc.ResourceReader.resource_path">

  232. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">resource_path</span></span><span class="sig-paren">(</span><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.abc.ResourceReader.resource_path" title="Link to this definition">¶</a></dt>

  233. <dd><p>Returns the file system path to the <em>resource</em>.</p>

  234. <p>If the resource does not concretely exist on the file system,

  235. raise <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileNotFoundError</span></code></a>.</p>

  236. </dd></dl>

  237. 

  238. <dl class="py method">

  239. <dt class="sig sig-object py" id="importlib.resources.abc.ResourceReader.is_resource">

  240. <em class="property"><span class="pre">abstractmethod</span> </em><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">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.ResourceReader.is_resource" title="Link to this definition">¶</a></dt>

  241. <dd><p>Returns <code class="docutils literal notranslate"><span class="pre">True</span></code> if the named <em>name</em> is considered a resource.

  242. <a class="reference internal" href="exceptions.html#FileNotFoundError" title="FileNotFoundError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">FileNotFoundError</span></code></a> is raised if <em>name</em> does not exist.</p>

  243. </dd></dl>

  244. 

  245. <dl class="py method">

  246. <dt class="sig sig-object py" id="importlib.resources.abc.ResourceReader.contents">

  247. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">contents</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.ResourceReader.contents" title="Link to this definition">¶</a></dt>

  248. <dd><p>Returns an <a class="reference internal" href="../glossary.html#term-iterable"><span class="xref std std-term">iterable</span></a> of strings over the contents of

  249. the package. Do note that it is not required that all names

  250. returned by the iterator be actual resources, e.g. it is

  251. acceptable to return names for which <a class="reference internal" href="#importlib.resources.abc.ResourceReader.is_resource" title="importlib.resources.abc.ResourceReader.is_resource"><code class="xref py py-meth docutils literal notranslate"><span class="pre">is_resource()</span></code></a> would

  252. be false.</p>

  253. <p>Allowing non-resource names to be returned is to allow for

  254. situations where how a package and its resources are stored

  255. are known a priori and the non-resource names would be useful.

  256. For instance, returning subdirectory names is allowed so that

  257. when it is known that the package and resources are stored on

  258. the file system then those subdirectory names can be used

  259. directly.</p>

  260. <p>The abstract method returns an iterable of no items.</p>

  261. </dd></dl>

  262. 

  263. </dd></dl>

  264. 

  265. <dl class="py class">

  266. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable">

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

  268. <dd><p>An object with a subset of <a class="reference internal" href="pathlib.html#pathlib.Path" title="pathlib.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">pathlib.Path</span></code></a> methods suitable for

  269. traversing directories and opening files.</p>

  270. <p>For a representation of the object on the file-system, use

  271. <a class="reference internal" href="importlib.resources.html#importlib.resources.as_file" title="importlib.resources.as_file"><code class="xref py py-meth docutils literal notranslate"><span class="pre">importlib.resources.as_file()</span></code></a>.</p>

  272. <dl class="py attribute">

  273. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable.name">

  274. <span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#importlib.resources.abc.Traversable.name" title="Link to this definition">¶</a></dt>

  275. <dd><p>Abstract. The base name of this object without any parent references.</p>

  276. </dd></dl>

  277. 

  278. <dl class="py method">

  279. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable.iterdir">

  280. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">iterdir</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.Traversable.iterdir" title="Link to this definition">¶</a></dt>

  281. <dd><p>Yield Traversable objects in self.</p>

  282. </dd></dl>

  283. 

  284. <dl class="py method">

  285. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable.is_dir">

  286. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">is_dir</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.Traversable.is_dir" title="Link to this definition">¶</a></dt>

  287. <dd><p>Return True if self is a directory.</p>

  288. </dd></dl>

  289. 

  290. <dl class="py method">

  291. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable.is_file">

  292. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">is_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.Traversable.is_file" title="Link to this definition">¶</a></dt>

  293. <dd><p>Return True if self is a file.</p>

  294. </dd></dl>

  295. 

  296. <dl class="py method">

  297. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable.joinpath">

  298. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">joinpath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">pathsegments</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.Traversable.joinpath" title="Link to this definition">¶</a></dt>

  299. <dd><p>Traverse directories according to <em>pathsegments</em> and return

  300. the result as <code class="xref py py-class docutils literal notranslate"><span class="pre">Traversable</span></code>.</p>

  301. <p>Each <em>pathsegments</em> argument may contain multiple names separated by

  302. forward slashes (<code class="docutils literal notranslate"><span class="pre">/</span></code>, <code class="docutils literal notranslate"><span class="pre">posixpath.sep</span></code> ).

  303. For example, the following are equivalent:</p>

  304. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">files</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s1">&#39;subdir&#39;</span><span class="p">,</span> <span class="s1">&#39;subsuddir&#39;</span><span class="p">,</span> <span class="s1">&#39;file.txt&#39;</span><span class="p">)</span>

  305. <span class="n">files</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s1">&#39;subdir/subsuddir/file.txt&#39;</span><span class="p">)</span>

  306. </pre></div>

  307. </div>

  308. <p>Note that some <code class="xref py py-class docutils literal notranslate"><span class="pre">Traversable</span></code> implementations

  309. might not be updated to the latest version of the protocol.

  310. For compatibility with such implementations, provide a single argument

  311. without path separators to each call to <code class="docutils literal notranslate"><span class="pre">joinpath</span></code>. For example:</p>

  312. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">files</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s1">&#39;subdir&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s1">&#39;subsubdir&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">joinpath</span><span class="p">(</span><span class="s1">&#39;file.txt&#39;</span><span class="p">)</span>

  313. </pre></div>

  314. </div>

  315. <div class="versionchanged">

  316. <p><span class="versionmodified changed">Changed in version 3.11: </span><code class="docutils literal notranslate"><span class="pre">joinpath</span></code> accepts multiple <em>pathsegments</em>, and these segments

  317. may contain forward slashes as path separators.

  318. Previously, only a single <em>child</em> argument was accepted.</p>

  319. </div>

  320. </dd></dl>

  321. 

  322. <dl class="py method">

  323. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable.__truediv__">

  324. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">__truediv__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">child</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.Traversable.__truediv__" title="Link to this definition">¶</a></dt>

  325. <dd><p>Return Traversable child in self.

  326. Equivalent to <code class="docutils literal notranslate"><span class="pre">joinpath(child)</span></code>.</p>

  327. </dd></dl>

  328. 

  329. <dl class="py method">

  330. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable.open">

  331. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">open</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'r'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.Traversable.open" title="Link to this definition">¶</a></dt>

  332. <dd><p><em>mode</em> may be ‘r’ or ‘rb’ to open as text or binary. Return a handle

  333. suitable for reading (same as <a class="reference internal" href="pathlib.html#pathlib.Path.open" title="pathlib.Path.open"><code class="xref py py-attr docutils literal notranslate"><span class="pre">pathlib.Path.open</span></code></a>).</p>

  334. <p>When opening as text, accepts encoding parameters such as those

  335. accepted by <a class="reference internal" href="io.html#io.TextIOWrapper" title="io.TextIOWrapper"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.TextIOWrapper</span></code></a>.</p>

  336. </dd></dl>

  337. 

  338. <dl class="py method">

  339. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable.read_bytes">

  340. <span class="sig-name descname"><span class="pre">read_bytes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.Traversable.read_bytes" title="Link to this definition">¶</a></dt>

  341. <dd><p>Read contents of self as bytes.</p>

  342. </dd></dl>

  343. 

  344. <dl class="py method">

  345. <dt class="sig sig-object py" id="importlib.resources.abc.Traversable.read_text">

  346. <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">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.Traversable.read_text" title="Link to this definition">¶</a></dt>

  347. <dd><p>Read contents of self as text.</p>

  348. </dd></dl>

  349. 

  350. </dd></dl>

  351. 

  352. <dl class="py class">

  353. <dt class="sig sig-object py" id="importlib.resources.abc.TraversableResources">

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

  355. <dd><p>An abstract base class for resource readers capable of serving

  356. the <a class="reference internal" href="importlib.resources.html#importlib.resources.files" title="importlib.resources.files"><code class="xref py py-meth docutils literal notranslate"><span class="pre">importlib.resources.files()</span></code></a> interface. Subclasses

  357. <a class="reference internal" href="#importlib.resources.abc.ResourceReader" title="importlib.resources.abc.ResourceReader"><code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceReader</span></code></a> and provides

  358. concrete implementations of the <code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceReader</span></code>’s

  359. abstract methods. Therefore, any loader supplying

  360. <code class="xref py py-class docutils literal notranslate"><span class="pre">TraversableResources</span></code> also supplies <code class="xref py py-class docutils literal notranslate"><span class="pre">ResourceReader</span></code>.</p>

  361. <p>Loaders that wish to support resource reading are expected to

  362. implement this interface.</p>

  363. <dl class="py method">

  364. <dt class="sig sig-object py" id="importlib.resources.abc.TraversableResources.files">

  365. <em class="property"><span class="pre">abstractmethod</span> </em><span class="sig-name descname"><span class="pre">files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#importlib.resources.abc.TraversableResources.files" title="Link to this definition">¶</a></dt>

  366. <dd><p>Returns a <a class="reference internal" href="#importlib.resources.abc.Traversable" title="importlib.resources.abc.Traversable"><code class="xref py py-class docutils literal notranslate"><span class="pre">importlib.resources.abc.Traversable</span></code></a> object for the loaded

  367. package.</p>

  368. </dd></dl>

  369. 

  370. </dd></dl>

  371. 

  372. </section>

  373. 

  374. 

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

  376.           </div>

  377.         </div>

  378.       </div>

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

  380.         <div class="sphinxsidebarwrapper">

  381.   <div>

  382.     <h4>Previous topic</h4>

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

  384.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources</span></code> – Package resource reading, opening and access</a></p>

  385.   </div>

  386.   <div>

  387.     <h4>Next topic</h4>

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

  389.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.metadata</span></code> – Accessing package metadata</a></p>

  390.   </div>

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

  392.     <h3>This Page</h3>

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

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

  395.       <li>

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

  397.             rel="nofollow">Show Source

  398.         </a>

  399.       </li>

  400.     </ul>

  401.   </div>

  402.         </div>

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

  404. <span>«</span>

  405. </div>

  406. 

  407.       </div>

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

  409.     </div>  

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

  411.       <h3>Navigation</h3>

  412.       <ul>

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

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

  415.              >index</a></li>

  416.         <li class="right" >

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

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

  419.         <li class="right" >

  420.           <a href="importlib.metadata.html" title="importlib.metadata – Accessing package metadata"

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

  422.         <li class="right" >

  423.           <a href="importlib.resources.html" title="importlib.resources – Package resource reading, opening and access"

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

  425. 

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

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

  428.           <li class="switchers">

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

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

  431.           </li>

  432.           <li>

  433.               

  434.           </li>

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

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

  437.     </li>

  438. 

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

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

  441.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib.resources.abc</span></code> – Abstract base classes for resources</a></li>

  442.                 <li class="right">

  443.                     

  444. 

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

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

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

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

  449.         </form>

  450.     </div>

  451.                      |

  452.                 </li>

  453.             <li class="right">

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

  455.     Theme

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

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

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

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

  460.     </select>

  461. </label> |</li>

  462.             

  463.       </ul>

  464.     </div>  

  465.     <div class="footer">

  466.     &copy; 

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

  468.     

  469.     Copyright

  470.     

  471.       </a>

  472.      2001-2024, Python Software Foundation.

  473.     <br />

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

  475.     <br />

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

  477.     <br />

  478.     

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

  480.     

  481.     

  482.     <br />

  483. 

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

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

  486. <br />

  487.     <br />

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

  489.     

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

  491.     

  492.     <br />

  493. 

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

  495.     </div>

  496. 

  497.   </body>

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