summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorNikita Sobolev <mail@sobolevn.me>2023-10-19 14:20:52 (GMT)
committerGitHub <noreply@github.com>2023-10-19 14:20:52 (GMT)
commita89708aeeaa32135dcde5b728800b9bc7801c80c (patch)
tree98355c00931bec6414893821c07548d6bda6220b /Doc/library
parente9b5399bee7106beeeb38a45cfef3f0ed3fdd703 (diff)
downloadcpython-a89708aeeaa32135dcde5b728800b9bc7801c80c.zip
cpython-a89708aeeaa32135dcde5b728800b9bc7801c80c.tar.gz
cpython-a89708aeeaa32135dcde5b728800b9bc7801c80c.tar.bz2
gh-101100: Fix sphinx warnings in `library/codecs.rst` (#110979)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/codecs.rst69
1 files changed, 36 insertions, 33 deletions
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index 2db4a67..4617624 100644
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -520,44 +520,46 @@ The base :class:`Codec` class defines these methods which also define the
function interfaces of the stateless encoder and decoder:
-.. method:: Codec.encode(input, errors='strict')
+.. class:: Codec
- Encodes the object *input* and returns a tuple (output object, length consumed).
- For instance, :term:`text encoding` converts
- a string object to a bytes object using a particular
- character set encoding (e.g., ``cp1252`` or ``iso-8859-1``).
+ .. method:: encode(input, errors='strict')
- The *errors* argument defines the error handling to apply.
- It defaults to ``'strict'`` handling.
+ Encodes the object *input* and returns a tuple (output object, length consumed).
+ For instance, :term:`text encoding` converts
+ a string object to a bytes object using a particular
+ character set encoding (e.g., ``cp1252`` or ``iso-8859-1``).
- The method may not store state in the :class:`Codec` instance. Use
- :class:`StreamWriter` for codecs which have to keep state in order to make
- encoding efficient.
+ The *errors* argument defines the error handling to apply.
+ It defaults to ``'strict'`` handling.
- The encoder must be able to handle zero length input and return an empty object
- of the output object type in this situation.
+ The method may not store state in the :class:`Codec` instance. Use
+ :class:`StreamWriter` for codecs which have to keep state in order to make
+ encoding efficient.
+ The encoder must be able to handle zero length input and return an empty object
+ of the output object type in this situation.
-.. method:: Codec.decode(input, errors='strict')
- Decodes the object *input* and returns a tuple (output object, length
- consumed). For instance, for a :term:`text encoding`, decoding converts
- a bytes object encoded using a particular
- character set encoding to a string object.
+ .. method:: decode(input, errors='strict')
- For text encodings and bytes-to-bytes codecs,
- *input* must be a bytes object or one which provides the read-only
- buffer interface -- for example, buffer objects and memory mapped files.
+ Decodes the object *input* and returns a tuple (output object, length
+ consumed). For instance, for a :term:`text encoding`, decoding converts
+ a bytes object encoded using a particular
+ character set encoding to a string object.
- The *errors* argument defines the error handling to apply.
- It defaults to ``'strict'`` handling.
+ For text encodings and bytes-to-bytes codecs,
+ *input* must be a bytes object or one which provides the read-only
+ buffer interface -- for example, buffer objects and memory mapped files.
- The method may not store state in the :class:`Codec` instance. Use
- :class:`StreamReader` for codecs which have to keep state in order to make
- decoding efficient.
+ The *errors* argument defines the error handling to apply.
+ It defaults to ``'strict'`` handling.
- The decoder must be able to handle zero length input and return an empty object
- of the output object type in this situation.
+ The method may not store state in the :class:`Codec` instance. Use
+ :class:`StreamReader` for codecs which have to keep state in order to make
+ decoding efficient.
+
+ The decoder must be able to handle zero length input and return an empty object
+ of the output object type in this situation.
Incremental Encoding and Decoding
@@ -705,7 +707,7 @@ Stream Encoding and Decoding
The :class:`StreamWriter` and :class:`StreamReader` classes provide generic
working interfaces which can be used to implement new encoding submodules very
-easily. See :mod:`encodings.utf_8` for an example of how this is done.
+easily. See :mod:`!encodings.utf_8` for an example of how this is done.
.. _stream-writer-objects:
@@ -895,9 +897,10 @@ The design is such that one can use the factory functions returned by the
.. class:: StreamRecoder(stream, encode, decode, Reader, Writer, errors='strict')
Creates a :class:`StreamRecoder` instance which implements a two-way conversion:
- *encode* and *decode* work on the frontend — the data visible to
- code calling :meth:`read` and :meth:`write`, while *Reader* and *Writer*
- work on the backend — the data in *stream*.
+ *encode* and *decode* work on the frontend — the data visible to
+ code calling :meth:`~StreamReader.read` and :meth:`~StreamWriter.write`,
+ while *Reader* and *Writer*
+ work on the backend — the data in *stream*.
You can use these objects to do transparent transcodings, e.g., from Latin-1
to UTF-8 and back.
@@ -1417,8 +1420,8 @@ to :class:`bytes` mappings. They are not supported by :meth:`bytes.decode`
| | quotedprintable, | quoted printable. | ``quotetabs=True`` / |
| | quoted_printable | | :meth:`quopri.decode` |
+----------------------+------------------+------------------------------+------------------------------+
-| uu_codec | uu | Convert the operand using | :meth:`uu.encode` / |
-| | | uuencode. | :meth:`uu.decode` |
+| uu_codec | uu | Convert the operand using | |
+| | | uuencode. | |
+----------------------+------------------+------------------------------+------------------------------+
| zlib_codec | zip, zlib | Compress the operand using | :meth:`zlib.compress` / |
| | | gzip. | :meth:`zlib.decompress` |