Mailman 3 March 2017 - docs

[issue26979] The danger of PyType_FromSpec()
by Serhiy Storchaka Oct. 26, 2018

Oct. 26, 2018

New submission from Serhiy Storchaka: There is a catch when convert static types to dynamic types using PyType_FromSpec(). tp_new is not inherited for static types whose base class is 'object' (see a comment in inherit_special() in Objects/typeobject.c:4569 for explanation). Such types left not callable and not pickleable unless tp_new is explicitly specified. But since PyType_FromSpec() creates heap types, tp_new is inherited from the base 'object' class. Converted types unexpectedly becomes callable and pickleable. Since object.__new__ wouldn't insure the invariants that the extension type's own factory function ensures, instantiated object can be in inconsistent state. Using it can lead to a crash. We already fallen two time in this catch with _tkinter (issue15721) and curses.panel (issue14936) modules (fixed in issue23815). We should document this catch and a way to avoid it (explicitly set tp_new to NULL for the result of PyType_FromSpec()). Both the C API documentation and PEP 384 should be updated. Would be great if standard examples include a case of non-callable heap type. As option we can introduce more handy way to set tp_new to NULL by adding {Py_tp_new, NULL} to slots array (currently this doesn't have any effect). But this is new feature. ---------- assignee: docs@python components: Documentation messages: 265152 nosy: docs@python, loewis, serhiy.storchaka priority: high severity: normal status: open title: The danger of PyType_FromSpec() type: security versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26979> _______________________________________

6 16

[issue28960] Small typo in Thread.join docs
by Ryan Oct. 22, 2018

Oct. 22, 2018

New submission from Ryan: There is a '--' before a ',' that doesn't make sense here: https://docs.python.org/3/library/threading.html#threading.Thread.join ---------- assignee: docs@python components: Documentation files: fixdoc.patch keywords: patch messages: 283101 nosy: docs@python, rcorre priority: normal severity: normal status: open title: Small typo in Thread.join docs type: enhancement versions: Python 3.7 Added file: http://bugs.python.org/file45875/fixdoc.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28960> _______________________________________

5 7

[issue21196] Name mangling example in Python tutorial
by Chandan Kumar Oct. 20, 2018

Oct. 20, 2018

New submission from Chandan Kumar: The example used for demonstrating name mangling could be better if two versions of code are shown - one with name mangling and one without. I have modified the original example to incorporate this (see attached). ---------- assignee: docs@python components: Documentation files: name_mangling_works.py messages: 215872 nosy: chandan, docs@python, rhettinger priority: normal severity: normal status: open title: Name mangling example in Python tutorial type: enhancement Added file: http://bugs.python.org/file34781/name_mangling_works.py _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21196> _______________________________________

9 18

[issue24568] Misc/NEWS: "free-after-use" -> "use-after-free"
by Jakub Wilk Oct. 18, 2018

Oct. 18, 2018

New submission from Jakub Wilk: Misc/NEWS reads: "Fix free-after-use bug" It should be "use-after-free", not "free-after-use". ---------- assignee: docs@python components: Documentation messages: 246310 nosy: docs@python, jwilk priority: normal severity: normal status: open title: Misc/NEWS: "free-after-use" -> "use-after-free" versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24568> _______________________________________

5 7

[issue14911] generator.throw() documentation inaccurate
by Kristján Valur Jónsson Oct. 17, 2018

Oct. 17, 2018

New submission from Kristján Valur Jónsson <kristjan(a)ccpgames.com>: the documentation for generator.throw() does not mention the fact that it has the same semantics for the three arguments as a "raise" expression has. The first two arguments can be: throw(exc_type, None) throw(exc_type, value) throw(exc_type, exc_instance) throw(exc_instance, None) ---------- assignee: docs@python components: Documentation messages: 161565 nosy: docs@python, kristjan.jonsson priority: normal severity: normal status: open title: generator.throw() documentation inaccurate versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14911> _______________________________________

5 12

[issue11233] clarifying Availability: Unix
by Sandro Tosi Oct. 15, 2018

Oct. 15, 2018

New submission from Sandro Tosi <sandro.tosi(a)gmail.com>: Hi, following up http://mail.python.org/pipermail/docs/2011-February/003083.html we have a chat on #python-dev on the topic, the situation is - all started with os.lchmod() and as.lchflags() methods not available on a Debian system - that's because POSIX does not require those functions and then Linux systems don't provide them - so we then thought about clarifying, only for those 2 methods, that they might not be available with a format like "availability: some unix systems" - then we noticed that on top of os doc there's a notice "An “Availability: Unix” note means that this function is commonly found on Unix systems. It does not make any claims about its existence on a specific operating system." and so we thought about linking every 'Availability: Unix' to that note - or transform that not in a footnote and link every 'Availability: Unix' for functions that might not be present to that footnote. It's enough for the conversation dump: ideas/suggestions? :) ---------- assignee: docs@python components: Documentation messages: 128746 nosy: docs@python, sandro.tosi priority: normal severity: normal status: open title: clarifying Availability: Unix _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11233> _______________________________________

11 25

[issue23554] EchoServerClientProtocol class should be called EchoServerProtocol
by Giovanni Cannata Oct. 15, 2018

Oct. 15, 2018

New submission from Giovanni Cannata: In 18.5.4.3.2. TCP echo server protocol the class in the example code is called EchoServerClientProtocol. It should be EchoServerProtocol. (The client protocol example is correctly called EchoClientProtocol). ---------- assignee: docs@python components: Documentation messages: 236932 nosy: docs@python, gc priority: normal severity: normal status: open title: EchoServerClientProtocol class should be called EchoServerProtocol versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23554> _______________________________________

6 9

[issue28234] In xml.etree.ElementTree docs there are many absent Element class links
by py.user Oct. 9, 2018

Oct. 9, 2018

New submission from py.user: https://docs.python.org/3/library/xml.etree.elementtree.html#reference 1. Comment 2. iselement() 3. ProcessingInstruction 4. SubElement 5. Element.find() 6. ElementTree._setroot() 7. TreeBuilder Applied a patch to the issue that adds Element class links. ---------- assignee: docs@python components: Documentation, Library (Lib), XML files: element-link.diff keywords: patch messages: 277121 nosy: docs@python, py.user priority: normal severity: normal status: open title: In xml.etree.ElementTree docs there are many absent Element class links type: behavior versions: Python 3.6 Added file: http://bugs.python.org/file44775/element-link.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28234> _______________________________________

3 9

[issue28418] Raise Deprecation warning for tokenize.generate_tokens
by Matthias Bussonnier Sept. 24, 2018

Sept. 24, 2018

New submission from Matthias Bussonnier: the Tokenize module has the following code: # An undocumented, backwards compatible, API for all the places in the standard # library that expect to be able to use tokenize with strings def generate_tokens(readline): return _tokenize(readline, None) So I'm going to assume it is Deprecated... (since 3.0 AFAICT). If it is expected from Python developers to not use it, may I suggest: 1) Marking it as deprecated in the docstring/ 2) Raise a deprecation warning. Indeed not everyone code by looking at the documentation and it is relatively easy to have your IDE/editor/REPL to complete it. Even tools that grab the source (IPython double question mark for example) will not show the comment above which make it kinda pointless. ---------- assignee: docs@python components: Documentation messages: 278500 nosy: docs@python, mbussonn priority: normal severity: normal status: open title: Raise Deprecation warning for tokenize.generate_tokens versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28418> _______________________________________

5 6

[issue24937] Multiple problems in getters & setters in capsulethunk.h
by Petr Viktorin Sept. 24, 2018

Sept. 24, 2018

New submission from Petr Viktorin: In https://docs.python.org/3/howto/cporting.html#cobject-replaced-with-capsule (added in issue13053): 1) __PyCapsule_GetField is defined as:: #define __PyCapsule_GetField(capsule, field, default_value) ... but called as:: __PyCapsule_GetField(capsule, field) 2) __PyCapsule_SetField returns the wrong value (1 for success, 0 for failure). 3) Both the getter and setter don't set the exception on failure, leading to "SystemError: error return without exception set". Here's a patch. ---------- assignee: docs@python components: Documentation files: capsulethunk.patch keywords: patch messages: 249138 nosy: docs@python, encukou, larry, ncoghlan priority: normal severity: normal status: open title: Multiple problems in getters & setters in capsulethunk.h versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6 Added file: http://bugs.python.org/file40256/capsulethunk.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24937> _______________________________________

3 11