Mailman 3 March 2019 - docs

[issue33319] `subprocess.run` documentation doesn't tell is using `stdout=PIPE` safe
by Gregory P. Smith March 23, 2019

March 23, 2019

Change by Gregory P. Smith <greg(a)krypto.org>: ---------- keywords: +patch pull_requests: +12459 stage: needs patch -> patch review _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33319> _______________________________________

1 0

[issue36404] Document PendingDeprecationWarning as deprecated
by Inada Naoki March 23, 2019

March 23, 2019

Change by Inada Naoki <songofacandy(a)gmail.com>: ---------- keywords: +patch pull_requests: +12456 stage: -> patch review _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue36404> _______________________________________

1 0

[issue36404] Document PendingDeprecationWarning as deprecated
by Inada Naoki March 23, 2019

March 23, 2019

Change by Inada Naoki <songofacandy(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue36404> _______________________________________

1 0

[issue33319] `subprocess.run` documentation doesn't tell is using `stdout=PIPE` safe
by Martin Panter March 23, 2019

March 23, 2019

Martin Panter <vadmium+py(a)gmail.com> added the comment: This is a regression in the 3.7+ documentation. It previously said “To [capture output], pass PIPE for the ‘stdout’ and/or ‘stderr’ arguments”. This was removed by Bo Bayles in Issue 32102. ---------- keywords: +3.7regression nosy: +bbayles, gregory.p.smith, martin.panter stage: -> needs patch versions: +Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33319> _______________________________________

1 0

[issue27464] Document that SplitResult & friends are namedtuples
by Martin Panter March 23, 2019

March 23, 2019

Martin Panter <vadmium+py(a)gmail.com> added the comment: Suggest merging this with Issue 31822, which seems to have more progress, and where Raymond also seems to be involed. ---------- resolution: -> duplicate stage: needs patch -> resolved status: open -> closed superseder: -> Document that urllib.parse.{Defrag,Split,Parse}Result are namedtuples _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue27464> _______________________________________

1 0

[issue31369] re.RegexFlag is not included in __all__
by Serhiy Storchaka March 22, 2019

March 22, 2019

Serhiy Storchaka <storchaka+cpython(a)gmail.com> added the comment: I concur with David. This is an imlementation detail. No need to prefix it with a _ if the module uses __all__for public names. ---------- nosy: +serhiy.storchaka _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue31369> _______________________________________

1 0

[issue18249] Incorrect and incomplete help docs for close() method
by Dave Angel March 22, 2019

March 22, 2019

New submission from Dave Angel: Python 3.3.0 (default, Mar 7 2013, 00:24:38) [GCC 4.6.3] on linux q = open('/dev/null') help(q.close) the entire output is: ------------------------------- Help on built-in function close: close(...) (END) ------------------------------- But close() is NOT a built-in, it's a method. (In Python 2.7.* the output is: ------------------------------- Help on built-in function close: close(...) close() -> None or (perhaps) an integer. Close the file. Sets data attribute .closed to True. A closed file cannot be used for further I/O operations. close() may be called more than once without error. Some kinds of file objects (for example, opened by popen()) may return an exit status upon closing. (END) ------------------------------- which is only partially wrong. ---------- assignee: docs@python components: Documentation messages: 191382 nosy: DaveA, docs@python priority: normal severity: normal status: open title: Incorrect and incomplete help docs for close() method _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18249> _______________________________________

3 2

[issue31470] Py_Initialize documentation wrong
by Jim Jewett March 21, 2019

March 21, 2019

New submission from Jim Jewett: Per https://docs.python.org/3/c-api/init.html#initializing-and-finalizing-the-i… Py_Initialize() "should be called before using any other Python/C API functions; with the exception of Py_SetProgramName(), Py_SetPythonHome() and Py_SetPath()." (1) I suspect that should be either Py_Initialize() or Py_InitializeEx(). (2) Other functions can also be called first. The ones I notice are: (2a) Py_IsInitialized() wouldn't be useful if you couldn't call it first. (2b) Py_SetStandardStreamEncoding explicitly says it *should* be called before Py_Initialize, if it is called at all. (Probably applies to earlier python versions as well.) ---------- assignee: docs@python components: Documentation messages: 302179 nosy: Jim.Jewett, docs@python priority: normal severity: normal status: open title: Py_Initialize documentation wrong versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue31470> _______________________________________

2 1

[issue31369] re.RegexFlag is not included in __all__
by Cheryl Sabella March 21, 2019

March 21, 2019

Cheryl Sabella <cheryl.sabella(a)gmail.com> added the comment: @ethan.furman, since you had originally added RegexFlag in #28082, do have an opinion on this? Thanks. ---------- nosy: +cheryl.sabella, ethan.furman versions: +Python 3.8 -Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue31369> _______________________________________

1 0

[issue32142] heapq.heappop - documentation misleading or doesn't work
by Scott Queen March 21, 2019

March 21, 2019

New submission from Scott Queen <scooter4j(a)gmail.com>: The documentation for heapq.heappop(heap) says: "Pop and return the smallest item from the heap, maintaining the heap invariant. If the heap is empty, IndexError is raised. To access the smallest item without popping it, use heap[0]." yet, in the following code, the resultant heap doesn't reflect the heap invariant: import heapq li = [5, 7, 9, 1, 4, 3] heapq.heapify(li) #change a couple values in the heap li[3] = 16 li[4] = 2 print (heapq.heappop(li)) print ("The heap after pop is : ",end="") print (list(li)) This prints: The heap after pop is : [3, 4, 9, 16, 2] The documentation implies to me that heapify would be called internally after heappop, but I may be misreading. Perhaps heappop could say that the heap invariant is maintained if the heap is properly sorted before the heappop invocation. ---------- assignee: docs@python components: Documentation messages: 307006 nosy: docs@python, scooter4j priority: normal severity: normal status: open title: heapq.heappop - documentation misleading or doesn't work type: behavior versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32142> _______________________________________

6 8