Mailman 3 February 2020 - docs

[issue37970] urllib.parse docstrings incomplete
by Zachary Ware Feb. 23, 2020

Feb. 23, 2020

New submission from Zachary Ware <zachary.ware(a)gmail.com>: For example, urlsplit: >>> from urllib.parse import urlsplit >>> help(urlsplit) Help on function urlsplit in module urllib.parse: urlsplit(url, scheme='', allow_fragments=True) Parse a URL into 5 components: <scheme>://<netloc>/<path>?<query>#<fragment> Return a 5-tuple: (scheme, netloc, path, query, fragment). Note that we don't break the components up in smaller bits (e.g. netloc is a single string) and we don't expand % escapes. The current docstring does not describe the `scheme` or `allow_fragments` arguments. Also, the note about not splitting netloc is misleading; the components of netloc (username, password, hostname, and port) are available as extra attributes of the returned SplitResult. urlparse has similar issues; other functions could stand to be checked. ---------- assignee: docs@python components: Documentation, Library (Lib) keywords: newcomer friendly messages: 350668 nosy: docs@python, zach.ware priority: normal severity: normal stage: needs patch status: open title: urllib.parse docstrings incomplete versions: Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37970> _______________________________________

6 17

Definition of "getattr" incorrectly lists "default" value.
by B. James Maher Feb. 23, 2020

Feb. 23, 2020

Here is the header definition of "getattr". def getattr(object, name, default=None): # known special case of getattr """ getattr(object, name[, default]) -> value Get a named attribute from an object; getattr(x, 'y') is equivalent to x.y. When a default argument is given, it is returned when the attribute doesn't exist; without it, an exception is raised in that case. """ pass ----------- The way this is shown is that, if you do not provide a value to the parameter "default", then it defaults to the value "None". However, that is NOT what is happening. You specifically have to pass in "None" in order for "default" to have the value "None" as in: fly_method = getattr(duck, "fly", None) You only see the querk if you read the info instead of just looking at the header. You need to change it back to : getattr(object, name[, default]) -> value Thanks.

1 0

[issue39691] Allow passing Pathlike objects to io.open_code
by Steve Dower Feb. 23, 2020

Feb. 23, 2020

Steve Dower <steve.dower(a)python.org> added the comment: As per PEP 578 it only accepts absolute path str. Requires a documentation update to clarify, as this is not the only report. And issue39517 should add a str() call and ensure that the path is absolute. ---------- assignee: -> docs@python components: +Documentation -Library (Lib) nosy: +docs@python, steve.dower versions: +Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39691> _______________________________________

1 0

[issue38101] Update devguide triaging keywords
by Lisa Roach Feb. 23, 2020

Feb. 23, 2020

New submission from Lisa Roach <lisaroach14(a)gmail.com>: Currently the devguide triaging keywords page is out of date: https://devguide.python.org/triaging/#keywords It is missing keywords like "easy (C)", "security_issue", and "pep3121". ---------- assignee: docs@python components: Documentation keywords: easy messages: 351781 nosy: docs@python, lisroach priority: normal severity: normal status: open title: Update devguide triaging keywords _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue38101> _______________________________________

4 6

[issue39180] Missing getlines func documentation from linecache module
by Karthikeyan Singaravelan Feb. 22, 2020

Feb. 22, 2020

New submission from Karthikeyan Singaravelan <tir.karthi(a)gmail.com>: As a note getlines is not exposed via __all__ : https://github.com/python/cpython/blob/22424c02e51fab3b62cbe255d0b87d1b55b9… ---------- nosy: +xtreak _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39180> _______________________________________

3 5

[issue39139] Reference to depricated collections.abc class in collections is unnecessary and confusing
by Khalid Mammadov Feb. 22, 2020

Feb. 22, 2020

New submission from Khalid Mammadov <khalidmammadov9(a)gmail.com>: "Deprecated since version 3.3, will be removed in version 3.9: Moved Collections Abstract Base Classes to the collections.abc module. For backwards compatibility, they continue to be visible in this module through Python 3.8." on the overview is confusing as it's not listed on that page and explained on the next one. ---------- assignee: docs@python components: Documentation messages: 358889 nosy: docs@python, khalidmammadov priority: normal severity: normal status: open title: Reference to depricated collections.abc class in collections is unnecessary and confusing type: enhancement versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39139> _______________________________________

2 5

[issue39130] Dict is reversable from v3.8 and should say that in the doc
by miss-islington Feb. 22, 2020

Feb. 22, 2020

New submission from miss-islington <mariatta.wijaya+miss-islington(a)gmail.com>: New changeset 94d9cfc4ed9dd3c4a3a359bc194b4dc3f6ba63eb by Miss Islington (bot) (Khalid Mammadov) in branch 'master': bpo-39130: Dict reversed was added in v3.8 so should say in the doc as well (GH-17694) https://github.com/python/cpython/commit/94d9cfc4ed9dd3c4a3a359bc194b4dc3f6… ---------- nosy: +miss-islington _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39130> _______________________________________

2 3

[issue39540] Logging docs don't address the creation of multiple loggers when a hierarchy is provided
by Alexander McFarlane Feb. 19, 2020

Feb. 19, 2020

New submission from Alexander McFarlane <alexander.mcfarlane(a)nomura.com>: If `logger_name` is a hierarchy format (e.g. `logger_name = 'parent.child'`) and the logger name `'parent'` has not been created, the function call `logging.getLogger(logger_name)` will create all loggers in the hierarchy (in this instance two loggers, `'parent'` and `'parent.child'` will be created) This is not documented anywhere in the logging documentation. Suggest that this is detailed under `logging.getLogger` More info... https://stackoverflow.com/q/59990300/4013571 ---------- assignee: docs@python components: Documentation messages: 361287 nosy: docs@python, flipdazed priority: normal severity: normal status: open title: Logging docs don't address the creation of multiple loggers when a hierarchy is provided type: enhancement versions: Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39540> _______________________________________

3 3

[issue9182] document “--” as a way to distinguish option w/ narg='+' from positional argument in argparse
by hai shi Feb. 19, 2020

Feb. 19, 2020

hai shi <shihai1991(a)126.com> added the comment: It exists in master, so it still need a patch. ---------- nosy: +rhettinger, shihai1991 versions: +Python 3.9 -Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue9182> _______________________________________

1 0

[issue17050] argparse.REMAINDER doesn't work as first argument
by hai shi Feb. 19, 2020

Feb. 19, 2020

hai shi <shihai1991(a)126.com> added the comment: > Okay. Would it be all right if I submit a fix to get it working at least in the subparser case? Hi, dHannasch. According raymond and paul's opinion, you could try to create a PR to update argparse's doc. ---------- nosy: +shihai1991 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue17050> _______________________________________

1 0