Mailman 3 March 2013 - docs

Python 3.3 Module documentation bug: xml.sax
by Kenneth Hill March 18, 2013

March 18, 2013

For some reason xml.sax is a child of xml.parsers.expat.errors in the module index. Currently: xml.parsers.expat.errors xml.parsers.expat.model xml.sax xml.sax.handler xml.sax.saxutils xml.sax.xmlreader I suspect this should be: xml.parsers xml.parsers.expat xml.parsers.expat.errors xml.parsers.expat.model xml.sax xml.sax.handler xml.sax.saxutils xml.sax.xmlreader Regards, Ken

1 0

[issue17415] Documentation Ambiguity 1
by Gurmeet Singh March 18, 2013

March 18, 2013

New submission from Gurmeet Singh: This is the first time I am creating an issue. I may be doing something wrong. I will correct that if you make me aware about it! Issue with documentation: Documentation page: http://docs.python.org/3/library/os.path.html Entry: os.path.normpath(path) Contention line: "It should be understood that this may change the meaning of the path if it contains symbolic links!" Ambiguity Source: Contention line immediately follows the line "On Windows, it converts forward slashes to backward slashes." relating contention line to also windows. Ambiguity: "I think" (i.e. I do not know for sure) that, the contention line should apply to all OS, not just windows. for example, .. after a symlink should, according to me, remove the symlink itself by the normpath function. This would be an incorrect behaviour of the normpath (I consider that incorrect). Hence, should be documented for all OS. ---------- assignee: docs@python components: Documentation messages: 184152 nosy: docs@python, gsingh priority: normal severity: normal status: open title: Documentation Ambiguity 1 type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17415> _______________________________________

5 9

[issue16057] Subclasses of JSONEncoder should not be insturcted to call JSONEncoder.decode
by Justin Lebar March 18, 2013

March 18, 2013

New submission from Justin Lebar: The JSONEncoder documentation says we can implement our own encoder as: >>> class ComplexEncoder(json.JSONEncoder): ... def default(self, obj): ... if isinstance(obj, complex): ... return [obj.real, obj.imag] ... return json.JSONEncoder.default(self, obj) Later on, we give the following example of how to implement the default method in a subclass of json.JSONEncoder: def default(self, o): try: iterable = iter(o) except TypeError: pass else: return list(iterable) return JSONEncoder.default(self, o) These are both incorrect, as a quick reading of the source will reveal. JSONEncoder.default() throws for all input values. We should s/JSONEncoder.default/JSONEncoder.encode/ here, I think. ---------- assignee: docs@python components: Documentation messages: 171363 nosy: Justin.Lebar, docs@python priority: normal severity: normal status: open title: Subclasses of JSONEncoder should not be insturcted to call JSONEncoder.decode versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16057> _______________________________________

6 9

[issue17416] Documentation Ambiguity 2
by Gurmeet Singh March 17, 2013

March 17, 2013

New submission from Gurmeet Singh: Source page: http://docs.python.org/3/library/os.html Entry: os.walk(...) Ambiguity Source: Name of the argument TopDown and / or its description. The TopDown name is misleading to me. I would suggest BFS or DFS instead. TopDown false would imply to me that the traversal would run bottom up "from" the directory mentioned in the argument list (even though the name of that argument is top, it is confusing indicating a possibility of another naming mistake instead!) ---------- assignee: docs@python components: Documentation messages: 184153 nosy: docs@python, gsingh priority: normal severity: normal status: open title: Documentation Ambiguity 2 type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17416> _______________________________________

2 3

[issue17417] Documentation Modification Suggestion: os.walk, fwalk
by Gurmeet Singh March 16, 2013

March 16, 2013

New submission from Gurmeet Singh: Source page: http://docs.python.org/3/library/os.html Entry: os.walk(...), os.fwalk() These functions seems to be a generator functions. An expert like yourself may have no trouble to make this out. But for novice (or for people out of touch) like myself would have preferred a starting line of this function as "A generator function that generates file names.... ", rather than currently "Generates file names...." ---------- assignee: docs@python components: Documentation messages: 184155 nosy: docs@python, gsingh priority: normal severity: normal status: open title: Documentation Modification Suggestion: os.walk, fwalk type: enhancement versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17417> _______________________________________

2 3

[issue17337] input() and raw_input() do not work correctly with colored prompts
by Terry J. Reedy March 15, 2013

March 15, 2013

Terry J. Reedy added the comment: Please suggest the specific change in a specific place that you would like to see. Message is ok, patch even better. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17337> _______________________________________

1 0

[issue17398] document url argument of RobotFileParser
by Tshepang Lekhonkhobe March 15, 2013

March 15, 2013

New submission from Tshepang Lekhonkhobe: Looking at the documentation, one would think RobotFileParser does not accept any argument, but it does -- "url". Documenting this would remove the pain of having to call "set_url()". ---------- assignee: docs@python components: Documentation messages: 183979 nosy: docs@python, tshepang priority: normal severity: normal status: open title: document url argument of RobotFileParser versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17398> _______________________________________

3 3

daemon attribute in threading module doesn't have a "new in 2.6" next to it
by Darren Yin March 15, 2013

March 15, 2013

The docs are usually pretty good about saying when features were introduced, so if a documented property/method doesn't have an explicit "New in *" next to it, I assume it's valid in python 2.5 at least. http://docs.python.org/2/library/threading.html#threading.Thread.daemon --darren

1 0

[issue17337] input() and raw_input() do not work correctly with colored prompts
by Michael Enßlin March 15, 2013

March 15, 2013

Michael Enßlin added the comment: Terry, i guess you are right; it is indeed not the job of python to know how its terminal will print characters; there is a whole lot of issues to consider, such as terminal unicode support, control characters, ansi escape sequences, terminal-specific escape sequences such as terminal title, etc. I guess that on UNIX, a lot of that information could be taken from terminfo, to provide a method that guesses the length of a text on the terminal that is referenced in the $TERM environment variable. In fact, I think this is a design problem of readline; readline should print the prompt, and then try to determine its length via the dedicated escape sequence (if it really needs to know the prompt length). In that case, there would be no way to fix this in python - apart from re-implementing. In conclusion, no, I don't believe the python readline code should be modified, maybe an additional, os- and $TERM-dependent method for adding prompt escapes should be added. However, the issue should definitely be documented in the readline documentation: importing readline _will_ break input() if the prompt contains non-printable characters that are not escaped by '\x01' and '\x02' characters. Hence I have changed the bug components to 'Documentation'. ---------- assignee: -> docs@python components: +Documentation -Library (Lib) nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17337> _______________________________________

1 0

[issue17047] Fix double double words words
by Serhiy Storchaka March 15, 2013

March 15, 2013

New submission from Serhiy Storchaka: In additional to changeset 07488c3c85f1, here are yet some possible word duplications: Lib/_pyio.py:306: Change the stream position to byte offset offset. offset is Lib/concurrent/futures/_base.py:520: fn: A callable that will take take as many arguments as there are Lib/tkinter/__init__.py:3116: have the same start and and end line as the parent widget, but Lib/tkinter/tix.py:149: """Locates a bitmap file of the name name.xpm or name in one of the Lib/tkinter/tix.py:160: """Locates an image file of the name name.xpm, name.xbm or name.ppm Lib/lib2to3/pgen2/grammar.py:23: """Pgen parsing tables tables conversion class. Lib/lib2to3/pgen2/grammar.py:48: states, each state is is a list of arcs, and each Lib/email/_header_value_parser.py:1866: We allow anything except the excluded characters, but but if we find any Lib/email/_encoded_words.py:17:# to to the CTE tables, but YAGNI for now. 'q' is Quoted Printable, 'b' is Lib/email/mime/text.py:29: # If no _charset was specified, check to see see if there are non-ascii Lib/email/policy.py:26: The API extensions enabled by this this policy are currently provisional. Lib/unittest/mock.py:1420: attributes that your production code creates at runtime. It is off by by Lib/test/test_socket.py:845: # Try udp, but don't barf it it doesn't exist Lib/test/test_descrtut.py:322:getx() and and setx(): Lib/test/test_decimal.py:4495: # Do operations and check that it didn't change change internal objects. Lib/distutils/command/install.py:266: raise DistutilsOptionError("can't combine user with with prefix/" Lib/distutils/tests/test_install.py:168: # can't combine user with with prefix/exec_prefix/home or python-gdb.py:1466: '''Is this frame "collect" within the the garbage-collector?''' Include/pyport.h:884: * also also takes care of Apple's universal builds. Modules/_io/iobase.c:79: "Change the stream position to byte offset offset. offset is\n" Modules/_heapqmodule.c:91: /* The leaf at pos is empty now. Put newitem there, and and bubble Modules/_heapqmodule.c:431: /* The leaf at pos is empty now. Put newitem there, and and bubble Modules/socketmodule.c:3547: ensures that that doesn't happen. */ Modules/binascii.c:41:** I have attempted to break with this tradition, but I guess that that Modules/posixmodule.c:9747:Return the value of extended attribute attribute on path.\n\ Modules/posixmodule.c:9825:Set extended attribute attribute on path to value.\n\ Modules/posixmodule.c:9890:Remove extended attribute attribute on path.\n\ PC/msvcrtmodule.c:133:Create a C runtime file descriptor from the file handle handle. The\n\ Doc/c-api/intro.rst:436::c:func:`sum_sequence` example above. It so happens that that example doesn't Doc/c-api/long.rst:206: Return a C :c:type:`size_t` representation of of *pylong*. *pylong* must be Doc/c-api/long.rst:218: Return a C :c:type:`unsigned PY_LONG_LONG` representation of of *pylong*. Doc/library/stdtypes.rst:2640: Cast 1D/unsigned char to to 2D/unsigned long:: Doc/library/email.policy.rst:330: line breaks and and any (RFC invalid) binary data it may contain. Doc/library/unittest.mock.rst:991: attributes that your production code creates at runtime. It is off by by Doc/whatsnew/3.3.rst:1539:New attribute attribute :data:`multiprocessing.Process.sentinel` allows a Lib/idlelib/extend.txt:57:Here is a complete example example: Lib/idlelib/extend.txt:75:used to to configure the loading of extensions and to establish key (or, more ---------- assignee: docs@python components: Documentation keywords: easy messages: 180747 nosy: docs@python, ezio.melotti, serhiy.storchaka priority: normal severity: normal stage: needs patch status: open title: Fix double double words words type: enhancement versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17047> _______________________________________

7 31