Mailman 3 August 2012 - docs

Bug in python tutorial
by Øystein Rognes Solheim Aug. 18, 2012

Aug. 18, 2012

In chapter 4.4 of the python tutorial ( http://docs.python.org/tutorial/controlflow.html#break-and-continue-stateme… ), the second example reads: >>> for num in range(2, 10):... if x % 2 == 0:... print("Found an even number", num)... continue... print("Found a number", num)Found an even number 2Found a number 3Found an even number 4Found a number 5Found an even number 6Found a number 7Found an even number 8Found a number 9 The x in line 2 should be replaced by num. best regards, Øystein R. Solheim

2 1

[issue15636] base64.decodebytes is only available in Python3.1+
by Andrew Scheller Aug. 18, 2012

Aug. 18, 2012

New submission from Andrew Scheller: According to the documentation ( http://docs.python.org/py3k/library/base64.html#base64.decodebytes ) both the decodebytes and the deprecated decodestring methods are available in the base64 module in Python3.x However in Python3.0 (I'm testing with version 3.0.1 built from source) the base64 module only has the decodestring method, it doesn't have decodebytes. IMHO the documentation should be updated to reflect this. It looks like decodebytes was added to Python3.1 by http://bugs.python.org/issue3613 ---------- assignee: docs@python components: Documentation messages: 168080 nosy: docs@python, lurchman priority: normal severity: normal status: open title: base64.decodebytes is only available in Python3.1+ type: enhancement versions: Python 3.1, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15636> _______________________________________

5 5

[issue15355] generator.__next__() docs should mention exception if already executing
by Chris Jerdonek Aug. 18, 2012

Aug. 18, 2012

New submission from Chris Jerdonek <chris.jerdonek(a)gmail.com>: I think the generator.__next__() documentation should say that it raises an exception if the generator is already executing: http://docs.python.org/dev/reference/expressions.html#generator.__next__ I don't think this is currently mentioned anywhere in the section on yield expressions. I think this is worth mentioning because this is different from the general situation for iterators, for example. One consequence of this is that, unlike for iterators, using a bare generator in a multithreaded situation will always result in a critical section (since an iterator can be made to take care of its own locking, etc). ---------- assignee: docs@python components: Documentation keywords: easy messages: 165476 nosy: cjerdonek, docs@python priority: normal severity: normal status: open title: generator.__next__() docs should mention exception if already executing versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15355> _______________________________________

5 13

[issue15694] link to "file object" glossary entry in open() and io docs
by Chris Jerdonek Aug. 18, 2012

Aug. 18, 2012

New submission from Chris Jerdonek: It would be nice if the first sentence of the documentation for the open() built-in function: "Open file and return a corresponding stream. If the file cannot be opened, an OSError is raised." http://docs.python.org/dev/library/functions.html#open linked to the glossary entry for "file object": http://docs.python.org/dev/glossary.html#term-file-object Incidentally, this would be similar to what was done 2.7 documentation of open(): http://docs.python.org/library/functions.html#open Similarly, the introductory overview section of the io module should also link to the glossary entry for "file object": "Concrete objects belonging to any of these categories will often be called streams; another common term is file-like objects." (from http://docs.python.org/dev/library/io.html#overview ) ---------- assignee: docs@python components: Documentation messages: 168392 nosy: cjerdonek, docs@python priority: normal severity: normal status: open title: link to "file object" glossary entry in open() and io docs type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15694> _______________________________________

5 7

[issue15660] Clarify 0 prefix for width specifier in str.format doc,
by Terry J. Reedy Aug. 17, 2012

Aug. 17, 2012

Changes by Terry J. Reedy <tjreedy(a)udel.edu>: ---------- assignee: docs@python -> terry.reedy _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15660> _______________________________________

1 0

[issue15660] Clarify 0 prefix for width specifier in str.format doc,
by Terry J. Reedy Aug. 17, 2012

Aug. 17, 2012

Changes by Terry J. Reedy <tjreedy(a)udel.edu>: ---------- stage: needs patch -> committed/rejected status: open -> closed title: In str.format there is a misleading error message about alignment -> Clarify 0 prefix for width specifier in str.format doc, _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15660> _______________________________________

1 0

[issue15660] In str.format there is a misleading error message about alignment
by Terry J. Reedy Aug. 17, 2012

Aug. 17, 2012

Changes by Terry J. Reedy <tjreedy(a)udel.edu>: ---------- resolution: -> fixed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15660> _______________________________________

1 0

[issue15660] In str.format there is a misleading error message about alignment
by Roundup Robot Aug. 17, 2012

Aug. 17, 2012

Roundup Robot added the comment: New changeset 85cd54b2d3a1 by Terry Jan Reedy in branch '2.7': Issue 15660: Clarify 0 prefix for width field in str.format doc. http://hg.python.org/cpython/rev/85cd54b2d3a1 New changeset 6bc14974024f by Terry Jan Reedy in branch '3.2': Issue 15660: Clarify 0 prefix for width field in str.format doc. http://hg.python.org/cpython/rev/6bc14974024f New changeset f181dd088e63 by Terry Jan Reedy in branch 'default': Merge with 3.2 #15660 http://hg.python.org/cpython/rev/f181dd088e63 ---------- nosy: +python-dev _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15660> _______________________________________

1 0

[issue15660] In str.format there is a misleading error message about alignment
by Terry J. Reedy Aug. 17, 2012

Aug. 17, 2012

Terry J. Reedy added the comment: As I read the docs, the error message is correct and this issue is invalid as a behavior issue. I read the OP's second message as more or less saying this also. "'=' Forces the padding to be placed after the sign (if any) but before the digits. This is used for printing fields in the form ‘+000000120’. This alignment option is only valid for numeric types." "If the width field is preceded by a zero ('0') character, this enables zero-padding. This is equivalent to an alignment type of '=' and a fill character of '0'." So ":02" is equivalent to ":0=2", which is invalid. >>> '{:02d}'.format(1) '01' works fine. I decided make this a doc issue and add " for numeric types" after "this enables zero-padding" before closing this. ---------- assignee: -> docs@python components: +Documentation -Interpreter Core nosy: +docs@python, terry.reedy versions: +Python 2.7, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15660> _______________________________________

1 0

[issue15412] Note in documentation for weakrefs
by Richard Oudkerk Aug. 17, 2012

Aug. 17, 2012

New submission from Richard Oudkerk <shibturn(a)gmail.com>: In the documentation on weakrefs there is the following quote Note: Weak references to an object are cleared before the object’s __del__() is called, to ensure that the weak reference callback (if any) finds the object still alive. But I think the weakref is always dead by the time the callback is invoked. The first paragraph from the documentation for weakref.ref(object[, callback]) contains the following: If callback is provided and not None, and the returned weakref object is still alive, the callback will be called when the object is about to be finalized; the weak reference object will be passed as the only parameter to the callback; **the referent will no longer be available**. Which does prompt a question: what use is there for the weakref argument to the callback if it already dead? (Compare http://bugs.python.org/issue14933) ---------- assignee: docs@python components: Documentation messages: 166002 nosy: docs@python, pitrou, sbt priority: normal severity: normal status: open title: Note in documentation for weakrefs _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15412> _______________________________________

3 5