Mailman 3 March 2020 - docs

[issue15436] __sizeof__ is not documeneted
by Serhiy Storchaka March 22, 2020

March 22, 2020

New submission from Serhiy Storchaka <storchaka(a)gmail.com>: __sizeof__ is not mentioned on page Doc/reference/datamodel.rst together with other special methods. There is no __sizeof__ in index. ---------- assignee: docs@python components: Documentation messages: 166245 nosy: docs@python, storchaka priority: normal severity: normal status: open title: __sizeof__ is not documeneted versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15436> _______________________________________

14 24

[issue40016] Clarify flag case in `re` module docstring
by Terry J. Reedy March 21, 2020

March 21, 2020

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: The docstring is currently 103 lines. I intentionally replaced 1 line with 1 line that I believe to be more informative and kept the expansion of the other line to 3 lines. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40016> _______________________________________

1 0

[issue40016] Clarify flag case in `re` module docstring
by Terry J. Reedy March 21, 2020

March 21, 2020

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: The docstring line in question is (?aiLmsux) Set the A, I, L, M, S, U, or X flag for the RE (see below). This is exceptional in that other syntaxes in the special characters list use lower case only for syntax variables (m, n, name, id/name, yes, no). Here, each letter is a separate and literal special character. (Also exceptional is that the syntax given is illegal, as 'a', 'L', and 'u' are mutually exclusive.) The corresponding doc entry starts "(One or more letters from the set 'a', 'i', 'L', 'm', 's', 'u', 'x'.) ... the letters set the corresponding flags:" followed by 6 more lines. I suggest the following as the replacement here (followed by more 'below'). (?aiLmsux) The letters set the corresponding flags defined below. I think 'letters' pretty clearly refers to 'a', 'i', ..., and 'x' as given, and that each 'corresponds' to and sets a flag that is a separate entity. The more complicated inline flags syntax, "(?aiLmsux-imsx:...)", is omitted from the docstring. Perhaps this is intentional. The flag constants are currently introduced by Some of the functions in this module takes flags as optional parameters: My suggested more accurate and expanded replacement: "Each function other than purge and escape can take an optional 'flags' argument consisting of one or more of the following module constants, joined by "|". A, L, and U are mutually exclusive." ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40016> _______________________________________

1 0

[issue40016] Clarify flag case in `re` module docstring
by Terry J. Reedy March 21, 2020

March 21, 2020

Change by Terry J. Reedy <tjreedy(a)udel.edu>: ---------- title: Clarify flag case in `re` module -> Clarify flag case in `re` module docstring _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40016> _______________________________________

1 0

[issue40016] Clarify flag case in `re` module
by Terry J. Reedy March 21, 2020

March 21, 2020

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: The root confusion is that re compilation has several variations with two sets of indicators, each with an unhelpful exception, and each combined and used in different ways. 1. Module constants with uppercase English words or word pairs, also abbreviated by uppercase letters that are the first letter of the word -- except for S-DOTALL and X-VERBOSE. As arguments for the flags parameter of functions other than escape and purge, they are combined with '|'. 2. Syntax letters within '(?...)', itself within an regex string, that are the single letter module constants lowercased b -- except that L is not lowercased because some fonts make l and 1 look nearly the same or even identical. Multiple syntax letters are combined by concatenation. The additional issue for docstrings is the extreme compression, including the omission (here) of 're.' prefixes. They are intended as reminders for those who have read and understood the full doc, but we try to make them as clear as possible. I am working on an alternate revision. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40016> _______________________________________

1 0

[issue40016] Clarify flag case in `re` module
by Serhiy Storchaka March 21, 2020

March 21, 2020

Serhiy Storchaka <storchaka+cpython(a)gmail.com> added the comment: I apologize if I was rude. It's only because of my bad English. There were many translation options for my words suggested by Google Translator and I obviously picked up the wrong one. Improving documentation is always a good thing. But I leave the final decision to someone who is fluent in English. ---------- assignee: -> docs@python components: +Documentation -Library (Lib) nosy: +docs@python, mrabarnett, terry.reedy type: behavior -> enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40016> _______________________________________

1 0

[issue39971] Error on documentation - Quick fix.
by Diogo Flores March 20, 2020

March 20, 2020

New submission from Diogo Flores <dxflores(a)outlook.com>: Hello, A code example from the 'functional programming how-to' raises an error. The simplest fix would be to remove the Ellipsis object from the 'line_list'. Thank you, Diogo Please check below for the commands issued: # https://docs.python.org/3/howto/functional.html#generator-expressions-and-l… >>> line_list = [' line 1\n', 'line 2 \n', ...] >>> >>> # Generator expression -- returns iterator >>> stripped_iter = (line.strip() for line in line_list) >>> >>> # List comprehension -- returns list >>> stripped_list = [line.strip() for line in line_list] Traceback (most recent call last): File "<stdin>", line 1, in <module> File "<stdin>", line 1, in <listcomp> AttributeError: 'ellipsis' object has no attribute 'strip' ---------- assignee: docs@python components: Documentation messages: 364247 nosy: docs@python, dxflores priority: normal severity: normal status: open title: Error on documentation - Quick fix. versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39971> _______________________________________

3 5

[issue39797] shutdown() in socketserver.BaseServer should be in a different thread from serve_forever()
by Ama Aje My Fren March 20, 2020

March 20, 2020

New submission from Ama Aje My Fren <amaajemyfren(a)gmail.com>: When a subclass of socketserver.BaseServer is running after calling serve_forever() and needs to be shutdown, it may be shut down by sending a [shutdown()](https://docs.python.org/3/library/socketserver.html#socketserve…. The thing is though that the shutdown() call must be run in a different thread than the one where the serve_forever() was called otherwise it will deadlock. This is documented in the [code](https://github.com/python/cpython/blob/3.8/Lib/socketserver.py#L244) but not in the documentation. It should be in the documentation as well as it is not obvious. ---------- assignee: docs@python components: Documentation messages: 362981 nosy: amaajemyfren, docs@python priority: normal severity: normal status: open title: shutdown() in socketserver.BaseServer should be in a different thread from serve_forever() type: enhancement versions: Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39797> _______________________________________

3 11

[issue21108] Add doc examples for importlib
by Saimadhav Heblikar March 18, 2020

March 18, 2020

New submission from Saimadhav Heblikar: The imp module was the defacto module to access the import internals,upto 3.3 It has been deprecated(pending) in 3.4 in favor of importlib. There are plenty of examples on how to use imp around the web, but very little (even in doc.python.org), on how to use importlib. The proposed patch adds couple of examples. These examples are aimed towards people, who were earlier using imp's load_module(). Inspiration for the patch from this SO answer, where user had to go through source code. http://stackoverflow.com/questions/19009932/import-abitrary-python-source-f… ---------- assignee: docs@python components: Documentation files: importlib-example.patch keywords: patch messages: 215220 nosy: docs@python, sahutd priority: normal severity: normal status: open title: Add doc examples for importlib versions: Python 3.4 Added file: http://bugs.python.org/file34675/importlib-example.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21108> _______________________________________

5 6

[issue22014] Add summary table for OS exception <-> errno mapping
by Nick Coghlan March 18, 2020

March 18, 2020

New submission from Nick Coghlan: It would be handy if the main OS exception docs at https://docs.python.org/3/library/exceptions.html#os-exceptions included a summary table mapping between exception types and errno names, akin to the one in the original PEP (http://www.python.org/dev/peps/pep-3151/#new-exception-classes) ---------- assignee: docs@python components: Documentation keywords: easy messages: 223499 nosy: docs@python, ncoghlan priority: normal severity: normal status: open title: Add summary table for OS exception <-> errno mapping versions: Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22014> _______________________________________

5 10