From 7f82f7955efb5ad32e142a3164341c53565c7df0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Walter=20D=C3=B6rwald?= Date: Tue, 19 Nov 2002 21:42:53 +0000 Subject: Add missing documentation for the PEP 293 functionality to the codecs docstrings. --- Lib/codecs.py | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/Lib/codecs.py b/Lib/codecs.py index 0b43a72..e7967d8 100644 --- a/Lib/codecs.py +++ b/Lib/codecs.py @@ -67,15 +67,22 @@ class Codec: """ Defines the interface for stateless encoders/decoders. - The .encode()/.decode() methods may implement different error + The .encode()/.decode() methods may use different error handling schemes by providing the errors argument. These - string values are defined: + string values are predefined: 'strict' - raise a ValueError error (or a subclass) 'ignore' - ignore the character and continue with the next 'replace' - replace with a suitable replacement character; Python will use the official U+FFFD REPLACEMENT - CHARACTER for the builtin Unicode codecs. + CHARACTER for the builtin Unicode codecs on + decoding and '?' on encoding. + 'xmlcharrefreplace' - Replace with the appropriate XML + character reference (only for encoding). + 'backslashreplace' - Replace with backslashed escape sequences + (only for encoding). + + The set of allowed values can be extended via register_error. """ def encode(self, input, errors='strict'): @@ -136,14 +143,20 @@ class StreamWriter(Codec): stream must be a file-like object open for writing (binary) data. - The StreamWriter may implement different error handling + The StreamWriter may use different error handling schemes by providing the errors keyword argument. These - parameters are defined: + parameters are predefined: 'strict' - raise a ValueError (or a subclass) 'ignore' - ignore the character and continue with the next 'replace'- replace with a suitable replacement character + 'xmlcharrefreplace' - Replace with the appropriate XML + character reference. + 'backslashreplace' - Replace with backslashed escape + sequences (only for encoding). + The set of allowed parameter values can be extended via + register_error. """ self.stream = stream self.errors = errors @@ -192,14 +205,16 @@ class StreamReader(Codec): stream must be a file-like object open for reading (binary) data. - The StreamReader may implement different error handling + The StreamReader may use different error handling schemes by providing the errors keyword argument. These - parameters are defined: + parameters are predefined: 'strict' - raise a ValueError (or a subclass) 'ignore' - ignore the character and continue with the next 'replace'- replace with a suitable replacement character; + The set of allowed parameter values can be extended via + register_error. """ self.stream = stream self.errors = errors -- cgit v0.12