summaryrefslogtreecommitdiffstats
path: root/Doc/library/codecs.rst
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@haypocalc.com>2011-05-26 23:51:18 (GMT)
committerVictor Stinner <victor.stinner@haypocalc.com>2011-05-26 23:51:18 (GMT)
commit98fe1a0c3bacdc51071d960d8d76b3b9f5b0d8c6 (patch)
tree9f3ade330a69ba55b615ccbfcf4680939377ab84 /Doc/library/codecs.rst
parentc556e10b94541d7bf20e908f8eca78e7f63fc28c (diff)
downloadcpython-98fe1a0c3bacdc51071d960d8d76b3b9f5b0d8c6.zip
cpython-98fe1a0c3bacdc51071d960d8d76b3b9f5b0d8c6.tar.gz
cpython-98fe1a0c3bacdc51071d960d8d76b3b9f5b0d8c6.tar.bz2
Issue #8796: codecs.open() calls the builtin open() function instead of using
StreamReaderWriter. Deprecate StreamReader, StreamWriter, StreamReaderWriter, StreamRecoder and EncodedFile() of the codec module. Use the builtin open() function or io.TextIOWrapper instead.
Diffstat (limited to 'Doc/library/codecs.rst')
-rw-r--r--Doc/library/codecs.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
index 4d5058e..b58e410 100644
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -85,6 +85,9 @@ It defines the following functions:
In case a search function cannot find a given encoding, it should return
``None``.
+ .. deprecated:: 3.3
+ *streamreader* and *streamwriter* attributes are now deprecated.
+
.. function:: lookup(encoding)
@@ -139,6 +142,8 @@ functions which use :func:`lookup` for the codec lookup:
Raises a :exc:`LookupError` in case the encoding cannot be found.
+ .. deprecated:: 3.3
+
.. function:: getwriter(encoding)
@@ -147,6 +152,8 @@ functions which use :func:`lookup` for the codec lookup:
Raises a :exc:`LookupError` in case the encoding cannot be found.
+ .. deprecated:: 3.3
+
.. function:: register_error(name, error_handler)
@@ -217,6 +224,11 @@ utility functions:
.. note::
+ This function is kept for backward compatibility with Python 2, the
+ builtin :func:`open` function should be used instead.
+
+ .. note::
+
The wrapped version's methods will accept and return strings only. Bytes
arguments will be rejected.
@@ -251,6 +263,8 @@ utility functions:
``'strict'``, which causes :exc:`ValueError` to be raised in case an encoding
error occurs.
+ .. deprecated:: 3.3
+
.. function:: iterencode(iterator, encoding, errors='strict', **kwargs)
@@ -563,6 +577,9 @@ The :class:`StreamWriter` class is a subclass of :class:`Codec` and defines the
following methods which every stream writer must define in order to be
compatible with the Python codec registry.
+.. deprecated:: 3.3
+ Use the builtin the :class:`io.TextIOWrapper` class.
+
.. class:: StreamWriter(stream[, errors])
@@ -628,6 +645,9 @@ The :class:`StreamReader` class is a subclass of :class:`Codec` and defines the
following methods which every stream reader must define in order to be
compatible with the Python codec registry.
+.. deprecated:: 3.3
+ Use the builtin the :class:`io.TextIOWrapper` class.
+
.. class:: StreamReader(stream[, errors])
@@ -728,6 +748,9 @@ and write modes.
The design is such that one can use the factory functions returned by the
:func:`lookup` function to construct the instance.
+.. deprecated:: 3.3
+ Use the :class:`io.TextIOWrapper` class.
+
.. class:: StreamReaderWriter(stream, Reader, Writer, errors)
@@ -752,6 +775,8 @@ which is sometimes useful when dealing with different encoding environments.
The design is such that one can use the factory functions returned by the
:func:`lookup` function to construct the instance.
+.. deprecated:: 3.3
+
.. class:: StreamRecoder(stream, encode, decode, Reader, Writer, errors)