Mailman 3 January 2012 - docs

[issue13502] Documentation for Event.wait return value is either wrong or incomplete
by R. David Murray 07 Jan '12

07 Jan '12

New submission from R. David Murray <rdmurray(a)bitdance.com>: The documentation for Event.wait says: This method returns the internal flag on exit, so it will always return True except if a timeout is given and the operation times out. In fact, however, if the thread that sets the flag immediately clears it, wait will return False. Antoine looking at the code says that this appears to be intentional, and that would make sense since originally wait returned no value. My use case is one thread waiting on another to complete a work loop. Normally the worker thread goes to sleep after clearing the flag, but sometimes it immediately starts a new work loop. In either case I want the monitoring loop to take an action when the work loop completes, and raise an error if the wait times out. It looked to me like Event.wait would work in the scenario. ---------- assignee: docs@python components: Documentation messages: 148604 nosy: docs@python, pitrou, r.david.murray, tim_one priority: normal severity: normal stage: needs patch status: open title: Documentation for Event.wait return value is either wrong or incomplete type: behavior versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13502> _______________________________________

4 12

[issue12005] modulo result of Decimal differs from float/int
by Aaron Maenpaa 07 Jan '12

07 Jan '12

Aaron Maenpaa <aaron(a)maenpaa.ca> added the comment: Here is a patch that adds an explination for the difference in the behaviour to the FAQ section of the Decimal documentation. ---------- keywords: +patch nosy: +zacherates Added file: http://bugs.python.org/file24162/issue12005.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12005> _______________________________________

1 0

Py_SetPythonHome() before Py_Initialize()
by Cody Smith 07 Jan '12

07 Jan '12

Python folks, Your "Initialization, Finalization, and Threads" document* explains that embedded Python applications must call Py_Initialize() before any other Python/C API functions, with a handful of exceptions. It seems like Py_SetPythonHome() should be among the exceptions, but it isn't. Initialization potentially relies on "home", so Py_SetPythonHome() is useful before Py_Initialize(). This situation is similar to Py_SetProgramName(), which _is_ permitted before Py_Initialize(). Also, in practice, the implementation of Py_SetPythonHome() only accesses a single static global variable, "default_home". (This is based on a spot check of 2.0.1, 2.6.7 and 3.2 branches). Clarification would be much appreciated, since it might help me avoid a hack. Thanks, Cody * = http://docs.python.org/c-api/init.html

4 3

multiprocessing / Connection
by Chris Kogelnik 07 Jan '12

07 Jan '12

In both the 2.7 an 3.0 docs and online help, in the module multiprocessing for the Connection object, the 'recv', 'recv_bytes' and 'recv_bytes_into' methods do not mention that the routines block until data is available. I think this would be useful to add. Thanks.

2 1

documentation error w/ evaluation order
by Zach Wegner 07 Jan '12

07 Jan '12

In http://docs.python.org/reference/expressions.html#evaluation-order, there's a table that contains this entry, giving the order of evaluation for dict literals: {expr1: expr2, expr3: expr4} However, for each item, the value is evaluated before the key, like so: def ev(r): print(r) return r {ev(1): ev(2), ev(3): ev(4)} prints (under 3.2.2): 2 1 4 3 Thanks, Zach

2 1

option -m bug
by skeu.Grass 07 Jan '12

07 Jan '12

Hi, I found that the description of option '-m' is wrong: In Python v2.7.2 documentation » Python Setup and Usage » 1.1.1. Interface options -m <module-name> it says As with the -c option, the current directory will be added to the start of sys.path. But I found that using the "python -m<module-name>" the current directory won't be added to the start of sys.path. I tested the v2.6.6 v2.7.2 v3.2.2, they all have the problem. _____________________________ skeu.Grass

2 1

[issue13685] argparse does not sanitize help strings for % signs
by Terry J. Reedy 06 Jan '12

06 Jan '12

Changes by Terry J. Reedy <tjreedy(a)udel.edu>: ---------- nosy: +bethard _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13685> _______________________________________

1 0

[issue1040439] Missing documentation on how to link with libpython
by Éric Araujo 06 Jan '12

06 Jan '12

Éric Araujo <merwok(a)netwok.org> added the comment: Attached patch adds the useful bits from the review I did; I hope you won’t think it’s pointless nitpicking. ---------- Added file: http://bugs.python.org/file24155/docembed-edits.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue1040439> _______________________________________

2 1

[issue12042] What's New multiprocessing example error
by Davi Post 05 Jan '12

05 Jan '12

New submission from Davi Post <post(a)pobox.com>: In this section: http://docs.python.org/whatsnew/2.6.html#pep-371-the-multiprocessing-package This sentence follows the first example: "A Queue is used to communicate the input parameter N and the result." In the example, the queue is used only for the result, not the input parameter N. [P.S. I'd be happy to submit corrections, but don't want to have to install and learn Mercurial. Is there a simpler way?] ---------- assignee: docs@python components: Documentation messages: 135626 nosy: davipo, docs@python priority: normal severity: normal status: open title: What's New multiprocessing example error versions: Python 2.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12042> _______________________________________

8 19

[issue11984] Wrong "See also" in symbol and token module docs
by Davi Post 05 Jan '12

05 Jan '12

New submission from Davi Post <post(a)pobox.com>: The "See also" reference in the documentation for the token and symbol modules is no longer accurate. The "second example" mentioned was apparently removed in Python 2.7. This leaves no explanation for how to use the symbol module. I don't think this "See also" belongs in the token module at all. (It's in Python 2.5 and 2.6 as well.) http://docs.python.org/release/2.7.1/library/symbol.html See also: Module parser The second example for the parser module shows how to use the symbol module. ---------- assignee: docs@python components: Documentation messages: 135017 nosy: davipo, docs@python priority: normal severity: normal status: open title: Wrong "See also" in symbol and token module docs versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11984> _______________________________________

4 3