Mailman 3 June 2018 - docs

[issue22374] Replace contextmanager example and improve explanation
by Terry J. Reedy July 26, 2018

July 26, 2018

New submission from Terry J. Reedy: https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager The current html contextmanager example is 'not recommended' for actual use, because there are better ways to accomplish the same goal. To me, is also unsatifactory in that the context management is only metaphorical (conceptual) and not actual. I propose the following as a replacement. It actually manages context and is, I believe, both useful and currently* the best way to accomplish the goal of temporarily monkeypatching a module, It was directly inspired by #20752, see msg226657, though there have been other issues where monkeypatching as a solution has been discussed. --- from contextlib import contextmanager import itertools as its @contextmanager def mp(ob, attr, new): old = getattr(ob, attr) setattr(ob, attr, new) yield setattr(ob, attr, old) def f(): pass print(its.count, its.cycle) with mp(its, 'count', f), mp(its, 'cycle', f): print(its.count, its.cycle) print(its.count, its.cycle) # <class 'itertools.count'> # <function f at 0x00000000035A91E0> # <class 'itertools.count'> --- I am aware that the above does not follow the current style, which I dislike, of confusingly mixing together batch file code and interactive input code. I think the above is how the example should be written. It would work even better if Sphinx gave comment lines a different background color. (A '##' prefix could be used to differentiate code comments from commented-out output lines.) In the same section, I find the following paragraph a bit confusing (perhaps is tries to say too much): "contextmanager() uses ContextDecorator so the context managers it creates can be used as decorators as well as in with statements. When used as a decorator, a new generator instance is implicitly created on each function call (this allows the otherwise “one-shot” context managers created by contextmanager() to meet the requirement that context managers support multiple invocations in order to be used as decorators)." I am guessing that this means, among other things, that ContextDecorator is necessary and sufficient to use mp twice in one with statement. I intentionally added the double use to the example to make this possibility clear. * The only better way I know of would be if mp (spelled out as 'monkeypatch' were considered useful enough to be added to contextlib. ---------- assignee: docs@python components: Documentation messages: 226661 nosy: docs@python, ncoghlan, terry.reedy priority: normal severity: normal status: open title: Replace contextmanager example and improve explanation versions: Python 2.7, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22374> _______________________________________

5 5

[issue33121] recv returning 0 on closed connection not documented
by joders July 25, 2018

July 25, 2018

New submission from joders <jona.enders(a)yahoo.com>: The "Linux Programmer's Manual" states: When a stream socket peer has performed an orderly shutdown, the return value will be 0 (the traditional "end-of-file" return). I find that information pretty important which is why I am asking if you might want to add it to the python documentation as well. It would have prevented a bug in my code. ---------- assignee: docs@python components: Documentation messages: 314260 nosy: docs@python, joders priority: normal severity: normal status: open title: recv returning 0 on closed connection not documented type: enhancement versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33121> _______________________________________

3 2

[issue28677] difficult to parse sentence structure in "When an instance attribute is referenced that isn't a data attribute"
by Viorel Tabara July 25, 2018

July 25, 2018

New submission from Viorel Tabara: Method objects are explained at: https://docs.python.org/3/tutorial/classes.html#method-objects I'd like to suggest a change from: When an instance attribute is referenced that isn’t a data attribute, its class is searched. to something along this line: When an instance attribute --- that isn’t a data attribute --- is referenced, the instance parent class will be searched. ---------- assignee: docs@python components: Documentation messages: 280671 nosy: docs@python, viorel priority: normal severity: normal status: open title: difficult to parse sentence structure in "When an instance attribute is referenced that isn't a data attribute" type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28677> _______________________________________

8 14

[issue33028] tempfile.TemporaryDirectory incorrectly documented
by Richard Neumann July 25, 2018

July 25, 2018

New submission from Richard Neumann <r.neumann(a)homeinfo.de>: The tempfile.TemporaryDirectory is incorrectly documented at https://docs.python.org/3.6/library/tempfile.html#tempfile.TemporaryDirecto…. It is described as a function, though actually being a class (unlinke tempfile.NamedTemporaryFile). The respective property "name" and method "cleanup" are only documented in the continuous text but not explicitely highlighted as the properties and method of e.g. TarFile (https://docs.python.org/3/library/tarfile.html#tarfile-objects). ---------- assignee: docs@python components: Documentation messages: 313431 nosy: Richard Neumann, docs@python priority: normal severity: normal status: open title: tempfile.TemporaryDirectory incorrectly documented type: enhancement versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33028> _______________________________________

3 3

[issue33869] doc Add set, frozen set, and tuple entries to Glossary
by Andrés Delfino July 19, 2018

July 19, 2018

New submission from Andrés Delfino <adelfino(a)gmail.com>: PR adds entries for these three terms and a link to the list definition. ---------- assignee: docs@python components: Documentation messages: 319619 nosy: adelfino, docs@python priority: normal severity: normal status: open title: doc Add set, frozen set, and tuple entries to Glossary type: enhancement versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33869> _______________________________________

4 8

[issue33859] Spelling mistakes found using aspell
by Karthikeyan Singaravelan July 13, 2018

July 13, 2018

New submission from Karthikeyan Singaravelan <tir.karthi(a)gmail.com>: I have found some typos in docs folder using aspell. I have fixed them. The changes are as below : Doc/library/codecs.rst - cypher - cipher Doc/library/email.rst - Protcol - Protocol Doc/library/importlib.rst - abstact - abstract Doc/library/xmlrpc.client.rst - unmarsalling - unmarshalling Doc/license.rst - aheared to - adhered to Doc/using/cmdline.rst - descibed - described Doc/whatsnew/3.3.rst - accumlated - accumulated Doc/whatsnew/3.6.rst - Lollilop - Lollipop Doc/whatsnew/3.7.rst - direcory - directory Find typos - find . -iname '*rst' | xargs -I{} sh -c "aspell --master=en_US --extra-dicts=en_GB --ignore 3 list < {}" | sort | uniq > typos.txt Ignore case tr '[:upper:]' '[:lower:]' < typos.txt | sort | uniq | less This requires manually looking at output of less and then making changes. ---------- assignee: docs@python components: Documentation messages: 319510 nosy: docs@python, xtreak priority: normal severity: normal status: open title: Spelling mistakes found using aspell type: enhancement versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33859> _______________________________________

4 9

can python be used by a commercial company on their servers?
by Edger, Lisa A July 10, 2018

July 10, 2018

Please let me know. I can find a way to contact anyone on this?? Lisa Edger, CSAM Certified Software Asset Manager License Management & Software Compliance Corning Incorporated SP-ZV-01-F3L 21 Lynn Morse Dr. Painted Post, NY 14870 t (607)974-9114 m (607)684-8190 edgerla(a)corning.com<mailto:briggsaa@corning.com> Reach Software Management on Blue Line<https://www.yammer.com/corning.com/#/threads/inGroup?type=in_group&feedId=1…>

2 1

configparser example typo
by Weihe Chen July 10, 2018

July 10, 2018

To whom it may concern, In the page https://docs.python.org/3/library/configparser.html, under 14.2.1 Quick Start, example 2 with code: >>> import configparser>>> config = configparser.ConfigParser()>>> config['DEFAULT'] = {'ServerAliveInterval': '45',... 'Compression': 'yes',... 'CompressionLevel': '9'}>>> config['bitbucket.org'] = {}>>> config['bitbucket.org']['User'] = 'hg'>>> config['topsecret.server.com'] = {}>>> topsecret = config['topsecret.server.com']>>> topsecret['Port'] = '50022' # mutates the parser>>> topsecret['ForwardX11'] = 'no' # same here>>> config['DEFAULT']['ForwardX11'] = 'yes'>>> with open('example.ini', 'w') as configfile:... config.write(configfile)... Shouldn't the last line be configfile.write(config) ? Weihe

2 1

[issue24459] Mention PYTHONFAULTHANDLER in the man page
by Antony Lee July 9, 2018

July 9, 2018

New submission from Antony Lee: The man page doesn't mention PYTHONFAULTHANDER in the list of environment variables (I haven't thoroughly checked that everyone else is there, either). I would also suggest reordering the environment variables in alphabetical order. ---------- assignee: docs@python components: Documentation messages: 245422 nosy: Antony.Lee, docs@python priority: normal severity: normal status: open title: Mention PYTHONFAULTHANDLER in the man page versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24459> _______________________________________

8 33

[issue33888] Use CPython instead of Python when talking about implementation details
by Andrés Delfino July 8, 2018

July 8, 2018

New submission from Andrés Delfino <adelfino(a)gmail.com>: The FAQ talks about list and dictionary implementation details using "Python". I believe this should be changed to CPython. ---------- assignee: docs@python components: Documentation messages: 319825 nosy: adelfino, docs@python priority: normal severity: normal status: open title: Use CPython instead of Python when talking about implementation details versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33888> _______________________________________

4 10