Mailman 3 August 2013 - docs

Documentation error in function getaddrinfo in socket module
by Krishna Kumar Thakur June 30, 2014

June 30, 2014

Hi, python version : 3.3.0 Description : getaddrinfo() function expecting 'type' as the keyword argument but the function documentation says 'socktype' . please see the below output >>> help(getaddrinfo) Help on built-in function getaddrinfo in module _socket: getaddrinfo(...) getaddrinfo(host, port [, family, socktype, proto, flags]) -> list of (family, socktype, proto, canonname, sockaddr) >>> getaddrinfo.__doc__ 'getaddrinfo(host, port [, family, socktype, proto, flags])\n -> list of (family, socktype, proto, canonname, sockaddr)\n\nResolve host and port into addrinfo struct.' so if the function is called >>> i = getaddrinfo('www.python.org','http',socktype = SOCK_STREAM) Traceback (most recent call last): File "<pyshell#20>", line 1, in <module> i = getaddrinfo('www.python.org','http',socktype = SOCK_STREAM) TypeError: 'socktype' is an invalid keyword argument for this function then I have found the correct keyword argument as 'type' in python 3.3 official documentation. Its not the major issue but sometimes it confuses. As I appreciate python, so I felt its my duty to help make this language error free as much as possible. :) ________________________________ Thank You Krishna Kumar Thakur Contact: +91-7411251885 E_mail: krishnak.thakur(a)yahoo.com

2 1

[issue11385] TextTestRunner methods are not documented
by anatoly techtonik June 27, 2014

June 27, 2014

New submission from anatoly techtonik <techtonik(a)gmail.com>: TextTestRunner has a run method, which is not documented. It is also is not clear how to add suite to TextTestRunner to be executed later by unittest.main() ---------- assignee: docs@python components: Documentation, Tests messages: 129988 nosy: docs@python, techtonik priority: normal severity: normal status: open title: TextTestRunner methods are not documented versions: Python 2.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11385> _______________________________________

6 10

[issue15588] quopri: encodestring and decodestring handle bytes, not strings
by patrick vrijlandt June 25, 2014

June 25, 2014

New submission from patrick vrijlandt: quopri.py's functions encodestring and decodestring are documented to handle strings; and this is clearly suggested by their name. However, these functions accept and return bytes, not strings. This should be reflected in the documentation. Even better: deprecate these functions and introduce new ones with behaviour as suggested by their names: encode_string, encode_bytes etc. ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 167672 nosy: docs@python, patrick.vrijlandt priority: normal severity: normal status: open title: quopri: encodestring and decodestring handle bytes, not strings type: behavior versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________

6 8

[issue14013] tarfile should expose supported formats
by Éric Araujo June 23, 2014

June 23, 2014

New submission from Éric Araujo <merwok(a)netwok.org>: shutil contains high-level functions to create a zipfile or a tarball. When a new format is added to the tarfile module, then shutil needs to be updated manually. If tarfile exposed the names of the compressors it supports, then shutil could just automatically support everything that tarfile supports instead of having to re-do import dances for optional modules (bz2, lzma, zlib) and also duplicate formats in its doc. This may also be useful for other code wanting to do some introspection. Attached patch implements tarfile.formats, a list of strings (I thought about using a frozenset but then followed the precedent set by the 3.3 crypt module). Tests and docs not updated, I wanted to get Lars’ approval on the principle first. One could argue that this is not needed: compression modules are not added often; updating shutil after updating tarfile is not hard; it is not that useful to have access to the list of supported formats. ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 153350 nosy: docs@python, eric.araujo, lars.gustaebel, nadeem.vawda priority: normal severity: normal stage: patch review status: open title: tarfile should expose supported formats type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14013> _______________________________________

3 4

[issue18612] More elaborate documentation on how list comprehensions and generator expressions relate to each other
by uglemat June 19, 2014

June 19, 2014

New submission from uglemat: Today there are list comprehensions, set comprehensions, dict comprehensions and then... there are generator expressions, which apparently was called 'generator comprehensions' in the original PEP, don't know why that was changed. Some questions arises: * Are generator expressions a type of list comprehension, or are generator expressions to be considered their own thing. * Does 'list comprehension' mean a type of comprehension that happens to return a list, or is it to be considered more of a general concept. I usually talk about 'list comprehension' as a type of comprehension, and 'generator expression' as another type of comprehension, and after investigating whether or not that is correct I couldn't find an answer. On the wikipedia article on list comprension (http://en.wikipedia.org/wiki/List_comprehension#Python) they list generator expressions as well, indicating that it's a type of list comprehension. I think there's a lot of confusion to be had here, and that the documentation should clarify what exactly is meant by 'list comprehensions', regardless of what happens to be the case. I haven't really a bug report before, so forgive me if I'm doing something wrong. :) ---------- assignee: docs@python components: Documentation messages: 194048 nosy: docs@python, uglemat priority: normal severity: normal status: open title: More elaborate documentation on how list comprehensions and generator expressions relate to each other versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18612> _______________________________________

3 6

[issue18703] To change the doc of html/faq/gui.html
by madan ram June 19, 2014

June 19, 2014

New submission from madan ram: "Qt 4.5 upwards is licensed under the LGPL license; also, commercial licenses are available from Nokia." Since new version of Qt 5 is realsed and Licenced under Digia. So i am fixing this issue . i am going to write it as PyQt5 is licensed on all platforms under a commercial license and the GPL v3. Your PyQt5 license must be compatible with your Qt license. If you use the GPL version then your own code must also use a compatible license. Note:-PyQt5, unlike Qt, is not available under the LGPL. You can purchase a commercial PyQt5 license here. ---------- assignee: docs@python components: Documentation files: gui.rst messages: 194824 nosy: docs@python, madan.ram priority: normal severity: normal status: open title: To change the doc of html/faq/gui.html versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5 Added file: http://bugs.python.org/file31218/gui.rst _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18703> _______________________________________

4 8

[issue13779] os.walk: bottom-up
by patrick vrijlandt June 16, 2014

June 16, 2014

New submission from patrick vrijlandt <patrick.vrijlandt(a)gmail.com>: PythonWin 3.2 (r32:88445, Feb 20 2011, 21:29:02) [MSC v.1500 32 bit (Intel)] on win32. Portions Copyright 1994-2008 Mark Hammond - see 'Help/About PythonWin' for further copyright information. >>> import os >>> os.makedirs("g:/a/b/c") >>> os.listdir("g:/a") ['b'] >>> for root, dirs, files in os.walk("g:/a", topdown = False): ... print(root, dirs, files, os.listdir(root)) ... os.rmdir(root) ... g:/a\b\c [] [] [] g:/a\b ['c'] [] [] g:/a ['b'] [] [] >>> >From the documentation of os.walk: If topdown is False, the triple for a directory is generated after the triples for all of its subdirectories (directories are generated bottom-up). As the above example shows, the directories are generated in the correct order, "generated" referring to yield from generator os.walk. However, the generated (files? and) dirs do not necessarily reflect the current situation as produced by os.listdir. Therefore, this does not clear the entire directory tree as I would expect. >>> os.makedirs("g:/a/b/c") >>> for root, dirs, files in os.walk("g:/a", topdown = False): ... print(root, dirs, files, os.listdir(root)) ... if not (files + dirs): ... os.rmdir(root) ... g:/a\b\c [] [] [] g:/a\b ['c'] [] [] g:/a ['b'] [] ['b'] I think that at least the documentation should be more clear on this issue. I would like even better, if files + dirs would match os.listdir on the moment they are generated (=yielded). ---------- assignee: docs@python components: Documentation messages: 151169 nosy: docs@python, patrick.vrijlandt priority: normal severity: normal status: open title: os.walk: bottom-up type: behavior versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13779> _______________________________________

6 10

[issue12617] Mutable Sequence Type can work not only with iterable in slice[i:j] = t
by py.user June 14, 2014

June 14, 2014

New submission from py.user <port139(a)yandex.ru>: 1) 4.6.4 Mutable Sequence Types | s[i:j] = t | slice of s from i to j is replaced | | | by the contents of the iterable t | >>> lst = list('abc') >>> barr = bytearray(b'abc') >>> lst[:1] = 4 Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: can only assign an iterable >>> barr[:1] = 4 >>> barr bytearray(b'\x00\x00\x00\x00bc') >>> there is no info about this feature in the documentation 2) 4.6.4 Mutable Sequence Types | s.extend(x) | same as s[len(s):len(s)] = x | >>> lst = list('abc') >>> barr = bytearray(b'abc') >>> lst.extend(4) Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: 'int' object is not iterable >>> barr.extend(4) Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: 'int' object is not iterable >>> lst[len(lst):len(lst)] = 4 Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: can only assign an iterable >>> barr[len(barr):len(barr)] = 4 >>> barr bytearray(b'abc\x00\x00\x00\x00') >>> barr.extend(x) != barr[len(barr):len(barr)] = x ---------- assignee: docs@python components: Documentation, Interpreter Core messages: 140924 nosy: docs@python, py.user priority: normal severity: normal status: open title: Mutable Sequence Type can work not only with iterable in slice[i:j] = t type: behavior versions: Python 3.1 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12617> _______________________________________

6 5

[issue10503] os.getuid() documentation should be clear on what kind of uid it is referring
by Giampaolo Rodola' June 7, 2014

June 7, 2014

New submission from Giampaolo Rodola' <g.rodola(a)gmail.com>: http://docs.python.org/library/os.html#os.getuid os.getuid() documentation just states: > Return the current process’s user id. It is not clear, however, whether "user id" refers to real, effective or saved user id. As per: http://linux.about.com/library/cmd/blcmdl2_getuid.htm ...it should refer to _real_ user id. ---------- assignee: docs@python components: Documentation messages: 122117 nosy: docs@python, giampaolo.rodola priority: normal severity: normal status: open title: os.getuid() documentation should be clear on what kind of uid it is referring versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10503> _______________________________________

5 6

[issue16774] Additional recipes for itertools docs
by Alexey Kachayev May 26, 2014

May 26, 2014

New submission from Alexey Kachayev: Additional recipes for itertools documentation (widespread functions in other programming languages): * drop * split-at * split-by ---------- assignee: docs@python components: Documentation files: itertools.doc.diff keywords: patch messages: 178098 nosy: asvetlov, docs@python, kachayev priority: normal severity: normal status: open title: Additional recipes for itertools docs versions: Python 3.4 Added file: http://bugs.python.org/file28427/itertools.doc.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16774> _______________________________________

5 9