summaryrefslogtreecommitdiff
path: root/Doc/library/nntplib.rst
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2010-11-05 19:16:37 +0000
committerAntoine Pitrou <solipsis@pitrou.net>2010-11-05 19:16:37 +0000
commita078115434c58b2dce4cec82f3c2a90711166d60 (patch)
tree32c7524089fd9e97c4f275c3cff7a6d0a63941d9 /Doc/library/nntplib.rst
parent09fff7a8d185c5b87a979eefb94a2aa462b8a035 (diff)
downloadcpython-git-a078115434c58b2dce4cec82f3c2a90711166d60.tar.gz
Issue #10282: Add a `nntp_implementation` attribute to NNTP objects.
Diffstat (limited to 'Doc/library/nntplib.rst')
-rw-r--r--Doc/library/nntplib.rst46
1 files changed, 34 insertions, 12 deletions
diff --git a/Doc/library/nntplib.rst b/Doc/library/nntplib.rst
index 3f3995f25d..555d735f2c 100644
--- a/Doc/library/nntplib.rst
+++ b/Doc/library/nntplib.rst
@@ -54,7 +54,7 @@ The module itself defines the following classes:
.. class:: NNTP(host, port=119, user=None, password=None, readermode=None, usenetrc=True, [timeout])
- Return a new instance of the :class:`NNTP` class, representing a connection
+ Return a new :class:`NNTP` object, representing a connection
to the NNTP server running on host *host*, listening at port *port*.
An optional *timeout* can be specified for the socket connection.
If the optional *user* and *password* are provided, or if suitable
@@ -111,19 +111,41 @@ The module itself defines the following classes:
NNTP Objects
------------
-:class:`NNTP` instances have the following methods. The *response* that is
-returned as the first item in the return tuple of almost all methods is the
-server's response: a string beginning with a three-digit code. If the server's
-response indicates an error, the method raises one of the above exceptions.
+When connected, :class:`NNTP` objects support the following methods and
+attributes.
-.. note::
- Many of the following methods take an optional keyword-only argument *file*.
- When the *file* argument is supplied, it must be either a :term:`file object`
- opened for binary writing, or the name of an on-disk file to be written to.
- The method will then write any data returned by the server (except for the
- response line and the terminating dot) to the file; any list of lines,
- tuples or objects that the method normally returns will be empty.
+Attributes
+^^^^^^^^^^
+.. attribute:: NNTP.nntp_version
+
+ An integer representing the version of the NNTP protocol supported by the
+ server. In practice, this should be ``2`` for servers advertising
+ :rfc:`3977` compliance and ``1`` for others.
+
+ .. versionadded:: 3.2
+
+.. attribute:: NNTP.nntp_implementation
+
+ A string describing the software name and version of the NNTP server,
+ or :const:`None` if not advertised by the server.
+
+ .. versionadded:: 3.2
+
+Methods
+^^^^^^^
+
+The *response* that is returned as the first item in the return tuple of almost
+all methods is the server's response: a string beginning with a three-digit
+code. If the server's response indicates an error, the method raises one of
+the above exceptions.
+
+Many of the following methods take an optional keyword-only argument *file*.
+When the *file* argument is supplied, it must be either a :term:`file object`
+opened for binary writing, or the name of an on-disk file to be written to.
+The method will then write any data returned by the server (except for the
+response line and the terminating dot) to the file; any list of lines,
+tuples or objects that the method normally returns will be empty.
.. versionchanged:: 3.2
Many of the following methods have been reworked and fixed, which makes