Mailman 3 March 2011 - docs

[issue11282] unittest document not keep consist with code
by Ray.Allen April 3, 2011

April 3, 2011

New submission from Ray.Allen <ysj.ray(a)gmail.com>: r88451: Remove unittest methods scheduled for removal in 3.3 This commit remove assertSameElements() and assertDictContainsSubset(). But shouldn't some modification be done in the unittest library documentation? I wonder if we should remove the docs about the two methods. Now the doc only said "Deprecated since version 3.2." ---------- assignee: docs@python components: Documentation messages: 129036 nosy: docs@python, ysj.ray priority: normal severity: normal status: open title: unittest document not keep consist with code versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11282> _______________________________________

7 13

Typo in cProfile documentation
by Kurt McKee April 3, 2011

April 3, 2011

Howdy! Just wanted to let you know that there's a simple typo at: http://docs.python.org/dev/library/profile.html The note in section 26.3.1 uses the word "resonably" which should be spelled "reasonably". Thank you for the excellent documentation, it's marvelous! Sincerely, Kurt McKee

2 1

Error in The Python Tutorial
by Dhaval Patel April 3, 2011

April 3, 2011

Hi I am learning Python. As a part of my learning process, I found your tutorial very helpful. Today I have found error in section 4.4. break<https://mail.google.com/mail/html/compose/reference/simple_stmts.html#break>and continue<https://mail.google.com/mail/html/compose/reference/simple_stmts.html#conti…>Statements, and else<https://mail.google.com/mail/html/compose/reference/compound_stmts.html#else>Clauses on Loops >>> for n in range(2, 10):... for x in range(2, n):... if n % x == 0:... print n, 'equals', x, '*', n/x... break... else:... # loop fell through without finding a factor... print n, 'is a prime number'...2 is a prime number3 is a prime number4 equals 2 * 25 is a prime number6 equals 2 * 37 is a prime number8 equals 2 * 49 equals 3 * 3 The first output 2 is a prime number is not coming out I think when it goes in first inner for loop for x in range(2,2): range (2,2) is [] so it is not printing 2 is a prime number is not coming out I just want to make sure it my understanding is correct or there is mistake in document. Thanks -- Dhaval Patel

2 1

[issue8158] Docstring of optparse.OptionParser incomplete
by Jeff Ramnani March 31, 2011

March 31, 2011

Jeff Ramnani <jeff(a)jefframnani.com> added the comment: Attaching the same patch for 2.7. ---------- Added file: http://bugs.python.org/file21487/issue8151-2.7.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8158> _______________________________________

1 0

[issue8158] Docstring of optparse.OptionParser incomplete
by Jeff Ramnani March 31, 2011

March 31, 2011

Jeff Ramnani <jeff(a)jefframnani.com> added the comment: You are correct. I have added 'description' to the docstring of the OptionParser class for 2.7 and default (python3 tip). Here is the patch for python3 tip. ---------- keywords: +patch Added file: http://bugs.python.org/file21486/issue8151-default.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8158> _______________________________________

1 0

assertRegexpMatches arguments swapped in docs
by Danny Navarro March 30, 2011

March 30, 2011

Hi, I noticed that the ``assertRegexpMatches`` of the unittest module works by passing first the regex and then the text to be tested. However in the docs the text comes before the regex. http://docs.python.org/library/unittest.html#unittest.TestCase.assertRegexp… I'm on 2.7.1, BTW. Cheers, -- Danny Navarro | http://dannynavarro.net

1 0

[issue11712] Doc list.sort(cmp=,key=) result.
by Terry J. Reedy March 30, 2011

March 30, 2011

New submission from Terry J. Reedy <tjreedy(a)udel.edu>: l=[1,3,2] l.sort(cmp=lambda x,y:y-x, key=lambda x: x) print(l) With CPython 2.7 this 1) could raise an exception like TypeError: conflicting arguments passed; 2) could ignore cmp= and print [1,2,3] on the basis that the new should override the old; 3) does ignore key= and prints [3,2,1] (why does not matter now), but as near as I can tell, this is not documented. Suggestion: in 5.6.4. Mutable Sequence Types, in footnote 8, after "key specifies a function of one argument that is used to extract a comparison key from each list element: key=str.lower. The default value is None." add "Ignored if *cmp* is also given." ---------- assignee: docs@python components: Documentation keywords: easy, patch messages: 132507 nosy: docs@python, terry.reedy priority: normal severity: normal stage: needs patch status: open title: Doc list.sort(cmp=,key=) result. versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11712> _______________________________________

2 5

[issue9331] sys.setprofile is not described as CPython implementation detail
by Alexander Belopolsky March 29, 2011

March 29, 2011

New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: Unlike sys.settrace, sys.setprofile is not described as CPython implementation detail in Doc/library/sys.rst. ---------- assignee: docs@python components: Documentation messages: 111199 nosy: belopolsky, docs@python priority: normal severity: normal stage: needs patch status: open title: sys.setprofile is not described as CPython implementation detail type: feature request _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9331> _______________________________________

2 1

[issue11676] imp.load_module and submodules - doc issue, or bug?
by Brett Cannon March 29, 2011

March 29, 2011

Brett Cannon <brett(a)python.org> added the comment: It's actually not surprising that imp works this way: it predates packages. Because the semantics (I assume) have been like this for ages I say we document the current behavior (it's easy to work around) and simply continue to replace imp functionality with importlib ones that are more modern and reasonable. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11676> _______________________________________

1 0

[issue11690] Devguide: Add "communication" FAQ
by anatoly techtonik March 29, 2011

March 29, 2011

Changes by anatoly techtonik <techtonik(a)gmail.com>: ---------- assignee: -> docs@python components: +Devguide, Documentation -None nosy: +docs@python title: Add "communication" FAQ to devguide -> Devguide: Add "communication" FAQ _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11690> _______________________________________

1 0

[issue11676] imp.load_module and submodules - doc issue, or bug?
by Andreas Stührk March 29, 2011

March 29, 2011

Changes by Andreas Stührk <andy-python(a)hammerhartes.de>: ---------- nosy: +Trundle _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11676> _______________________________________

1 0

[issue11639] Documentation for *Config functions in logging module should be in logging.config
by Santoso Wijaya March 29, 2011

March 29, 2011

New submission from Santoso Wijaya <santoso.wijaya(a)gmail.com>: For example, the function `fileConfig` is listed in the documentation [1] as `logging.fileConfig`. This was a surprise for me when trying it gave me an AttributeError. Only after reading the source code that I found out this function is defined in the `logging.config` module, and must be referenced as such. [1] http://docs.python.org/library/logging.html#logging.fileConfig ---------- assignee: docs@python components: Documentation messages: 131791 nosy: docs@python, santa4nt priority: normal severity: normal status: open title: Documentation for *Config functions in logging module should be in logging.config versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11639> _______________________________________

3 6

[issue11676] imp.load_module and submodules - doc issue, or bug?
by Dave Peck March 28, 2011

March 28, 2011

Dave Peck <davepeck(a)gmail.com> added the comment: Definitely could agree with this assessment, but it is surprising given the lack of parallel behavior between 'import' and 'imp'. Note that imp.load_module(subpackage) _does_ modify the parent module's attributes -- but it will never put the subpackage attribute itself on parent. That's the part that made me think it shouldn't work this way and that its more bug than documentation. (That, and the specific use of the imp module in Google's dev_appserver.py which indicates that others have the same expectation of load_module() that I did.) ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11676> _______________________________________

1 0

[issue11704] functools.partial doesn't create bound methods
by Alex Gaynor March 28, 2011

March 28, 2011

Alex Gaynor <alex.gaynor(a)gmail.com> added the comment: Indeed I completely missed the section at the bottom. A note in the above section would be a useful addition. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11704> _______________________________________

1 0

[issue11704] functools.partial doesn't create bound methods
by Nick Coghlan March 28, 2011

March 28, 2011

Nick Coghlan <ncoghlan(a)gmail.com> added the comment: True, this could be documented better - flagging as a docs bug. (It is mentioned at the bottom of http://docs.python.org/library/functools.html#partial-objects, but that could be referenced better from the main documentation of the function higher up in the page) There's actually more to it than just an oversight though - partial() fills in positional arguments from the left, so using one as a method would require specification of a carefully crafted selection of positional and keyword arguments to ensure the instance was bound and passed in at the right point. ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python, ncoghlan _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11704> _______________________________________

1 0

[issue11676] imp.load_module and submodules - doc issue, or bug?
by Brett Cannon March 28, 2011

March 28, 2011

Brett Cannon <brett(a)python.org> added the comment: I say it's a documentation bug. ---------- assignee: -> docs@python components: +Documentation -Interpreter Core, Library (Lib) nosy: +brett.cannon, docs@python stage: -> needs patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11676> _______________________________________

1 0

[issue10617] Collections ABCs can’t be linked to
by Éric Araujo March 28, 2011

March 28, 2011

New submission from Éric Araujo <merwok(a)netwok.org>: ABCs in collections.rst are marked up with a class role, not a class directive, which means that constructs using the class role do not generate a link. ---------- assignee: docs@python components: Documentation messages: 123277 nosy: docs@python, eric.araujo priority: normal severity: normal stage: needs patch status: open title: Collections ABCs can’t be linked to versions: Python 2.7, Python 3.1, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10617> _______________________________________

6 21

[issue11699] Documentation for get_option_group is wrong
by Éric Araujo March 28, 2011

March 28, 2011

Changes by Éric Araujo <merwok(a)netwok.org>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python, eric.araujo, georg.brandl, lunar_yorn, nnorwitz versions: +Python 2.7, Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11699> _______________________________________

1 0

[issue1665333] Documentation missing for OptionGroup class in optparse
by Weeble March 28, 2011

March 28, 2011

Weeble <clockworksaint(a)gmail.com> added the comment: I think the documentation for get_option_group is not right. I've created a new bug: http://bugs.python.org/issue11699 ---------- nosy: +weeble _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue1665333> _______________________________________

1 0

[issue9694] argparse: Default Help Message Lists Required Args As Optional
by Éric Araujo March 27, 2011

March 27, 2011

Changes by Éric Araujo <merwok(a)netwok.org>: ---------- versions: +Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9694> _______________________________________

1 0

[issue9694] argparse: Default Help Message Lists Required Args As Optional
by Steven Bethard March 27, 2011

March 27, 2011

Steven Bethard <steven.bethard(a)gmail.com> added the comment: So it strikes me that there already exists an officially supported way to rename your option groups. Just only create your own option groups (never use the default ones) and only put arguments there, e.g.: ------------------------- temp.py -------------------------- parser = argparse.ArgumentParser(description = 'Do something', add_help=False) flags = parser.add_argument_group('flag arguments') flags.add_argument('-h', '--help', action='help') flags.add_argument('--reqarg', '-r', help='This is required', required=True) flags.add_argument('--optarg','-o', help="This is optional", required=False) args = parser.parse_args() ------------------------------------------------------------ $ python temp.py --help usage: temp.py [-h] --reqarg REQARG [--optarg OPTARG] Do something flag arguments: -h, --help --reqarg REQARG, -r REQARG This is required --optarg OPTARG, -o OPTARG This is optional ------------------------------------------------------------ The documentation for action='help' needs to be added, as pointed out in Issue# 10772. So basically, the API for customizing group names is already there. So I'm changing this to a documentation request - there should be an example in the docs showing how to change the default group names as above. ---------- assignee: -> docs@python components: +Documentation -Library (Lib) nosy: +docs@python stage: -> needs patch versions: +Python 3.3 -Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9694> _______________________________________

1 0

[issue1446619] extended slice behavior inconsistent with docs
by Mark Dickinson March 27, 2011

March 27, 2011

Changes by Mark Dickinson <dickinsm(a)gmail.com>: ---------- nosy: +mark.dickinson _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue1446619> _______________________________________

1 0

[issue1446619] extended slice behavior inconsistent with docs
by Steven Bethard March 27, 2011

March 27, 2011

Changes by Steven Bethard <steven.bethard(a)gmail.com>: ---------- stage: test needed -> patch review _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue1446619> _______________________________________

1 0

[issue1446619] extended slice behavior inconsistent with docs
by Steven Bethard March 27, 2011

March 27, 2011

Steven Bethard <steven.bethard(a)gmail.com> added the comment: The problem still exists in current trunk: The slicing semantics have been removed from the expressions reference: http://docs.python.org/py3k/reference/expressions.html#slicings The datamodel and types sections still have the same equations: http://docs.python.org/py3k/reference/datamodel.html#types http://docs.python.org/py3k/library/stdtypes.html#typesseq Here's a synopsis of the problem, in code: >>> # positive step, works as described >>> i, j, k = 2, 8, 2 >>> range(10)[i:j:k] [2, 4, 6] >>> [i + n * k for n in range(0, (j - i) / k)] [2, 4, 6] >>> [range(10)[i] for i in _] [2, 4, 6] >>> # negative step, does not work as described >>> i, j, k = 10, 0, -2 >>> range(10)[i:j:k] [9, 7, 5, 3, 1] >>> [i + n * k for n in range(0, (j - i) / k)] [10, 8, 6, 4, 2] >>> [range(10)[i] for i in _] Traceback (most recent call last): File "<stdin>", line 1, in <module> IndexError: list index out of range >>> # actual behavior trims 10 to 9 (is the same as 9:0:-2) >>> # that is, it trims to len(s) - 1, not len(s) >>> range(10)[9:0:-2] [9, 7, 5, 3, 1] I propose to ignore the definition in the datamodel section, since it's talking about extended slicing in general, and doesn't mention anything about negative indices. I propose the attached patch to fix the definition in the types section, which simply changes the statement: If i or j is greater than len(s), use len(s) to say: If *i* or *j* is greater than len(s), use len(s) if *k* is positive, or len(s) - 1 if *k* is negative. ---------- keywords: +patch versions: +Python 2.7, Python 3.2, Python 3.3 -Python 2.6, Python 3.0 Added file: http://bugs.python.org/file21428/extended_slicing_docs.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue1446619> _______________________________________

1 0

[issue11691] sqlite3 Cursor.description doesn't set type_code
by William Edward Stuart Clemens March 27, 2011

March 27, 2011

William Edward Stuart Clemens <wesclemens+python(a)gmail.com> added the comment: The patch for version 3.3 has a one line difference. ---------- assignee: -> docs@python components: +Documentation, Library (Lib) -None nosy: +docs@python versions: +Python 3.3 Added file: http://bugs.python.org/file21422/sqlite3_type_code_py33.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11691> _______________________________________

1 0