Issue #17844: Add links to encoders and decoders for bytes-to-bytes codecs.

This commit is contained in:
Serhiy Storchaka 2013-05-22 15:35:35 +03:00
commit 549681c79b
2 changed files with 28 additions and 27 deletions

View File

@ -1188,33 +1188,33 @@ particular, the following variants typically exist:
The following codecs provide bytes-to-bytes mappings. The following codecs provide bytes-to-bytes mappings.
.. tabularcolumns:: |l|L| .. tabularcolumns:: |l|L|L|
+--------------------+---------------------------+ +--------------------+---------------------------+------------------------------+
| Codec | Purpose | | Codec | Purpose | Encoder/decoder |
+====================+===========================+ +====================+===========================+==============================+
| base64_codec | Convert operand to MIME | | base64_codec | Convert operand to MIME | :meth:`base64.b64encode`, |
| | base64 (the result always | | | base64 (the result always | :meth:`base64.b64decode` |
| | includes a trailing | | | includes a trailing | |
| | ``'\n'``) | | | ``'\n'``) | |
+--------------------+---------------------------+ +--------------------+---------------------------+------------------------------+
| bz2_codec | Compress the operand | | bz2_codec | Compress the operand | :meth:`bz2.compress`, |
| | using bz2 | | | using bz2 | :meth:`bz2.decompress` |
+--------------------+---------------------------+ +--------------------+---------------------------+------------------------------+
| hex_codec | Convert operand to | | hex_codec | Convert operand to | :meth:`base64.b16encode`, |
| | hexadecimal | | | hexadecimal | :meth:`base64.b16decode` |
| | representation, with two | | | representation, with two | |
| | digits per byte | | | digits per byte | |
+--------------------+---------------------------+ +--------------------+---------------------------+------------------------------+
| quopri_codec | Convert operand to MIME | | quopri_codec | Convert operand to MIME | :meth:`quopri.encodestring`, |
| | quoted printable | | | quoted printable | :meth:`quopri.decodestring` |
+--------------------+---------------------------+ +--------------------+---------------------------+------------------------------+
| uu_codec | Convert the operand using | | uu_codec | Convert the operand using | :meth:`uu.encode`, |
| | uuencode | | | uuencode | :meth:`uu.decode` |
+--------------------+---------------------------+ +--------------------+---------------------------+------------------------------+
| zlib_codec | Compress the operand | | zlib_codec | Compress the operand | :meth:`zlib.compress`, |
| | using gzip | | | using gzip | :meth:`zlib.decompress` |
+--------------------+---------------------------+ +--------------------+---------------------------+------------------------------+
The following codecs provide string-to-string mappings. The following codecs provide string-to-string mappings.

View File

@ -327,10 +327,11 @@ Tests
- Issue #17692: test_sqlite now works with unittest test discovery. - Issue #17692: test_sqlite now works with unittest test discovery.
Patch by Zachary Ware. Patch by Zachary Ware.
Documentation Documentation
------------- -------------
- Issue #17844: Add links to encoders and decoders for bytes-to-bytes codecs.
- Issue #14097: improve the "introduction" page of the tutorial. - Issue #14097: improve the "introduction" page of the tutorial.
- Issue #17977: The documentation for the cadefault argument's default value - Issue #17977: The documentation for the cadefault argument's default value