traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document that uu.decode() will always raise a uu.Error if out_file 

isn't given, and the file in the uu header already exists.  Also add a
description of the uu.Error exception class.
This commit is contained in:
Barry Warsaw 2001-08-17 20:01:06 +00:00
parent d1795705de
commit dbfe5e8507
1 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Doc/lib/libuu.tex
View File

@ -7,7 +7,7 @@
This module encodes and decodes files in uuencode format, allowing This module encodes and decodes files in uuencode format, allowing
arbitrary binary data to be transferred over ascii-only connections. arbitrary binary data to be transferred over ASCII-only connections.
Wherever a file argument is expected, the methods accept a file-like Wherever a file argument is expected, the methods accept a file-like
object. For backwards compatibility, a string containing a pathname object. For backwards compatibility, a string containing a pathname
is also accepted, and the corresponding file will be opened for is also accepted, and the corresponding file will be opened for
@ -24,19 +24,28 @@ Jansen.
The \module{uu} module defines the following functions: The \module{uu} module defines the following functions:
\begin{funcdesc}{encode}{in_file, out_file\optional{, name\optional{, mode}}} \begin{funcdesc}{encode}{in_file, out_file\optional{, name\optional{, mode}}}
Uuencode file \var{in_file} into file \var{out_file}. The uuencoded Uuencode file \var{in_file} into file \var{out_file}. The uuencoded
file will have the header specifying \var{name} and \var{mode} as the file will have the header specifying \var{name} and \var{mode} as
defaults for the results of decoding the file. The default defaults the defaults for the results of decoding the file. The default
are taken from \var{in_file}, or \code{'-'} and \code{0666} respectively. defaults are taken from \var{in_file}, or \code{'-'} and \code{0666}
respectively.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{decode}{in_file\optional{, out_file\optional{, mode}}} \begin{funcdesc}{decode}{in_file\optional{, out_file\optional{, mode}}}
This call decodes uuencoded file \var{in_file} placing the result on This call decodes uuencoded file \var{in_file} placing the result on
file \var{out_file}. If \var{out_file} is a pathname, \var{mode} is file \var{out_file}. If \var{out_file} is a pathname, \var{mode} is
used to set the permission bits if the file must be created. Defaults used to set the permission bits if the file must be
for \var{out_file} and \var{mode} are taken from the uuencode header. created. Defaults for \var{out_file} and \var{mode} are taken from
the uuencode header. However, if the file specified in the header
already exists, a \exception{uu.Error} is raised.
\end{funcdesc} \end{funcdesc}
\begin{excclassdesc}{Error}{}
Subclass of \exception{Exception}, this can be raised by
\function{uu.decode()} under various situations, such as described
above, but also including a badly formated header, or truncated
input file.
\end{excclassdesc}
\begin{seealso} \begin{seealso}
\seemodule{binascii}{Support module containing \ASCII-to-binary \seemodule{binascii}{Support module containing \ASCII-to-binary