Mailman 3 June 2018 - docs

[issue25337] weakref.finalize documentation refers to old interpreter shutdown behavior
by Josh Rosenberg Feb. 25, 2019

Feb. 25, 2019

New submission from Josh Rosenberg: In weakref.finalize's documentation ( https://docs.python.org/3/library/weakref.html#weakref.finalize ), it says: "A finalizer will never invoke its callback during the later part of the interpreter shutdown when module globals are liable to have been replaced by None." While it may not invoke its callback during shutdown (I don't know if it does, or if it should), as of Python 3.4 (which is when weakref.finalize was introduced), module globals aren't set to None anymore, right? https://docs.python.org/3/whatsnew/3.4.html#whatsnew-pep-442 Presumably the docs should be updated not to mention a behavior that no longer occurs (and if it will or should be invoked, weakref.finalizer should have documentation or code updated). ---------- assignee: docs@python components: Documentation messages: 252504 nosy: docs@python, josh.r priority: normal severity: normal status: open title: weakref.finalize documentation refers to old interpreter shutdown behavior versions: Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25337> _______________________________________

2 1

[issue28450] Misleading/inaccurate documentation about unknown escape sequences
by Lele Gaifax Feb. 25, 2019

Feb. 25, 2019

New submission from Lele Gaifax: Python 3.6+ is stricter about escaped sequences in string literals. The documentation need some improvement to clarify the change: for example https://docs.python.org/3.6/library/re.html#re.sub first says that “Unknown escapes such as \& are left alone” then, in the “Changed in” section below, states that “[in Py3.6] Unknown escapes consisting of '\' and an ASCII letter now are errors”. When such changes are made, usually the documentation reports the “new”/“current” behaviour, and the history section mention when and how some detail changed. See this thread for details: https://mail.python.org/pipermail/python-list/2016-October/715462.html ---------- assignee: docs@python components: Documentation messages: 278716 nosy: docs@python, lelit priority: normal severity: normal status: open title: Misleading/inaccurate documentation about unknown escape sequences versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28450> _______________________________________

6 18

[issue11776] types.MethodType() params and usage is not documented
by anatoly techtonik Feb. 24, 2019

Feb. 24, 2019

New submission from anatoly techtonik <techtonik(a)gmail.com>: types.MethodType(function, instance) is used as a replacement for new.instancemethod(function, instance, class), but this usage is not documented. ---------- assignee: docs@python components: Documentation messages: 133089 nosy: docs@python, techtonik priority: normal severity: normal status: open title: types.MethodType() params and usage is not documented versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11776> _______________________________________

13 31

[issue13456] Providing a custom HTTPResponse class to HTTPConnection
by R. David Murray Feb. 24, 2019

Feb. 24, 2019

New submission from R. David Murray <rdmurray(a)bitdance.com>: The doc string for HTTPConnection.getresponse mentions (in broken English) that the instance's response_class attribute determines what class gets instantiated for a response. The docs do not mention this attribute, nor any other way to control what class is used. Since this attribute already exists and is mentioned in the doc string, can we consider this a doc error and just document it? ---------- assignee: docs@python components: Documentation messages: 148136 nosy: docs@python, orsenthil, r.david.murray priority: normal severity: normal status: open title: Providing a custom HTTPResponse class to HTTPConnection versions: Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13456> _______________________________________

5 5

[issue11352] Buf in cgi module doc
by Pierre Quentel Feb. 24, 2019

Feb. 24, 2019

New submission from Pierre Quentel <pierre.quentel(a)gmail.com>: Hi, I wrote a patch for the cgi module in version 3.2rc1 (#4953). Small changes should be done to the documentation of this module to reflect the changes in the module API : - in section "20.2.2. Using the cgi module" original text : "If a field represents an uploaded file, accessing the value via the value attribute or the getvalue() method reads the entire file in memory as a string. This may not be what you want. You can test for an uploaded file by testing either the filename attribute or the file attribute. You can then read the data at leisure from the file attribute:" proposed new text (for files, value is bytes, not string, and the read() method on file also returns bytes) : "If a field represents an uploaded file, accessing the value via the value attribute or the getvalue() method reads the entire file in memory as bytes. This may not be what you want. You can test for an uploaded file by testing either the filename attribute or the file attribute. You can then read the data at leisure from the file attribute (the read() and readline() methods will return bytes) :" - version 3.2 introduced a parameter "encoding" for the FieldStorage constructor, used to decode the bytes received on the HTTP connection for fields other than files. This encoding must the one defined in the HTML document holding the form submitted to the CGI script ; it is usually defined by a meta tag : <meta http-equiv="Content-type" content="text/html;charset=latin-1"> or by the Content-Type header for this document I'm not sure where this should be mentioned in the module documentation. Maybe in "20.2.9. Common problems and solutions" for the moment. But there are plans (#11066) to introduce another interface to change the encoding of sys.stdout in the CGI script itself, so another option would be to open a specific section about encodings Hope it's clear enough Pierre ---------- assignee: docs@python components: Documentation messages: 129691 nosy: docs@python, quentel priority: normal severity: normal status: open title: Buf in cgi module doc type: behavior versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11352> _______________________________________

14 27

[issue31035] Document order of firing callbacks added with Future.add_done_callback()
by Марк Коренберг Feb. 24, 2019

Feb. 24, 2019

New submission from Марк Коренберг: Please document these two things: * Order of callbacks firing is not specified. (Is it True?) * All callbacks are called *BEFORE* await triggered: ==== f = asyncio.Future() f.add_done_callback(xxx) f.add_done_callback(yyy) try: await f except Exception: ... # all callbacks are called BEFORE entering that place (for example) * How exceptions in callbacks are handled ---------- assignee: docs@python components: Documentation, asyncio messages: 299095 nosy: docs@python, socketpair, yselivanov priority: normal severity: normal status: open title: Document order of firing callbacks added with Future.add_done_callback() type: enhancement versions: Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue31035> _______________________________________

2 1

[issue24310] Idle documentation -- what to do if you do not see an underscore.
by Laura Creighton Feb. 24, 2019

Feb. 24, 2019

New submission from Laura Creighton: On some operating systems, for instance a Macbook Pro with Retina, the bottoms of hanging letters such as 'g' or 'y', as well as underscorces, cannot be seen in IDLE. The fix is to go to Options -> Configure IDLE, and change the size of the default font to 9 or 11. Can we add this line to 25.5.5.2. and 24.6.5.2. ? It is not obvious, especially to the newbie who is trying to write their first python program that the inability to type underscores is a font problem. ---------- assignee: docs@python components: Documentation messages: 244267 nosy: docs@python, lac priority: normal severity: normal status: open title: Idle documentation -- what to do if you do not see an underscore. type: enhancement versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24310> _______________________________________

4 13

[issue21150] Add quick links table to argparse docs
by Raymond Hettinger Feb. 24, 2019

Feb. 24, 2019

New submission from Raymond Hettinger: The argparse module has many functions and options. It would benefit from a summary and quick links table at the top of the page just like we have for the itertools module docs and the builtins module docs. ---------- assignee: docs@python components: Documentation keywords: easy messages: 215468 nosy: docs@python, rhettinger priority: normal severity: normal stage: needs patch status: open title: Add quick links table to argparse docs versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21150> _______________________________________

8 12

[issue28235] In xml.etree.ElementTree docs there is no parser argument in fromstring()
by py.user Feb. 22, 2019

Feb. 22, 2019

New submission from py.user: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.Elem… The function has argument parser that works like in XML() function, but in the description there is no info about it (copied from XML() description). Applied a patch to the issue that adds argument to the signature and describes it. ---------- assignee: docs@python components: Documentation, Library (Lib), XML files: fromstring-parser.diff keywords: patch messages: 277124 nosy: docs@python, py.user priority: normal severity: normal status: open title: In xml.etree.ElementTree docs there is no parser argument in fromstring() type: behavior versions: Python 3.6 Added file: http://bugs.python.org/file44776/fromstring-parser.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28235> _______________________________________

7 12

[issue31982] 8.3. collections — Container datatypes
by Sasha Kacanski Feb. 20, 2019

Feb. 20, 2019

New submission from Sasha Kacanski <skacanski(a)gmail.com>: Hi, In ChainMap example c = ChainMap() # Create root context d = c.new_child() # Create nested child context e = c.new_child() # Child of c, independent from d e.maps[0] # Current context dictionary -- like Python's locals() e.maps[-1] # Root context -- like Python's globals() e.parents # Enclosing context chain -- like Python's nonlocals d['x'] # Get first key in the chain of contexts d['x'] = 1 # Set value in current context d['x'] - will raise key does not exist error so simple fix is to flip last two lines... I know, possibly anal but look love Python and would like to help new folks to not get confused if they play with example in cPython shell... --best ---------- assignee: docs@python components: Documentation messages: 305876 nosy: Sasha Kacanski, docs@python priority: normal severity: normal status: open title: 8.3. collections — Container datatypes versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue31982> _______________________________________

4 8