From 78f7e3a8dc999114c6863754b0c72ad5a9ec93eb Mon Sep 17 00:00:00 2001 From: Benjamin Peterson Date: Sun, 2 Dec 2012 11:33:06 -0500 Subject: document UnicodeError attributes --- Doc/library/exceptions.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst index 053ba56..89f933c 100644 --- a/Doc/library/exceptions.rst +++ b/Doc/library/exceptions.rst @@ -371,6 +371,30 @@ The following exceptions are the exceptions that are usually raised. Raised when a Unicode-related encoding or decoding error occurs. It is a subclass of :exc:`ValueError`. + :exc:`UnicodeError` has attributes that describe the encoding or decoding + error. For example, ``err.object[err.start:err.end]`` gives the particular + invalid input that the codec failed on. + + .. attribute:: encoding + + The name of the encoding that raised the error. + + .. attribute:: reason + + A string describing the specific codec error. + + .. attribute:: object + + The object the codec was attempting to encode or decode. + + .. attribute:: start + + The first index of invalid data in :attr:`object`. + + .. attribute:: end + + The index after the last invalid data in :attr:`object`. + .. exception:: UnicodeEncodeError -- cgit v0.12