mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380) 

Co-authored-by: Andrew Kuchling <amk@amk.ca>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit a74892cb21)

Co-authored-by: yyyyyyyan <24644216+yyyyyyyan@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2022-04-04 19:30:25 -07:00 committed by GitHub
parent 5b4bc61d89
commit e47e6ffed3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 54 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
Doc/library/errno.rst
View File

@ -8,7 +8,7 @@
This module makes available standard ``errno`` system symbols. The value of each This module makes available standard ``errno`` system symbols. The value of each
symbol is the corresponding integer value. The names and descriptions are symbol is the corresponding integer value. The names and descriptions are
borrowed from :file:`linux/include/errno.h`, which should be pretty borrowed from :file:`linux/include/errno.h`, which should be
all-inclusive. all-inclusive.
@ -27,25 +27,26 @@ defined by the module. The specific list of defined symbols is available as
.. data:: EPERM .. data:: EPERM
Operation not permitted Operation not permitted. This error is mapped to the exception
:exc:`PermissionError`.
.. data:: ENOENT .. data:: ENOENT
No such file or directory No such file or directory. This error is mapped to the exception
:exc:`FileNotFoundError`.
.. data:: ESRCH .. data:: ESRCH
No such process No such process. This error is mapped to the exception
:exc:`ProcessLookupError`.
.. data:: EINTR .. data:: EINTR
Interrupted system call. Interrupted system call. This error is mapped to the exception
:exc:`InterruptedError`.
.. seealso::
This error is mapped to the exception :exc:`InterruptedError`.
.. data:: EIO .. data:: EIO
@ -75,12 +76,13 @@ defined by the module. The specific list of defined symbols is available as
.. data:: ECHILD .. data:: ECHILD
No child processes No child processes. This error is mapped to the exception
:exc:`ChildProcessError`.
.. data:: EAGAIN .. data:: EAGAIN
Try again Try again. This error is mapped to the exception :exc:`BlockingIOError`.
.. data:: ENOMEM .. data:: ENOMEM
@ -90,7 +92,8 @@ defined by the module. The specific list of defined symbols is available as
.. data:: EACCES .. data:: EACCES
Permission denied Permission denied. This error is mapped to the exception
:exc:`PermissionError`.
.. data:: EFAULT .. data:: EFAULT
@ -110,7 +113,8 @@ defined by the module. The specific list of defined symbols is available as
.. data:: EEXIST .. data:: EEXIST
File exists File exists. This error is mapped to the exception
:exc:`FileExistsError`.
.. data:: EXDEV .. data:: EXDEV
@ -125,12 +129,14 @@ defined by the module. The specific list of defined symbols is available as
.. data:: ENOTDIR .. data:: ENOTDIR
Not a directory Not a directory. This error is mapped to the exception
:exc:`NotADirectoryError`.
.. data:: EISDIR .. data:: EISDIR
Is a directory Is a directory. This error is mapped to the exception
:exc:`IsADirectoryError`.
.. data:: EINVAL .. data:: EINVAL
@ -185,7 +191,8 @@ defined by the module. The specific list of defined symbols is available as
.. data:: EPIPE .. data:: EPIPE
Broken pipe Broken pipe. This error is mapped to the exception
:exc:`BrokenPipeError`.
.. data:: EDOM .. data:: EDOM
@ -230,7 +237,8 @@ defined by the module. The specific list of defined symbols is available as
.. data:: EWOULDBLOCK .. data:: EWOULDBLOCK
Operation would block Operation would block. This error is mapped to the exception
:exc:`BlockingIOError`.
.. data:: ENOMSG .. data:: ENOMSG
@ -540,12 +548,14 @@ defined by the module. The specific list of defined symbols is available as
.. data:: ECONNABORTED .. data:: ECONNABORTED
Software caused connection abort Software caused connection abort. This error is mapped to the
exception :exc:`ConnectionAbortedError`.
.. data:: ECONNRESET .. data:: ECONNRESET
Connection reset by peer Connection reset by peer. This error is mapped to the exception
:exc:`ConnectionResetError`.
.. data:: ENOBUFS .. data:: ENOBUFS
@ -565,7 +575,8 @@ defined by the module. The specific list of defined symbols is available as
.. data:: ESHUTDOWN .. data:: ESHUTDOWN
Cannot send after transport endpoint shutdown Cannot send after transport endpoint shutdown. This error is mapped
to the exception :exc:`BrokenPipeError`.
.. data:: ETOOMANYREFS .. data:: ETOOMANYREFS
@ -575,12 +586,14 @@ defined by the module. The specific list of defined symbols is available as
.. data:: ETIMEDOUT .. data:: ETIMEDOUT
Connection timed out Connection timed out. This error is mapped to the exception
:exc:`TimeoutError`.
.. data:: ECONNREFUSED .. data:: ECONNREFUSED
Connection refused Connection refused. This error is mapped to the exception
:exc:`ConnectionRefusedError`.
.. data:: EHOSTDOWN .. data:: EHOSTDOWN
@ -595,12 +608,14 @@ defined by the module. The specific list of defined symbols is available as
.. data:: EALREADY .. data:: EALREADY
Operation already in progress Operation already in progress. This error is mapped to the
exception :exc:`BlockingIOError`.
.. data:: EINPROGRESS .. data:: EINPROGRESS
Operation now in progress Operation now in progress. This error is mapped to the exception
:exc:`BlockingIOError`.
.. data:: ESTALE .. data:: ESTALE

28
Doc/library/exceptions.rst
View File

@ -613,8 +613,8 @@ depending on the system error code.
Raised when an operation would block on an object (e.g. socket) set Raised when an operation would block on an object (e.g. socket) set
for non-blocking operation. for non-blocking operation.
Corresponds to :c:data:`errno` ``EAGAIN``, ``EALREADY``, Corresponds to :c:data:`errno` :py:data:`~errno.EAGAIN`, :py:data:`~errno.EALREADY`,
``EWOULDBLOCK`` and ``EINPROGRESS``. :py:data:`~errno.EWOULDBLOCK` and :py:data:`~errno.EINPROGRESS`.
In addition to those of :exc:`OSError`, :exc:`BlockingIOError` can have In addition to those of :exc:`OSError`, :exc:`BlockingIOError` can have
one more attribute: one more attribute:
@ -628,7 +628,7 @@ depending on the system error code.
.. exception:: ChildProcessError .. exception:: ChildProcessError
Raised when an operation on a child process failed. Raised when an operation on a child process failed.
Corresponds to :c:data:`errno` ``ECHILD``. Corresponds to :c:data:`errno` :py:data:`~errno.ECHILD`.
.. exception:: ConnectionError .. exception:: ConnectionError
@ -642,35 +642,35 @@ depending on the system error code.
A subclass of :exc:`ConnectionError`, raised when trying to write on a A subclass of :exc:`ConnectionError`, raised when trying to write on a
pipe while the other end has been closed, or trying to write on a socket pipe while the other end has been closed, or trying to write on a socket
which has been shutdown for writing. which has been shutdown for writing.
Corresponds to :c:data:`errno` ``EPIPE`` and ``ESHUTDOWN``. Corresponds to :c:data:`errno` :py:data:`~errno.EPIPE` and :py:data:`~errno.ESHUTDOWN`.
.. exception:: ConnectionAbortedError .. exception:: ConnectionAbortedError
A subclass of :exc:`ConnectionError`, raised when a connection attempt A subclass of :exc:`ConnectionError`, raised when a connection attempt
is aborted by the peer. is aborted by the peer.
Corresponds to :c:data:`errno` ``ECONNABORTED``. Corresponds to :c:data:`errno` :py:data:`~errno.ECONNABORTED`.
.. exception:: ConnectionRefusedError .. exception:: ConnectionRefusedError
A subclass of :exc:`ConnectionError`, raised when a connection attempt A subclass of :exc:`ConnectionError`, raised when a connection attempt
is refused by the peer. is refused by the peer.
Corresponds to :c:data:`errno` ``ECONNREFUSED``. Corresponds to :c:data:`errno` :py:data:`~errno.ECONNREFUSED`.
.. exception:: ConnectionResetError .. exception:: ConnectionResetError
A subclass of :exc:`ConnectionError`, raised when a connection is A subclass of :exc:`ConnectionError`, raised when a connection is
reset by the peer. reset by the peer.
Corresponds to :c:data:`errno` ``ECONNRESET``. Corresponds to :c:data:`errno` :py:data:`~errno.ECONNRESET`.
.. exception:: FileExistsError .. exception:: FileExistsError
Raised when trying to create a file or directory which already exists. Raised when trying to create a file or directory which already exists.
Corresponds to :c:data:`errno` ``EEXIST``. Corresponds to :c:data:`errno` :py:data:`~errno.EEXIST`.
.. exception:: FileNotFoundError .. exception:: FileNotFoundError
Raised when a file or directory is requested but doesn't exist. Raised when a file or directory is requested but doesn't exist.
Corresponds to :c:data:`errno` ``ENOENT``. Corresponds to :c:data:`errno` :py:data:`~errno.ENOENT`.
.. exception:: InterruptedError .. exception:: InterruptedError
@ -686,7 +686,7 @@ depending on the system error code.
Raised when a file operation (such as :func:`os.remove`) is requested Raised when a file operation (such as :func:`os.remove`) is requested
on a directory. on a directory.
Corresponds to :c:data:`errno` ``EISDIR``. Corresponds to :c:data:`errno` :py:data:`~errno.EISDIR`.
.. exception:: NotADirectoryError .. exception:: NotADirectoryError
@ -694,23 +694,23 @@ depending on the system error code.
something which is not a directory. On most POSIX platforms, it may also be something which is not a directory. On most POSIX platforms, it may also be
raised if an operation attempts to open or traverse a non-directory file as if raised if an operation attempts to open or traverse a non-directory file as if
it were a directory. it were a directory.
Corresponds to :c:data:`errno` ``ENOTDIR``. Corresponds to :c:data:`errno` :py:data:`~errno.ENOTDIR`.
.. exception:: PermissionError .. exception:: PermissionError
Raised when trying to run an operation without the adequate access Raised when trying to run an operation without the adequate access
rights - for example filesystem permissions. rights - for example filesystem permissions.
Corresponds to :c:data:`errno` ``EACCES`` and ``EPERM``. Corresponds to :c:data:`errno` :py:data:`~errno.EACCES` and :py:data:`~errno.EPERM`.
.. exception:: ProcessLookupError .. exception:: ProcessLookupError
Raised when a given process doesn't exist. Raised when a given process doesn't exist.
Corresponds to :c:data:`errno` ``ESRCH``. Corresponds to :c:data:`errno` :py:data:`~errno.ESRCH`.
.. exception:: TimeoutError .. exception:: TimeoutError
Raised when a system function timed out at the system level. Raised when a system function timed out at the system level.
Corresponds to :c:data:`errno` ``ETIMEDOUT``. Corresponds to :c:data:`errno` :py:data:`~errno.ETIMEDOUT`.
.. versionadded:: 3.3 .. versionadded:: 3.3
All the above :exc:`OSError` subclasses were added. All the above :exc:`OSError` subclasses were added.

1
Misc/ACKS
View File

@ -1269,6 +1269,7 @@ Ethan Onstott
Piet van Oostrum Piet van Oostrum
Tomas Oppelstrup Tomas Oppelstrup
Jason Orendorff Jason Orendorff
Yan "yyyyyyyan" Orestes
Bastien Orivel Bastien Orivel
orlnub123 orlnub123
Douglas Orr Douglas Orr

1
Misc/NEWS.d/next/Documentation/2020-07-07-22-54-51.bpo-41233.lyUJ8L.rst Normal file
View File

@ -0,0 +1 @@
Link the errnos referenced in ``Doc/library/exceptions.rst`` to their respective section in ``Doc/library/errno.rst``, and vice versa. Previously this was only done for EINTR and InterruptedError. Patch by Yan "yyyyyyyan" Orestes.