Mailman 3 March 2021 - docs

[issue20364] Rename & explain sqlite3.Cursor.execute 'parameters' param
by Terry J. Reedy April 14, 2021

April 14, 2021

New submission from Terry J. Reedy: "execute(sql[, parameters]) Executes an SQL statement. The SQL statement may be parametrized (i. e. placeholders instead of SQL literals). The sqlite3 module supports two kinds of placeholders: question marks (qmark style) and named placeholders (named style)." Experimental facts based on experiments with the code example in the doc, using 3.4.b2: 'parameters' is a single subscriptable collection parameter, sequence or dict, that might be called … [View More]

7 12

[issue39774] Missing documentation on how to make package executable as script
by igo95862 April 12, 2021

April 12, 2021

New submission from igo95862 <igo9586(a)gmail.com>: This is package documentation: https://docs.python.org/3/tutorial/modules.html#packages To make package executable (python -m package) you need to create a file __main__.py in the package directory. This is pretty much not documented anyone aside of trying to run a package missing __main__.py This page already contains information on how to make module executable. (https://docs.python.org/3/tutorial/modules.html#executing-modules-… [View More]

3 3

[issue39125] Type signature of @property not shown in help()
by Nguyễn Gia Phong April 11, 2021

April 11, 2021

New submission from Nguyễn Gia Phong <vn.mcsinyx(a)gmail.com>: Dear Maintainer, I want to request a feature on the generative documentation of type-hinting. As of December 2019, I believe there is no support for generating such information in help(). For demonstration, I have this tiny piece of code class Foo: @property def bar(self) -> int: return 42 @bar.setter def bar(self, value: int) -> None: pass def baz(self, arg: float) -> str: pass whose … [View More]

4 5

[issue38963] multiprocessing processes seem to "bleed" user information (GID/UID/groups)
by Roman Joost April 9, 2021

April 9, 2021

New submission from Roman Joost <roman(a)bromeco.de>: When running a process which changes UID/GID, some of the following processes will run as the user I change to per process. In order to reproduce (see the attached reproducer): 1. Change the 'USERNAME' to an unprivileged user on your system. 2. Run the reproducer as a user with elevated privileges (e.g. root or some secondary user you have on your system). Mind you, I don't think the user you run as needs elevated privileges, but … [View More]

2 1

[issue43540] importlib: Document how to replace load_module() in What's New in Python 3.10
by STINNER Victor April 8, 2021

April 8, 2021

New submission from STINNER Victor <vstinner(a)python.org>: The load_module() method of importlib loaders is deprecated which cause test failures in multiple projects. It is not easy to guess how to replace it. Examples: * pkg_resources fix adding create_module() and exec_module() methods: https://github.com/pypa/setuptools/commit/6ad2fb0b78d11e22672f56ef9d65d13eb… * pkg_resources fix replacing importlib.load_module() function call (not loader methods) with importlib.import_module(): … [View More]

4 6

[issue42999] `pathlib.Path.link_to()` documentation is misleading
by Barney Gale April 7, 2021

April 7, 2021

New submission from Barney Gale <barney.gale(a)gmail.com>: Compare the documentation of `symlink_to()` and `link_to()`: .. method:: Path.symlink_to(target, target_is_directory=False) Make this path a symbolic link to *target*. .. method:: Path.link_to(target) Create a hard link pointing to a path named *target*. In fact, `link_to()` does something like: Make *target* a hard link to this path. Which is unexpected given the naming and inconsistency with `symlink_to()`, but … [View More]

3 9

[issue43325] Documentation should warn that 'is' is not a safe comparison operator for most values.
by Anthony Flury April 6, 2021

April 6, 2021

New submission from Anthony Flury <anthony.flury(a)btinternet.com>: A frequent bug for beginners is to assume that 'is' is somehow 'better' then '==' when comparing values, and it is certainly a cause for confusion amongst beginners as to why: [1,2] is [1,2] evaluates to False but 'a' is 'a' evaluates to True and many similar examples. As far as I can see the first mention of the 'is' operator is under Section 5 - More on conditionals : https://docs.python.org/3/tutorial/… [View More]

4 8

[issue41283] The parameter name for imghdr.what in the documentation is wrong
by Adam Eltawla April 2, 2021

April 2, 2021

New submission from Adam Eltawla <bekerpico(a)gmail.com>: I noticed the parameter name for imghdr.what in the documentation is wrong Link: https://docs.python.org/3.8/library/imghdr.html?highlight=imghdr function imghdr.what(filename, h=None) In reality: def what(file, h=None): It is 'file' not 'filename'. ---------- assignee: docs@python components: Documentation messages: 373551 nosy: aeltawela, docs@python priority: normal severity: normal status: open title: The parameter name … [View More]

3 4

[issue40932] subprocess docs don't qualify the instruction to use shlex.quote by OS
by Stephen Farris April 2, 2021

April 2, 2021

New submission from Stephen Farris <stephen.farris(a)jhuapl.edu>: The subprocess docs state: "When using shell=True, the shlex.quote() function can be used to properly escape whitespace and shell metacharacters in strings that are going to be used to construct shell commands." While this is true on Unix, it is not true on Windows. On Windows it is easy to create scenarios where shell injection still exists despite using shlex.quote properly (e.g. subprocess.run(shlex.quote("'&calc '")… [View More]

6 8

[issue34398] Docs search does not index glossary
by Jonathan Fine April 2, 2021

April 2, 2021

New submission from Jonathan Fine <jfine2358(a)gmail.com>: The docs contain a very useful page https://docs.python.org/3.5/glossary.html. However, the search feature does not index the glossary. Thus, the search https://docs.python.org/3.5/search.html?q=iterable does not produce the helpful glossary entry === iterable An object capable of returning its members one at a time. Examples of iterables include all sequence types (such as list, str, and tuple) and some non-sequence types like … [View More]

6 12