Mailman 3 June 2015 - docs

[issue24509] Undocumented features of asyncio: call_at, call_later
by Yury Selivanov June 25, 2015

June 25, 2015

Yury Selivanov added the comment: Thanks for reporting this Mark! ---------- resolution: -> fixed stage: -> commit review status: open -> closed versions: +Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24509> _______________________________________

1 0

[issue24509] Undocumented features of asyncio: call_at, call_later
by Roundup Robot June 25, 2015

June 25, 2015

Roundup Robot added the comment: New changeset 3199ec504dbe by Yury Selivanov in branch '3.4': Issue #24509: Clarify Handle.cancel() and loop.call_* methods. https://hg.python.org/cpython/rev/3199ec504dbe New changeset fc69dd6aea55 by Yury Selivanov in branch '3.5': Merge 3.4 (issue #24509) https://hg.python.org/cpython/rev/fc69dd6aea55 New changeset 9aad116baee8 by Yury Selivanov in branch 'default': Merge 3.5 (issue #24509) https://hg.python.org/cpython/rev/9aad116baee8 ---------- nosy: +… [View More]

1 0

[issue24439] Feedback for awaitable coroutine documentation
by Martin Panter June 25, 2015

June 25, 2015

New submission from Martin Panter: Today I tried playing with the new “async def” functionality in the interactive interpreter, based on reading the documentation. Here are some bits that surprised me, so could be the focus of further documentation. (Initial documentation added in Issue 24180.) 1. Confusion between coroutine and generator terms <coroutine object f at 0x7f9a5ae45200> AttributeError: 'generator' object has no attribute '__await__' <class 'generator'> TypeError: … [View More]coroutine-objects do not support iteration TypeError: can't send non-None value to a just-started generator Is it a coroutine object, or a generator object? The error messages etc seem to be split between the two terms. I guess the underlying implementation is closely shared between the two types, so old error messages still say “generator”, while new ones say “coroutine”. So there may not be an easy fix, but it was initially disconcerting. Perhaps a statement somewhere explaining coroutine instances are (based on / modified / a kind of / evolved from) generator instance objects, as appropriate. 2. Properties of a coroutine instance object <https://docs.python.org/dev/reference/datamodel.html#awaitable-objects> suggests that a coroutine instance should implement __await__(), but it apparently does not. How to drive through the coroutine’s await points? This should be documented, and linked from relevant places in the documentation; perhaps the “coroutine” glossary entry, “async” statement, and “await” expression. The best clue that I found in the current documentation was <https://docs.python.org/dev/library/collections.abc.html#collections.abc.Co…>, suggesting to use send(). Without having studied the PEP recently, I was expecting __await__() to be implemented, and invoking it would be similar to calling next() on an old-skool generator-iterator. Instead I see that calling __await__() is semantically more like __iter__(): it is only invoked once per “await” expression, and the return value is iterated over. 3. Allergic reaction to “await” on the same line as “async def” >>> async def f(): await A(()) SyntaxError: invalid syntax I see this is mentioned in the PEP that this is necessary so that “await” doesn’t have to be made a strict language keyword. But it should also be in the documentation. 4. Coroutine instances don’t implement the Coroutine ABC >>> isinstance(c, Coroutine) True >>> hasattr(Coroutine, "__await__") True >>> hasattr(c, "__await__") False Reading closely, the documentation says “coroutine compatible classes”, but given the liberal use of “coroutine” everywhere, I think there should be a more obvious warning of how much a coroutine is a Coroutine. ---------- assignee: docs@python components: Documentation messages: 245256 nosy: docs@python, vadmium, yselivanov priority: normal severity: normal status: open title: Feedback for awaitable coroutine documentation type: enhancement versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24439> _______________________________________ [View Less]

3 13

[issue24509] Undocumented features of asyncio: call_at, call_later
by Марк Коренберг June 25, 2015

June 25, 2015

Марк Коренберг added the comment: For delayed execution methods: "Returned handle is actually timer object. That timer can be deactivated using asyncio.Handle.cancel() method, so registered callback won't be called". For other callback registration methods: "Returned handle may be used to unregister callback using asyncio.Handle.cancel(), so registered callback won't be called". Also: 1. Documentation of .cancel does not say if it is allowed to cancel cancelled handle. 2. Documentation … [View More]

1 0

[issue24509] Undocumented features of asyncio: call_at, call_later
by STINNER Victor June 25, 2015

June 25, 2015

STINNER Victor added the comment: Documentatin of call_soon() and call_later() contain the sentence "An instance of asyncio.Handle is returned." with a link to Handle which shows the cancel() method: https://docs.python.org/dev/library/asyncio-eventloop.html#asyncio.BaseEven… https://docs.python.org/dev/library/asyncio-eventloop.html#asyncio.BaseEven… Can you please suggest a new sentence to explain that a Handle can be cancelled? ---------- _______________________________________ Python … [View More]

1 0

[issue24509] Undocumented features of asyncio: call_at, call_later
by Марк Коренберг June 25, 2015

June 25, 2015

Changes by Марк Коренберг <socketpair(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation, asyncio nosy: +docs@python, gvanrossum, haypo, yselivanov type: -> enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24509> _______________________________________

1 0

[issue24497] test_decimal.py contains a dead link
by mattyw June 24, 2015

June 24, 2015

New submission from mattyw: The comments in test_decimal contain a url for downloading tests written by Mike Cowlishaw: Cowlishaw's tests can be downloaded from: www2.hursley.ibm.com/decimal/dectest.zip Python 3.4.3 contains an updated url: http://speleotrove.com/decimal/dectest.zip It seems like the url should be updated in 2.7 as well ---------- assignee: docs@… [View More]

3 3

Re: [docs] Feedback for awaitable coroutine documentation (issue 24439)
by yselivanov＠gmail.com June 24, 2015

June 24, 2015

LGTM. Will commit it soon. http://bugs.python.org/review/24439/diff/15143/Objects/genobject.c File Objects/genobject.c (right): http://bugs.python.org/review/24439/diff/15143/Objects/genobject.c#newcode9… Objects/genobject.c:913: {"close",(PyCFunction)coro_wrapper_close, METH_NOARGS, coro_close_doc}, I could have sworn I did that change myself in 24400! :) http://bugs.python.org/review/24439/

1 0

logging.config - turn the "note" into a "warning"
by Jacek Wielemborek June 24, 2015

June 24, 2015

Hi, Somewhere on StackOverflow, I saw a recommendation to use logging.config instead of hardcoding things [1]. I took a look at the sample config file and immediately noticed that this can be a security risk. I checked the documentation for this module [2] for such notes and found a few ones, but marked as "Note" instead of "Warning. Compare this to subprocess documentation [3]. I believe that this should be unified. Cheers, d33tah [1] http://stackoverflow.com/a/30752753/1091116 [2] https://… [View More]

1 0