Mailman 3 February 2020 - docs

[issue32377] Difference in ressurrection behavior with __del__ in py2 vs. py3
by Eric Cousineau April 9, 2020

April 9, 2020

New submission from Eric Cousineau <eric.cousineau(a)tri.global>: Due to how `PyObject_CallFinalizer` is written in python3, `__del__` will only *ever* be called once. In my use case, I am experimenting with a feature in `pybind11` to prevent slicing with Python class instances that inherit from pybind11-C++ base classes, which involves detecting when an instance loses all reference in Python (`Py_REFCNT(...) == 0`) but still has reference in C++ (`shared_ptr::count() > 0`), and reviving the Python portion when this situation happens. In python2, I could do this without a hitch, as a resurrected object could have its `__del__` method called multiple times (through `tp_dealloc` I believe?). But in python3, the object is marked with `_PyGC_SET_FINALIZED(...)`, thus preventing `__del__` from being called again. It'd be nice to either (a) somehow allow `__del__` to be called naturally without too much fuss or, at the least, (b) have this reflected in the documentation: https://docs.python.org/3/reference/datamodel.html#object.__del__ See attached `revive_test`. Example execution: ``` $ python2 ./revive_test.py Revive Destroy [ Done ] $ python3 ./revive_test.py Revive [ Done ] ``` ---------- assignee: docs@python components: Documentation files: revive_test.py messages: 308660 nosy: Eric Cousineau, docs@python priority: normal severity: normal status: open title: Difference in ressurrection behavior with __del__ in py2 vs. py3 type: behavior versions: Python 3.4, Python 3.5, Python 3.6 Added file: https://bugs.python.org/file47339/revive_test.py _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32377> _______________________________________

3 11

[issue15140] PEP 384 inconsistent with implementation
by Antoine Pitrou April 1, 2020

April 1, 2020

New submission from Antoine Pitrou <pitrou(a)free.fr>: In PEP 384, the PyType_Spec struct has a "const char *doc" that is not present in the implementation (Include/object.h). ---------- assignee: docs@python components: Documentation messages: 163449 nosy: docs@python, loewis, pitrou priority: normal severity: normal stage: needs patch status: open title: PEP 384 inconsistent with implementation type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15140> _______________________________________

4 3

[issue37390] Generate table of audit events for docs
by Steve Dower March 30, 2020

March 30, 2020

New submission from Steve Dower <steve.dower(a)python.org>: All audit events are marked in the docs with the ".. audit-event:: <name> <args>" syntax. We should automatically collate these into a single table and generate a new doc page as part of docs build. ---------- assignee: docs@python components: Documentation messages: 346417 nosy: christian.heimes, docs@python, steve.dower priority: normal severity: normal stage: needs patch status: open title: Generate table of audit events for docs type: enhancement versions: Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37390> _______________________________________

3 17

[issue15436] __sizeof__ is not documeneted
by Serhiy Storchaka March 22, 2020

March 22, 2020

New submission from Serhiy Storchaka <storchaka(a)gmail.com>: __sizeof__ is not mentioned on page Doc/reference/datamodel.rst together with other special methods. There is no __sizeof__ in index. ---------- assignee: docs@python components: Documentation messages: 166245 nosy: docs@python, storchaka priority: normal severity: normal status: open title: __sizeof__ is not documeneted versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15436> _______________________________________

14 24

[issue39797] shutdown() in socketserver.BaseServer should be in a different thread from serve_forever()
by Ama Aje My Fren March 20, 2020

March 20, 2020

New submission from Ama Aje My Fren <amaajemyfren(a)gmail.com>: When a subclass of socketserver.BaseServer is running after calling serve_forever() and needs to be shutdown, it may be shut down by sending a [shutdown()](https://docs.python.org/3/library/socketserver.html#socketserve…. The thing is though that the shutdown() call must be run in a different thread than the one where the serve_forever() was called otherwise it will deadlock. This is documented in the [code](https://github.com/python/cpython/blob/3.8/Lib/socketserver.py#L244) but not in the documentation. It should be in the documentation as well as it is not obvious. ---------- assignee: docs@python components: Documentation messages: 362981 nosy: amaajemyfren, docs@python priority: normal severity: normal status: open title: shutdown() in socketserver.BaseServer should be in a different thread from serve_forever() type: enhancement versions: 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/issue39797> _______________________________________

3 11

[issue21108] Add doc examples for importlib
by Saimadhav Heblikar March 18, 2020

March 18, 2020

New submission from Saimadhav Heblikar: The imp module was the defacto module to access the import internals,upto 3.3 It has been deprecated(pending) in 3.4 in favor of importlib. There are plenty of examples on how to use imp around the web, but very little (even in doc.python.org), on how to use importlib. The proposed patch adds couple of examples. These examples are aimed towards people, who were earlier using imp's load_module(). Inspiration for the patch from this SO answer, where user had to go through source code. http://stackoverflow.com/questions/19009932/import-abitrary-python-source-f… ---------- assignee: docs@python components: Documentation files: importlib-example.patch keywords: patch messages: 215220 nosy: docs@python, sahutd priority: normal severity: normal status: open title: Add doc examples for importlib versions: Python 3.4 Added file: http://bugs.python.org/file34675/importlib-example.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21108> _______________________________________

5 6

[issue22014] Add summary table for OS exception <-> errno mapping
by Nick Coghlan March 18, 2020

March 18, 2020

New submission from Nick Coghlan: It would be handy if the main OS exception docs at https://docs.python.org/3/library/exceptions.html#os-exceptions included a summary table mapping between exception types and errno names, akin to the one in the original PEP (http://www.python.org/dev/peps/pep-3151/#new-exception-classes) ---------- assignee: docs@python components: Documentation keywords: easy messages: 223499 nosy: docs@python, ncoghlan priority: normal severity: normal status: open title: Add summary table for OS exception <-> errno mapping versions: Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22014> _______________________________________

5 10

[issue39677] 3.6+ documentation for MAKE_FUNCTION
by thautwarm March 14, 2020

March 14, 2020

New submission from thautwarm <yaoxiansamma(a)gmail.com>: LINK: https://docs.python.org/3.6/library/dis.html?highlight=bytecode#opcode-MAKE… To avoid being confusing, MAKE_FUNCTION(argc) shall be MAKE_FUNCTION(flag), since 3.6 the operand of MAKE_FUNCTION never means `argcount`. ---------- assignee: docs@python components: Documentation messages: 362208 nosy: docs@python, thautwarm priority: normal severity: normal status: open title: 3.6+ documentation for MAKE_FUNCTION type: enhancement versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39677> _______________________________________

3 10

[issue20039] Missing documentation for argparse.ArgumentTypeError
by Arnaut Billings March 11, 2020

March 11, 2020

New submission from Arnaut Billings: There is no documentation for argparse.ArgumentTypeError: http://docs.python.org/3/library/unittest.html Though it does appear in an example and its usage is simple enough to decipher what it means, it would none the less look more professional if there was formal documentation for it. Not only on what it is, but when it should actually be used, etc... ---------- assignee: docs@python components: Documentation messages: 206723 nosy: arnaut-billings, docs@python priority: normal severity: normal status: open title: Missing documentation for argparse.ArgumentTypeError versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20039> _______________________________________

5 6

[issue17422] language reference should specify restrictions on class namespace
by Eric Snow March 10, 2020

March 10, 2020

New submission from Eric Snow: (related to PEP 422 and issue #17044) The execution namespace from a class definition is passed as the third argument to the metaclass (see builtin___build_class__() in Python/bltinmodule.c). When applicable, which is almost always, the subsequent call to type.__new__() copies that namespace into a new dict which is in turn exposed via the class's __dict__. This matters in the case where a metaclass with __prepare__() gets used (or the PEP 422 equivalent). The language reference[1] should note that the object returned by __prepare__() is copied into a new dict when the class is finally created via the metaclass. [1] http://docs.python.org/3.4/reference/datamodel.html#customizing-class-creat… ---------- assignee: docs@python components: Documentation messages: 184188 nosy: docs@python, eric.snow, ncoghlan priority: normal severity: normal stage: needs patch status: open title: language reference should specify restrictions on class namespace type: enhancement versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17422> _______________________________________

8 25