[Python-checkins] r86366 - in python/branches/py3k: Doc/library/nntplib.rst Lib/nntplib.py Misc/NEWS

[antoine.pitrou]

Author: antoine.pitrou
Date: Tue Nov  9 19:58:42 2010
New Revision: 86366

Log:
Make `usenetrc` False by default (the old behaviour of having it True by 
default could be rather confusing).



Modified:
   python/branches/py3k/Doc/library/nntplib.rst
   python/branches/py3k/Lib/nntplib.py
   python/branches/py3k/Misc/NEWS

Modified: python/branches/py3k/Doc/library/nntplib.rst
==============================================================================
--- python/branches/py3k/Doc/library/nntplib.rst	(original)
+++ python/branches/py3k/Doc/library/nntplib.rst	Tue Nov  9 19:58:42 2010
@@ -52,24 +52,26 @@
 The module itself defines the following classes:
 
 
-.. class:: NNTP(host, port=119, user=None, password=None, readermode=None, usenetrc=True, [timeout])
+.. class:: NNTP(host, port=119, user=None, password=None, readermode=None, usenetrc=False, [timeout])
 
    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
    credentials are present in :file:`/.netrc` and the optional flag *usenetrc*
-   is true (the default), the ``AUTHINFO USER`` and ``AUTHINFO PASS`` commands
-   are used to identify and authenticate the user to the server.  If the optional
+   is true, the ``AUTHINFO USER`` and ``AUTHINFO PASS`` commands are used
+   to identify and authenticate the user to the server.  If the optional
    flag *readermode* is true, then a ``mode reader`` command is sent before
    authentication is performed.  Reader mode is sometimes necessary if you are
    connecting to an NNTP server on the local machine and intend to call
    reader-specific commands, such as ``group``.  If you get unexpected
    :exc:`NNTPPermanentError`\ s, you might need to set *readermode*.
-   *readermode* defaults to ``None``. *usenetrc* defaults to ``True``.
+
+   .. versionchanged:: 3.2
+      *usenetrc* is now False by default.
 
 
-.. class:: NNTP_SSL(host, port=563, user=None, password=None, ssl_context=None, readermode=None, usenetrc=True, [timeout])
+.. class:: NNTP_SSL(host, port=563, user=None, password=None, ssl_context=None, readermode=None, usenetrc=False, [timeout])
 
    Return a new :class:`NNTP_SSL` object, representing an encrypted
    connection to the NNTP server running on host *host*, listening at

Modified: python/branches/py3k/Lib/nntplib.py
==============================================================================
--- python/branches/py3k/Lib/nntplib.py	(original)
+++ python/branches/py3k/Lib/nntplib.py	Tue Nov  9 19:58:42 2010
@@ -308,7 +308,7 @@
                  readermode=None, timeout=_GLOBAL_DEFAULT_TIMEOUT):
         """Initialize an instance.  Arguments:
         - file: file-like object (open for read/write in binary mode)
-        - host: hostname of the server (used if `usenetrc` is True)
+        - host: hostname of the server
         - readermode: if true, send 'mode reader' command after
                       connecting.
         - timeout: timeout (in seconds) used for socket connections
@@ -986,7 +986,7 @@
 class NNTP(_NNTPBase):
 
     def __init__(self, host, port=NNTP_PORT, user=None, password=None,
-                 readermode=None, usenetrc=True,
+                 readermode=None, usenetrc=False,
                  timeout=_GLOBAL_DEFAULT_TIMEOUT):
         """Initialize an instance.  Arguments:
         - host: hostname to connect to
@@ -1026,7 +1026,7 @@
 
         def __init__(self, host, port=NNTP_SSL_PORT,
                     user=None, password=None, ssl_context=None,
-                    readermode=None, usenetrc=True,
+                    readermode=None, usenetrc=False,
                     timeout=_GLOBAL_DEFAULT_TIMEOUT):
             """This works identically to NNTP.__init__, except for the change
             in default port and the `ssl_context` argument for SSL connections.

Modified: python/branches/py3k/Misc/NEWS
==============================================================================
--- python/branches/py3k/Misc/NEWS	(original)
+++ python/branches/py3k/Misc/NEWS	Tue Nov  9 19:58:42 2010
@@ -60,6 +60,8 @@
 Library
 -------
 
+- ``usenetrc`` is now false by default for NNTP objects.
+
 - Issue #1926: Add support for NNTP over SSL on port 563, as well as
   STARTTLS.  Patch by Andrew Vant.