Mailman 3 December 2017 - docs

[issue32322] Heap type with Py_TPFLAGS_HAVE_GC leads to segfault due to not incrementing type object refcout in PyObject_GC_New
by Rostislav Kondratenko Dec. 14, 2017

Dec. 14, 2017

New submission from Rostislav Kondratenko <grostik(a)gmail.com>: If one creates a type with both Py_TPFLAGS_HAVE_GC and Py_TPFLAGS_HEAPTYPE set and implemented, one has to create instances with PyObject_GC_New() per current docs: https://docs.python.org/3.7/c-api/gcsupport.html . However, PyObject_GC_New() unlike PyType_GenericAlloc() does not increment refcount of a type object. As the refcount is still decremented when instances are destroyed, it leads to steady drain on type object's refcount. Eventually it reaches zero and the type object gets deleted while there are still instances and references to it. And it usually results in crash after a number of instances (20-50 is usually enough) is created and destroyed. One should either update the docs to point that call to PyType_GenericAlloc() would be sufficient (as it would use _PyObject_GC_Malloc() and increment refcount when appropriate) or update _PyObject_GC_New() code to increment type object's refcount when the type is heap type. Or both. ---------- assignee: docs@python components: Documentation, Interpreter Core messages: 308302 nosy: docs@python, rkond priority: normal severity: normal status: open title: Heap type with Py_TPFLAGS_HAVE_GC leads to segfault due to not incrementing type object refcout in PyObject_GC_New type: crash versions: Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32322> _______________________________________

1 0

[issue32309] Implement asyncio.create_task() and asyncio.run_in_executor shortcuts
by Andrew Svetlov Dec. 13, 2017

Dec. 13, 2017

New submission from Andrew Svetlov <andrew.svetlov(a)gmail.com>: loop.create_task() and loop.run_in_executor are present very often in user code. But they are require a loop instance, actual call looks like loop = asyncio.get_running_loop() loop.create_task(coro()) The proposal adds create_task(coro) and run_in_executor(executor, func, *args) shortcuts for this. ---------- assignee: docs@python components: Documentation, asyncio messages: 308238 nosy: asvetlov, docs@python, yselivanov priority: normal severity: normal status: open title: Implement asyncio.create_task() and asyncio.run_in_executor shortcuts versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32309> _______________________________________

2 2

Suggestion/request
by David VanderWyst Dec. 13, 2017

Dec. 13, 2017

While the plain text documents are really close, it would be nice to see a markdown formatted version of the documentation, even replacing the .txt version with a markdown set could be benificial. Markdown can easily be converted to plain text if necessary, and to html for viewing. I'm not sure if there is enough demand for this to make it worth it or not, but I would see it as an asset but a bigger undertaking than I could do alone. plain text lacks a lot of the formatting needed to differentiate between code comments and code snipits when rendering it directly as markdown with tools like md-fileserver. The plain text works great for custom search tools when using a local file store for the documentation and markdown wouldn't hinder that. -- ------------------------------------------------------------------------ David VanderWyst Owner, Thriftech services <https://thriftechs.com/> dave.cs(a)thriftechs.com

2 1

[issue10344] codecs.open() buffering doc needs fix
by Alexey Izbyshev Dec. 13, 2017

Dec. 13, 2017

Change by Alexey Izbyshev <izbyshev(a)ispras.ru>: ---------- keywords: +patch pull_requests: +4731 stage: needs patch -> patch review _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue10344> _______________________________________

1 0

Mistake - gzip.open
by Oleg Tropinin Dec. 13, 2017

Dec. 13, 2017

Hi, Pls replace "open" to "gzip.open" when code open file.txt. https://docs.python.org/2/library/gzip.html Example of how to GZIP compress an existing file: import gzip import shutil with _open_('file.txt', 'rb') as f_in, gzip.open('file.txt.gz', 'wb') as f_out: shutil.copyfileobj(f_in, f_out) Regards Oleg Tropinin

2 1

[issue32301] Typo in array documentation
by Maik Ro Dec. 13, 2017

Dec. 13, 2017

New submission from Maik Ro <lefthand3r(a)googlemail.com>: .. class:: array(typecode[, initializer]) should be typecode, [initializer] - comma is in square brackets ---------- assignee: docs@python components: Documentation messages: 308195 nosy: Maik Ro, docs@python priority: normal severity: normal status: open title: Typo in array documentation type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32301> _______________________________________

2 1

[issue22671] Typo in class io.BufferedIOBase docs
by gigaplastik Dec. 12, 2017

Dec. 12, 2017

New submission from gigaplastik: The online documentation for class io.BufferedIOBase states the following: "Besides, the read() method does not have a default implementation that defers to readinto()." According to the documentation for class io.RawIOBase (which the statement compares with) read() method actually defers to readall(), NOT readinto() as misleadingly stated. The same typo is present in help('io.BufferedIOBase') output and, very likely, in all 3.X line docs for this class. ---------- assignee: docs@python components: Documentation messages: 229677 nosy: docs@python, gigaplastik priority: normal severity: normal status: open title: Typo in class io.BufferedIOBase docs type: enhancement versions: Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22671> _______________________________________

9 14

PyImport_ExecCodeModuleWithPathnames documentation is wrong
by Florian Link Dec. 12, 2017

Dec. 12, 2017

Hi, the PyImport_ExecCodeModuleWithPathnames documentation states that the char* strings should be encoded in UTF-8. But looking at the Python C code, it is aparent that PyUnicode_DecodeFSDefault is used to convert these string, so the documentation need to state the the string should be encoded as in the default of the local filesystem. https://docs.python.org/3/c-api/import.html#c.PyImport_ExecCodeModuleWithPa… regards, Florian P.S. I ran into this because I passed in UTF-8 and the __file__ attribute of the imported modules was wrong afterwards. -- ------------------------------------------------------------------------ Florian Link MeVisLab Tel.: +49-421-22495 579 Fax: +49-421-22495 899 www.mevis.de / www.mevislab.de MeVis Medical Solutions AG Caroline-Herschel-Str. 1 28359 Bremen Germany Trade Registry: Bremen HRB 23791 VAT ID: DE250659412 Executive Board: Marcus Kirchhoff (Chairman), Dr. Robert Hannemann Chairperson of Supervisory Board: Kimberley E. Honeysett

1 0

[issue32289] Glossary does not define "extended slicing"
by Steven D'Aprano Dec. 12, 2017

Dec. 12, 2017

New submission from Steven D'Aprano <steve+python(a)pearwood.info>: Looking at issue 32288, I realised that the glossary doesn't define "extended slicing" or "extended slice", even though they are common terms. Although I thought I know what they meant, on closer reflection I realised I wasn't sure. Does extended slicing refer to slice *objects* with a stride/step, as opposed to slice objects all the way back in Python 1.3 (yes, *one* point 3) that only had start and end? Does it refer specifically to the two-colon form of slice *syntax*? Both? Neither? https://docs.python.org/3/glossary.html#term-slice The only documentation I found is from the 2.3 What's New: https://docs.python.org/2.3/whatsnew/section-slices.html ---------- assignee: docs@python components: Documentation messages: 308125 nosy: Massimiliano Culpo, docs@python, steven.daprano priority: normal severity: normal status: open title: Glossary does not define "extended slicing" type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32289> _______________________________________

1 0

[issue31942] Document that support of start and stop parameters in the Sequence's index() is optional
by Serhiy Storchaka Dec. 12, 2017

Dec. 12, 2017

New submission from Serhiy Storchaka <storchaka+cpython(a)gmail.com>: Parameters start and stop were added to the Sequence.index() mixin method in 3.5 (see issue23086). But not all concrete implementations of the Sequence ABC support them (for example range.index() doesn't, see issue28197). This should be explicitly documented (including the docstring of Sequence.index). ---------- assignee: docs@python components: Documentation keywords: easy messages: 305547 nosy: docs@python, rhettinger, serhiy.storchaka priority: normal severity: normal stage: needs patch status: open title: Document that support of start and stop parameters in the Sequence's index() is optional type: behavior versions: Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue31942> _______________________________________

4 9