Edit File: uu.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.16. uu — Encode and decode uuencode files — Python v2.6.6 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.6.6', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python v2.6.6 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 v2.6.6 documentation" href="../index.html" /> <link rel="up" title="18. Internet Data Handling" href="netdata.html" /> <link rel="next" title="19. Structured Markup Processing Tools" href="markup.html" /> <link rel="prev" title="18.15. quopri — Encode and decode MIME quoted-printable data" href="quopri.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> </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="../modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li> <li class="right" > <a href="markup.html" title="19. Structured Markup Processing Tools" accesskey="N">next</a> |</li> <li class="right" > <a href="quopri.html" title="18.15. quopri — Encode and decode MIME quoted-printable data" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 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-uu"> <h1>18.16. <tt class="xref docutils literal"><span class="pre">uu</span></tt> — Encode and decode uuencode files<a class="headerlink" href="#module-uu" title="Permalink to this headline">¶</a></h1> <p>This module encodes and decodes files in uuencode format, allowing arbitrary binary data to be transferred over ASCII-only connections. Wherever a file argument is expected, the methods accept a file-like object. For backwards compatibility, a string containing a pathname is also accepted, and the corresponding file will be opened for reading and writing; the pathname <tt class="docutils literal"><span class="pre">'-'</span></tt> is understood to mean the standard input or output. However, this interface is deprecated; it’s better for the caller to open the file itself, and be sure that, when required, the mode is <tt class="docutils literal"><span class="pre">'rb'</span></tt> or <tt class="docutils literal"><span class="pre">'wb'</span></tt> on Windows.</p> <p id="index-731">This code was contributed by Lance Ellinghouse, and modified by Jack Jansen.</p> <p>The <tt class="xref docutils literal"><span class="pre">uu</span></tt> module defines the following functions:</p> <dl class="function"> <dt id="uu.encode"> <tt class="descclassname">uu.</tt><tt class="descname">encode</tt><big>(</big><em>in_file</em>, <em>out_file</em><span class="optional">[</span>, <em>name</em><span class="optional">[</span>, <em>mode</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#uu.encode" title="Permalink to this definition">¶</a></dt> <dd>Uuencode file <em>in_file</em> into file <em>out_file</em>. The uuencoded file will have the header specifying <em>name</em> and <em>mode</em> as the defaults for the results of decoding the file. The default defaults are taken from <em>in_file</em>, or <tt class="docutils literal"><span class="pre">'-'</span></tt> and <tt class="docutils literal"><span class="pre">0666</span></tt> respectively.</dd></dl> <dl class="function"> <dt id="uu.decode"> <tt class="descclassname">uu.</tt><tt class="descname">decode</tt><big>(</big><em>in_file</em><span class="optional">[</span>, <em>out_file</em><span class="optional">[</span>, <em>mode</em><span class="optional">[</span>, <em>quiet</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#uu.decode" title="Permalink to this definition">¶</a></dt> <dd><p>This call decodes uuencoded file <em>in_file</em> placing the result on file <em>out_file</em>. If <em>out_file</em> is a pathname, <em>mode</em> is used to set the permission bits if the file must be created. Defaults for <em>out_file</em> and <em>mode</em> are taken from the uuencode header. However, if the file specified in the header already exists, a <a title="uu.Error" class="reference internal" href="#uu.Error"><tt class="xref docutils literal"><span class="pre">uu.Error</span></tt></a> is raised.</p> <p><a title="uu.decode" class="reference internal" href="#uu.decode"><tt class="xref docutils literal"><span class="pre">decode()</span></tt></a> may print a warning to standard error if the input was produced by an incorrect uuencoder and Python could recover from that error. Setting <em>quiet</em> to a true value silences this warning.</p> </dd></dl> <dl class="exception"> <dt id="uu.Error"> <em class="property">exception </em><tt class="descclassname">uu.</tt><tt class="descname">Error</tt><a class="headerlink" href="#uu.Error" title="Permalink to this definition">¶</a></dt> <dd>Subclass of <a title="exceptions.Exception" class="reference external" href="exceptions.html#exceptions.Exception"><tt class="xref docutils literal"><span class="pre">Exception</span></tt></a>, this can be raised by <a title="uu.decode" class="reference internal" href="#uu.decode"><tt class="xref docutils literal"><span class="pre">uu.decode()</span></tt></a> under various situations, such as described above, but also including a badly formatted header, or truncated input file.</dd></dl> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <dl class="last docutils"> <dt>Module <a title="Tools for converting between binary and various ASCII-encoded binary representations." class="reference external" href="binascii.html#module-binascii"><tt class="xref docutils literal"><span class="pre">binascii</span></tt></a></dt> <dd>Support module containing ASCII-to-binary and binary-to-ASCII conversions.</dd> </dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="quopri.html" title="previous chapter">18.15. <tt class="docutils literal docutils literal docutils literal"><span class="pre">quopri</span></tt> — Encode and decode MIME quoted-printable data</a></p> <h4>Next topic</h4> <p class="topless"><a href="markup.html" title="next chapter">19. Structured Markup Processing Tools</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/uu.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" size="18" /> <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="../modindex.html" title="Global Module Index" >modules</a> |</li> <li class="right" > <a href="markup.html" title="19. Structured Markup Processing Tools" >next</a> |</li> <li class="right" > <a href="quopri.html" title="18.15. quopri — Encode and decode MIME quoted-printable data" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 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-2011, 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 Jul 20, 2011. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6. </div> </body> </html>
Back to File Manager