Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
보기 1
좋아요 0
위키 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
트리: 0f75e31513
브랜치 태그
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/email.iterators.html

373 lines
21KB
Raw 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="email.iterators: Iterators" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/email/iterators.py Iterating over a message object tree is fairly easy with the Message.walk method. The email.iterators module provides some useful higher level iterations over me..." />

  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/email/iterators.py Iterating over a message object tree is fairly easy with the Message.walk method. The email.iterators module provides some useful higher level iterations over me..." />

  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>email.iterators: Iterators &#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="json — JSON encoder and decoder" href="json.html" />

  39.     <link rel="prev" title="email.utils: Miscellaneous utilities" href="email.utils.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/email.iterators.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="email.utils.html"

  98.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.utils</span></code>: Miscellaneous utilities</a></p>

  99.   </div>

  100.   <div>

  101.     <h4>Next topic</h4>

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

  103.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">json</span></code> — JSON encoder and decoder</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/email.iterators.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="json.html" title="json — JSON encoder and decoder"

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

  133.         <li class="right" >

  134.           <a href="email.utils.html" title="email.utils: Miscellaneous utilities"

  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="netdata.html" >Internet Data Handling</a> &#187;</li>

  152.           <li class="nav-item nav-item-3"><a href="email.html" accesskey="U"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code> — An email and MIME handling package</a> &#187;</li>

  153.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.iterators</span></code>: Iterators</a></li>

  154.                 <li class="right">

  155.                     

  156. 

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

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

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

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

  161.         </form>

  162.     </div>

  163.                      |

  164.                 </li>

  165.             <li class="right">

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

  167.     Theme

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

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

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

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

  172.     </select>

  173. </label> |</li>

  174.             

  175.       </ul>

  176.     </div>    

  177. 

  178.     <div class="document">

  179.       <div class="documentwrapper">

  180.         <div class="bodywrapper">

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

  182.             

  183.   <section id="module-email.iterators">

  184. <span id="email-iterators-iterators"></span><h1><a class="reference internal" href="#module-email.iterators" title="email.iterators: Iterate over a  message object tree."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.iterators</span></code></a>: Iterators<a class="headerlink" href="#module-email.iterators" title="Link to this heading">¶</a></h1>

  185. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/email/iterators.py">Lib/email/iterators.py</a></p>

  186. <hr class="docutils" />

  187. <p>Iterating over a message object tree is fairly easy with the

  188. <a class="reference internal" href="email.compat32-message.html#email.message.Message.walk" title="email.message.Message.walk"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Message.walk</span></code></a> method.  The

  189. <a class="reference internal" href="#module-email.iterators" title="email.iterators: Iterate over a  message object tree."><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.iterators</span></code></a> module provides some useful higher level iterations over

  190. message object trees.</p>

  191. <dl class="py function">

  192. <dt class="sig sig-object py" id="email.iterators.body_line_iterator">

  193. <span class="sig-prename descclassname"><span class="pre">email.iterators.</span></span><span class="sig-name descname"><span class="pre">body_line_iterator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">decode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#email.iterators.body_line_iterator" title="Link to this definition">¶</a></dt>

  194. <dd><p>This iterates over all the payloads in all the subparts of <em>msg</em>, returning the

  195. string payloads line-by-line.  It skips over all the subpart headers, and it

  196. skips over any subpart with a payload that isn’t a Python string.  This is

  197. somewhat equivalent to reading the flat text representation of the message from

  198. a file using <a class="reference internal" href="io.html#io.TextIOBase.readline" title="io.TextIOBase.readline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">readline()</span></code></a>, skipping over all the

  199. intervening headers.</p>

  200. <p>Optional <em>decode</em> is passed through to <a class="reference internal" href="email.compat32-message.html#email.message.Message.get_payload" title="email.message.Message.get_payload"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Message.get_payload</span></code></a>.</p>

  201. </dd></dl>

  202. 

  203. <dl class="py function">

  204. <dt class="sig sig-object py" id="email.iterators.typed_subpart_iterator">

  205. <span class="sig-prename descclassname"><span class="pre">email.iterators.</span></span><span class="sig-name descname"><span class="pre">typed_subpart_iterator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maintype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'text'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subtype</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="#email.iterators.typed_subpart_iterator" title="Link to this definition">¶</a></dt>

  206. <dd><p>This iterates over all the subparts of <em>msg</em>, returning only those subparts that

  207. match the MIME type specified by <em>maintype</em> and <em>subtype</em>.</p>

  208. <p>Note that <em>subtype</em> is optional; if omitted, then subpart MIME type matching is

  209. done only with the main type.  <em>maintype</em> is optional too; it defaults to

  210. <em class="mimetype">text</em>.</p>

  211. <p>Thus, by default <a class="reference internal" href="#email.iterators.typed_subpart_iterator" title="email.iterators.typed_subpart_iterator"><code class="xref py py-func docutils literal notranslate"><span class="pre">typed_subpart_iterator()</span></code></a> returns each subpart that has a

  212. MIME type of <em class="mimetype">text/*</em>.</p>

  213. </dd></dl>

  214. 

  215. <p>The following function has been added as a useful debugging tool.  It should

  216. <em>not</em> be considered part of the supported public interface for the package.</p>

  217. <dl class="py function">

  218. <dt class="sig sig-object py" id="email.iterators._structure">

  219. <span class="sig-prename descclassname"><span class="pre">email.iterators.</span></span><span class="sig-name descname"><span class="pre">_structure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#email.iterators._structure" title="Link to this definition">¶</a></dt>

  220. <dd><p>Prints an indented representation of the content types of the message object

  221. structure.  For example:</p>

  222. <div class="highlight-pycon notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">msg</span> <span class="o">=</span> <span class="n">email</span><span class="o">.</span><span class="n">message_from_file</span><span class="p">(</span><span class="n">somefile</span><span class="p">)</span>

  223. <span class="gp">&gt;&gt;&gt; </span><span class="n">_structure</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>

  224. <span class="go">multipart/mixed</span>

  225. <span class="go">    text/plain</span>

  226. <span class="go">    text/plain</span>

  227. <span class="go">    multipart/digest</span>

  228. <span class="go">        message/rfc822</span>

  229. <span class="go">            text/plain</span>

  230. <span class="go">        message/rfc822</span>

  231. <span class="go">            text/plain</span>

  232. <span class="go">        message/rfc822</span>

  233. <span class="go">            text/plain</span>

  234. <span class="go">        message/rfc822</span>

  235. <span class="go">            text/plain</span>

  236. <span class="go">        message/rfc822</span>

  237. <span class="go">            text/plain</span>

  238. <span class="go">    text/plain</span>

  239. </pre></div>

  240. </div>

  241. <p>Optional <em>fp</em> is a file-like object to print the output to.  It must be

  242. suitable for Python’s <a class="reference internal" href="functions.html#print" title="print"><code class="xref py py-func docutils literal notranslate"><span class="pre">print()</span></code></a> function.  <em>level</em> is used internally.

  243. <em>include_default</em>, if true, prints the default type as well.</p>

  244. </dd></dl>

  245. 

  246. </section>

  247. 

  248. 

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

  250.           </div>

  251.         </div>

  252.       </div>

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

  254.         <div class="sphinxsidebarwrapper">

  255.   <div>

  256.     <h4>Previous topic</h4>

  257.     <p class="topless"><a href="email.utils.html"

  258.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.utils</span></code>: Miscellaneous utilities</a></p>

  259.   </div>

  260.   <div>

  261.     <h4>Next topic</h4>

  262.     <p class="topless"><a href="json.html"

  263.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">json</span></code> — JSON encoder and decoder</a></p>

  264.   </div>

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

  266.     <h3>This Page</h3>

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

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

  269.       <li>

  270.         <a href="https://github.com/python/cpython/blob/main/Doc/library/email.iterators.rst"

  271.             rel="nofollow">Show Source

  272.         </a>

  273.       </li>

  274.     </ul>

  275.   </div>

  276.         </div>

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

  278. <span>«</span>

  279. </div>

  280. 

  281.       </div>

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

  283.     </div>  

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

  285.       <h3>Navigation</h3>

  286.       <ul>

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

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

  289.              >index</a></li>

  290.         <li class="right" >

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

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

  293.         <li class="right" >

  294.           <a href="json.html" title="json — JSON encoder and decoder"

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

  296.         <li class="right" >

  297.           <a href="email.utils.html" title="email.utils: Miscellaneous utilities"

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

  299. 

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

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

  302.           <li class="switchers">

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

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

  305.           </li>

  306.           <li>

  307.               

  308.           </li>

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

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

  311.     </li>

  312. 

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

  314.           <li class="nav-item nav-item-2"><a href="netdata.html" >Internet Data Handling</a> &#187;</li>

  315.           <li class="nav-item nav-item-3"><a href="email.html" ><code class="xref py py-mod docutils literal notranslate"><span class="pre">email</span></code> — An email and MIME handling package</a> &#187;</li>

  316.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">email.iterators</span></code>: Iterators</a></li>

  317.                 <li class="right">

  318.                     

  319. 

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

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

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

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

  324.         </form>

  325.     </div>

  326.                      |

  327.                 </li>

  328.             <li class="right">

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

  330.     Theme

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

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

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

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

  335.     </select>

  336. </label> |</li>

  337.             

  338.       </ul>

  339.     </div>  

  340.     <div class="footer">

  341.     &copy; 

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

  343.     

  344.     Copyright

  345.     

  346.       </a>

  347.      2001-2024, Python Software Foundation.

  348.     <br />

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

  350.     <br />

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

  352.     <br />

  353.     

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

  355.     

  356.     

  357.     <br />

  358. 

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

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

  361. <br />

  362.     <br />

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

  364.     

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

  366.     

  367.     <br />

  368. 

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

  370.     </div>

  371. 

  372.   </body>

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