Mailman 3 May 2020 - docs

[issue11425] Cleanup sample codes in tutorial.
by INADA Naoki 14 May '20

14 May '20

New submission from INADA Naoki <songofacandy(a)gmail.com>: * Insert spaces around operators and after commas. * Split one liner blocks (ex. def foo(x, y): return x + y) to multi-line blocks. * Insert empty line after def block for scripts (not interactive mode). * Use new-style raise (s/ralse KeyboardInterrupt/raise KeyboardInterrupt()/) * Use x ** 3 instead of x * x * x. Attached patch is for Python 2.6. I'll make same changes for Python 3.1 if this patch is accepted. ---------- assignee: docs@python components: Documentation files: cleanup_tutorial_codes.patch keywords: patch messages: 130225 nosy: docs@python, naoki priority: normal severity: normal status: open title: Cleanup sample codes in tutorial. versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3 Added file: http://bugs.python.org/file21027/cleanup_tutorial_codes.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11425> _______________________________________

5 5

Not too sure of this doc typo
by Maziar Shahabi 13 May '20

13 May '20

Hello, I am not sure but I this the polarity of the flag defined in the documentation for popitem() is reversed. I have just started learning Python.Regards,M.Shahabi

2 1

python question from Blaise Carrington, a Cameroonian living in Equatorial Guinea.
by Oliver Carrington 12 May '20

12 May '20

Good day, sorry for any inconveniences. I wish to get an explanation concerning the first code in section 4.4 of the python manual... 4.4 break and continue statements, and else clauses in loops... according to my understanding of the code, I figured the break applies to values that go thru the if function, so I was wondering, for the number 5 o 7, they should always fail the condition of the if function and hence always break, how do the eventually get to the else part? pleasw a response will do a lot to my tiny brain... thank you.

2 3

[issue40589] Missing path-like versionchanged in shutil.rmtree
by Ville Skyttä 12 May '20

12 May '20

New submission from Ville Skyttä <ville.skytta(a)iki.fi>: shutil.rmtree takes a path-like object starting from 3.6 (due to internal use of os.lstat which does that too). ---------- assignee: docs@python components: Documentation messages: 368613 nosy: docs@python, scop priority: normal severity: normal status: open title: Missing path-like versionchanged in shutil.rmtree _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40589> _______________________________________

2 2

Tutorial Chapter 6, item 6.2 - Standard Modules
by Edilson Vieira 11 May '20

11 May '20

Trying to see the variables "sys.ps1" and "sys.ps2" raise an error: *>>> import sys>>> sys.ps1Traceback (most recent call last): File "<pyshell#73>", line 1, in <module> sys.ps1AttributeError: module 'sys' has no attribute 'ps1'* https://docs.python.org/3/tutorial/modules.html Att., -- Edilson Vieira +55 21 99245-4633

3 2

[issue40588] Creating Virtual Environments Does Not Work (Not Creating Folder)
by Shengjun Zhu 11 May '20

11 May '20

New submission from Shengjun Zhu <zhushengjun1(a)gmail.com>: I followed the instructions, run "python3 -m venv tutorial-env" , but the command doesn't create any directory. https://docs.python.org/3.8/tutorial/venv.html I followed the instructions in the post below to remove the "Application Execution Aliases" for python.exe and python3.exe. That got rid of the exe files in WindowsApps. However, now when I type where python3 in CMD, I get: INFO: Could not find files for the given pattern(s). https://superuser.com/questions/1437590/typing-python-on-windows-10-version… I changed python3 in the command to python, it worked. python -m venv tutorial-env I think in version python3.8, instead python3 , we should use python, right? ---------- assignee: docs@python components: Documentation messages: 368610 nosy: Shengjun Zhu, docs@python priority: normal severity: normal status: open title: Creating Virtual Environments Does Not Work (Not Creating Folder) versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40588> _______________________________________

1 0

[issue23677] Mention dict and set comps in library reference
by Frank Millman 10 May '20

10 May '20

New submission from Frank Millman: This is from the documentation at Section 4.6.4. Lists """ Lists may be constructed in several ways: Using a pair of square brackets to denote the empty list: [] Using square brackets, separating items with commas: [a], [a, b, c] Using a list comprehension: [x for x in iterable] Using the type constructor: list() or list(iterable) """ Comprehensions are mentioned as a constructor. This is from the documentation at Section 4.10. Mapping Types """ Dictionaries can be created by placing a comma-separated list of key: value pairs within braces, for example: {'jack': 4098, 'sjoerd': 4127} or {4098: 'jack', 4127: 'sjoerd'}, or by the dict constructor. class dict(**kwarg) class dict(mapping, **kwarg) class dict(iterable, **kwarg) Return a new dictionary initialized from an optional positional argument and a possibly empty set of keyword arguments. """ There is no mention of dictionary comprehensions. For consistency, I believe that the documentation for Dicts and Sets should mention comprehensions. ---------- assignee: docs@python components: Documentation messages: 238186 nosy: FrankMillman, docs@python priority: normal severity: normal status: open title: Mention dict and set comps in library reference versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23677> _______________________________________

8 11

[issue1944] Document PyUnicode_* API
by STINNER Victor 10 May '20

10 May '20

STINNER Victor <vstinner(a)python.org> added the comment: """ Following functions likely should be wrapped with "#ifndef Py_LIMITED_API": _PyUnicode_ClearStaticStrings _PyUnicode_EQ _PyUnicode_FromId """ It's already the case since at least Python 3.7. Extract of Python 3.7 Include/unicodeobject.h: #ifndef Py_LIMITED_API /* Return an interned Unicode object for an Identifier; may fail if there is no memory.*/ PyAPI_FUNC(PyObject*) _PyUnicode_FromId(_Py_Identifier*); /* Clear all static strings. */ PyAPI_FUNC(void) _PyUnicode_ClearStaticStrings(void); /* Fast equality check when the inputs are known to be exact unicode types and where the hash values are equal (i.e. a very probable match) */ PyAPI_FUNC(int) _PyUnicode_EQ(PyObject *, PyObject *); #endif /* !Py_LIMITED_API */ ---------- nosy: +vstinner _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue1944> _______________________________________

1 0

[issue26817] Docs for StringIO should link to io.BytesIO
by Thomas Guettler 10 May '20

10 May '20

New submission from Thomas Guettler: I think a warning at the top of StringIO docs is needed. And it should link to io.BytesIO. Maybe even deprecate StringIO and cStringIO in Python2? StringIO docs: https://docs.python.org/2/library/stringio.html io.BytesIO docs: https://docs.python.org/2/library/io.html#io.BytesIO I would like to see this at the top of StringIO: {{{ Please use io.BytesIO and io.StringIO since this module is not supported in Python3 }} ---------- assignee: docs@python components: Documentation messages: 263917 nosy: docs@python, guettli priority: normal severity: normal status: open title: Docs for StringIO should link to io.BytesIO versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26817> _______________________________________

3 2

[issue40576] Align docs for list.sort, sorted, and on the website
by Sam Lijin 09 May '20

09 May '20

New submission from Sam Lijin <python(a)sxlijin.com>: It's mildly confusing to see `pydoc sorted` and `pydoc list.sort` to look so different, esp. since sorted just delegates to list.sort. By extension, https://docs.python.org/3/library/functions.html#sorted should also be aligned with this, but I'm not super familiar with what the distinction content in the docstrings and the website is intended to be, if there is any guiding philosophy there. sorted() appears to have been documented as an afterthought as part of this commit: https://github.com/python/cpython/commit/f9e227e5a9d7a74393ef259c861660c3d1… list.sort was last updated in 2018 by https://github.com/python/cpython/pull/8516 I have an incoming PR for this. ---------- assignee: docs@python components: Documentation messages: 368508 nosy: docs@python, sxlijin priority: normal severity: normal status: open title: Align docs for list.sort, sorted, and on the website type: enhancement versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40576> _______________________________________

3 5