Mailman 3 January 2020 - docs

[issue39364] Automatically tabulate module contents in the docs
by alex c Jan. 17, 2020

Jan. 17, 2020

New submission from alex c <alexchandel(a)gmail.com>: By default, the docs.python.org page for a module does not list or tabulate the contents of that module. This makes it difficult to browse a module's functions or get a bird's-eye view. For example, the logging module (https://docs.python.org/3/library/logging.html) has almost 70 functions, methods, and attributes. But it's impossible to scan them without scrolling the entire length of the entry (~18 pages of US letter). Compare to the browsability of itertools (https://docs.python.org/3/library/itertools.html), which manually tabulates its functions in the first section. docs.python.org should automatically generate a TOC of the module's contents (classes, functions, etc) in the navigation sidebar, below the existing sidebar sections (perhaps in a collapsible section). Rust's documentation does this (example: https://doc.rust-lang.org/std/time/struct.Duration.html), and doc.rust-lang.org also effectively allows the entire page to function as a TOC by providing a "collapse page" button. ---------- assignee: docs@python components: Documentation messages: 360148 nosy: alexchandel, docs@python priority: normal severity: normal status: open title: Automatically tabulate module contents in the docs type: enhancement versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39364> _______________________________________

2 1

Bug Report: Python C library not compatible with C++2020
by Tang Tien Wei Keith Jan. 16, 2020

Jan. 16, 2020

The Python library will not compile with a C++2020 compiler because the code uses the reserved "module" keyword For example, in warnings.h, we have the following code: #ifndef Py_LIMITED_API PyAPI_FUNC(int) PyErr_WarnExplicitObject( PyObject *category, PyObject *message, PyObject *filename, int lineno, PyObject *module, PyObject *registry); In modsupport.h we have the following code: PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def); We can fix this by using a different identifier, for example "pyModule" instead of "module" This e-mail and any attachments are only for the use of the intended recipient and may contain material that is confidential, privileged and/or protected by the Official Secrets Act. If you are not the intended recipient, please delete it or notify the sender immediately. Please do not copy or use it for any purpose or disclose the contents to any other person.

2 2

[issue39348] wrong rst syntax in socket.rst
by Oz Tiram Jan. 15, 2020

Jan. 15, 2020

New submission from Oz Tiram <nahumoz(a)gmail.com>: The code block for the isn't hightlighted: Changed in version 3.7: When SOCK_NONBLOCK or SOCK_CLOEXEC bit flags are applied to type they are cleared, and socket.type will not reflect them. They are still passed to the underlying system socket() call. Therefore:: sock = socket.socket( ... This is because the double colon is directly after the word Therefore. This fix is very simple: :attr:`socket.type` will not reflect them. They are still passed - to the underlying system `socket()` call. Therefore:: + to the underlying system `socket()` call. Therefore, + + :: sock = socket.socket( socket.AF_INET, ... I have prepared a PR for this. ---------- assignee: docs@python components: Documentation messages: 360086 nosy: Oz.Tiram, docs@python priority: normal severity: normal status: open title: wrong rst syntax in socket.rst versions: Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39348> _______________________________________

3 8

Windows HTML Help (.chm) file
by Ray Leiter Jan. 15, 2020

Jan. 15, 2020

At URL: https://www.python.org/downloads/windows/ I find: Python Releases for Windows § Latest Python 3 Release - Python 3.8.1 § Latest Python 2 Release - Python 2.7.17 Stable Releases § Python 3.8.1 - Dec. 18, 2019 Note that Python 3.8.1 cannot be used on Windows XP or earlier. § Download Windows help file When I click on the link to download Windows help file, it downloads and then when I double-click it to open it, I get this: Any thoughts on why? (I’m using MS Windows 7 Pro, SP 1) Thank you; Ray Leiter

3 3

[issue39222] unittest.mock.Mock.parent is broken or undocumented
by Florian Brucker Jan. 15, 2020

Jan. 15, 2020

New submission from Florian Brucker <python-bugs(a)florianbrucker.de>: The "parent" attribute of unittest.mock.Mock is either broken or undocumented. For example, on Python 3.7.4: >>> from unittest.mock import Mock >>> m = Mock(x=1, parent=2) >>> m.x 1 >>> m.parent Traceback (most recent call last): File "<stdin>", line 1, in <module> File "/usr/local/lib/python3.7/unittest/mock.py", line 659, in __repr__ name = self._extract_mock_name() File "/usr/local/lib/python3.7/unittest/mock.py", line 638, in _extract_mock_name _name_list.append(_parent._mock_new_name + dot) AttributeError: 'int' object has no attribute '_mock_new_name' >>> parent = Mock() >>> child = Mock(parent=parent) >>> child.parent is parent False I stumbled upon this while trying to mock an object that has a "parent" attribute. >From the documentation I understand that mocks have built-in parents. However, the documentation never mentions the "parent" attribute specifically, so I always assumed that the built-in parent-child relationship was handled using private or name-mangled attributes. And since the "parent" attribute is not mentioned in the docs, I assumed I could set it by passing an additional kwarg to Mock. I would have expected one of the following, in order of personal preference: a) That a private or name-mangled attribute is used for the built-in parent-child relationship, so that I can mock objects which themselves have a "parent" attribute b) That the special meaning of the "parent" attribute is documented, and that trying to set it directly (via the constructor or via attribute assignment, and without going through attach_mock) triggers a warning. ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 359348 nosy: docs@python, florian.brucker priority: normal severity: normal status: open title: unittest.mock.Mock.parent is broken or undocumented type: behavior versions: Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39222> _______________________________________

4 7

[issue39037] Look up __enter__ before __exit__ in the with statement documentation
by Géry Jan. 14, 2020

Jan. 14, 2020

Change by Géry <gery.ogam(a)gmail.com>: ---------- title: Fix the trial order of the __exit__ and __enter__ methods in the with statement documentation -> Look up __enter__ before __exit__ in the with statement documentation _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39037> _______________________________________

1 0

Small broken link on the docs.python.org page
by Nicholas Chen Jan. 13, 2020

Jan. 13, 2020

Hey Python team! I’m noticing a broken link on the docs.python.org <http://docs.python.org/> page. The bottom of the page, regarding Sphinx, is broken: Clicking that Sphinx link leads to a 404 error. I believe the link should be updated to: https://pypi.org/project/Sphinx/ <https://pypi.org/project/Sphinx/> as referenced here: https://github.com/python/cpython/tree/master/Doc <https://github.com/python/cpython/tree/master/Doc> Thanks, Nick

2 2

Anyone out there?
by Ray Leiter Jan. 13, 2020

Jan. 13, 2020

Hello, does anyone actually read emails sent to this address?

2 2

[issue16575] ctypes: unions as arguments
by Vinay Sajip Jan. 12, 2020

Jan. 12, 2020

Vinay Sajip <vinay_sajip(a)yahoo.co.uk> added the comment: New changeset 9dbf5d3bc2033940cdca35440cf08814544f81e4 by Vinay Sajip in branch '3.7': [3.7] bpo-16575: Disabled checks for union types being passed by value. (GH-17960) (GH-17970) https://github.com/python/cpython/commit/9dbf5d3bc2033940cdca35440cf0881454… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue16575> _______________________________________

1 0

[issue3530] ast.NodeTransformer doc bug
by miss-islington Jan. 12, 2020

Jan. 12, 2020

miss-islington <mariatta.wijaya+miss-islington(a)gmail.com> added the comment: New changeset ef0af30e507a29dae03aae40459b9c44c96f260d by Miss Islington (bot) in branch '3.8': bpo-3530: Add advice on when to correctly use fix_missing_locations in the AST docs (GH-17172) https://github.com/python/cpython/commit/ef0af30e507a29dae03aae40459b9c44c9… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue3530> _______________________________________

1 0