Mailman 3 December 2012 - docs

[issue16609] random.random() / float() loses precision when passed to str()
by R. David Murray Dec. 4, 2012

Dec. 4, 2012

R. David Murray added the comment: In fact it has been changed. In Python3 you get: >>> x = 0.88022393777095409 >>> x 0.8802239377709541 >>> str(x) '0.8802239377709541' Even in 2.7 you would get the above repr, not the one you showed. This is because 2.7 and 3.3 use the "shortest repr" described in the floating point document, but 2.7 still uses the old rounding as the default str representation (for backward compatibility reasons). While you could still make an argument for updating the 2.7 docs, I'm not sure it is worth it. If you (or anyone) want to propose a patch, I would suggest that instead of adding a note to the random docs, that a glossary entry be added for 'floating point' which mentions it as a 2.7 limitation, and a link to that glossary entry from the random docs. ---------- assignee: -> docs@python components: +Documentation -Interpreter Core nosy: +docs@python, r.david.murray priority: normal -> low type: -> behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16609> _______________________________________

1 0

A couple of minor issues
by Daniel Shahaf Dec. 4, 2012

Dec. 4, 2012

First, http://mail.python.org/mailman/listinfo/docs claims this list's archives aren't public, and then links to the pipermail archives --- which are anonymously accessible. You might want to fix this inconsistency. Second, I think it'd be useful for :mod:`faulthandler.register` to link to :mod:`signal`, in case readers aren't already aware of the latter: diff -r b3fe2ef13470 Doc/library/faulthandler.rst --- a/Doc/library/faulthandler.rst Tue Dec 04 09:30:24 2012 +0100 +++ b/Doc/library/faulthandler.rst Tue Dec 04 16:20:40 2012 +0000 @@ -96,7 +96,9 @@ Register a user signal: install a handler for the *signum* signal to dump the traceback of all threads, or of the current thread if *all_threads* is - ``False``, into *file*. Call the previous handler if chain is ``True``. + ``False``, into *file*. Call the previous handler if *chain* is ``True``. + + See :mod:`signal.SIG*` for symbolic names of the available signals. Not available on Windows. Daniel (not subscribed; please CC on replies)

1 0

Bug in example code for the CSV library
by Kyle Gorman Dec. 4, 2012

Dec. 4, 2012

Good day Python maintainers, I recently copied and pasted the example code at the bottom of the CSV module documentation. This code is designed to allow you to read and write unicode CSV files (by default, UTF-8). However, it doesn't work on quite minimal examples, in a way likely to stump beginners. I assume you have the code at the bottom of the CSV documentation page in a file called CSVunicode.py and it's in your path (I didn't bother attaching: lots of email systems are going to strip anything like Python attachments off an email, anyways). >>> from CSVunicode import UnicodeWriter >>> UnicodeWriter(open('temp.csv', 'r')).writerow((1, 2, 3)) Traceback (most recent call last): File "<input>", line 1, in <module> File "UnicodeCSV.py", line 58, in writerow self.writer.writerow([s.encode("utf-8") for s in row]) AttributeError: 'int' object has no attribute 'encode' The problem, of course, is that there is no guarantee that iterable argument sent to the writerow method each have a method "encode": they are quite likely to be integers. I don't have a simple suggestion about how to fix this. You could wrap "s" in the line that throws the AttributeError with the str() function (or check to see if hasattr(s, 'encode') before doing so), but that will break the functionality of the csv.QUOTE_* kwargs, which differentiate between numeric row values and their stringified variants. The whole issue seems to indicate the wrong level of abstraction, unfortunately (to my eyes). I'd be glad to help if I can be of any use as a writer (I used to work as a technical writer) or developer; Python means a lot to me. Yours, Kyle Gorman Center for Spoken Language Understanding, Oregon Health & Science University

1 1

bug report for docs.python.org for sqlite3 library doc
by Benjamin Dopplinger Dec. 3, 2012

Dec. 3, 2012

hi I have found a bug on the page http://docs.python.org/3/library/sqlite3.html. There are a few examples where the documentation shows that it is possible to call close() on a Cursor object. But according to the list of all the Cursor methods which can be found on http://docs.python.org/3/library/sqlite3.html#cursor-objects no such close() method exists (although it does exist of course). So the only fix which has to be applied is to add the close() method in the listing of all the Cursor methods on http://docs.python.org/3/library/sqlite3.html#cursor-objects. Best regards Benjamin Dopplinger

1 0

File size!
by Andrie Vorster Dec. 3, 2012

Dec. 3, 2012

Halo I am Andrie Vorster, here on this page: http://docs.python.org/2/download.html it says the file size is 8 MB but it's 10.3 MB! Good day!

1 0

[issue16568] allow constructors to be documented separately from class
by Chris Jerdonek Dec. 3, 2012

Dec. 3, 2012

New submission from Chris Jerdonek: This issue is to settle on and provide a way to document the constructor of a class separately from the overall summary/description of a class. This is something that Ezio, Nick, and I discussed briefly on IRC a few hours ago. We all see the value in it. Currently, Sphinx's "class" directive is used in many places to document the constructor of a class. One drawback of this approach is that linking to the class using the :class: role links to the constructor as opposed to the class summary. As a result, in many cases the class description needs to be added before the class directive, and a second link needs to be created and used for the overall description. One way to address this would be to create a new "constructor" directive similar to directives like method, classmethod, and staticmethod. The constructor documentation could then be hyperlinked to using a new :constructor: role (or perhaps :ctor: to go with the pattern of 4-letter roles). The class summary could then go immediately after the class directive, with the constructor directive following, as follows: .. class:: Foo Description of Foo. .. constructor:: Foo(bar=1) Return a Foo. This could render as-- class **Foo** Description of Foo. *constructor* **Foo**(bar=1) Return a Foo. It is possible that something similar could be achieved by abusing the method directive for constructors and linking to them using :meth:`~Foo.Foo`, but that wouldn't be ideal in a few respects. Nick also raised a related issue for base classes, etc. I will let him speak to that issue, which might be best as part of another new issue. ---------- assignee: docs@python components: Documentation messages: 176524 nosy: chris.jerdonek, docs@python, ezio.melotti, ncoghlan priority: normal severity: normal status: open title: allow constructors to be documented separately from class type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16568> _______________________________________

5 9

[issue16585] surrogateescape broken w/ multibytecodecs' encode
by Roundup Robot Dec. 2, 2012

Dec. 2, 2012

Roundup Robot added the comment: New changeset 777aabdff35a by Benjamin Peterson in branch '3.3': document that encoding error handlers may return bytes (#16585) http://hg.python.org/cpython/rev/777aabdff35a ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16585> _______________________________________

1 0

[issue16585] surrogateescape broken w/ multibytecodecs' encode
by Roundup Robot Dec. 2, 2012

Dec. 2, 2012

Roundup Robot added the comment: New changeset 5c88c72dec60 by Benjamin Peterson in branch '3.3': support encoding error handlers that return bytes (closes #16585) http://hg.python.org/cpython/rev/5c88c72dec60 New changeset 2181c37977d3 by Benjamin Peterson in branch 'default': merge 3.3 (#16585) http://hg.python.org/cpython/rev/2181c37977d3 ---------- nosy: +python-dev resolution: -> fixed stage: needs patch -> committed/rejected status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16585> _______________________________________

1 0

[issue16556] Update string.Formatter.vformat documentation to say "**kwargs"
by Taavi Burns Dec. 2, 2012

Dec. 2, 2012

New submission from Taavi Burns: The documentation says "**kwds" instead of "**kwargs", which is what the function signature uses. I noticed some other (internally-consistent) occurrences in string.rst. Is there any interest in replacing "**kwds" generally with "**kwargs"? It looks like 327 vs 932 ratio in the docs, and closer to 1185 vs 2361 in the source tree as a whole. Thanks! ---------- assignee: docs@python components: Documentation files: kwds_kwargs.diff keywords: patch messages: 176393 nosy: docs@python, taavi-burns priority: normal severity: normal status: open title: Update string.Formatter.vformat documentation to say "**kwargs" type: enhancement versions: Python 2.7, Python 3.3 Added file: http://bugs.python.org/file28127/kwds_kwargs.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16556> _______________________________________

4 7

[issue16585] surrogateescape broken w/ multibytecodecs' encode
by Antoine Pitrou Dec. 2, 2012

Dec. 2, 2012

Changes by Antoine Pitrou <pitrou(a)free.fr>: ---------- assignee: docs@python -> components: +Library (Lib) -Documentation, Interpreter Core, Unicode _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16585> _______________________________________

1 0