Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Minimal update of socket docs for PEP 3151. 

More editing is probably desirable.
This commit is contained in:
Antoine Pitrou 2011-10-12 16:20:53 +02:00
parent f9c774696e
commit 70fa31c936
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
Doc/library/socket.rst
View File

@ -120,20 +120,15 @@ The module :mod:`socket` exports the following constants and functions:
.. exception:: error .. exception:: error
.. index:: module: errno A deprecated alias of :exc:`OSError`.
A subclass of :exc:`IOError`, this exception is raised for socket-related .. versionchanged:: 3.3
errors. It is recommended that you inspect its ``errno`` attribute to Following :pep:`3151`, this class was made an alias of :exc:`OSError`.
discriminate between different kinds of errors.
.. seealso::
The :mod:`errno` module contains symbolic names for the error codes
defined by the underlying operating system.
.. exception:: herror .. exception:: herror
A subclass of :exc:`socket.error`, this exception is raised for A subclass of :exc:`OSError`, this exception is raised for
address-related errors, i.e. for functions that use *h_errno* in the POSIX address-related errors, i.e. for functions that use *h_errno* in the POSIX
C API, including :func:`gethostbyname_ex` and :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
@ -141,10 +136,12 @@ The module :mod:`socket` exports the following constants and functions:
*string* represents the description of *h_errno*, as returned by the *string* represents the description of *h_errno*, as returned by the
:c:func:`hstrerror` C function. :c:func:`hstrerror` C function.
.. versionchanged:: 3.3
This class was made a subclass of :exc:`OSError`.
.. exception:: gaierror .. exception:: gaierror
A subclass of :exc:`socket.error`, this exception is raised for A subclass of :exc:`OSError`, this exception is raised for
address-related errors by :func:`getaddrinfo` and :func:`getnameinfo`. address-related errors by :func:`getaddrinfo` and :func:`getnameinfo`.
The accompanying value is a pair ``(error, string)`` representing an error The accompanying value is a pair ``(error, string)`` representing an error
returned by a library call. *string* represents the description of returned by a library call. *string* represents the description of
@ -152,15 +149,19 @@ The module :mod:`socket` exports the following constants and functions:
numeric *error* value will match one of the :const:`EAI_\*` constants numeric *error* value will match one of the :const:`EAI_\*` constants
defined in this module. defined in this module.
.. versionchanged:: 3.3
This class was made a subclass of :exc:`OSError`.
.. exception:: timeout .. exception:: timeout
A subclass of :exc:`socket.error`, this exception is raised when a timeout A subclass of :exc:`OSError`, this exception is raised when a timeout
occurs on a socket which has had timeouts enabled via a prior call to occurs on a socket which has had timeouts enabled via a prior call to
:meth:`~socket.settimeout` (or implicitly through :meth:`~socket.settimeout` (or implicitly through
:func:`~socket.setdefaulttimeout`). The accompanying value is a string :func:`~socket.setdefaulttimeout`). The accompanying value is a string
whose value is currently always "timed out". whose value is currently always "timed out".
.. versionchanged:: 3.3
This class was made a subclass of :exc:`OSError`.
.. data:: AF_UNIX .. data:: AF_UNIX
AF_INET AF_INET