Mailman 3 November 2017 - docs

[issue32017] profile.Profile() has no method enable()
by Antoine Pitrou 25 Feb '18

25 Feb '18

New submission from Antoine Pitrou <pitrou(a)free.fr>: The section here is wrong as it claims that API is common to profile and cProfile. https://docs.python.org/3/library/profile.html#module-cProfile ---------- assignee: docs@python components: Documentation messages: 306169 nosy: docs@python, eric.araujo, ezio.melotti, pitrou, willingc priority: normal severity: normal status: open title: profile.Profile() has no method enable() type: behavior versions: Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32017> _______________________________________

3 5

[issue17232] Improve -O docs
by Maciej Fijalkowski 24 Feb '18

24 Feb '18

New submission from Maciej Fijalkowski: This is what the current documentation says: -O Turn on basic optimizations. This changes the filename extension for compiled (bytecode) files from .pyc to .pyo. See also PYTHONOPTIMIZE. -OO Discard docstrings in addition to the -O optimizations. As far as I know, the only "optimization" that's done is removal of __debug__ sections and assert statements and has been like this for years. Maybe it should say so "-O does not do any optimizations, only removes assert statement" or so. ---------- assignee: docs@python components: Documentation messages: 182365 nosy: docs@python, fijall priority: normal severity: normal status: open title: Improve -O docs type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17232> _______________________________________

15 33

[issue32087] deprecated-removed directive generates overlapping msgids in .pot files
by KINEBUCHI Tomohiko 23 Feb '18

23 Feb '18

New submission from KINEBUCHI Tomohiko <cocoatomo77(a)gmail.com>: When gettext builder is invoked, deprecated-removed directive which is defined in Doc/tools/extensions/pyspecific.py generates overlapping msgids in .pot files. For example, the following .rst source (taken from Doc/library/dmb.rst L354):: .. deprecated-removed:: 3.6 3.8 Creating database in ``'r'`` and ``'w'`` modes. Modifying database in ``'r'`` mode. results to following .pot file entries:: #: ../../library/dbm.rst:357 msgid "Deprecated since version 3.6, will be removed in version 3.8: Creating database in 'r' and 'w' modes. Modifying database in 'r' mode." msgstr "" #: ../../library/dbm.rst:357 msgid "Creating database in ``'r'`` and ``'w'`` modes. Modifying database in ``'r'`` mode." msgstr "" using the command:: sphinx-build -E -b gettext -D gettext_compact=0 -w warnings.txt -d build/.doctrees . locale/pot The root cause is deprecated-removed directive constructs inappropriate sub-doctree for translation. First, above .rst source is compiled into following tree structure:: <versionmodified type="deprecated-removed" version="('3.6', '3.8')"> <paragraph> <inline classes="versionmodified"> Deprecated since version 3.6, will be removed in version 3.8: <inline translatable="True"> Creating database in... and gettext builder picks up paragraph node and the second inline node as translation targets. Expected result is that two inline nodes are picked up as translation targets and the paragraph node is not, and expected .pot file entries are such as following:: #: ../../library/dbm.rst:357 msgid "Deprecated since version 3.6, will be removed in version 3.8:" msgstr "" #: ../../library/dbm.rst:357 msgid "Creating database in ``'r'`` and ``'w'`` modes. Modifying database in ``'r'`` mode." msgstr "" ---------- assignee: docs@python components: Documentation messages: 306546 nosy: cocoatomo, docs@python priority: normal severity: normal status: open title: deprecated-removed directive generates overlapping msgids in .pot files versions: Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32087> _______________________________________

3 7

[issue18356] help(numpy) causes segfault on exit
by Michelle Arzul 22 Feb '18

22 Feb '18

New submission from Michelle Arzul: As far as we could tell this bug is only consistently reproducible on Ubuntu 13.04. A line in pydoc.py causes a segfault when help(numpy) (no other libraries that I know of) exits. The offending method is pipepager(). For a full trackdown and workaround of the problem see http://stackoverflow.com/questions/17344974/python-helpnumpy-causes-segfaul… ---------- assignee: docs@python components: Documentation messages: 192276 nosy: Leeward, docs@python priority: normal severity: normal status: open title: help(numpy) causes segfault on exit type: crash versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18356> _______________________________________

6 9

[issue31937] Add the term "dunder" to the glossary
by Brett Cannon 19 Feb '18

19 Feb '18

New submission from Brett Cannon <brett(a)python.org>: The term "dunder" is used out in the community regularly, but if you have never been exposed to it before it can seem a little odd without context. ---------- assignee: docs@python components: Documentation messages: 305509 nosy: brett.cannon, docs@python priority: normal severity: normal status: open title: Add the term "dunder" to the glossary _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue31937> _______________________________________

8 16

[issue27846] Base64 expansion factor is 4 to 3, not 6 to 4
by Jens Jørgen Mortensen 13 Feb '18

13 Feb '18

New submission from Jens Jørgen Mortensen: The documentation has a note saying: "Base64 has an expansion factor of 6 to 4". I believe it should be 4 to 3. https://docs.python.org/dev/library/base64.html ---------- assignee: docs@python components: Documentation messages: 273543 nosy: Jens.Jørgen.Mortensen, docs@python priority: normal severity: normal status: open title: Base64 expansion factor is 4 to 3, not 6 to 4 type: enhancement versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27846> _______________________________________

7 13

[issue11015] Bring test.support docs up to date
by Nick Coghlan 11 Feb '18

11 Feb '18

New submission from Nick Coghlan <ncoghlan(a)gmail.com>: The test.support docs are there to help CPython devs with writing good unit tests more easily. There are a few additions we've made in recent years that haven't made it into the .rst file, so it is easy to miss useful tools if you don't go looking through the module source code. There are some other helper modules (such as test.script_helper) that could also stand to be made easier to find. Fixing this is just a matter of doing a pass through test.support and the test directory looking for things that might be worth mentioning in the test package docs. ---------- assignee: docs@python keywords: easy messages: 127086 nosy: docs@python, ncoghlan priority: normal severity: normal stage: needs patch status: open title: Bring test.support docs up to date type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11015> _______________________________________

11 36

[issue8722] Documentation for __getattr__
by Paul Davis 04 Feb '18

04 Feb '18

New submission from Paul Davis <paul.joseph.davis(a)gmail.com>: The docs for __getattr__ in the object model section could be more specific on the behavior when a @property raises an AttributeError and there is a custom __getattr__ defined. Specifically, it wasn't exactly clear that __getattr__ would be invoked after a @property was found and evaluated. The attached script demonstrates the issue on OS X 10.6, Python 2.6.1 I'm thinking something along the lines of: If the attribute search encounters an AttributeError (perhaps due to a @property raising the error) the search is considered a failure and __getattr__ is invoked. ---------- assignee: docs@python components: Documentation files: example.py messages: 105790 nosy: Paul.Davis, docs@python priority: normal severity: normal status: open title: Documentation for __getattr__ type: feature request versions: Python 2.6 Added file: http://bugs.python.org/file17349/example.py _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8722> _______________________________________

8 23

[issue30569] Tutorial section 2.1 has *nix example at 3.7, but Windows at 3.6
by Cheryl Sabella 04 Feb '18

04 Feb '18

New submission from Cheryl Sabella: https://docs.python.org/3.7/tutorial/interpreter.html The first lines for the location/command have been updated for 3.7, but next paragraph for Windows has not been updated. ---------- assignee: docs@python components: Documentation messages: 295142 nosy: csabella, docs@python priority: normal severity: normal status: open title: Tutorial section 2.1 has *nix example at 3.7, but Windows at 3.6 type: enhancement versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30569> _______________________________________

2 2

[issue27505] Missing documentation for setting module __class__ attribute
by Nick Coghlan 26 Jan '18

26 Jan '18

New submission from Nick Coghlan: Python 3.5 added the ability to set module __class__ attributes by way of http://bugs.python.org/issue22986 However, this isn't covered in the What's New guide or anywhere else in the documentation, and even in the NEWS file it appears under the cryptic title "Issue #22986: Allow changing an object’s __class__ between a dynamic type and static type in some cases." for 3.5.0a1 This should be documented somewhere (perhaps in the data model section of the language reference?) and an example given of using the feature to emit DeprecationWarning for access to a particular module level attribute. It should also be mentioned in the Python 3.5 What's New documentation. ---------- assignee: docs@python components: Documentation messages: 270285 nosy: docs@python, ncoghlan, njs priority: normal severity: normal stage: needs patch status: open title: Missing documentation for setting module __class__ attribute type: enhancement versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27505> _______________________________________

2 12