From: Benjamin Peterson <benjamin@python.org>
Date: Sun, 2 Dec 2012 16:33:06 +0000 (-0500)
Subject: document UnicodeError attributes
X-Git-Tag: v2.7.5~109^2~70
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d5f462bbc409a5ce89ad3e1d6045d2d11aae7378;p=python

document UnicodeError attributes
---

diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index 6c80df7c60..c12e874a39 100644
--- a/Doc/library/exceptions.rst
+++ b/Doc/library/exceptions.rst
@@ -387,6 +387,30 @@ The following exceptions are the exceptions that are actually 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`.
+
    .. versionadded:: 2.0