Edit File: multifile.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>18.10. multifile — Support for files containing distinct parts — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="18. Internet Data Handling" href="netdata.html" /> <link rel="next" title="18.11. rfc822 — Parse RFC 2822 mail headers" href="rfc822.html" /> <link rel="prev" title="18.9. mimify — MIME processing of mail messages" href="mimify.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="rfc822.html" title="18.11. rfc822 — Parse RFC 2822 mail headers" accesskey="N">next</a> |</li> <li class="right" > <a href="mimify.html" title="18.9. mimify — MIME processing of mail messages" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="netdata.html" accesskey="U">18. Internet Data Handling</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-multifile"> <span id="multifile-support-for-files-containing-distinct-parts"></span><h1>18.10. <a class="reference internal" href="#module-multifile" title="multifile: Support for reading files which contain distinct parts, such as some MIME data. (deprecated)"><tt class="xref py py-mod docutils literal"><span class="pre">multifile</span></tt></a> — Support for files containing distinct parts<a class="headerlink" href="#module-multifile" title="Permalink to this headline">¶</a></h1> <p class="deprecated"> <span class="versionmodified">Deprecated since version 2.5: </span>The <a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages, including MIME documents."><tt class="xref py py-mod docutils literal"><span class="pre">email</span></tt></a> package should be used in preference to the <a class="reference internal" href="#module-multifile" title="multifile: Support for reading files which contain distinct parts, such as some MIME data. (deprecated)"><tt class="xref py py-mod docutils literal"><span class="pre">multifile</span></tt></a> module. This module is present only to maintain backward compatibility.</p> <p>The <a class="reference internal" href="#multifile.MultiFile" title="multifile.MultiFile"><tt class="xref py py-class docutils literal"><span class="pre">MultiFile</span></tt></a> object enables you to treat sections of a text file as file-like input objects, with <tt class="docutils literal"><span class="pre">''</span></tt> being returned by <a class="reference internal" href="readline.html#module-readline" title="readline: GNU readline support for Python. (Unix)"><tt class="xref py py-meth docutils literal"><span class="pre">readline()</span></tt></a> when a given delimiter pattern is encountered. The defaults of this class are designed to make it useful for parsing MIME multipart messages, but by subclassing it and overriding methods it can be easily adapted for more general use.</p> <dl class="class"> <dt id="multifile.MultiFile"> <em class="property">class </em><tt class="descclassname">multifile.</tt><tt class="descname">MultiFile</tt><big>(</big><em>fp</em><span class="optional">[</span>, <em>seekable</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#multifile.MultiFile" title="Permalink to this definition">¶</a></dt> <dd><p>Create a multi-file. You must instantiate this class with an input object argument for the <a class="reference internal" href="#multifile.MultiFile" title="multifile.MultiFile"><tt class="xref py py-class docutils literal"><span class="pre">MultiFile</span></tt></a> instance to get lines from, such as a file object returned by <a class="reference internal" href="functions.html#open" title="open"><tt class="xref py py-func docutils literal"><span class="pre">open()</span></tt></a>.</p> <p><a class="reference internal" href="#multifile.MultiFile" title="multifile.MultiFile"><tt class="xref py py-class docutils literal"><span class="pre">MultiFile</span></tt></a> only ever looks at the input object’s <a class="reference internal" href="readline.html#module-readline" title="readline: GNU readline support for Python. (Unix)"><tt class="xref py py-meth docutils literal"><span class="pre">readline()</span></tt></a>, <a class="reference internal" href="#multifile.MultiFile.seek" title="multifile.MultiFile.seek"><tt class="xref py py-meth docutils literal"><span class="pre">seek()</span></tt></a> and <a class="reference internal" href="#multifile.MultiFile.tell" title="multifile.MultiFile.tell"><tt class="xref py py-meth docutils literal"><span class="pre">tell()</span></tt></a> methods, and the latter two are only needed if you want random access to the individual MIME parts. To use <a class="reference internal" href="#multifile.MultiFile" title="multifile.MultiFile"><tt class="xref py py-class docutils literal"><span class="pre">MultiFile</span></tt></a> on a non-seekable stream object, set the optional <em>seekable</em> argument to false; this will prevent using the input object’s <a class="reference internal" href="#multifile.MultiFile.seek" title="multifile.MultiFile.seek"><tt class="xref py py-meth docutils literal"><span class="pre">seek()</span></tt></a> and <a class="reference internal" href="#multifile.MultiFile.tell" title="multifile.MultiFile.tell"><tt class="xref py py-meth docutils literal"><span class="pre">tell()</span></tt></a> methods.</p> </dd></dl> <p>It will be useful to know that in <a class="reference internal" href="#multifile.MultiFile" title="multifile.MultiFile"><tt class="xref py py-class docutils literal"><span class="pre">MultiFile</span></tt></a>‘s view of the world, text is composed of three kinds of lines: data, section-dividers, and end-markers. MultiFile is designed to support parsing of messages that may have multiple nested message parts, each with its own pattern for section-divider and end-marker lines.</p> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <dl class="last docutils"> <dt>Module <a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages, including MIME documents."><tt class="xref py py-mod docutils literal"><span class="pre">email</span></tt></a></dt> <dd>Comprehensive email handling package; supersedes the <a class="reference internal" href="#module-multifile" title="multifile: Support for reading files which contain distinct parts, such as some MIME data. (deprecated)"><tt class="xref py py-mod docutils literal"><span class="pre">multifile</span></tt></a> module.</dd> </dl> </div> <div class="section" id="multifile-objects"> <span id="id1"></span><h2>18.10.1. MultiFile Objects<a class="headerlink" href="#multifile-objects" title="Permalink to this headline">¶</a></h2> <p>A <a class="reference internal" href="#multifile.MultiFile" title="multifile.MultiFile"><tt class="xref py py-class docutils literal"><span class="pre">MultiFile</span></tt></a> instance has the following methods:</p> <dl class="method"> <dt id="multifile.MultiFile.readline"> <tt class="descclassname">MultiFile.</tt><tt class="descname">readline</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#multifile.MultiFile.readline" title="Permalink to this definition">¶</a></dt> <dd><p>Read a line. If the line is data (not a section-divider or end-marker or real EOF) return it. If the line matches the most-recently-stacked boundary, return <tt class="docutils literal"><span class="pre">''</span></tt> and set <tt class="docutils literal"><span class="pre">self.last</span></tt> to 1 or 0 according as the match is or is not an end-marker. If the line matches any other stacked boundary, raise an error. On encountering end-of-file on the underlying stream object, the method raises <tt class="xref py py-exc docutils literal"><span class="pre">Error</span></tt> unless all boundaries have been popped.</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.readlines"> <tt class="descclassname">MultiFile.</tt><tt class="descname">readlines</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#multifile.MultiFile.readlines" title="Permalink to this definition">¶</a></dt> <dd><p>Return all lines remaining in this part as a list of strings.</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.read"> <tt class="descclassname">MultiFile.</tt><tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#multifile.MultiFile.read" title="Permalink to this definition">¶</a></dt> <dd><p>Read all lines, up to the next section. Return them as a single (multiline) string. Note that this doesn’t take a size argument!</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.seek"> <tt class="descclassname">MultiFile.</tt><tt class="descname">seek</tt><big>(</big><em>pos</em><span class="optional">[</span>, <em>whence</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#multifile.MultiFile.seek" title="Permalink to this definition">¶</a></dt> <dd><p>Seek. Seek indices are relative to the start of the current section. The <em>pos</em> and <em>whence</em> arguments are interpreted as for a file seek.</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.tell"> <tt class="descclassname">MultiFile.</tt><tt class="descname">tell</tt><big>(</big><big>)</big><a class="headerlink" href="#multifile.MultiFile.tell" title="Permalink to this definition">¶</a></dt> <dd><p>Return the file position relative to the start of the current section.</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.next"> <tt class="descclassname">MultiFile.</tt><tt class="descname">next</tt><big>(</big><big>)</big><a class="headerlink" href="#multifile.MultiFile.next" title="Permalink to this definition">¶</a></dt> <dd><p>Skip lines to the next section (that is, read lines until a section-divider or end-marker has been consumed). Return true if there is such a section, false if an end-marker is seen. Re-enable the most-recently-pushed boundary.</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.is_data"> <tt class="descclassname">MultiFile.</tt><tt class="descname">is_data</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#multifile.MultiFile.is_data" title="Permalink to this definition">¶</a></dt> <dd><p>Return true if <em>str</em> is data and false if it might be a section boundary. As written, it tests for a prefix other than <tt class="docutils literal"><span class="pre">'-</span></tt><tt class="docutils literal"><span class="pre">-'</span></tt> at start of line (which all MIME boundaries have) but it is declared so it can be overridden in derived classes.</p> <p>Note that this test is used intended as a fast guard for the real boundary tests; if it always returns false it will merely slow processing, not cause it to fail.</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.push"> <tt class="descclassname">MultiFile.</tt><tt class="descname">push</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#multifile.MultiFile.push" title="Permalink to this definition">¶</a></dt> <dd><p>Push a boundary string. When a decorated version of this boundary is found as an input line, it will be interpreted as a section-divider or end-marker (depending on the decoration, see <span class="target" id="index-0"></span><a class="rfc reference external" href="http://tools.ietf.org/html/rfc2045.html"><strong>RFC 2045</strong></a>). All subsequent reads will return the empty string to indicate end-of-file, until a call to <a class="reference internal" href="#multifile.MultiFile.pop" title="multifile.MultiFile.pop"><tt class="xref py py-meth docutils literal"><span class="pre">pop()</span></tt></a> removes the boundary a or <a class="reference internal" href="#multifile.MultiFile.next" title="multifile.MultiFile.next"><tt class="xref py py-meth docutils literal"><span class="pre">next()</span></tt></a> call reenables it.</p> <p>It is possible to push more than one boundary. Encountering the most-recently-pushed boundary will return EOF; encountering any other boundary will raise an error.</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.pop"> <tt class="descclassname">MultiFile.</tt><tt class="descname">pop</tt><big>(</big><big>)</big><a class="headerlink" href="#multifile.MultiFile.pop" title="Permalink to this definition">¶</a></dt> <dd><p>Pop a section boundary. This boundary will no longer be interpreted as EOF.</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.section_divider"> <tt class="descclassname">MultiFile.</tt><tt class="descname">section_divider</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#multifile.MultiFile.section_divider" title="Permalink to this definition">¶</a></dt> <dd><p>Turn a boundary into a section-divider line. By default, this method prepends <tt class="docutils literal"><span class="pre">'--'</span></tt> (which MIME section boundaries have) but it is declared so it can be overridden in derived classes. This method need not append LF or CR-LF, as comparison with the result ignores trailing whitespace.</p> </dd></dl> <dl class="method"> <dt id="multifile.MultiFile.end_marker"> <tt class="descclassname">MultiFile.</tt><tt class="descname">end_marker</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#multifile.MultiFile.end_marker" title="Permalink to this definition">¶</a></dt> <dd><p>Turn a boundary string into an end-marker line. By default, this method prepends <tt class="docutils literal"><span class="pre">'--'</span></tt> and appends <tt class="docutils literal"><span class="pre">'--'</span></tt> (like a MIME-multipart end-of-message marker) but it is declared so it can be overridden in derived classes. This method need not append LF or CR-LF, as comparison with the result ignores trailing whitespace.</p> </dd></dl> <p>Finally, <a class="reference internal" href="#multifile.MultiFile" title="multifile.MultiFile"><tt class="xref py py-class docutils literal"><span class="pre">MultiFile</span></tt></a> instances have two public instance variables:</p> <dl class="attribute"> <dt id="multifile.MultiFile.level"> <tt class="descclassname">MultiFile.</tt><tt class="descname">level</tt><a class="headerlink" href="#multifile.MultiFile.level" title="Permalink to this definition">¶</a></dt> <dd><p>Nesting depth of the current part.</p> </dd></dl> <dl class="attribute"> <dt id="multifile.MultiFile.last"> <tt class="descclassname">MultiFile.</tt><tt class="descname">last</tt><a class="headerlink" href="#multifile.MultiFile.last" title="Permalink to this definition">¶</a></dt> <dd><p>True if the last end-of-file was for an end-of-message marker.</p> </dd></dl> </div> <div class="section" id="multifile-example"> <span id="id2"></span><h2>18.10.2. <a class="reference internal" href="#multifile.MultiFile" title="multifile.MultiFile"><tt class="xref py py-class docutils literal"><span class="pre">MultiFile</span></tt></a> Example<a class="headerlink" href="#multifile-example" title="Permalink to this headline">¶</a></h2> <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">mimetools</span> <span class="kn">import</span> <span class="nn">multifile</span> <span class="kn">import</span> <span class="nn">StringIO</span> <span class="k">def</span> <span class="nf">extract_mime_part_matching</span><span class="p">(</span><span class="n">stream</span><span class="p">,</span> <span class="n">mimetype</span><span class="p">):</span> <span class="sd">"""Return the first element in a multipart MIME message on stream</span> <span class="sd"> matching mimetype."""</span> <span class="n">msg</span> <span class="o">=</span> <span class="n">mimetools</span><span class="o">.</span><span class="n">Message</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span> <span class="n">msgtype</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">gettype</span><span class="p">()</span> <span class="n">params</span> <span class="o">=</span> <span class="n">msg</span><span class="o">.</span><span class="n">getplist</span><span class="p">()</span> <span class="n">data</span> <span class="o">=</span> <span class="n">StringIO</span><span class="o">.</span><span class="n">StringIO</span><span class="p">()</span> <span class="k">if</span> <span class="n">msgtype</span><span class="p">[:</span><span class="mi">10</span><span class="p">]</span> <span class="o">==</span> <span class="s">"multipart/"</span><span class="p">:</span> <span class="nb">file</span> <span class="o">=</span> <span class="n">multifile</span><span class="o">.</span><span class="n">MultiFile</span><span class="p">(</span><span class="n">stream</span><span class="p">)</span> <span class="nb">file</span><span class="o">.</span><span class="n">push</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">getparam</span><span class="p">(</span><span class="s">"boundary"</span><span class="p">))</span> <span class="k">while</span> <span class="nb">file</span><span class="o">.</span><span class="n">next</span><span class="p">():</span> <span class="n">submsg</span> <span class="o">=</span> <span class="n">mimetools</span><span class="o">.</span><span class="n">Message</span><span class="p">(</span><span class="nb">file</span><span class="p">)</span> <span class="k">try</span><span class="p">:</span> <span class="n">data</span> <span class="o">=</span> <span class="n">StringIO</span><span class="o">.</span><span class="n">StringIO</span><span class="p">()</span> <span class="n">mimetools</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="nb">file</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">submsg</span><span class="o">.</span><span class="n">getencoding</span><span class="p">())</span> <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span> <span class="k">continue</span> <span class="k">if</span> <span class="n">submsg</span><span class="o">.</span><span class="n">gettype</span><span class="p">()</span> <span class="o">==</span> <span class="n">mimetype</span><span class="p">:</span> <span class="k">break</span> <span class="nb">file</span><span class="o">.</span><span class="n">pop</span><span class="p">()</span> <span class="k">return</span> <span class="n">data</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span> </pre></div> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">18.10. <tt class="docutils literal"><span class="pre">multifile</span></tt> — Support for files containing distinct parts</a><ul> <li><a class="reference internal" href="#multifile-objects">18.10.1. MultiFile Objects</a></li> <li><a class="reference internal" href="#multifile-example">18.10.2. <tt class="docutils literal"><span class="pre">MultiFile</span></tt> Example</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="mimify.html" title="previous chapter">18.9. <tt class="docutils literal"><span class="pre">mimify</span></tt> — MIME processing of mail messages</a></p> <h4>Next topic</h4> <p class="topless"><a href="rfc822.html" title="next chapter">18.11. <tt class="docutils literal"><span class="pre">rfc822</span></tt> — Parse RFC 2822 mail headers</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/library/multifile.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="rfc822.html" title="18.11. rfc822 — Parse RFC 2822 mail headers" >next</a> |</li> <li class="right" > <a href="mimify.html" title="18.9. mimify — MIME processing of mail messages" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="netdata.html" >18. Internet Data Handling</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>