Mailman 3 January 2021 - docs

[issue34538] Remove encouragement to author a base class for all Exception subclasses in a module
by Nathaniel Manista March 14, 2021

March 14, 2021

New submission from Nathaniel Manista <nathaniel(a)google.com>: https://docs.python.org/3.8/tutorial/errors.html (and all other versions of that page back at least as far as 2.7) currently contain the guidance "When creating a module that can raise several distinct errors, a common practice is to create a base class for exceptions defined by that module, and subclass that to create specific exception classes for different error conditions: <code example>". It may have seemed like … [View More]

8 15

[issue40763] zipfile.extractall is safe by now
by Va March 13, 2021

March 13, 2021

New submission from Va <d.python.dc54(a)indigo.re>: In documentation of all Python 3 versions, [ZipFile.extractall](https://docs.python.org/3/library/zipfile.html#zipfile.… states with a big red warning: > Warning > Never extract archives from untrusted sources without prior inspection. It is possible that files are created outside of path, e.g. members that have absolute filenames starting with "/" or filenames with two dots "..". This module attempts to prevent that. See extract(… [View More]

4 5

[issue30435] Documentation either unclear or incorrect on comparisons between bytes and strings in Python 3
by ipatrol March 13, 2021

March 13, 2021

New submission from ipatrol: https://docs.python.org/3/reference/expressions.html#comparisons says that "Strings and binary sequences cannot be directly compared." That would seem to me to imply that an equality between them would raise an exception, as also claimed by https://wiki.python.org/moin/BytesStr However, that is manifestly incorrect. Bytes and strings can be compared: they are always unequal. This appears to be a result of the operation falling through to the default comparison, … [View More]

5 7

[issue18017] ctypes.PyDLL documentation
by Marc Brünink March 13, 2021

March 13, 2021

New submission from Marc Brünink: The documentation for is not very clear regarding the usage of CDLL and PyDLL. Especially it is not obvious that you should use PyDLL whenever you call any function of the Python/C API. Since calling a Python/C API function without owning the GIL will most likely cause latent segfaults, I think it warrants a warning box in section 16.17.2.2 and maybe also somewhere prominent in http://docs.python.org/dev/c-api/intro.html. For section 16.17.2.2 I would put a … [View More]

5 5

[issue27886] Docs: the difference between rename and replace is not obvious
by Andrew Svetlov March 13, 2021

March 13, 2021

New submission from Andrew Svetlov: Hi. On reading the doc for pathlib I've stuck with `.rename()` and `.replace()` (https://docs.python.org/3/library/pathlib.html#pathlib.Path.rename). What's the difference? Going to pathlib's source code I've figured out that methods are use different functions from `os` module: `os.rename()` and `os.replace()`. But the documentation for `os` module is not obvious too: the docs for both functions are almost equal from my perspective, the only … [View More]

4 8

[issue25741] Usual Installation Directory
by Firat Ozgul March 12, 2021

March 12, 2021

New submission from Firat Ozgul: Official documentation reads: "On Windows machines, the Python installation is usually placed in C:\Python35" However, as of Python 3.5.0, usual installation directory on Windows is %LOCALAPPDATA%\Programs\Python. ---------- assignee: docs@python components: Documentation messages: 255455 nosy: docs@python, firatozgul priority: normal severity: normal status: open title: Usual Installation Directory type: enhancement versions: Python 3.5 … [View More]

6 10

[issue31427] Proposed addition to Windows FAQ
by Stephan Houben March 12, 2021

March 12, 2021

New submission from Stephan Houben: Several people have asked on python-list why they are running into these errors. Python 3.6.0 can't start because api-ms-win-crt-runtime-l1-1-0.dll is missing. The solution is to install KB 2999226 "Update for Universal C Runtime in Windows". https://support.microsoft.com/en-us/help/2999226/update-for-universal-c-run… Propose to add this as a Windows FAQ. ---------- assignee: docs@python components: Documentation messages: 301952 nosy: Stephan Houben, … [View More]

4 5

[issue43044] Python 2.7 documentation links to 404 pages when the library was moved or renamed
by Борис Верховский March 10, 2021

March 10, 2021

New submission from Борис Верховский <boris.verk(a)gmail.com>: 1. go to https://docs.python.org/2/library/stringio.html (note the "/2/") 2. click on "You should upgrade and read the Python documentation for the current stable release." at the top I expect to be sent to the Python 3 documentation for StringIO (or at least the index.html page of the Python 3 documentaion) but because StringIO was moved from its own library into `io`, the Python 2 docs are linking to a 404 error page, … [View More]

2 2

[issue15097] Improving wording on the thread-safeness of import
by Merlijn van Deen March 9, 2021

March 9, 2021

New submission from Merlijn van Deen <valhallasw(a)gmail.com>: http://docs.python.org/library/threading.html#importing-in-threaded-code Currently, the documentation states "Firstly, other than in the main module, an import should not have the side effect of spawning a new thread and then waiting for that thread in any way. Failing to abide by this restriction can lead to a deadlock if the spawned thread directly or indirectly attempts to import a module." which, I think, fails to make … [View More]

3 6

[issue40982] copytree example in shutil
by Alberto Torres Barrán March 7, 2021

March 7, 2021

New submission from Alberto Torres Barrán <albertotb(a)gmail.com>: The copytree example in https://docs.python.org/3/library/shutil.html#copytree-example does not match the source code, even removing docstrings. In particular is missing parameters and the exceptions are in the wrong order (Error will never be reachable since it is n instance of OSError). ---------- assignee: docs@python components: Documentation messages: 371535 nosy: Alberto Torres Barrán, docs@python priority: normal … [View More]

3 2