diff Doc/lib/libcodecs.tex @ 26099:135f08b73bd5 legacy-trunk

Add documentation for the PEP 293 functionality: The errors attribute can be changed after the reader/writer is created. For encoding there are two additional errors values: "xmlcharrefreplace" and "backslashreplace". These values can be extended via register_error().
author Walter Dörwald <walter@livinglogic.de>
date Thu, 07 Nov 2002 22:33:17 +0000
parents 611af79c0e89
children 6d0cd80e2804
line wrap: on
line diff
--- a/Doc/lib/libcodecs.tex	Thu Nov 07 17:13:03 2002 +0000
+++ b/Doc/lib/libcodecs.tex	Thu Nov 07 22:33:17 2002 +0000
@@ -227,14 +227,21 @@
 codecs:
 
 \begin{tableii}{l|l}{code}{Value}{Meaning}
-  \lineii{'strict'}{Raise \exception{ValueError} (or a subclass);
+  \lineii{'strict'}{Raise \exception{UnicodeError} (or a subclass);
                     this is the default.}
   \lineii{'ignore'}{Ignore the character and continue with the next.}
   \lineii{'replace'}{Replace with a suitable replacement character;
                      Python will use the official U+FFFD REPLACEMENT
-                     CHARACTER for the built-in Unicode codecs.}
+                     CHARACTER for the built-in Unicode codecs on
+                     decoding and '?' on encoding.}
+  \lineii{'xmlcharrefreplace'}{Replace with the appropriate XML
+                     character reference (only for encoding).}
+  \lineii{'backslashreplace'}{Replace with backslashed escape sequences
+                     (only for encoding).}
 \end{tableii}
 
+The set of allowed values can be extended via \method{register_error}.
+
 
 \subsubsection{Codec Objects \label{codec-objects}}
 
@@ -303,14 +310,25 @@
 
   The \class{StreamWriter} may implement different error handling
   schemes by providing the \var{errors} keyword argument. These
-  parameters are defined:
+  parameters are predefined:
 
   \begin{itemize}
     \item \code{'strict'} Raise \exception{ValueError} (or a subclass);
                           this is the default.
     \item \code{'ignore'} Ignore the character and continue with the next.
     \item \code{'replace'} Replace with a suitable replacement character
+    \item \code{'xmlcharrefreplace'} Replace with the appropriate XML
+                     character reference
+    \item \code{'backslashreplace'} Replace with backslashed escape sequences.
   \end{itemize}
+
+  The \var{errors} argument will be assigned to an attribute of the
+  same name. Assigning to this attribute makes it possible to switch
+  between different error handling strategies during the lifetime
+  of the \class{StreamWriter} object.
+
+  The set of allowed values for the \var{errors} argument can
+  be extended with \function{register_error()}.
 \end{classdesc}
 
 \begin{methoddesc}{write}{object}
@@ -360,6 +378,14 @@
     \item \code{'ignore'} Ignore the character and continue with the next.
     \item \code{'replace'} Replace with a suitable replacement character.
   \end{itemize}
+
+  The \var{errors} argument will be assigned to an attribute of the
+  same name. Assigning to this attribute makes it possible to switch
+  between different error handling strategies during the lifetime
+  of the \class{StreamReader} object.
+
+  The set of allowed values for the \var{errors} argument can
+  be extended with \function{register_error()}.
 \end{classdesc}
 
 \begin{methoddesc}{read}{\optional{size}}