Mailman 3 May 2020 - docs

[issue23802] patch: __deepcopy__ memo dict argument usage
by Daniel Shahaf 19 Aug '20

19 Aug '20

New submission from Daniel Shahaf: In the 'copy' module documentation, it wasn't fully clear to me how __deepcopy__ implementations should treat the memo dict argument. The attached patch clarifies that __deepcopy__ implementations should treat the memo dict argument as an opaque type. ---------- assignee: docs@python components: Documentation files: opaque.diff keywords: patch messages: 239473 nosy: danielsh, docs@python priority: normal severity: normal status: open title: patch: __deepcopy__ memo dict argument usage type: enhancement Added file: http://bugs.python.org/file38723/opaque.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23802> _______________________________________

4 6

[issue40815] Multiprocessing docs don't describe thread-safety
by Ben 17 Aug '20

17 Aug '20

New submission from Ben <benjsimner(a)gmail.com>: The Multiprocessing docs specifically say that Queue is process- and thread- safe: https://docs.python.org/3/library/multiprocessing.html#exchanging-objects-b…. But this information is not given for the various synchronisation primitives and such (Lock, Semaphore, Event, etc) Are they thread-safe? Should the docs say whether they are or are not? ---------- assignee: docs@python components: Documentation messages: 370310 nosy: bjs, docs@python priority: normal severity: normal status: open title: Multiprocessing docs don't describe thread-safety _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40815> _______________________________________

3 3

[issue30757] pyinstaller can be added to docs, py2exe ref can be updated
by Denis Akhiyarov 17 Aug '20

17 Aug '20

New submission from Denis Akhiyarov: https://github.com/python/cpython/pull/1158 It is not clear why this FAQ item is written in addition to this document: https://github.com/python/cpython/blob/master/Doc/faq/windows.rst#how-do-i-… https://github.com/python/cpython/blob/master/Doc/faq/programming.rst#how-c… ---------- assignee: docs@python components: Documentation messages: 296844 nosy: denfromufa, docs@python priority: normal severity: normal status: open title: pyinstaller can be added to docs, py2exe ref can be updated type: enhancement versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30757> _______________________________________

4 4

[issue35786] get_lock() method is not present for Values created using multiprocessing.Manager()
by Lorenzo Persichetti 15 Aug '20

15 Aug '20

New submission from Lorenzo Persichetti <lpersichetti(a)gmail.com>: According to the documentation of the multiprocessing.Value() class available here https://docs.python.org/3.6/library/multiprocessing.html#multiprocessing.Va… Operations like += which involve a read and write are not atomic. So if, for instance, you want to atomically increment a shared value it is insufficient to just do counter.value += 1 Assuming the associated lock is recursive (which it is by default) you can instead do with counter.get_lock(): counter.value += 1 What happens is that when running the following snippet import multiprocessing manager = multiprocessing.Manager() value = manager.Value('i', 0) value.get_lock() the result is AttributeError: 'ValueProxy' object has no attribute 'get_lock' ---------- assignee: docs@python components: Documentation, Library (Lib), Windows messages: 334070 nosy: Lorenzo Persichetti, docs@python, paul.moore, steve.dower, tim.golden, zach.ware priority: normal severity: normal status: open title: get_lock() method is not present for Values created using multiprocessing.Manager() versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35786> _______________________________________

8 9

[issue36700] base64 has old references that should be updated
by Paul Hoffman 10 Aug '20

10 Aug '20

New submission from Paul Hoffman <phoffman(a)proper.com>: The documentation for base64 library has an RFC that is obsolete. ---------- assignee: docs@python components: Documentation messages: 340668 nosy: docs@python, paulehoffman priority: normal pull_requests: 12839 severity: normal status: open title: base64 has old references that should be updated _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue36700> _______________________________________

3 4

[issue40051] Dead link in help(lib2to3)
by wyz23x2 07 Aug '20

07 Aug '20

New submission from wyz23x2 <wyz23x2(a)163.com>: When typing this in shell: >>> import lib2to3 >>> help(lib2to3) The output contains this link: --snip-- MODULE REFERENCE https://docs.python.org/3.8/library/lib2to3 <-- The following documentation is automatically generated from the Python --snip-- But when you access it, 404! This works: https://docs.python.org/3.8/library/2to3.html#module-lib2to3 Please change it. Thanks! ---------- assignee: docs@python components: 2to3 (2.x to 3.x conversion tool), Documentation, Library (Lib) messages: 364917 nosy: docs@python, wyz23x2 priority: normal severity: normal status: open title: Dead link in help(lib2to3) type: performance versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40051> _______________________________________

2 7

[issue40045] Make "dunder" method documentation easier to locate
by Kyle Stanley 30 Jul '20

30 Jul '20

New submission from Kyle Stanley <aeros167(a)gmail.com>: In a recent python-ideas thread, the rule of dunder methods being reserved for Python internal usage only was brought up (https://mail.python.org/archives/list/python-ideas@python.org/message/GMRPS…), due to an author of a third party library using them without knowing better. Steven D'Aprano linked the following section of the docs that defines the rule: https://docs.python.org/3/reference/lexical_analysis.html#reserved-classes-…. When I had attempted to search for the rule in the documentation (prior to the above discussion), I noticed that it was rather difficult to discover because it was written just as "System-defined names" with no mention of "dunder" (which is what the dev community typically refers to them as, at least in more recent history). To make it easier for the average user and library maintainer to locate this section, I propose changing the first line to one of the following: 1) System-defined names, also known as "dunder" names. 2) System-defined names, informally known as "dunder" names. I'm personally in favor of (1), but I could also see a reasonable argument for (2). If we can decide on the wording, it would make for a good first-time PR to the CPython docs. ---------- assignee: docs@python components: Documentation keywords: easy, newcomer friendly messages: 364832 nosy: aeros, docs@python priority: normal severity: normal status: open title: Make "dunder" method documentation easier to locate type: enhancement versions: Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40045> _______________________________________

7 13

[issue36661] Missing import in docs
by Merlin Fisher-Levine 28 Jul '20

28 Jul '20

New submission from Merlin Fisher-Levine <merlin.fisherlevine(a)gmail.com>: Dataclasses docs don't mention needing import for @dataclass decorator https://docs.python.org/3/library/dataclasses.html ---------- assignee: docs@python components: Documentation messages: 340510 nosy: docs@python, mfisherlevine priority: normal severity: normal status: open title: Missing import in docs type: enhancement versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue36661> _______________________________________

10 16

[issue39868] Stale Python Language Reference docs (no walrus).
by Brandt Bucher 26 Jul '20

26 Jul '20

New submission from Brandt Bucher <brandtbucher(a)gmail.com>: It looks like https://docs.python.org/3/reference/expressions.html and https://docs.python.org/3/reference/compound_stmts.html were never updated for named expressions. Because this change has to be backported, it's sort of a blocker for my PEP 614 doc updates in issue 39702, which need to use the missing node in 3.9 only (I'd rather have this get a clean backport now than a messy one later)! Is somebody more familiar with PEP 572 willing to take this? Should be pretty straightforward. Pinging Emily since it looks like you've done some grammar/doc work for this in the past. ---------- assignee: docs@python components: Documentation keywords: easy messages: 363456 nosy: brandtbucher, docs@python, emilyemorehouse priority: normal severity: normal status: open title: Stale Python Language Reference docs (no walrus). versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39868> _______________________________________

4 24

[issue37082] Assignment expression operator (walrus) not in built-in help()
by Matthias Bussonnier 25 Jul '20

25 Jul '20

New submission from Matthias Bussonnier <bussonniermatthias(a)gmail.com>: Do the following at a Python prompt: ``` >>> help() Welcome to Python 3.8's help utility! [...]SNIP help> symbols Here is a list of the punctuation symbols which Python assigns special meaning to. Enter any symbol to get more help. != + <= __ " += <> ` """ , == b" % - > b' %= -= >= f" & . >> f' &= ... >>= j ' / @ r" ''' // J r' ( //= [ u" ) /= \ u' * : ] | ** < ^ |= **= << ^= ~ *= <<= _ ``` Oh no ! Our favorite `:=` is missing :-( ---------- assignee: docs@python components: Documentation messages: 343813 nosy: docs@python, mbussonn priority: normal severity: normal status: open title: Assignment expression operator (walrus) not in built-in help() versions: Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37082> _______________________________________

6 7