From: cocoatomo Date: Thu, 30 Mar 2017 01:18:44 +0000 (+0900) Subject: Avoid consuming two lines per one exception name X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a0e3bb76ab6cbb55396fcc885e8809830d06678a;p=thirdparty%2FPython%2Fcpython.git Avoid consuming two lines per one exception name --- diff --git a/Doc/c-api/exceptions.rst b/Doc/c-api/exceptions.rst index 64e64b5f88f0..747f4805e9dd 100644 --- a/Doc/c-api/exceptions.rst +++ b/Doc/c-api/exceptions.rst @@ -750,114 +750,169 @@ All standard Python exceptions are available as global variables whose names are :c:type:`PyObject\*`; they are all class objects. For completeness, here are all the variables: +.. index:: + single: PyExc_ArithmeticError + single: PyExc_AssertionError + single: PyExc_AttributeError + single: PyExc_BaseException + single: PyExc_BlockingIOError + single: PyExc_BrokenPipeError + single: PyExc_BufferError + single: PyExc_ChildProcessError + single: PyExc_ConnectionAbortedError + single: PyExc_ConnectionError + single: PyExc_ConnectionRefusedError + single: PyExc_ConnectionResetError + single: PyExc_EOFError + single: PyExc_Exception + single: PyExc_FileExistsError + single: PyExc_FileNotFoundError + single: PyExc_FloatingPointError + single: PyExc_GeneratorExit + single: PyExc_ImportError + single: PyExc_IndentationError + single: PyExc_IndexError + single: PyExc_InterruptedError + single: PyExc_IsADirectoryError + single: PyExc_KeyError + single: PyExc_KeyboardInterrupt + single: PyExc_LookupError + single: PyExc_MemoryError + single: PyExc_ModuleNotFoundError + single: PyExc_NameError + single: PyExc_NotADirectoryError + single: PyExc_NotImplementedError + single: PyExc_OSError + single: PyExc_OverflowError + single: PyExc_PermissionError + single: PyExc_ProcessLookupError + single: PyExc_RecursionError + single: PyExc_ReferenceError + single: PyExc_RuntimeError + single: PyExc_StopAsyncIteration + single: PyExc_StopIteration + single: PyExc_SyntaxError + single: PyExc_SystemError + single: PyExc_SystemExit + single: PyExc_TabError + single: PyExc_TimeoutError + single: PyExc_TypeError + single: PyExc_UnboundLocalError + single: PyExc_UnicodeDecodeError + single: PyExc_UnicodeEncodeError + single: PyExc_UnicodeError + single: PyExc_UnicodeTranslateError + single: PyExc_ValueError + single: PyExc_ZeroDivisionError + +-----------------------------------------+---------------------------------+----------+ | C Name | Python Name | Notes | +=========================================+=================================+==========+ -| .. c:var:: PyExc_BaseException | :exc:`BaseException` | \(1) | +| :c:data:`PyExc_ArithmeticError` | :exc:`ArithmeticError` | \(1) | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_Exception | :exc:`Exception` | \(1) | +| :c:data:`PyExc_AssertionError` | :exc:`AssertionError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ArithmeticError | :exc:`ArithmeticError` | \(1) | +| :c:data:`PyExc_AttributeError` | :exc:`AttributeError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_AssertionError | :exc:`AssertionError` | | +| :c:data:`PyExc_BaseException` | :exc:`BaseException` | \(1) | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_AttributeError | :exc:`AttributeError` | | +| :c:data:`PyExc_BlockingIOError` | :exc:`BlockingIOError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_BlockingIOError | :exc:`BlockingIOError` | | +| :c:data:`PyExc_BrokenPipeError` | :exc:`BrokenPipeError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_BrokenPipeError | :exc:`BrokenPipeError` | | +| :c:data:`PyExc_BufferError` | :exc:`BufferError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_BufferError | :exc:`BufferError` | | +| :c:data:`PyExc_ChildProcessError` | :exc:`ChildProcessError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ChildProcessError | :exc:`ChildProcessError` | | +| :c:data:`PyExc_ConnectionAbortedError` | :exc:`ConnectionAbortedError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ConnectionAbortedError | :exc:`ConnectionAbortedError` | | +| :c:data:`PyExc_ConnectionError` | :exc:`ConnectionError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ConnectionError | :exc:`ConnectionError` | | +| :c:data:`PyExc_ConnectionRefusedError` | :exc:`ConnectionRefusedError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ConnectionRefusedError | :exc:`ConnectionRefusedError` | | +| :c:data:`PyExc_ConnectionResetError` | :exc:`ConnectionResetError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ConnectionResetError | :exc:`ConnectionResetError` | | +| :c:data:`PyExc_EOFError` | :exc:`EOFError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_EOFError | :exc:`EOFError` | | +| :c:data:`PyExc_Exception` | :exc:`Exception` | \(1) | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_FileExistsError | :exc:`FileExistsError` | | +| :c:data:`PyExc_FileExistsError` | :exc:`FileExistsError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_FileNotFoundError | :exc:`FileNotFoundError` | | +| :c:data:`PyExc_FileNotFoundError` | :exc:`FileNotFoundError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_FloatingPointError | :exc:`FloatingPointError` | | +| :c:data:`PyExc_FloatingPointError` | :exc:`FloatingPointError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_GeneratorExit | :exc:`GeneratorExit` | | +| :c:data:`PyExc_GeneratorExit` | :exc:`GeneratorExit` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ImportError | :exc:`ImportError` | | +| :c:data:`PyExc_ImportError` | :exc:`ImportError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_IndentationError | :exc:`IndentationError` | | +| :c:data:`PyExc_IndentationError` | :exc:`IndentationError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_IndexError | :exc:`IndexError` | | +| :c:data:`PyExc_IndexError` | :exc:`IndexError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_InterruptedError | :exc:`InterruptedError` | | +| :c:data:`PyExc_InterruptedError` | :exc:`InterruptedError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_IsADirectoryError | :exc:`IsADirectoryError` | | +| :c:data:`PyExc_IsADirectoryError` | :exc:`IsADirectoryError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_KeyError | :exc:`KeyError` | | +| :c:data:`PyExc_KeyError` | :exc:`KeyError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_KeyboardInterrupt | :exc:`KeyboardInterrupt` | | +| :c:data:`PyExc_KeyboardInterrupt` | :exc:`KeyboardInterrupt` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_LookupError | :exc:`LookupError` | \(1) | +| :c:data:`PyExc_LookupError` | :exc:`LookupError` | \(1) | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_MemoryError | :exc:`MemoryError` | | +| :c:data:`PyExc_MemoryError` | :exc:`MemoryError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ModuleNotFoundError | :exc:`ModuleNotFoundError` | | +| :c:data:`PyExc_ModuleNotFoundError` | :exc:`ModuleNotFoundError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_NameError | :exc:`NameError` | | +| :c:data:`PyExc_NameError` | :exc:`NameError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_NotADirectoryError | :exc:`NotADirectoryError` | | +| :c:data:`PyExc_NotADirectoryError` | :exc:`NotADirectoryError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_NotImplementedError | :exc:`NotImplementedError` | | +| :c:data:`PyExc_NotImplementedError` | :exc:`NotImplementedError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_OSError | :exc:`OSError` | \(1) | +| :c:data:`PyExc_OSError` | :exc:`OSError` | \(1) | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_OverflowError | :exc:`OverflowError` | | +| :c:data:`PyExc_OverflowError` | :exc:`OverflowError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_PermissionError | :exc:`PermissionError` | | +| :c:data:`PyExc_PermissionError` | :exc:`PermissionError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ProcessLookupError | :exc:`ProcessLookupError` | | +| :c:data:`PyExc_ProcessLookupError` | :exc:`ProcessLookupError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_RecursionError | :exc:`RecursionError` | | +| :c:data:`PyExc_RecursionError` | :exc:`RecursionError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ReferenceError | :exc:`ReferenceError` | \(2) | +| :c:data:`PyExc_ReferenceError` | :exc:`ReferenceError` | \(2) | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_RuntimeError | :exc:`RuntimeError` | | +| :c:data:`PyExc_RuntimeError` | :exc:`RuntimeError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_StopAsyncIteration | :exc:`StopAsyncIteration` | | +| :c:data:`PyExc_StopAsyncIteration` | :exc:`StopAsyncIteration` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_StopIteration | :exc:`StopIteration` | | +| :c:data:`PyExc_StopIteration` | :exc:`StopIteration` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_SyntaxError | :exc:`SyntaxError` | | +| :c:data:`PyExc_SyntaxError` | :exc:`SyntaxError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_SystemError | :exc:`SystemError` | | +| :c:data:`PyExc_SystemError` | :exc:`SystemError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_SystemExit | :exc:`SystemExit` | | +| :c:data:`PyExc_SystemExit` | :exc:`SystemExit` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_TabError | :exc:`TabError` | | +| :c:data:`PyExc_TabError` | :exc:`TabError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_TimeoutError | :exc:`TimeoutError` | | +| :c:data:`PyExc_TimeoutError` | :exc:`TimeoutError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_TypeError | :exc:`TypeError` | | +| :c:data:`PyExc_TypeError` | :exc:`TypeError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_UnboundLocalError | :exc:`UnboundLocalError` | | +| :c:data:`PyExc_UnboundLocalError` | :exc:`UnboundLocalError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_UnicodeDecodeError | :exc:`UnicodeDecodeError` | | +| :c:data:`PyExc_UnicodeDecodeError` | :exc:`UnicodeDecodeError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_UnicodeEncodeError | :exc:`UnicodeEncodeError` | | +| :c:data:`PyExc_UnicodeEncodeError` | :exc:`UnicodeEncodeError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_UnicodeError | :exc:`UnicodeError` | | +| :c:data:`PyExc_UnicodeError` | :exc:`UnicodeError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_UnicodeTranslateError | :exc:`UnicodeTranslateError` | | +| :c:data:`PyExc_UnicodeTranslateError` | :exc:`UnicodeTranslateError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ValueError | :exc:`ValueError` | | +| :c:data:`PyExc_ValueError` | :exc:`ValueError` | | +-----------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ZeroDivisionError | :exc:`ZeroDivisionError` | | +| :c:data:`PyExc_ZeroDivisionError` | :exc:`ZeroDivisionError` | | +-----------------------------------------+---------------------------------+----------+ .. versionadded:: 3.3 @@ -878,14 +933,19 @@ the variables: These are compatibility aliases to :c:data:`PyExc_OSError`: +.. index:: + single: PyExc_EnvironmentError + single: PyExc_IOError + single: PyExc_WindowsError + +-------------------------------------+----------+ | C Name | Notes | +=====================================+==========+ -| .. c:var:: PyExc_EnvironmentError | | +| :c:data:`PyExc_EnvironmentError` | | +-------------------------------------+----------+ -| .. c:var:: PyExc_IOError | | +| :c:data:`PyExc_IOError` | | +-------------------------------------+----------+ -| .. c:var:: PyExc_WindowsError | \(3) | +| :c:data:`PyExc_WindowsError` | \(3) | +-------------------------------------+----------+ .. versionchanged:: 3.3 @@ -911,31 +971,44 @@ names are ``PyExc_`` followed by the Python exception name. These have the type :c:type:`PyObject\*`; they are all class objects. For completeness, here are all the variables: -+--------------------------------------------+---------------------------------+----------+ -| C Name | Python Name | Notes | -+============================================+=================================+==========+ -| .. c:var:: PyExc_Warning | :exc:`Warning` | \(1) | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_BytesWarning | :exc:`BytesWarning` | | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_DeprecationWarning | :exc:`DeprecationWarning` | | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_FutureWarning | :exc:`FutureWarning` | | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ImportWarning | :exc:`ImportWarning` | | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_PendingDepricationWarning | :exc:`PendingDeprecationWarning`| | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_ResourceWarning | :exc:`ResourceWarning` | | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_RuntimeWarning | :exc:`RuntimeWarning` | | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_SyntaxWarning | :exc:`SyntaxWarning` | | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_UnicodeWarning | :exc:`UnicodeWarning` | | -+--------------------------------------------+---------------------------------+----------+ -| .. c:var:: PyExc_UserWarning | :exc:`UserWarning` | | -+--------------------------------------------+---------------------------------+----------+ +.. index:: + single: PyExc_BytesWarning + single: PyExc_DepricationWarning + single: PyExc_FutureWarning + single: PyExc_ImportWarning + single: PyExc_PendingDeprecationWarning + single: PyExc_ResourceWarning + single: PyExc_RuntimeWarning + single: PyExc_SyntaxWarning + single: PyExc_UnicodeWarning + single: PyExc_UserWarning + single: PyExc_Warning + ++------------------------------------------+---------------------------------+----------+ +| C Name | Python Name | Notes | ++==========================================+=================================+==========+ +| :c:data:`PyExc_BytesWarning` | :exc:`BytesWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_DeprecationWarning` | :exc:`DeprecationWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_FutureWarning` | :exc:`FutureWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ImportWarning` | :exc:`ImportWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_PendingDepricationWarning`| :exc:`PendingDeprecationWarning`| | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_ResourceWarning` | :exc:`ResourceWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_RuntimeWarning` | :exc:`RuntimeWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_SyntaxWarning` | :exc:`SyntaxWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_UnicodeWarning` | :exc:`UnicodeWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_UserWarning` | :exc:`UserWarning` | | ++------------------------------------------+---------------------------------+----------+ +| :c:data:`PyExc_Warning` | :exc:`Warning` | \(1) | ++------------------------------------------+---------------------------------+----------+ .. versionadded:: 3.2 :c:data:`PyExc_ResourceWarning`.