Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libbase64.tex @ 5817:48b94de85bf3 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Extensive changes by AMK.
author Guido van Rossum <guido@python.org>
date Thu, 17 Jul 1997 16:29:42 +0000
parents 9ca27188da23
children 3468ea8645ca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5344
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
1 \section{Standard Module \sectcode{base64}}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 \stmodindex{base64}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
3
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 This module perform base-64 encoding and decoding of arbitrary binary
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 strings into text strings that can be safely emailed or posted. The
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 encoding scheme is defined in RFC 1421 and is used for MIME email and
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 various other Internet-related applications; it is not the same as the
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 output produced by the \file{uuencode} program. For example, the
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 string \code{'www.python.org'} is encoded as the string
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 \code{'d3d3LnB5dGhvbi5vcmc=\e n'}.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
11 \indexii{base-64}{encoding}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 \indexii{RFC}{1421}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
13 \index{MIME, base 64 encoding}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
14
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 \begin{funcdesc}{decode}{input\, output}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 Decode the contents of the \var{input} file and write the resulting
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 binary data to the \var{output} file.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 \var{input} and \var{output} must either be file objects or objects that
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 mimic the file object interface. \var{input} will be read until
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
20 \code{\var{input}.read()} returns an empty string.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 \end{funcdesc}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
22
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 \begin{funcdesc}{decodestring}{s}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 Decode the string \var{s}, which must contain one or more lines of
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 base-64 encoded data, and return a string containing the resulting
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 binary data.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
27 \end{funcdesc}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
28
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
29 \begin{funcdesc}{encode}{input\, output}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 Encode the contents of the \var{input} file and write the resulting
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 base-64 encoded data to the \var{output} file.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
32 \var{input} and \var{output} must either be file objects or objects that
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 mimic the file object interface. \var{input} will be read until
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
34 \code{\var{input}.read()} returns an empty string.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 \end{funcdesc}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
36
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
37 \begin{funcdesc}{encodestring}{s}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 Encode the string \var{s}, which can contain arbitrary binary data,
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
39 and return a string containing one or more lines of
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
40 base-64 encoded data.
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
41 \end{funcdesc}
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
42
9ca27188da23 Added fnmatch, base64 and quopri, received from Andrew Kuchling.
Guido van Rossum <guido@python.org>
parents:
diff changeset
43