Mailman 3 January 2021 - docs

[issue42300] Typo in translation to portuguese
by Ronan Soares Jan. 23, 2021

Jan. 23, 2021

New submission from Ronan Soares <ronan.soares(a)gmail.com>: Change "múltiplo menos comum" to "menor múltiplo comum" in the portuguese section of the what changed in python 3.9 ---------- assignee: docs@python components: Documentation messages: 380626 nosy: docs@python, ronan.soares priority: normal severity: normal status: open title: Typo in translation to portuguese type: enhancement versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42300> _______________________________________

3 2

[issue43005] Package Relative Imports - double dot doc example not working
by Ixio Jan. 22, 2021

Jan. 22, 2021

New submission from Ixio <ektech(a)gmx.com>: I've been trying to do a double dot import without success, I've tried going back to the official documentation in order to figure it out however even the example shown does not work. Official example : https://docs.python.org/3/reference/import.html#package-relative-imports The following instructions mimic pretty well the doc example : ```bash mkdir package cd package touch __init__.py mkdir subpackage1 touch subpackage1/__init__.py mkdir subpackage2 touch subpackage2/__init__.py echo "eggs = 42" > subpackage2/moduleZ.py echo "from ..subpackage2.moduleZ import eggs" > subpackage1/moduleX.py python subpackage1/moduleX.py cd subpackage1 python moduleX.py cd .. echo "from subpackage1 import moduleX" > moduleA.py python moduleA.py ``` However I get 3 times the following error : from ..subpackage2.moduleZ import eggs ImportError: attempted relative import beyond top-level package Even though the docs say "In [...] subpackage1/moduleX.py [...] the following are valid relative imports: [...] from ..subpackage2.moduleZ import eggs". I have no idea how to fix the doc as I would love to do "from ..subpackage2.moduleZ import eggs" from "subpackage1/moduleX.py" since that's the structure I'm trying to set up for a Python project of mine but obviously it does not seem to work. My system uses Python 3.9 and I've used Docker to try this scenario on Python 3.8, 3.5 and even 3.2: it does not work either. I've also tried on another machine and asked a friend to try, no luck. I'm hoping someone here can explain how double dot imports work and fix the documentation accordingly. ---------- assignee: docs@python components: Documentation messages: 385515 nosy: Ixio, brett.cannon, docs@python, eric.snow, ncoghlan priority: normal severity: normal status: open title: Package Relative Imports - double dot doc example not working type: behavior versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43005> _______________________________________

2 1

[issue42996] hashlib documentation references an obsolete RFC 2898
by Illia Volochii Jan. 22, 2021

Jan. 22, 2021

New submission from Illia Volochii <illia.volochii(a)gmail.com>: RFC 2898 mentioned in the "See also" section of hashlib documentation was superseded by RFC 8018. https://docs.python.org/3/library/hashlib.html https://www.ietf.org/rfc/rfc8018.txt ---------- assignee: docs@python components: Documentation messages: 385457 nosy: docs@python, illia-v priority: normal severity: normal status: open title: hashlib documentation references an obsolete RFC 2898 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42996> _______________________________________

2 3

[issue40304] Classes created using type() don't need to explicitly inherit from object
by Борис Верховский Jan. 21, 2021

Jan. 21, 2021

New submission from Борис Верховский <boris.verk(a)gmail.com>: As far as I can tell, passing `(object,)` and `()` as the `bases` parameter to the 3-argument version of type() produces the same result, because classes inherit from `object` in Python 3: >>> type('X', (object,), dict(a=1)).__bases__ (<class 'object'>,) >>> type('X', (), dict(a=1)).__bases__ (<class 'object'>,) I just want to make sure I'm not missing something and update the documentation of `type()` to reflect that. ---------- assignee: docs@python components: Documentation messages: 366613 nosy: boris, docs@python priority: normal pull_requests: 18902 severity: normal status: open title: Classes created using type() don't need to explicitly inherit from object type: enhancement versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40304> _______________________________________

3 6

[issue42993] doc xml.etree.ElementTree.ElementTree.write does not mention attribute order
by Christian Buhtz Jan. 21, 2021

Jan. 21, 2021

New submission from Christian Buhtz <c.buhtz(a)posteo.jp>: The docs for 'xml.etree.ElementTree.ElementTree.write' in Python 3.7 (and possible earlier) does not say a word about the ordering of the attributes. This makes unittesting hard. But looking in the code tells me that the attributes are ordered lexically. Important to know. So please upgrade the docu about that. In Python 3.8 the ordering behavior changed again but is mentioned in the docu. So no need to change in 3.8 or later. ---------- assignee: docs@python components: Documentation messages: 385448 nosy: buhtz, docs@python priority: normal severity: normal status: open title: doc xml.etree.ElementTree.ElementTree.write does not mention attribute order type: enhancement versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42993> _______________________________________

1 0

[issue36769] doc Document that fnmatch.filter supports any kind of iterable not just lists
by Andrés Delfino Jan. 20, 2021

Jan. 20, 2021

New submission from Andrés Delfino <adelfino(a)gmail.com>: Documentation on fnmatch.filter says: Return the subset of the list of names that match pattern. It is the same as [n for n in names if fnmatch(n, pattern)], but implemented more efficiently. But the function actual accepts any kind of iterable. I think it should be documented. ---------- assignee: docs@python components: Documentation messages: 341198 nosy: adelfino, docs@python priority: normal severity: normal status: open title: doc Document that fnmatch.filter supports any kind of iterable not just lists type: enhancement versions: Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue36769> _______________________________________

4 8

[issue14191] argparse doesn't allow optionals within positionals
by Tadek Kijkowski Jan. 19, 2021

Jan. 19, 2021

Change by Tadek Kijkowski <tkijkowski(a)gmail.com>: ---------- nosy: +monkeyman79 nosy_count: 9.0 -> 10.0 pull_requests: +23084 pull_request: https://github.com/python/cpython/pull/24259 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue14191> _______________________________________

1 0

asyncio doc bug
by Bas Terwijn Jan. 19, 2021

Jan. 19, 2021

Hello, Here: https://docs.python.org/dev/library/asyncio-task.html It says: task1 = asyncio.create_task( say_after(1, 'hello')) task2 = asyncio.create_task( say_after(2, 'world')) but I think it should be (flipped arguments): task1 = asyncio.create_task( say_after('hello', 1 )) task2 = asyncio.create_task( say_after('world', 2 )) Thanks for the docs. Regards, Bas Terwijn

1 0

[issue42705] Intercepting thread lock objects not working under context managers
by Mohamad Kanj Jan. 17, 2021

Jan. 17, 2021

New submission from Mohamad Kanj <mhmd.kanj(a)gmail.com>: The interception of Python and C functions is achieved through the `sys` module - however, when using thread locks from `threading` module for instance under context managers, the calls on the lock to `acquire()` and `release()` cannot be witnessed. If these methods were to be called explicitly then this is no problem. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42705> _______________________________________

3 3

[issue42945] weakref.finalize documentation contradicts itself RE: finalizer callback or args referencing object
by Ryan Heisler Jan. 16, 2021

Jan. 16, 2021

New submission from Ryan Heisler <ryan.a.heisler(a)gmail.com>: In the documentation for `weakref.finalize` (https://docs.python.org/3.9/library/weakref.html#weakref.finalize), it says: "Note It is important to ensure that func, args and kwargs do not own any references to obj, either directly or indirectly, since otherwise obj will never be garbage collected. In particular, func should not be a bound method of obj." However, at the bottom of the document, in the section called "Comparing finalizers with __del__() methods" (https://docs.python.org/3.8/library/weakref.html#comparing-finalizers-with-…), the following code is part of an example of how to use `weakref.finalize`: class TempDir: def __init__(self): self.name = tempfile.mkdtemp() self._finalizer = weakref.finalize(self, shutil.rmtree, self.name) I believe this code violates the rule that func, args, and kwargs should not have a reference to obj. In the example, obj is the instance of TempDir, and one of the arguments to finalize's callback is an attribute of the same instance of TempDir. I do not know how to fix this example code. I found it while trying to figure out how to use `weakref.finalize`. ---------- assignee: docs@python components: Documentation messages: 385155 nosy: docs@python, ryan.a.heisler priority: normal severity: normal status: open title: weakref.finalize documentation contradicts itself RE: finalizer callback or args referencing object versions: Python 3.10, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42945> _______________________________________

2 2