Mailman 3 August 2013 - docs

[issue15863] Fine-grained info about Python versions which support changes introduced in micro releases
by Alexander Konovalenko Oct. 8, 2013

Oct. 8, 2013

New submission from Alexander Konovalenko: Some security fixes and bug fixes that are simultaneously issued for multiple Python versions require changes to the documentation. I'm now looking at the hash randomization vulnerability that was fixed in 2.6.8 and 2.7.3. The docs always mention the release in which a new feature was added. That's great. But for a security fix such as the bug in question, the set of versions which support it doesn't look like "2.x.y or later". The documentation for the -R command-line option and the PYTHONHASHSEED environment variable says "New in version 2.6.8". A reader who is not familiar with the context would infer that those feature are supported in Python 2.7 through 2.7.2, which is not the case. The docs should say "New in version 2.6.8 and 2.7.3". http://docs.python.org/using/cmdline.html#cmdoption-R http://docs.python.org/using/cmdline.html#envvar-PYTHONHASHSEED The documentation for the sys.flags.hash_randomization attribute says "New in version 2.7.3". Again, that leaves out the version 2.6.8 and future versions in the 2.6.x branch, which presumably support the new attribute. The docs should say "New in version 2.6.8 and 2.7.3". http://docs.python.org/library/sys.html#sys.flags Disclaimer: I did not test the relevant micro releases to see whether they actually support those features. Just checked the release dates and applied common sense. If you know of any other micro release bugfixes that were mentioned in the docs, the same considerations apply to them. Please verify the docs are correct, fix them or file appropriate bugs. ---------- assignee: docs@python components: Documentation messages: 169841 nosy: alexkon, docs@python priority: normal severity: normal status: open title: Fine-grained info about Python versions which support changes introduced in micro releases versions: Python 2.6, Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15863> _______________________________________

4 6

[issue15455] index entries not showing up in glossary
by Chris Jerdonek Oct. 8, 2013

Oct. 8, 2013

New submission from Chris Jerdonek <chris.jerdonek(a)gmail.com>: I haven't tracked down the reason for this, but certain index entries seem to be getting skipped in the Glossary. If you view source on the Glossary page and search for "index-": http://docs.python.org/dev/glossary.html You will find that it skips from 'index-2' to 'index-5'. Only :pep: index entries are getting included even though the Glossary's rst file contains explicit index directives (where 'index-3' and 'index-4' would otherwise be). I tried some experiments, and this seems to occur even if the index directive text does not match the name of the Glossary term. ---------- assignee: docs@python components: Documentation messages: 166467 nosy: cjerdonek, docs@python priority: normal severity: normal status: open title: index entries not showing up in glossary type: behavior versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15455> _______________________________________

3 3

[issue15264] PyErr_SetFromErrnoWithFilenameObject() undocumented
by Antoine Pitrou Oct. 8, 2013

Oct. 8, 2013

New submission from Antoine Pitrou <pitrou(a)free.fr>: Title says it all. ---------- assignee: docs@python components: Documentation, Interpreter Core messages: 164736 nosy: docs@python, pitrou priority: normal severity: normal stage: needs patch status: open title: PyErr_SetFromErrnoWithFilenameObject() undocumented type: behavior versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15264> _______________________________________

2 1

[issue13867] misleading comment in weakrefobject.h
by Jim Jewett Oct. 8, 2013

Oct. 8, 2013

New submission from Jim Jewett <jimjjewett(a)gmail.com>: http://hg.python.org/cpython/file/fec45282dc28/Include/weakrefobject.h#l54 The comment makes sense -- but doesn't appear to be true, so perhaps it is the macro that should change. /* This macro calls PyWeakref_CheckRef() last since that can involve a function call; this makes it more likely that the function call will be avoided. */ #define PyWeakref_Check(op) \ (PyWeakref_CheckRef(op) || PyWeakref_CheckProxy(op)) ---------- assignee: docs@python components: Documentation, Extension Modules messages: 151983 nosy: Jim.Jewett, docs@python priority: normal severity: normal status: open title: misleading comment in weakrefobject.h _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13867> _______________________________________

4 5

[issue14224] packaging: path description of resources is mixed up
by Johannes Kolb Oct. 8, 2013

Oct. 8, 2013

New submission from Johannes Kolb <johannes.kolb(a)gmx.net>: The documentation for "files" section of the setup.cfg file causes confusion: The examples don't match the description. Obviously the order of "destination" and "source" part in the generated filenames was mixed up in some places. ---------- assignee: docs@python components: Documentation files: packaging-docfixes.diff keywords: patch messages: 155123 nosy: docs@python, jokoala priority: normal severity: normal status: open title: packaging: path description of resources is mixed up type: behavior versions: Python 3.3 Added file: http://bugs.python.org/file24754/packaging-docfixes.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14224> _______________________________________

3 2

[issue13436] compile() doesn't work on ImportFrom with level=None
by Janosch Gräf Oct. 8, 2013

Oct. 8, 2013

New submission from Janosch Gräf <janosch.graef(a)gmx.net>: The documentation for ast says that arguments that are marked with a '?' in the abstract grammar are optional and can therefore be None. When I try to compile a Module node which contains an ImportFrom node with attribute level=None compile() throws an exception: Module(body=[ImportFrom(module='time', names=[alias(name='sleep', asname=None), alias(name='time', asname=None)], level=None, lineno=0, col_offset=0)]) Traceback (most recent call last): File "g0.py", line 423, in <module> p.main() File "g0.py", line 65, in main self.reproduce("g1.pyc") File "g0.py", line 85, in reproduce co = self.generate_bytecode(st, genome) File "g0.py", line 243, in generate_bytecode co = compile(st, id, "exec") ValueError: invalid integer value: �� So, I tried to set level=0: Module(body=[ImportFrom(module='time', names=[alias(name='sleep', asname=None), alias(name='time', asname=None)], level=0, lineno=0, col_offset=0)]) and everything worked fine. BTW: The unprintable bytes in the error message are: ef bf bd ef bf bd ef bf bd ef bf bd ef bf bd ef bf bd ef bf bd ef bf bd ---------- assignee: docs@python components: Documentation, Interpreter Core messages: 147972 nosy: Janosch.Gräf, docs@python priority: normal severity: normal status: open title: compile() doesn't work on ImportFrom with level=None type: behavior versions: Python 3.1 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13436> _______________________________________

6 9

Confusing default redirects
by Dražen Lučanin Oct. 7, 2013

Oct. 7, 2013

Dear Sir/Madam, When I open http://docs.python.org/ it redirects me to http://docs.python.org/3/ When I open http://docs.python.org/library/ it redirects me to http://docs.python.org/2/library/ Expected - all "versionless" URLs should redirect to the same (current stable and recommended) version of Python. Regards, Dražen Lučanin

2 2

[issue12162] Documentation about re \number
by Seth Troisi Oct. 6, 2013

Oct. 6, 2013

New submission from Seth Troisi <braintwo(a)gmail.com>: It would be nice to clarify re documentation on how to use \number. current documentation lists three half examples: "(.+) \1 matches 'the the' or '55 55', but not 'the end' (note the space after the group)." This is rather confusing (at least to me) as it might be assumed that re.search("(.+) \1", "the the") would return a match, which it does not. A better example would be re.search("(\w+) \\1", "the the") which does match. the other confusing portion is the requirement of the second "\" to make it match. I would think that a quick example below the text would help. >>> re.search("(\w+) \\1", "can you do the can can?") # \\1 matches the second can at the end of the sentence <_sre.SRE_Match object at ...> This is my first python issue and if I have misfiled or left out some information please tell me how to proceed. ---------- assignee: docs@python components: Documentation messages: 136708 nosy: Seth.Troisi, docs@python priority: normal severity: normal status: open title: Documentation about re \number type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12162> _______________________________________

5 8

[issue11789] Extend upon metaclass/type class documentation, here: zope.interface and usage of instances of classes as base classes
by Carsten Klein Oct. 6, 2013

Oct. 6, 2013

New submission from Carsten Klein <carsten.klein(a)axn-software.de>: In zope.interface, you have something the following construct: class InterfaceBase: pass Interface = InterfaceBase() Using the above Interface as a derivation base for your own classes, will make that instance a type derived class: class IFoo(Interface): pass type(IFoo) -> Interface type(Interface) -> type I wonder why this behavior is not documented in the official documentation, or at least, I was unable to find it there... ---------- assignee: docs@python components: Documentation messages: 133173 nosy: carsten.klein, docs@python priority: normal severity: normal status: open title: Extend upon metaclass/type class documentation, here: zope.interface and usage of instances of classes as base classes type: feature request versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11789> _______________________________________

2 2

[issue11585] Documentation 1.8 shows Python 2 example
by Clive Darke Oct. 6, 2013

Oct. 6, 2013

New submission from Clive Darke <clive.darke(a)qa.com>: Python 3.2 version attached ---------- assignee: docs@python components: Documentation files: parrot.c messages: 131246 nosy: cdarke, docs@python priority: normal severity: normal status: open title: Documentation 1.8 shows Python 2 example versions: Python 3.1, Python 3.2 Added file: http://bugs.python.org/file21267/parrot.c _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11585> _______________________________________

2 2