Mailman 3 May 2021 - docs

[issue43354] xmlrpc.client: Fault.faultCode erroneously documented to be a string, should be int
by Jürgen Gmach 05 May '21

05 May '21

New submission from Jürgen Gmach <juergen.gmach(a)googlemail.com>: I created a XMLRPC API (via Zope), which gets consumed by a C# application. C#'s XMLRPC lib expects an `int` for the `faultCode` but I currently return a string, as this is the type which is currently documented in the official docs https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.Fault.fa… This leads to a `TypeMismatch` error on the client's side. The documentation for `faultCode` is pretty much unchanged since 2007, when `xmlrpc.client.rst` was first created (at least at that place) by Georg Brandl. The docs are most probably older, but I do not know where they were managed before. I had a look at the cpython source code, and at least the tests all use ints for `faultCode` (both of them :-) ) eg https://github.com/python/cpython/blob/255f53bdb54a64b93035374ca4484ba0cc1b… Having a look at the XMLRPC spec at http://xmlrpc.com/spec.md it is clearly shown that `faultCode` has to be an int. Typeshed recently added type hints for xmlrpc lib, and they used string for `faultCode` - but I guess this is just an aftereffect from the faulty documentation. https://github.com/python/typeshed/pull/3834 I suggest to both update cpython's documentation and to create a PR for typeshed in order to fix the type issue. If any core dev agrees on this, I'd like to prepare the pull requests. Thanks for taking your time to look into this! ---------- assignee: docs@python components: Documentation messages: 387866 nosy: docs@python, jugmac00 priority: normal severity: normal status: open title: xmlrpc.client: Fault.faultCode erroneously documented to be a string, should be int 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/issue43354> _______________________________________

4 6

[issue44038] In documentation Section 8.6, the definition of parameter_list need correcting
by Webb Scales 05 May '21

05 May '21

New submission from Webb Scales <wscales(a)redhat.com>: In Section 8.6 ("Function definitions"; https://docs.python.org/3/reference/compound_stmts.html#function-definitions), the definition of "parameter_list" looks slightly wrong: parameter_list ::= defparameter ("," defparameter)* "," "/" ["," [parameter_list_no_posonly]] | parameter_list_no_posonly The "/" (and the comma preceding it) is not a required component. (Sorry, I'm afraid I'm not smart enough right now to suggest a correction. :-p ) ---------- assignee: docs@python components: Documentation messages: 392943 nosy: docs@python, webbnh priority: normal severity: normal status: open title: In documentation Section 8.6, the definition of parameter_list need correcting versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44038> _______________________________________

1 0

[issue44025] Match doc: Clarify '_' as a soft keyword
by Terry J. Reedy 05 May '21

05 May '21

New submission from Terry J. Reedy <tjreedy(a)udel.edu>: In #44010, we are trying, as best as is possible with comprehensible REs, to identify in which circumstances occurrences of 'match', 'case' and '_' are keywords, and should be marked as such. I was initially unsure and even wrong about '_'. 1. Capture Patterns: I was confused by 'And is instead...'. 'It is instead ...', where 'it' refers to '_', is clearer to me. 2. Wildcard Patterns: "'_' is a soft keyword" just says it sometimes is and sometimes is not, but not when, or rather, where. After experiments like this (using the new IDLE 'copy with prompts' option ;-): >>> _ = 'a' >>> match [_, 'b']: ... case [capture, _] if _ == 'a': ... print(capture, _) ... a a I added (in PR to come, with markup that might be improved) "within any pattern, but only within patterns. It is an identifier, as usual, even within ``match`` headers, ``guards``, and ``case blocks``. Please consider also adding an example like the above. ---------- assignee: docs@python components: Documentation messages: 392848 nosy: brandtbucher, docs@python, gvanrossum, terry.reedy priority: normal severity: normal stage: patch review status: open title: Match doc: Clarify '_' as a soft keyword type: behavior versions: Python 3.10, Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44025> _______________________________________

2 4

[issue43978] Incorrect "versionadded" info in typing.NoReturn documentation
by Mariatta 05 May '21

05 May '21

New submission from Mariatta <mariatta(a)python.org>: We received a documentation bug report in docs mailing list. https://mail.python.org/archives/list/docs@python.org/thread/BLANNZUPUEOJ4L… It looks like the doc currently says that, typing.NoReturn was added in both 3.5.4 and 3.6.2 It appeared from this change, that it was originally added in 3.6.5 (https://github.com/python/cpython/pull/7107/files) However, during a refactoring effort, in https://github.com/python/cpython/commit/ab72fdeb82c3ab045b480cd4bb4f928c12…, the 3.5.4 and 3.6.2 info were added, perhaps due to copy-pasting. I think it should be changed into .. versionadded:: 3.6.5 However, I'm curious to know whether there are other parts in the doc, where this info is wrong. So perhaps there was other parts of the doc that was added in 3.5.4, but somehow we moved that to the typing.NoReturn section. For now, I think we can just fix it by adding .. versionadded: 3.6.5 And maybe someone else can look into other parts of the doc to see if the version info are correct. ---------- assignee: docs@python components: Documentation keywords: easy, newcomer friendly messages: 392341 nosy: Mariatta, docs@python priority: normal severity: normal stage: needs patch status: open title: Incorrect "versionadded" info in typing.NoReturn documentation versions: Python 3.10, Python 3.11, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43978> _______________________________________

4 7

[issue43349] [doc] incorrect tuning(7) manpage link
by Erlend Egeberg Aasland 04 May '21

04 May '21

New submission from Erlend Egeberg Aasland <erlend.aasland(a)innova.no>: In https://docs.python.org/3.10/library/resource.html#resource.RLIMIT_SWAP, tuning(7) points to https://manpages.debian.org/tuning(7), however this is a FreeBSD only (?) system call, so the link is incorrect. I suggest linking to either: - https://docs.freebsd.org/en/books/handbook/config/ - https://www.freebsd.org/cgi/man.cgi?query=tuning&sektion=7&format=html ---------- assignee: docs@python components: Documentation messages: 387845 nosy: docs@python, erlendaasland priority: normal severity: normal status: open title: [doc] incorrect tuning(7) manpage link versions: Python 3.10, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43349> _______________________________________

4 8

[issue38352] In typing docs, note explicit import needed for IO and Pattern/Match
by Karl Kornel 04 May '21

04 May '21

New submission from Karl Kornel <karl(a)kornel.us>: Hello! In https://github.com/python/cpython/blob/master/Lib/typing.py#L115-L117, there is a note about the io and re classes not being included in typing.__all__. I am a relatively new user of typing, and I did `from typing import *` in my code. I ran the code through mypy first, which reported no problems, but then running Python 3.6 failed with a NameError (name 'IO' is not defined). Reading through the typing source, it's clear that this was an intentional decision. So, instead of reporting a bug, I'd like to request a documentation enhancement! The docs for typing make no mention of typing.io or typing.re. So, my request is: In the sections for the IO/TextIO/BinaryIO and Pattern/Match classes, include text warning the user that these types are not imported when you do `from typing import *`. ---------- assignee: docs@python components: Documentation messages: 353763 nosy: Karl Kornel, docs@python priority: normal severity: normal status: open title: In typing docs, note explicit import needed for IO and Pattern/Match type: behavior versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue38352> _______________________________________

8 12

[issue32822] finally block doesn't re-raise exception if return statement exists inside
by Łukasz Langa 04 May '21

04 May '21

Change by Łukasz Langa <lukasz(a)langa.pl>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32822> _______________________________________

1 0

[issue32822] finally block doesn't re-raise exception if return statement exists inside
by Łukasz Langa 04 May '21

04 May '21

Łukasz Langa <lukasz(a)langa.pl> added the comment: New changeset 8655521de8760e8a695bcce92937800c079ea2b2 by Miss Islington (bot) in branch '3.10': bpo-32822: Add finally with return/break/continue to the tutorial (GH-25600) (#25893) https://github.com/python/cpython/commit/8655521de8760e8a695bcce92937800c07… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32822> _______________________________________

1 0

[issue32822] finally block doesn't re-raise exception if return statement exists inside
by Łukasz Langa 04 May '21

04 May '21

Łukasz Langa <lukasz(a)langa.pl> added the comment: New changeset 91cb1e20e6a432b8b2c1b5db37b03c84b15384fa by Miss Islington (bot) in branch '3.9': bpo-32822: Add finally with return/break/continue to the tutorial (GH-25600) (#25890) https://github.com/python/cpython/commit/91cb1e20e6a432b8b2c1b5db37b03c84b1… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32822> _______________________________________

1 0

[issue32822] finally block doesn't re-raise exception if return statement exists inside
by miss-islington 04 May '21

04 May '21

Change by miss-islington <mariatta.wijaya+miss-islington(a)gmail.com>: ---------- pull_requests: +24567 pull_request: https://github.com/python/cpython/pull/25893 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32822> _______________________________________

1 0