docs July 2020

docs@python.org

10 participants
138 discussions

by wyz23x2

New submission from wyz23x2 <wyz23x2(a)163.com>: When typing this in shell: >>> import lib2to3 >>> help(lib2to3) The output contains this link: --snip-- MODULE REFERENCE https://docs.python.org/3.8/library/lib2to3 <-- The following documentation is automatically generated from the Python --snip-- But when you access it, 404! This works: https://docs.python.org/3.8/library/2to3.html#module-lib2to3 Please change it. Thanks! ---------- assignee: docs@python components: 2to3 (2.x to 3.x conversion tool), Documentation, Library (Lib) messages: 364917 nosy: docs@python, wyz23x2 priority: normal severity: normal status: open title: Dead link in help(lib2to3) type: performance versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40051> _______________________________________

16 hours, 56 minutes

[issue41411] Improve and consolidate f-strings docs

by Ezio Melotti

New submission from Ezio Melotti <ezio.melotti(a)gmail.com>: [Creating a new issue from #41045] I was just just trying to link to someone the documentation for f-strings, but: 1) Searching "fstring" only returns two results about xdrlib[0]; 2) Searching "f-string" returns many unrelated results[1]; 3) The first (and closer) result (string -- Common string operations[2]) yields nothing while using ctrl+f with fstring, f-string, f', f"; 4) at the top of that page there are two links in a "see also": * Text Sequence Type — str[3]: it mentions raw strings at the beginning, but also yields no results for fstring, f-string, f', f"; * String Methods[4]: that is another section of the previous page (so ctrl+f doesn't find anything), but has a link to "Format String Syntax"[5]; 5) The "Format String Syntax" page[5] has another link in the middle of a paragraph that points to "formatted string literals", that eventually brings us to the right page[6]; 6) the "right page"[6] has a wall of text with a block of code containing the grammar, luckily followed by a few examples. I think we should: 1) add index entries for "f-string" and "fstring" in the relevant sections of the docs, so that they appear in the search result; 2) in the Text Sequence Type — str[3] section, have a bullet list for f-strings, raw-strings, and possibly u-strings; 3) possibly use the term "f-string" in addition (or instead) of "formatted string literal", to make the pages more ctrl+f-friendly throughout the docs; 4) possibly have another more newbie-friendly section on f-string (compared to the lexical analysis page) in the tutorial, in the stdtypes page[7] (e.g. before the printf-style String Formatting" section[8]), or in the string page[2] (e.g. after the "Format String Syntax" section[10]); 5) possibly reorganize and consolidate the different sections about strings, string methods, str.format(), the format mini-language, f-strings, raw/unicode-strings, %-style formatting in a single page or two (a page for the docs and one for the grammar), since it seems to me that over the years these sections got a bit scattered around as they were being added. [0]: https://docs.python.org/3/search.html?q=fstring [1]: https://docs.python.org/3/search.html?q=f-string [2]: https://docs.python.org/3/library/string.html [3]: https://docs.python.org/3/library/stdtypes.html#textseq [4]: https://docs.python.org/3/library/stdtypes.html#string-methods [5]: https://docs.python.org/3/library/string.html#formatstrings [6]: https://docs.python.org/3/reference/lexical_analysis.html#f-strings [7]: https://docs.python.org/3/library/stdtypes.html [8]: https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatt… ---------- assignee: docs@python components: Documentation messages: 374398 nosy: docs@python, eric.smith, ezio.melotti priority: normal severity: normal stage: needs patch status: open title: Improve and consolidate f-strings docs type: enhancement versions: Python 3.10, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41411> _______________________________________

2 days, 3 hours

[issue41450] OSError is not documented in ssl library, but still can be thrown

by Alexander Sibiryakov

New submission from Alexander Sibiryakov <sixty-one(a)yandex.ru>: See stack trace [07/15/2020 08:51:14.799: ERROR/kafka.producer.sender] Uncaught error in kafka producer I/O thread Traceback (most recent call last): File "/usr/local/lib/python3.6/site-packages/kafka/producer/sender.py", line 60, in run self.run_once() File "/usr/local/lib/python3.6/site-packages/kafka/producer/sender.py", line 160, in run_once self._client.poll(timeout_ms=poll_timeout_ms) File "/usr/local/lib/python3.6/site-packages/kafka/client_async.py", line 580, in poll self._maybe_connect(node_id) File "/usr/local/lib/python3.6/site-packages/kafka/client_async.py", line 390, in _maybe_connect conn.connect() File "/usr/local/lib/python3.6/site-packages/kafka/conn.py", line 426, in connect if self._try_handshake(): File "/usr/local/lib/python3.6/site-packages/kafka/conn.py", line 505, in _try_handshake self._sock.do_handshake() File "/usr/local/lib/python3.6/ssl.py", line 1077, in do_handshake self._sslobj.do_handshake() File "/usr/local/lib/python3.6/ssl.py", line 689, in do_handshake self._sslobj.do_handshake() OSError: [Errno 0] Error See docs https://docs.python.org/3.8/library/ssl.html and see source code: https://github.com/python/cpython/blob/3.8/Modules/_ssl.c Probably the best would be to proceed with using SSLError, but short term OSError could be documented. ---------- assignee: docs@python components: Documentation messages: 374644 nosy: docs@python, sibiryakov priority: normal severity: normal status: open title: OSError is not documented in ssl library, but still can be thrown type: behavior versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41450> _______________________________________

2 days, 6 hours

[issue41259] Find adverbs is not correct

by Rim Chatti

New submission from Rim Chatti <chattiriim(a)gmail.com>: re.findall(r"\w+ly", text) does not find all adverbs in a sentence, it finds words that contain ly (not ending with ly) : if text= 'andlying clearly', output: [andly, clearly] which is wrong! the right way to do this is re.findall(r'\b(\w+ly)\b',text) output= clearly! ---------- assignee: docs@python components: Documentation messages: 373406 nosy: Rim Chatti, docs@python priority: normal severity: normal status: open title: Find adverbs is not correct versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41259> _______________________________________

3 days, 23 hours

[issue41449] An article on Python 3 stdout and stderr output buffering

by Anatoli Babenia

New submission from Anatoli Babenia <anatoli(a)rainforce.org>: It is hard to find info why Python 3 buffers stdout/stderr. The buffering causes problems when debugging Python apps in Docker and Kubernetes, and it is unclear if it is Python 3 who starts to buffer stdout if no tty is attached, it is Docker, or it is Kubernetes. The only bit of info that could be searched is the description of -u option https://docs.python.org/3.8/using/cmdline.html?#cmdoption-u which is not linked to any article. The `-u` description also says. > Changed in version 3.7: The text layer of the stdout and stderr streams now is unbuffered. However, I don't understand what is the text layers of stdout. And there is no description of behaviour when the output is not attached, and when the output is redirected. ---------- assignee: docs@python components: Documentation messages: 374633 nosy: Anatoli Babenia, docs@python priority: normal severity: normal status: open title: An article on Python 3 stdout and stderr output buffering _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41449> _______________________________________

4 days, 13 hours

[issue40204] Docs build error with Sphinx 3.0 due to invalid C declaration

by Karthikeyan Singaravelan

New submission from Karthikeyan Singaravelan <tir.karthi(a)gmail.com>: The following error is caused in Docs build for a 3.8 backport since sphinx is ran with warnings. Sphinx released 3.0 on April 6. The last successful build on master uses Sphinx 2.2.0 [0]. My guess is sphinx new version possibly breaking the build on Python 3.8 where it's not pinned to use 2.2.0 pulling the latest version. The changelog for Sphinx has below note : https://www.sphinx-doc.org/en/master/changes.html#release-3-0-0-released-ap… The C domain has been rewritten, with additional directives and roles. The existing ones are now more strict, resulting in new warnings. Python 3.8 and Python 3.7 doesn't have Sphinx pinned to 2.2.0 while master does. Python 3.8 Docs makefile : https://github.com/python/cpython/blob/f7b0259d0d243a71d79a3fda9ec7aad43065… Failed build : https://github.com/python/cpython/pull/19388/checks?check_run_id=563053793#… Error : Warning, treated as error: /home/runner/work/cpython/cpython/Doc/c-api/buffer.rst:92:Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*buf -----^ Makefile:49: recipe for target 'build' failed make[1]: *** [build] Error 2 [0] https://github.com/python/cpython/runs/564123625#step:6:24 ---------- assignee: docs@python components: Documentation messages: 365858 nosy: docs@python, eric.araujo, ezio.melotti, mdk, rhettinger, vstinner, willingc, xtreak priority: normal severity: normal status: open title: Docs build error with Sphinx 3.0 due to invalid C declaration type: behavior versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40204> _______________________________________

4 days, 15 hours

[issue41425] [tkinter] "Coupling Widget Variables" example missing code

by Brett Cannon

New submission from Brett Cannon <brett(a)python.org>: The example for https://docs.python.org/3.8/library/tkinter.html#coupling-widget-variables is missing: 1. Imports 2. Code to launch the example ---------- assignee: docs@python components: Documentation keywords: easy messages: 374522 nosy: brett.cannon, docs@python priority: normal severity: normal status: open title: [tkinter] "Coupling Widget Variables" example missing code versions: Python 3.10, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41425> _______________________________________

5 days, 3 hours

[issue41424] [tkinter] Grammatical error in "Packer" docs

by Brett Cannon

New submission from Brett Cannon <brett(a)python.org>: "Geometry managers are used to specify the relative positioning of the positioning of widgets within their container". Remove "of the positioning". ---------- assignee: docs@python components: Documentation keywords: newcomer friendly messages: 374520 nosy: brett.cannon, docs@python priority: normal severity: normal status: open title: [tkinter] Grammatical error in "Packer" docs versions: Python 3.10, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41424> _______________________________________

5 days, 4 hours

[issue40978] Document that typing.SupportsXXX protocols are runtime checkable

by ramalho

New submission from ramalho <luciano(a)ramalho.org>: The typing module documentation (https://docs.python.org/3/library/typing.html#typing.SupportsInt) does not mention that the protocols listed below are all decorated with `@runtime_checkable`. This should mentioned in the entry for each protocol and also in the entry for `@runtime_checkable` * SupportsAbs * SupportsBytes * SupportsComplex * SupportsFloat * SupportsIndex * SupportsInt * SupportsRound ---------- assignee: docs@python components: Documentation messages: 371513 nosy: docs@python, ramalho priority: normal severity: normal status: open title: Document that typing.SupportsXXX protocols are runtime checkable versions: Python 3.10, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40978> _______________________________________

5 days, 7 hours

[issue40979] typing module docs: keep text, add subsections

by ramalho

New submission from ramalho <luciano(a)ramalho.org>: The typing module documentation page has a very long section "Classes, functions, and decorators" (https://docs.python.org/3/library/typing.html#classes-functions-and-decorat…) that should be split in subsections. The ordering of the entries seems haphazard: it's not alphabetical. Its grouped according to invisible categories. The categories appear as comments in the source code of typing.py: the `__all__` global lists the API split into categories (see below). We should add these categories to the page as subsections of "Classes, functions, and decorators" - Super-special typing primitives. - ABCs (from collections.abc). - Structural checks, a.k.a. protocols. - Concrete collection types. ---------- assignee: docs@python components: Documentation messages: 371514 nosy: docs@python, ramalho priority: normal severity: normal status: open title: typing module docs: keep text, add subsections versions: Python 3.10, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40979> _______________________________________

5 days, 9 hours

Jump to page:

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

docs July 2020