Mailman 3 August 2019 - docs

[issue9938] Documentation for argparse interactive use
by Jay T 12 Sep '19

12 Sep '19

New submission from Jay T <jaytula(a)gmail.com>: I want to create a custom interactive shell where I continually do parse_args. Like the following: parser = argparse.ArgumentParser() command = raw_input() while(True): args = parser.parse_args(shlex.split(command)) # Do some magic stuff command = raw_input() The problem is that if I give it invalid input, it errors and exits with a help message. I learned from argparse-users group that you can override the exit method like the following: class MyParser(ArgumentParser): def exit(self, status=0, message=None): # do whatever you want here I would be nice to have this usage documented perhaps along with best practices for doing help messages in this scenario. ---------- assignee: docs@python components: Documentation messages: 117287 nosy: docs@python, jayt priority: normal severity: normal status: open title: Documentation for argparse interactive use type: feature request versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9938> _______________________________________

16 28

[issue37829] Documentation of stdlib: add example of mixed arguments to dict()
by pasenor 12 Sep '19

12 Sep '19

New submission from pasenor <gosha(a)fro.lv>: The following use of the dict() function with both positional and keyword arguments does follow from the description, but probably needs it's own example: dict({'a': 1}, b=2}) == {'a': 1, 'b': 2} ---------- assignee: docs@python components: Documentation messages: 349446 nosy: docs@python, pasenor priority: normal severity: normal status: open title: Documentation of stdlib: add example of mixed arguments to dict() versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37829> _______________________________________

3 3

[issue27589] asyncio doc: issue in as_completed() doc
by STINNER Victor 12 Sep '19

12 Sep '19

New submission from STINNER Victor: Remark on as_completed() doc by Hynek. https://docs.python.org/dev/library/asyncio-task.html#asyncio.as_completed Futures are yielded in an unexpected order: as soon as a future completes. ---------- assignee: docs@python components: Documentation, asyncio messages: 270982 nosy: docs@python, gvanrossum, haypo, yselivanov priority: normal severity: normal status: open title: asyncio doc: issue in as_completed() doc versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27589> _______________________________________

6 7

[issue37698] Update doc of PyBuffer_ToContiguous
by hai shi 11 Sep '19

11 Sep '19

New submission from hai shi <shihai1991(a)126.com>: Due to https://github.com/python/cpython/blob/master/Objects/memoryobject.c#L985, order could be 'A' in PyBuffer_ToContiguous() ---------- assignee: docs@python components: Documentation messages: 348585 nosy: docs@python, shihai1991 priority: normal severity: normal status: open title: Update doc of PyBuffer_ToContiguous _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37698> _______________________________________

3 8

[issue37750] PyBuffer_FromContiguous not documented
by hai shi 11 Sep '19

11 Sep '19

New submission from hai shi <shihai1991(a)126.com>: as the title said. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37750> _______________________________________

3 10

[issue36182] Path.write_text() docs do not include the case that a file exists
by Lysandros Nikolaou 11 Sep '19

11 Sep '19

New submission from Lysandros Nikolaou <lisandrosnik(a)gmail.com>: Hi, in the pathlib.Path.write_bytes() documentation it is clearly stated that "An existing file of the same name is overwritten." Wouldn't it make sense to include something similar to the pathlib.Path.write_text() docs. I had to quickly test it manually to find out what's happening as it wasn't clear to me if the statement applies to write_text() as well. ---------- assignee: docs@python components: Documentation messages: 337100 nosy: docs@python, lys.nikolaou priority: normal severity: normal status: open title: Path.write_text() docs do not include the case that a file exists versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue36182> _______________________________________

5 10

[issue37651] Change of inheritance of asyncio.CancelledError needs documentation
by Gary van der Merwe 11 Sep '19

11 Sep '19

New submission from Gary van der Merwe <garyvdm(a)gmail.com>: asyncio.CancelledError inheritance was changed in 3.8. https://bugs.python.org/issue32528 https://github.com/python/cpython/commit/431b540bf79f0982559b1b0e420b1b085f… The documentation still instructs the user to perform a pattern needed before this change. The documentation should probably change to inform them of the change, and to let them know that pattern is only necessary prior to 3.8. ---------- assignee: docs@python components: Documentation messages: 348297 nosy: docs@python, garyvdm priority: normal severity: normal status: open title: Change of inheritance of asyncio.CancelledError needs documentation versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37651> _______________________________________

4 6

[issue31163] Return destination path in Path.rename and Path.replace
by Alberto Gomez-Casado 11 Sep '19

11 Sep '19

New submission from Alberto Gomez-Casado: Extracted from issue31154 Both calls lack any kind of return, which leads me to expect after a rename/replace the Path instance would be changed to the new path. This is not the case (reading the PEP I have seen Path instances are kind of immutable), after the call the Path instance keeps "pointing" to the previous (and quite likely now useless) path. Returning the new path would be a reasonable option. In any case, I think the documentation should mention this behavior explicitly. ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 300019 nosy: Alberto Gomez-Casado, docs@python, pitrou priority: normal severity: normal status: open title: Return destination path in Path.rename and Path.replace type: enhancement versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue31163> _______________________________________

7 8

[issue25810] Python 3 documentation for eval is incorrect
by Andre Roberge 11 Sep '19

11 Sep '19

New submission from Andre Roberge: The documentation for eval() indicates that it takes keyword arguments: eval(expression, globals=None, locals=None) However, that is incorrect, as indicated by the builtin help: >>> help(eval) Help on built-in function eval in module builtins: eval(...) eval(source[, globals[, locals]]) -> value ---------- assignee: docs@python components: Documentation messages: 255969 nosy: aroberge, docs@python priority: normal severity: normal status: open title: Python 3 documentation for eval is incorrect versions: Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25810> _______________________________________

12 23

[issue16438] Numeric operator predecence confusing
by Yongzhi Pan 11 Sep '19

11 Sep '19

New submission from Yongzhi Pan: http://docs.python.org/3/library/stdtypes.html#numeric-types-int-float-comp… "All numeric types (except complex) support the following operations, sorted by ascending priority." It list '-' after '+', '/' after '*'. That is to mean '-' has higher precedence than '+'. That is wrong, and is contradicting with here: http://docs.python.org/3/reference/expressions.html#summary This should be made clear. ---------- assignee: docs@python components: Documentation messages: 175163 nosy: docs@python, fossilet priority: normal severity: normal status: open title: Numeric operator predecence confusing versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16438> _______________________________________

13 23