traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merged revisions 88686 via svnmerge from 

svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r88686 | antoine.pitrou | 2011-02-28 23:38:07 +0100 (lun., 28 févr. 2011) | 4 lines

  Recommend inspecting the errno attribute of socket.error objects,
  and improve wording.
........
This commit is contained in:
Antoine Pitrou 2011-02-28 23:03:28 +00:00
parent d1c9845b54
commit 6120d87d32
1 changed files with 26 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
Doc/library/socket.rst
View File

@ -117,39 +117,44 @@ The module :mod:`socket` exports the following constants and functions:
.. index:: module: errno .. index:: module: errno
This exception is raised for socket-related errors. The accompanying value is A subclass of :exc:`IOError`, this exception is raised for socket-related
either a string telling what went wrong or a pair ``(errno, string)`` errors. It is recommended that you inspect its ``errno`` attribute to
representing an error returned by a system call, similar to the value discriminate between different kinds of errors.
accompanying :exc:`os.error`. See the module :mod:`errno`, which contains names
for the error codes defined by the underlying operating system. .. seealso::
The :mod:`errno` module contains symbolic names for the error codes
defined by the underlying operating system.
.. exception:: herror .. exception:: herror
This exception is raised for address-related errors, i.e. for functions that use A subclass of :exc:`socket.error`, this exception is raised for
*h_errno* in the C API, including :func:`gethostbyname_ex` and address-related errors, i.e. for functions that use *h_errno* in the POSIX
:func:`gethostbyaddr`. C API, including :func:`gethostbyname_ex` and :func:`gethostbyaddr`.
The accompanying value is a pair ``(h_errno, string)`` representing an
The accompanying value is a pair ``(h_errno, string)`` representing an error error returned by a library call. *h_errno* is a numeric value, while
returned by a library call. *string* represents the description of *h_errno*, as *string* represents the description of *h_errno*, as returned by the
returned by the :c:func:`hstrerror` C function. :c:func:`hstrerror` C function.
.. exception:: gaierror .. exception:: gaierror
This exception is raised for address-related errors, for :func:`getaddrinfo` and A subclass of :exc:`socket.error`, this exception is raised for
:func:`getnameinfo`. The accompanying value is a pair ``(error, string)`` address-related errors by :func:`getaddrinfo` and :func:`getnameinfo`.
representing an error returned by a library call. *string* represents the The accompanying value is a pair ``(error, string)`` representing an error
description of *error*, as returned by the :c:func:`gai_strerror` C function. The returned by a library call. *string* represents the description of
*error* value will match one of the :const:`EAI_\*` constants defined in this *error*, as returned by the :c:func:`gai_strerror` C function. The
module. numeric *error* value will match one of the :const:`EAI_\*` constants
defined in this module.
.. exception:: timeout .. exception:: timeout
This exception is raised when a timeout occurs on a socket which has had A subclass of :exc:`socket.error`, this exception is raised when a timeout
timeouts enabled via a prior call to :meth:`~socket.settimeout`. The occurs on a socket which has had timeouts enabled via a prior call to
accompanying value is a string whose value is currently always "timed out". :meth:`~socket.settimeout` (or implicitly through
:func:`~socket.setdefaulttimeout`). The accompanying value is a string
whose value is currently always "timed out".
.. data:: AF_UNIX .. data:: AF_UNIX