projects / OpenSPARC-T2-SAM / blame
| Commit | Line | Data |
|---|---|---|
| 920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <html> | |
| 3 | <head> | |
| 4 | <link rel="STYLESHEET" href="lib.css" type='text/css' /> | |
| 5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
| 6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
| 7 | <link rel="first" href="lib.html" title='Python Library Reference' /> | |
| 8 | <link rel='contents' href='contents.html' title="Contents" /> | |
| 9 | <link rel='index' href='genindex.html' title='Index' /> | |
| 10 | <link rel='last' href='about.html' title='About this document...' /> | |
| 11 | <link rel='help' href='about.html' title='About this document...' /> | |
| 12 | <link rel="next" href="module-rfc822.html" /> | |
| 13 | <link rel="prev" href="module-mimify.html" /> | |
| 14 | <link rel="parent" href="netdata.html" /> | |
| 15 | <link rel="next" href="MultiFile-objects.html" /> | |
| 16 | <meta name='aesop' content='information' /> | |
| 17 | <title>12.10 multifile -- Support for files containing distinct parts</title> | |
| 18 | </head> | |
| 19 | <body> | |
| 20 | <DIV CLASS="navigation"> | |
| 21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
| 22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
| 23 | <tr> | |
| 24 | <td class='online-navigation'><a rel="prev" title="12.9 mimify " | |
| 25 | href="module-mimify.html"><img src='../icons/previous.png' | |
| 26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
| 27 | <td class='online-navigation'><a rel="parent" title="12. Internet Data Handling" | |
| 28 | href="netdata.html"><img src='../icons/up.png' | |
| 29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
| 30 | <td class='online-navigation'><a rel="next" title="12.10.1 MultiFile Objects" | |
| 31 | href="MultiFile-objects.html"><img src='../icons/next.png' | |
| 32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
| 33 | <td align="center" width="100%">Python Library Reference</td> | |
| 34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
| 35 | href="contents.html"><img src='../icons/contents.png' | |
| 36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
| 37 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
| 38 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
| 39 | <td class='online-navigation'><a rel="index" title="Index" | |
| 40 | href="genindex.html"><img src='../icons/index.png' | |
| 41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
| 42 | </tr></table> | |
| 43 | <div class='online-navigation'> | |
| 44 | <b class="navlabel">Previous:</b> | |
| 45 | <a class="sectref" rel="prev" href="module-mimify.html">12.9 mimify </A> | |
| 46 | <b class="navlabel">Up:</b> | |
| 47 | <a class="sectref" rel="parent" href="netdata.html">12. Internet Data Handling</A> | |
| 48 | <b class="navlabel">Next:</b> | |
| 49 | <a class="sectref" rel="next" href="MultiFile-objects.html">12.10.1 MultiFile Objects</A> | |
| 50 | </div> | |
| 51 | <hr /></div> | |
| 52 | </DIV> | |
| 53 | <!--End of Navigation Panel--> | |
| 54 | ||
| 55 | <H1><A NAME="SECTION00141000000000000000000"> | |
| 56 | 12.10 <tt class="module">multifile</tt> -- | |
| 57 | Support for files containing distinct parts</A> | |
| 58 | </H1> | |
| 59 | ||
| 60 | <P> | |
| 61 | <A NAME="module-multifile"></A> | |
| 62 | ||
| 63 | <P> | |
| 64 | The <tt class="class">MultiFile</tt> object enables you to treat sections of a text | |
| 65 | file as file-like input objects, with <code>''</code> being returned by | |
| 66 | <tt class="method">readline()</tt> when a given delimiter pattern is encountered. The | |
| 67 | defaults of this class are designed to make it useful for parsing | |
| 68 | MIME multipart messages, but by subclassing it and overriding methods | |
| 69 | it can be easily adapted for more general use. | |
| 70 | ||
| 71 | <P> | |
| 72 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
| 73 | <td><nobr><b><span class="typelabel">class</span> <tt id='l2h-4059' xml:id='l2h-4059' class="class">MultiFile</tt></b>(</nobr></td> | |
| 74 | <td><var>fp</var><big>[</big><var>, seekable</var><big>]</big><var></var>)</td></tr></table></dt> | |
| 75 | <dd> | |
| 76 | Create a multi-file. You must instantiate this class with an input | |
| 77 | object argument for the <tt class="class">MultiFile</tt> instance to get lines from, | |
| 78 | such as a file object returned by <tt class="function">open()</tt>. | |
| 79 | ||
| 80 | <P> | |
| 81 | <tt class="class">MultiFile</tt> only ever looks at the input object's | |
| 82 | <tt class="method">readline()</tt>, <tt class="method">seek()</tt> and <tt class="method">tell()</tt> methods, and | |
| 83 | the latter two are only needed if you want random access to the | |
| 84 | individual MIME parts. To use <tt class="class">MultiFile</tt> on a non-seekable | |
| 85 | stream object, set the optional <var>seekable</var> argument to false; this | |
| 86 | will prevent using the input object's <tt class="method">seek()</tt> and | |
| 87 | <tt class="method">tell()</tt> methods. | |
| 88 | </dl> | |
| 89 | ||
| 90 | <P> | |
| 91 | It will be useful to know that in <tt class="class">MultiFile</tt>'s view of the world, text | |
| 92 | is composed of three kinds of lines: data, section-dividers, and | |
| 93 | end-markers. MultiFile is designed to support parsing of | |
| 94 | messages that may have multiple nested message parts, each with its | |
| 95 | own pattern for section-divider and end-marker lines. | |
| 96 | ||
| 97 | <P> | |
| 98 | <div class="seealso"> | |
| 99 | <p class="heading">See Also:</p> | |
| 100 | ||
| 101 | <dl compact="compact" class="seemodule"> | |
| 102 | <dt>Module <b><tt class="module"><a href="module-email.html">email</a></tt>:</b> | |
| 103 | <dd>Comprehensive email handling package; supersedes | |
| 104 | the <tt class="module">multifile</tt> module. | |
| 105 | </dl> | |
| 106 | </div> | |
| 107 | ||
| 108 | <P> | |
| 109 | ||
| 110 | <p><br /></p><hr class='online-navigation' /> | |
| 111 | <div class='online-navigation'> | |
| 112 | <!--Table of Child-Links--> | |
| 113 | <A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a> | |
| 114 | ||
| 115 | <UL CLASS="ChildLinks"> | |
| 116 | <LI><A href="MultiFile-objects.html">12.10.1 MultiFile Objects</a> | |
| 117 | <LI><A href="multifile-example.html">12.10.2 <tt class="class">MultiFile</tt> Example</a> | |
| 118 | </ul> | |
| 119 | <!--End of Table of Child-Links--> | |
| 120 | </div> | |
| 121 | ||
| 122 | <DIV CLASS="navigation"> | |
| 123 | <div class='online-navigation'> | |
| 124 | <p></p><hr /> | |
| 125 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
| 126 | <tr> | |
| 127 | <td class='online-navigation'><a rel="prev" title="12.9 mimify " | |
| 128 | href="module-mimify.html"><img src='../icons/previous.png' | |
| 129 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
| 130 | <td class='online-navigation'><a rel="parent" title="12. Internet Data Handling" | |
| 131 | href="netdata.html"><img src='../icons/up.png' | |
| 132 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
| 133 | <td class='online-navigation'><a rel="next" title="12.10.1 MultiFile Objects" | |
| 134 | href="MultiFile-objects.html"><img src='../icons/next.png' | |
| 135 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
| 136 | <td align="center" width="100%">Python Library Reference</td> | |
| 137 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
| 138 | href="contents.html"><img src='../icons/contents.png' | |
| 139 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
| 140 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
| 141 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
| 142 | <td class='online-navigation'><a rel="index" title="Index" | |
| 143 | href="genindex.html"><img src='../icons/index.png' | |
| 144 | border='0' height='32' alt='Index' width='32' /></A></td> | |
| 145 | </tr></table> | |
| 146 | <div class='online-navigation'> | |
| 147 | <b class="navlabel">Previous:</b> | |
| 148 | <a class="sectref" rel="prev" href="module-mimify.html">12.9 mimify </A> | |
| 149 | <b class="navlabel">Up:</b> | |
| 150 | <a class="sectref" rel="parent" href="netdata.html">12. Internet Data Handling</A> | |
| 151 | <b class="navlabel">Next:</b> | |
| 152 | <a class="sectref" rel="next" href="MultiFile-objects.html">12.10.1 MultiFile Objects</A> | |
| 153 | </div> | |
| 154 | </div> | |
| 155 | <hr /> | |
| 156 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
| 157 | </DIV> | |
| 158 | <!--End of Navigation Panel--> | |
| 159 | <ADDRESS> | |
| 160 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
| 161 | </ADDRESS> | |
| 162 | </BODY> | |
| 163 | </HTML> |