Mailman 3 July 2019 - docs

EPUB and PDF files unavailable
by Omar Francisco Olivares July 7, 2019

July 7, 2019

Hello I tried to download the EPUB and PDF files from https://docs.python.org/dev/download.html but they're currently unavailable. How can I download them? Greetings from Chile Omar --

2 1

[issue37513] Fix a type error in ctypes.rst
by hai shi July 7, 2019

July 7, 2019

New submission from hai shi <shihai1991(a)126.com>: Python 3.9.0a0 (heads/master-dirty:80097e0, Jul 6 2019, 02:14:54) [GCC 4.8.5 20150623 (Red Hat 4.8.5-36)] on linux Type "help", "copyright", "credits" or "license" for more information. >>> from ctypes import * >>> class POINT(Structure): ... _fields_ = [("x", c_int), ... ("y", c_int)] ... >>> POINT(1, 2, 3) Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: too many initializers and the init function in: https://github.com/python/cpython/blob/master/Modules/_ctypes/_ctypes.c#L43… ---------- assignee: docs@python components: Documentation messages: 347419 nosy: docs@python, shihai1991 priority: normal severity: normal status: open title: Fix a type error in ctypes.rst _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37513> _______________________________________

3 11

[issue34446] ambiguous _max_size parameter in SpooledTemporaryFile
by Andrew Scheller July 7, 2019

July 7, 2019

Andrew Scheller <launchpad(a)loowis.durge.org> added the comment: I agree that this is ambiguous behaviour. The docs at https://docs.python.org/3/library/tempfile.html#tempfile.SpooledTemporaryFi… say "This function operates exactly as TemporaryFile() does, except that data is spooled in memory until the file size exceeds max_size, or until the file’s fileno() method is called, at which point the contents are written to disk and operation proceeds as with TemporaryFile().", and as the default value for max_size is 0, that would imply to me that _any_ data written to a SpooledTemporaryFile (constructed with a max_size of 0) would instantly get (internally) converted to a TemporaryFile. Whereas looking at the code https://github.com/python/cpython/blob/master/Lib/tempfile.py#L650 it seems a max_size of 0 means "don't rollover". Perhaps it would have made sense to have SpooledTemporaryFile default to a max_size of None (and use that to mean "never rollover") ? So as well as the inconsistency between rollover behaviour in the write()/writelines() methods and the truncate() method (when max_size is 0) that jcc2220 pointed out, I believe there's also a documentation issue here in that it's not clear what a max_size of 0 is /supposed/ to do. ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python, lurchman versions: +Python 2.7, Python 3.5, Python 3.6, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue34446> _______________________________________

1 0

[issue37478] Docs: Method os.chdir() does not mention errors that can be raised
by Kyle Stanley July 7, 2019

July 7, 2019

New submission from Kyle Stanley <aeros167(a)gmail.com>: In the section describing the functionality of os.chdir(), there is no mention of possible errors that can be raised. This differentiates significantly from the sections of other methods, such as os.is_dir(): "This method can raise :exc:`OSError`, such as :exc:`PermissionError`, but :exc:`FileNotFoundError` is caught and not raised." For the purpose of consistency and providing additional useful information, I would suggest doing the same for os.chdir(). os.chdir() differs from os.is_dir() by directly raising the OSErrors FileNotFoundError and NotADirectoryError rather than handling them. I would suggest the addition of the following in os.chdir()'s section: "This method can raise :exc:`OSError`, such as exc:`FileNotFoundError` if the *path* does not lead to a valid file or exc:`NotADirectoryError` if the file specified is not a valid directory." or a less verbose alternative: "This method can raise :exc:`OSError`, such as exc:`FileNotFoundError` and exc:`NotADirectoryError`." If a user is reading the documentation, they might naturally assume that os.chdir() catches the FileNotFoundError, similar to the behavior in os.is_dir(). Also, the NotADirectoryError is not explicitly mentioned anywhere else on the "os.rst" page. If it were to be mentioned anywhere, os.chdir() would probably be the most relevant location to do so. Also, as a general question, what exactly is the standard for mentioning errors in the method sections for the Python documentation? For the purposes of clarity, I think it would be quite useful to explicitly mention errors, and a brief description of situations which raise them. If the behavior of the errors is consistent across of a group of methods, it can instead be mentioned in the header section. However, if the behavior not consistent, such as in this case, I think it is useful to briefly mention how the method deviates. It also seems useful to mention the error at least once if it is not explicitly mentioned elsewhere on the page, even if the parent is mentioned, such as with NotADirectoryError and OSError. This seems to be particularly important to do for the docs in a language such as Python, as it does not require the raise-able/throw-able errors to be mentioned in the code. I have already created a branch in my local fork of the cpython repository which implements this change, but I'll await feedback before submitting the PR. ---------- assignee: docs@python components: Documentation messages: 347080 nosy: aeros167, docs@python priority: normal severity: normal status: open title: Docs: Method os.chdir() does not mention errors that can be raised type: enhancement versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37478> _______________________________________

3 19

[issue37487] PyList_GetItem() document regarding index
by 杨昆仑 July 6, 2019

July 6, 2019

New submission from 杨昆仑 <yangkunlun(a)gmail.com>: The document of this function (PyList_GetItem()) says: "Return the object at position index in the list pointed to by list. The position must be **positive**,". However test shows the correct position index should be from 0 to len(list)-1. The claim of index **must be positive** is inaccurate and confusing. ---------- assignee: docs@python components: Documentation messages: 347144 nosy: docs@python, 杨昆仑 priority: normal severity: normal status: open title: PyList_GetItem() document regarding index type: behavior versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37487> _______________________________________

3 11

have a question about "strip"
by chinapython＠yeah.net July 6, 2019

July 6, 2019

hi.all I'm robin.come from china,I have a question about "strip": version：Python 3.7.0 >>> a='ea' >>> print([a.strip()]) ['ea'] >>> print([a.strip('page')]) [''] >>> print([a.strip('ge')]) ['a'] is this a bug? chinapython(a)yeah.net

2 2

[issue37508] A wrong return type in memory.rst
by hai shi July 6, 2019

July 6, 2019

New submission from hai shi <shihai1991(a)126.com>: the result should be a bytes object in #L70 in https://github.com/python/cpython/blob/master/Doc/c-api/memory.rst ---------- assignee: docs@python components: Documentation messages: 347356 nosy: docs@python, shihai1991 priority: normal severity: normal status: open title: A wrong return type in memory.rst _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37508> _______________________________________

3 6

[issue23312] google thinks the docs are mobile unfriendly
by Benjamin Peterson July 5, 2019

July 5, 2019

New submission from Benjamin Peterson: According to Google webmaster tools, the documentation has the following failings on mobile devices: - The font size is too small. https://developers.google.com/speed/docs/insights/UseLegibleFontSizes - The viewport is not configured. - Touch controls are too close together. You can look at the complaints on (for example) https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fd… ---------- assignee: docs@python components: Documentation messages: 234625 nosy: benjamin.peterson, docs@python priority: normal severity: normal stage: needs patch status: open title: google thinks the docs are mobile unfriendly type: enhancement versions: Python 2.7, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23312> _______________________________________

8 11

[issue37346] Documentation of os not using OSError subclasses
by Tim Hoffmann July 5, 2019

July 5, 2019

New submission from Tim Hoffmann <tim.hoffmann(a)posteo.de>: The documentation of `os` does not use the more specific `OSError` subclasses introduced in PEP 3151. ---------- assignee: docs@python components: Documentation messages: 346110 nosy: docs@python, timhoffm priority: normal severity: normal status: open title: Documentation of os not using OSError subclasses _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37346> _______________________________________

3 4

[issue37503] Queue.join(): Broken example in documentation
by Marco Dickert July 5, 2019

July 5, 2019

New submission from Marco Dickert <marco(a)misterunknown.de>: I guess I found a bug in the documented Queue.join() example [1]. The problem is the break condition for the while loop of the worker. If the item is None, the loop breaks, but the worker never calls item.task_done(). Thus the q.join() statement never returns, because the last task (None) remains unfinished. This should solve the issue: ``` if item is None: item.task_done() break ``` [1] https://docs.python.org/3/library/queue.html#queue.Queue.join ---------- assignee: docs@python components: Documentation messages: 347310 nosy: docs@python, misterunknown priority: normal severity: normal status: open title: Queue.join(): Broken example in documentation versions: Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37503> _______________________________________

1 1