]> granicus.if.org Git - python/commitdiff
document UnicodeError attributes
authorBenjamin Peterson <benjamin@python.org>
Sun, 2 Dec 2012 16:33:06 +0000 (11:33 -0500)
committerBenjamin Peterson <benjamin@python.org>
Sun, 2 Dec 2012 16:33:06 +0000 (11:33 -0500)
Doc/library/exceptions.rst

index 6c80df7c603a4fc567e15934595365ac8515e87c..c12e874a39f558041fd40dfae273a0b9d3065890 100644 (file)
@@ -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