mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 17:08:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

#3613: add base64.encodebytes and decodebytes as the new spelling of encodestring and decodestring; deprecate the latter.

Browse source
This commit is contained in:
Georg Brandl 2009-06-04 09:11:51 +00:00
parent cef803f82c
commit b54d801280
6 changed files with 66 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

42
Doc/library/base64.rst
View file

@ -116,38 +116,44 @@ The modern interface provides:
incorrectly padded or if there are non-alphabet characters present in the
string.
The legacy interface:
The legacy interface:
.. function:: decode(input, output)
Decode the contents of the *input* file and write the resulting binary data to
the *output* file. *input* and *output* must either be file objects or objects
that mimic the file object interface. *input* will be read until
``input.read()`` returns an empty string.
Decode the contents of the binary *input* file and write the resulting binary
data to the *output* file. *input* and *output* must either be file objects
or objects that mimic the file object interface working with bytes
objects. *input* will be read until ``input.read()`` returns an empty string.
.. function:: decodestring(s)
.. function:: decodebytes(s)
decodestring(s)
Decode the string *s*, which must contain one or more lines of base64 encoded
data, and return a string containing the resulting binary data.
Decode the bytestring *s*, which must contain one or more lines of base64
encoded data, and return a bytestring containing the resulting binary data.
``decodestring`` is a deprecated alias.
.. function:: encode(input, output)
Encode the contents of the *input* file and write the resulting base64 encoded
data to the *output* file. *input* and *output* must either be file objects or
objects that mimic the file object interface. *input* will be read until
``input.read()`` returns an empty string. :func:`encode` returns the encoded
data plus a trailing newline character (``'\n'``).
Encode the contents of the binary *input* file and write the resulting base64
encoded data to the *output* file. *input* and *output* must either be file
objects or objects that mimic the file object interface working with bytes
objects. *input* will be read until ``input.read()`` returns an empty string.
:func:`encode` returns the encoded data plus a trailing newline character
(``b'\n'``).
.. function:: encodestring(s)
.. function:: encodebytes(s)
encodestring(s)
Encode the bytestring *s*, which can contain arbitrary binary data, and
return a bytestring containing one or more lines of base64-encoded data.
:func:`encodebytes` returns a string containing one or more lines of
base64-encoded data always including an extra trailing newline (``b'\n'``).
``encodestring`` is a deprecated alias.
Encode the string *s*, which can contain arbitrary binary data, and return a
string containing one or more lines of base64-encoded data.
:func:`encodestring` returns a string containing one or more lines of
base64-encoded data always including an extra trailing newline (``'\n'``).
An example usage of the module: