From 8b8f2ec560136a6b4bf91726aaaff2376a725cbf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Sat, 26 Mar 2011 07:22:01 +0100 Subject: [PATCH 01/12] Kill last reference to defunct module --- Doc/c-api/intro.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst index e8b62dc5fc7..c008b5c93dd 100644 --- a/Doc/c-api/intro.rst +++ b/Doc/c-api/intro.rst @@ -511,13 +511,12 @@ interpreter can only be used after the interpreter has been initialized. module: builtins module: __main__ module: sys - module: exceptions triple: module; search; path single: path (in module sys) The basic initialization function is :cfunc:`Py_Initialize`. This initializes the table of loaded modules, and creates the fundamental modules -:mod:`builtins`, :mod:`__main__`, :mod:`sys`, and :mod:`exceptions`. It also +:mod:`builtins`, :mod:`__main__`, and :mod:`sys`. It also initializes the module search path (``sys.path``). .. index:: single: PySys_SetArgv() From 395ba35a9224339bdcaf20ad966ceaf084142444 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Fri, 15 Apr 2011 23:34:31 +0200 Subject: [PATCH 02/12] Minor tweaks to a few comments in heapq --- Lib/heapq.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Lib/heapq.py b/Lib/heapq.py index b74818e2ba7..cc61294cc8b 100644 --- a/Lib/heapq.py +++ b/Lib/heapq.py @@ -172,7 +172,7 @@ def heappushpop(heap, item): return item def heapify(x): - """Transform list into a heap, in-place, in O(len(heap)) time.""" + """Transform list into a heap, in-place, in O(len(x)) time.""" n = len(x) # Transform bottom-up. The largest index there's any point to looking at # is the largest with a child index in-range, so must have 2*i + 1 < n, @@ -363,7 +363,7 @@ def nsmallest(n, iterable, key=None): return [min(chain(head, it))] return [min(chain(head, it), key=key)] - # When n>=size, it's faster to use sort() + # When n>=size, it's faster to use sorted() try: size = len(iterable) except (TypeError, AttributeError): @@ -401,7 +401,7 @@ def nlargest(n, iterable, key=None): return [max(chain(head, it))] return [max(chain(head, it), key=key)] - # When n>=size, it's faster to use sort() + # When n>=size, it's faster to use sorted() try: size = len(iterable) except (TypeError, AttributeError): From 691840f2189d78e50e63ec04f5ce71b9d3049c54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Thu, 14 Apr 2011 03:49:19 +0200 Subject: [PATCH 03/12] Fix improper tests in RegisterTestCase --- Lib/distutils/tests/test_register.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Lib/distutils/tests/test_register.py b/Lib/distutils/tests/test_register.py index c712f56a788..cb72a115382 100644 --- a/Lib/distutils/tests/test_register.py +++ b/Lib/distutils/tests/test_register.py @@ -137,7 +137,7 @@ class RegisterTestCase(PyPIRCCommandTestCase): # let's see what the server received : we should # have 2 similar requests - self.assertTrue(self.conn.reqs, 2) + self.assertEqual(len(self.conn.reqs), 2) req1 = dict(self.conn.reqs[0].headers) req2 = dict(self.conn.reqs[1].headers) @@ -169,7 +169,7 @@ class RegisterTestCase(PyPIRCCommandTestCase): del register_module.input # we should have send a request - self.assertTrue(self.conn.reqs, 1) + self.assertEqual(len(self.conn.reqs), 1) req = self.conn.reqs[0] headers = dict(req.headers) self.assertEqual(headers['Content-length'], '608') @@ -187,7 +187,7 @@ class RegisterTestCase(PyPIRCCommandTestCase): del register_module.input # we should have send a request - self.assertTrue(self.conn.reqs, 1) + self.assertEqual(len(self.conn.reqs), 1) req = self.conn.reqs[0] headers = dict(req.headers) self.assertEqual(headers['Content-length'], '290') From a0b3c32c7a35422c1196824dce1a0c1f7f8969eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Sat, 16 Apr 2011 23:47:53 +0200 Subject: [PATCH 04/12] Advertise nesting directives for class/method and class/data combos. Also fix a typo and a misleading example (method used to describe function). --- Doc/documenting/markup.rst | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 34a79d4372a..be7718d82e3 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -152,7 +152,7 @@ The directives are: Describes global data in a module, including both variables and values used as "defined constants." Class and object attributes are not documented - using this environment. + using this directive. .. describe:: exception @@ -165,7 +165,7 @@ The directives are: parameters, enclosing optional parameters in brackets. Default values can be given if it enhances clarity. For example:: - .. function:: Timer.repeat([repeat=3[, number=1000000]]) + .. function:: repeat([repeat=3[, number=1000000]]) Object methods are not documented using this directive. Bound object methods placed in the module namespace as part of the public interface of the module @@ -186,13 +186,30 @@ The directives are: Describes an object data attribute. The description should include information about the type of the data to be expected and whether it may be - changed directly. + changed directly. This directive should be nested in a class directive, + like in this example:: + + .. class:: Spam + + Description of the class. + + .. data:: ham + + Description of the attribute. + + If is also possible to document an attribute outside of a class directive, + for example if the documentation for different attributes and methods is + split in multiple sections. The class name should then be included + explicitly:: + + .. data:: Spam.eggs .. describe:: method Describes an object method. The parameters should not include the ``self`` parameter. The description should include similar information to that - described for ``function``. + described for ``function``. This method should be nested in a class + method, like in the example above. .. describe:: opcode From dcb22a39366f7bea8aa3359803ee32fe46debf58 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Sun, 17 Apr 2011 14:27:07 +0200 Subject: [PATCH 05/12] Fix resource warning found manually --- Lib/distutils/command/sdist.py | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/Lib/distutils/command/sdist.py b/Lib/distutils/command/sdist.py index 1118060cbb9..fdbebd7e0fc 100644 --- a/Lib/distutils/command/sdist.py +++ b/Lib/distutils/command/sdist.py @@ -294,17 +294,20 @@ class sdist(Command): join_lines=1, lstrip_ws=1, rstrip_ws=1, collapse_join=1) - while True: - line = template.readline() - if line is None: # end of file - break + try: + while True: + line = template.readline() + if line is None: # end of file + break - try: - self.filelist.process_template_line(line) - except DistutilsTemplateError as msg: - self.warn("%s, line %d: %s" % (template.filename, - template.current_line, - msg)) + try: + self.filelist.process_template_line(line) + except DistutilsTemplateError as msg: + self.warn("%s, line %d: %s" % (template.filename, + template.current_line, + msg)) + finally: + template.close() def prune_file_list(self): """Prune off branches that might slip into the file list as created From f8e1b607994028c826401c7f6f3637d9c797ed25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Wed, 20 Apr 2011 18:52:55 +0200 Subject: [PATCH 06/12] Add docstring to dbm.open --- Lib/dbm/__init__.py | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/Lib/dbm/__init__.py b/Lib/dbm/__init__.py index 99c16379a95..57be17b4081 100644 --- a/Lib/dbm/__init__.py +++ b/Lib/dbm/__init__.py @@ -24,16 +24,8 @@ It has the following interface (key and data are strings): list = d.keys() # return a list of all existing keys (slow!) Future versions may change the order in which implementations are -tested for existence, add interfaces to other dbm-like +tested for existence, and add interfaces to other dbm-like implementations. - -The open function has an optional second argument. This can be 'r', -for read-only access, 'w', for read-write access of an existing -database, 'c' for read-write access to a new or existing database, and -'n' for read-write access to a new database. The default is 'r'. - -Note: 'r' and 'w' fail if the database doesn't exist; 'c' creates it -only if it doesn't exist; and 'n' always creates a new database. """ __all__ = ['open', 'whichdb', 'error', 'error'] @@ -54,7 +46,17 @@ _modules = {} error = (error, IOError) -def open(file, flag = 'r', mode = 0o666): +def open(file, flag='r', mode=0o666): + """Open or create database at path given by *file*. + + Optional argument *flag* can be 'r' (default) for read-only access, 'w' + for read-write access of an existing database, 'c' for read-write access + to a new or existing database, and 'n' for read-write access to a new + database. + + Note: 'r' and 'w' fail if the database doesn't exist; 'c' creates it + only if it doesn't exist; and 'n' always creates a new database. + """ global _defaultmod if _defaultmod is None: for name in _names: From 5c1a0c969d82670ba7aac7647b9828f4df85c1bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Wed, 20 Apr 2011 19:11:12 +0200 Subject: [PATCH 07/12] Fix argument name in reST doc to match the code --- Doc/library/dbm.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst index c7c73475eb6..cbefc1aa118 100644 --- a/Doc/library/dbm.rst +++ b/Doc/library/dbm.rst @@ -30,9 +30,9 @@ the Oracle Berkeley DB. name, such as ``'dbm.ndbm'`` or ``'dbm.gnu'``. -.. function:: open(filename, flag='r', mode=0o666) +.. function:: open(file, flag='r', mode=0o666) - Open the database file *filename* and return a corresponding object. + Open the database file *file* and return a corresponding object. If the database file already exists, the :func:`whichdb` function is used to determine its type and the appropriate module is used; if it does not exist, From de579d4359e0088feb36bb4be080c2ab36cd9365 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Thu, 21 Apr 2011 02:37:41 +0200 Subject: [PATCH 08/12] Add a space to make json doc a bit more readable --- Doc/library/json.rst | 2 +- Lib/json/__init__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/json.rst b/Doc/library/json.rst index 6bb48e81ef5..48acaf19d6f 100644 --- a/Doc/library/json.rst +++ b/Doc/library/json.rst @@ -34,7 +34,7 @@ Encoding basic Python object hierarchies:: Compact encoding:: >>> import json - >>> json.dumps([1,2,3,{'4': 5, '6': 7}], separators=(',',':')) + >>> json.dumps([1,2,3,{'4': 5, '6': 7}], separators=(',', ':')) '[1,2,3,{"4":5,"6":7}]' Pretty printing:: diff --git a/Lib/json/__init__.py b/Lib/json/__init__.py index a746f9cf9c9..6d88931dcbd 100644 --- a/Lib/json/__init__.py +++ b/Lib/json/__init__.py @@ -31,7 +31,7 @@ Encoding basic Python object hierarchies:: Compact encoding:: >>> import json - >>> json.dumps([1,2,3,{'4': 5, '6': 7}], separators=(',',':')) + >>> json.dumps([1,2,3,{'4': 5, '6': 7}], separators=(',', ':')) '[1,2,3,{"4":5,"6":7}]' Pretty printing:: From 2b9388a03325fa4452a8cb3b9df8a7fbb7302b87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Fri, 22 Apr 2011 21:27:10 +0200 Subject: [PATCH 09/12] Fix weird executable name --- Doc/distutils/examples.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/distutils/examples.rst b/Doc/distutils/examples.rst index 6c2773874cd..e8d1ec99374 100644 --- a/Doc/distutils/examples.rst +++ b/Doc/distutils/examples.rst @@ -280,7 +280,7 @@ For example, if the :file:`setup.py` script is changed like this:: Where the long description is broken, ``check`` will be able to detect it by using the :mod:`docutils` parser:: - $ pythontrunk setup.py check --restructuredtext + $ python setup.py check --restructuredtext running check warning: check: Title underline too short. (line 2) warning: check: Could not finish the parsing. From 2bad92d31076118d1e9aad1b8fb8a24b03a18f00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Sun, 24 Apr 2011 17:10:30 +0200 Subject: [PATCH 10/12] Remove obsolete/duplicate docstring --- Lib/test/tracedmodules/__init__.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/Lib/test/tracedmodules/__init__.py b/Lib/test/tracedmodules/__init__.py index 4628d8a3a37..13fa4f2be9f 100644 --- a/Lib/test/tracedmodules/__init__.py +++ b/Lib/test/tracedmodules/__init__.py @@ -2,8 +2,3 @@ that the exact location of functions in these modules is important, as trace.py takes the real line numbers into account. """ -"""This directory contains modules that help testing the trace.py module. Note -that the exact location of functions in these modules is important, as trace.py -takes the real line numbers into account. - -""" From 16190c8236f6d154507353850916cd49292cc720 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Mon, 25 Apr 2011 19:05:53 +0200 Subject: [PATCH 11/12] Change markup so that it creates a link --- Doc/library/wsgiref.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index fda9e70e5c9..231449ce9f0 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -664,7 +664,7 @@ input, output, and error streams. .. attribute:: BaseHandler.wsgi_file_wrapper A ``wsgi.file_wrapper`` factory, or ``None``. The default value of this - attribute is the :class:`FileWrapper` class from :mod:`wsgiref.util`. + attribute is the :class:`wsgiref.util.FileWrapper` class. .. method:: BaseHandler.sendfile() From 10f3d7acbd69206bd9166f812d0503fed187eb5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Wed, 27 Apr 2011 16:22:32 +0200 Subject: [PATCH 12/12] Change markup so it generates a link --- Doc/library/__future__.rst | 2 +- Doc/library/sys.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Doc/library/__future__.rst b/Doc/library/__future__.rst index 3c423939f19..2348217f3dc 100644 --- a/Doc/library/__future__.rst +++ b/Doc/library/__future__.rst @@ -26,7 +26,7 @@ Each statement in :file:`__future__.py` is of the form:: where, normally, *OptionalRelease* is less than *MandatoryRelease*, and both are -5-tuples of the same form as ``sys.version_info``:: +5-tuples of the same form as :data:`sys.version_info`:: (PY_MAJOR_VERSION, # the 2 in 2.1.0a3; an int PY_MINOR_VERSION, # the 1; an int diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index e51e8eaba83..acf57638191 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -447,8 +447,8 @@ always available. This is called ``hexversion`` since it only really looks meaningful when viewed as the result of passing it to the built-in :func:`hex` function. The - ``version_info`` value may be used for a more human-friendly encoding of the - same information. + struct sequence :data:`sys.version_info` may be used for a more human-friendly + encoding of the same information. .. data:: int_info