Guido van Rossum | e76b7a8 | 1997-04-27 21:25:52 +0000 | [diff] [blame] | 1 | \section{Standard Module \sectcode{base64}} |
Guido van Rossum | e47da0a | 1997-07-17 16:34:52 +0000 | [diff] [blame] | 2 | \label{module-base64} |
Guido van Rossum | e76b7a8 | 1997-04-27 21:25:52 +0000 | [diff] [blame] | 3 | \stmodindex{base64} |
| 4 | |
| 5 | This module perform base-64 encoding and decoding of arbitrary binary |
| 6 | strings into text strings that can be safely emailed or posted. The |
| 7 | encoding scheme is defined in RFC 1421 and is used for MIME email and |
| 8 | various other Internet-related applications; it is not the same as the |
| 9 | output produced by the \file{uuencode} program. For example, the |
| 10 | string \code{'www.python.org'} is encoded as the string |
| 11 | \code{'d3d3LnB5dGhvbi5vcmc=\e n'}. |
| 12 | \indexii{base-64}{encoding} |
| 13 | \indexii{RFC}{1421} |
| 14 | \index{MIME, base 64 encoding} |
| 15 | |
| 16 | \begin{funcdesc}{decode}{input\, output} |
| 17 | Decode the contents of the \var{input} file and write the resulting |
| 18 | binary data to the \var{output} file. |
| 19 | \var{input} and \var{output} must either be file objects or objects that |
| 20 | mimic the file object interface. \var{input} will be read until |
| 21 | \code{\var{input}.read()} returns an empty string. |
| 22 | \end{funcdesc} |
| 23 | |
| 24 | \begin{funcdesc}{decodestring}{s} |
| 25 | Decode the string \var{s}, which must contain one or more lines of |
| 26 | base-64 encoded data, and return a string containing the resulting |
| 27 | binary data. |
| 28 | \end{funcdesc} |
| 29 | |
| 30 | \begin{funcdesc}{encode}{input\, output} |
| 31 | Encode the contents of the \var{input} file and write the resulting |
| 32 | base-64 encoded data to the \var{output} file. |
| 33 | \var{input} and \var{output} must either be file objects or objects that |
| 34 | mimic the file object interface. \var{input} will be read until |
| 35 | \code{\var{input}.read()} returns an empty string. |
| 36 | \end{funcdesc} |
| 37 | |
| 38 | \begin{funcdesc}{encodestring}{s} |
| 39 | Encode the string \var{s}, which can contain arbitrary binary data, |
| 40 | and return a string containing one or more lines of |
| 41 | base-64 encoded data. |
| 42 | \end{funcdesc} |
| 43 | |
| 44 | |