Mailman 3 December 2012 - docs

[issue16678] optparse: parse only known options
by anatoly techtonik Dec. 14, 2012

Dec. 14, 2012

New submission from anatoly techtonik: This following recipe from Optik examples should be added to documentation. It is extremely helpful when porting to optparse from getopt or other option parsing schemes. ---------- assignee: docs@python components: Documentation messages: 177447 nosy: docs@python, techtonik priority: normal severity: normal status: open title: optparse: parse only known options versions: Python 2.6, Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16678> _______________________________________

4 6

[issue16683] Resort audioop documentation
by Serhiy Storchaka Dec. 14, 2012

Dec. 14, 2012

New submission from Serhiy Storchaka: Functions in the audioop module documentation enumerated in alphabetic order. Only one function out of order. Here is a patch that fixes this. ---------- assignee: docs@python components: Documentation files: audioop_docs_resort.patch keywords: patch messages: 177475 nosy: docs@python, serhiy.storchaka priority: normal severity: normal stage: patch review status: open title: Resort audioop documentation type: enhancement versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4 Added file: http://bugs.python.org/file28313/audioop_docs_resort.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16683> _______________________________________

3 2

[issue16607] Bad examples in documentation
by myreallycoolname Dec. 13, 2012

Dec. 13, 2012

New submission from myreallycoolname: The doumentation examples imn the tutorial in python3.2 are at lest in part invalid. I was having trouble understanding the documentation so I pulled out my pthony interperator and pluged in one of tyhe examples. Just as I thought self was not defined. You can't learn python if the docs are bad. Please review the examples under classes to make sure they are all correct. ---------- assignee: docs@python components: Documentation messages: 176927 nosy: docs@python, myreallycoolname priority: normal severity: normal status: open title: Bad examples in documentation versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16607> _______________________________________

5 11

[issue16667] timezone docs need "versionadded: 3.2"
by Éric Araujo Dec. 13, 2012

Dec. 13, 2012

Éric Araujo added the comment: Second patch has a stray slash character, and the versionadded directive does not seem to be in the same place as the first patch. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16667> _______________________________________

1 0

[issue16667] timezone docs need "versionadded: 3.2"
by Andrew Svetlov Dec. 13, 2012

Dec. 13, 2012

Changes by Andrew Svetlov <andrew.svetlov(a)gmail.com>: ---------- stage: needs patch -> patch review _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16667> _______________________________________

1 0

[issue16667] timezone docs need "versionadded: 3.2"
by Éric Araujo Dec. 13, 2012

Dec. 13, 2012

Changes by Éric Araujo <merwok(a)netwok.org>: ---------- Removed message: http://bugs.python.org/msg177410 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16667> _______________________________________

1 0

[issue16667] timezone docs need "versionadded: 3.2"
by Nurhusien Hasen Dec. 13, 2012

Dec. 13, 2012

Nurhusien Hasen added the comment: On 12/14/12, Berker Peksag <report(a)bugs.python.org> wrote: > > Changes by Berker Peksag <berker.peksag(a)gmail.com>: > > > ---------- > keywords: +patch > Added file: http://bugs.python.org/file28301/issue16667.diff > > _______________________________________ > Python tracker <report(a)bugs.python.org> > <http://bugs.python.org/issue16667> > _______________________________________ > _______________________________________________ > Python-bugs-list mailing list > Unsubscribe: > http://mail.python.org/mailman/options/python-bugs-list/nurhusien.hasen27%4… > > -- find signatures serves ---------- nosy: +Nurhusien2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16667> _______________________________________

1 0

[issue16667] timezone docs need "versionadded: 3.2"
by Andrew Svetlov Dec. 13, 2012

Dec. 13, 2012

Andrew Svetlov added the comment: I've reworded patch a bit and made it based on 3.2 for easier merging. ---------- nosy: +asvetlov Added file: http://bugs.python.org/file28302/issue16667_v2.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16667> _______________________________________

1 0

[issue16667] timezone docs need "versionadded: 3.2"
by Berker Peksag Dec. 13, 2012

Dec. 13, 2012

Changes by Berker Peksag <berker.peksag(a)gmail.com>: ---------- nosy: +berker.peksag _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16667> _______________________________________

1 0

[issue16667] timezone docs need "versionadded: 3.2"
by Berker Peksag Dec. 13, 2012

Dec. 13, 2012

Changes by Berker Peksag <berker.peksag(a)gmail.com>: ---------- keywords: +patch Added file: http://bugs.python.org/file28301/issue16667.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16667> _______________________________________

1 0

[issue12600] Add example of using load_tests to parameterise Test Cases
by Mark Dickinson Dec. 12, 2012

Dec. 12, 2012

Changes by Mark Dickinson <dickinsm(a)gmail.com>: ---------- nosy: +mark.dickinson _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12600> _______________________________________

1 0

[issue16667] timezone docs need "versionadded: 3.2"
by Éric Araujo Dec. 12, 2012

Dec. 12, 2012

Changes by Éric Araujo <merwok(a)netwok.org>: ---------- keywords: +easy nosy: +eric.araujo _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16667> _______________________________________

1 0

[issue16667] timezone docs need "versionadded: 3.2"
by Nick Coghlan Dec. 12, 2012

Dec. 12, 2012

Changes by Nick Coghlan <ncoghlan(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16667> _______________________________________

1 0

FOO and BAR
by Andrew.Roe＠rbs.com Dec. 11, 2012

Dec. 11, 2012

Do you think it would be possible to write your documentation avoiding the silly usage of FOO and BAR everywhere? This is a very very old and boring joke, and does nothing to clarify what you are trying to clarify. If you could include real-world examples in your documentation, rather than "clever" programmer "jokes", learners such as myself would have far more respect for the good work you are obviously doing here. For example, the section on argparser is full of this sort of rubbish: argparse.ArgumentParser(description='A foo that bars') Under what circumstances would you ever put that in a program? Are you mad? Please take this into consideration. Andrew Roe RAD Developer Markets & International Banking RBS 250 Bishopsgate, London, EC2M 4AA, GB Office: +44 20 7678 0425 *********************************************************************************** The Royal Bank of Scotland plc. Registered in Scotland No 90312. Registered Office: 36 St Andrew Square, Edinburgh EH2 2YB. Authorised and regulated by the Financial Services Authority. The Royal Bank of Scotland N.V. is authorised and regulated by the De Nederlandsche Bank and has its seat at Amsterdam, the Netherlands, and is registered in the Commercial Register under number 33002587. Registered Office: Gustav Mahlerlaan 350, Amsterdam, The Netherlands. The Royal Bank of Scotland N.V. and The Royal Bank of Scotland plc are authorised to act as agent for each other in certain jurisdictions. This e-mail message is confidential and for use by the addressee only. If the message is received by anyone other than the addressee, please return the message to the sender by replying to it and then delete the message from your computer. Internet e-mails are not necessarily secure. The Royal Bank of Scotland plc and The Royal Bank of Scotland N.V. including its affiliates ("RBS group") does not accept responsibility for changes made to this message after it was sent. For the protection of RBS group and its clients and customers, and in compliance with regulatory requirements, the contents of both incoming and outgoing e-mail communications, which could include proprietary information and Non-Public Personal Information, may be read by authorised persons within RBS group other than the intended recipient(s). Whilst all reasonable care has been taken to avoid the transmission of viruses, it is the responsibility of the recipient to ensure that the onward transmission, opening or use of this message and any attachments will not adversely affect its systems or data. No responsibility is accepted by the RBS group in this regard and the recipient should carry out such virus and other checks as it considers appropriate. Visit our website at www.rbs.com ***********************************************************************************

1 0

[issue12600] Add example of using load_tests to parameterise Test Cases
by Robert Collins Dec. 11, 2012

Dec. 11, 2012

Robert Collins added the comment: BTW I'm very happy with testscenarios (on pypi) for this, modulo one small issue which is the use of __str__ by the stdlib [which isn't easily overridable - there is a separate issue on that]. I'd be delighted to have testscenarios be in the stdlib, if thats desirable. ---------- nosy: +rbcollins _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12600> _______________________________________

1 0

[issue14783] Make int() and str() docstrings correct
by Roundup Robot Dec. 10, 2012

Dec. 10, 2012

Roundup Robot added the comment: New changeset 181c170c6270 by Chris Jerdonek in branch '3.2': Issue #16629: Fix IDLE idlelib.CallTips test. Patch by Roger Serwy. http://hg.python.org/cpython/rev/181c170c6270 ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14783> _______________________________________

1 0

[issue16634] urllib.error.HTTPError.reason is not documented
by Berker Peksag Dec. 9, 2012

Dec. 9, 2012

New submission from Berker Peksag: The "reason" attribute has been added to urllib.error.HTTPError in issue 13211. Related changeset: http://hg.python.org/cpython/rev/deb60efd32eb ---------- assignee: docs@python components: Documentation files: httperror-reason.diff keywords: patch messages: 177083 nosy: berker.peksag, docs@python priority: normal severity: normal status: open title: urllib.error.HTTPError.reason is not documented versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4 Added file: http://bugs.python.org/file28241/httperror-reason.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16634> _______________________________________

3 2

[issue16267] order of decorators @abstractmethod and @classmethod is significant (is not documented to be in @abstractclassmethod which advises their combined use)
by Christopher the Magnificent Dec. 9, 2012

Dec. 9, 2012

New submission from Christopher the Magnificent: This may be an issue with the interpreter behavior or it may be a documentation issue. Note: I only selected Python 3.3 as the version, but it probably affects MANY other Python versions. Python 3.3.0 (v3.3.0:bd8afb90ebf2, Sep 29 2012, 01:25:11) [GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin Type "copyright", "credits" or "license()" for more information. >>> import abc >>> help(abc.abstractclassmethod) Help on class abstractclassmethod in module abc: class abstractclassmethod(builtins.classmethod) | A decorator indicating abstract classmethods. | | Similar to abstractmethod. | | Usage: | | class C(metaclass=ABCMeta): | @abstractclassmethod | def my_abstract_classmethod(cls, ...): | ... | | 'abstractclassmethod' is deprecated. Use 'classmethod' with | 'abstractmethod' instead. . (et cetra) . . >>> # doesn't work >>> class Demo(metaclass=abc.ABCMeta): ... @abc.abstractmethod ... @classmethod ... def test(cls): ... pass ... Traceback (most recent call last): File "<pyshell#26>", line 1, in <module> class Demo3(metaclass=abc.ABCMeta): File "<pyshell#26>", line 3, in Demo3 @classmethod File "/Library/Frameworks/Python.framework/Versions/3.3/lib/python3.3/abc.py", line 24, in abstractmethod funcobj.__isabstractmethod__ = True AttributeError: attribute '__isabstractmethod__' of 'classmethod' objects is not writable >>> # DOES work >>> class Demo2(metaclass=abc.ABCMeta): ... @classmethod ... @abc.abstractmethod ... def test(cls): ... pass ... >>> Demo2() Traceback (most recent call last): File "<pyshell#33>", line 1, in <module> Demo4() TypeError: Can't instantiate abstract class Demo2 with abstract methods test Hopefully this is enough documentation to show what the issues is. If not, just chime in. :-) ---------- assignee: docs@python components: Documentation, Interpreter Core messages: 173183 nosy: christopherthemagnificent, docs@python priority: normal severity: normal status: open title: order of decorators @abstractmethod and @classmethod is significant (is not documented to be in @abstractclassmethod which advises their combined use) type: behavior versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16267> _______________________________________

9 14

[issue16598] Docs: double newlines printed in some file iteration examples
by Steven Kryskalla Dec. 8, 2012

Dec. 8, 2012

New submission from Steven Kryskalla: I heard someone complain about this code appearing in the official documentation in a few places: for line in open("file.txt"): print(line) This code will print two newlines. I went through the current "default" and "2.7" branches and changed the places where this occurred to use print(line, end="") for 3.x or "print line," for 2.x. r80699.patch is for the "default" branch (3.x) r80694.py27.patch is for the "2.7" branch ---------- assignee: docs@python components: Documentation files: r80699.patch hgrepos: 164 keywords: patch messages: 176824 nosy: docs@python, lost-theory priority: normal severity: normal status: open title: Docs: double newlines printed in some file iteration examples type: enhancement versions: Python 3.3, Python 3.4, Python 3.5 Added file: http://bugs.python.org/file28191/r80699.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16598> _______________________________________

3 5

[issue4395] Document auto __ne__ generation; provide a use case for non-trivial __ne__
by Chris Jerdonek Dec. 8, 2012

Dec. 8, 2012

Changes by Chris Jerdonek <chris.jerdonek(a)gmail.com>: ---------- nosy: +chris.jerdonek _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue4395> _______________________________________

1 0

[issue4395] Document auto __ne__ generation; provide a use case for non-trivial __ne__
by Nick Coghlan Dec. 8, 2012

Dec. 8, 2012

Changes by Nick Coghlan <ncoghlan(a)gmail.com>: ---------- nosy: +antocuni _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue4395> _______________________________________

1 0

[issue4395] Document auto __ne__ generation; provide a use case for non-trivial __ne__
by Nick Coghlan Dec. 8, 2012

Dec. 8, 2012

Changes by Nick Coghlan <ncoghlan(a)gmail.com>: ---------- nosy: +ncoghlan _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue4395> _______________________________________

1 0

[issue16609] float loses precision when passed to str()
by Terry J. Reedy Dec. 8, 2012

Dec. 8, 2012

Changes by Terry J. Reedy <tjreedy(a)udel.edu>: ---------- status: pending -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16609> _______________________________________

1 0

[issue14901] Python Windows FAQ is Very Outdated
by Ashish Nitin Patil Dec. 7, 2012

Dec. 7, 2012

Ashish Nitin Patil added the comment: Just added my name to the Misc/ACKS. ---------- Added file: http://bugs.python.org/file28250/faq+ack.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14901> _______________________________________

1 0

[issue14901] Python Windows FAQ is Very Outdated
by Ashish Nitin Patil Dec. 7, 2012

Dec. 7, 2012

Ashish Nitin Patil added the comment: Made most of the relevant changes & updation to the FAQ. 1. Updated references to Windows 7/XP/Vista & dropped all references & solutions on older Windows. 2. Also, many of the ending FAQs like cw3215mt.dll, CTL3D32 were completely dropped as I found that the googled pages show most results(pages) dating back more than 10 years. 3. Modified the questioon on 'freeze' to 'conversion from py to exe' 4. Did not touch questions that I am not familiar with, like CGI, os.kill(), etc. 5. Dropped questions that were directly in respect to older (unsupported) Windows. Any suggestion/correction is wel-received. My first patch! :-) \m/ ---------- keywords: +patch Added file: http://bugs.python.org/file28245/faq.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14901> _______________________________________

1 0

[issue14901] Python Windows FAQ is Very Outdated
by Ashish Nitin Patil Dec. 7, 2012

Dec. 7, 2012

Ashish Nitin Patil added the comment: Found this - http://docs.python.org/3/using/windows.html Seems like my work got a bit easy. Need to truncate the bits & bytes oof the document so as to fit with FAQ system. I think I will also need to do changes to the official wiki (online) too. Any help/suggestion is appreciated. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14901> _______________________________________

1 0

xml.etree.ElementTree.tostring
by Quarante-Deux Dec. 7, 2012

Dec. 7, 2012

Hello, For http://docs.python.org/2/library/xml.etree.elementtree.html#xml.etree.Eleme… could you please add that if the tag of the element is set to None, said tag is omitted in the resulting bytes: Python 3.3.0 (v3.3.0:bd8afb90ebf2, Sep 29 2012, 01:25:11) from xml.etree.ElementTree import fromstring, tostring e = fromstring('<xml>example accentué</xml>') tostring(e) --> b'<xml>example accentué</xml>' e.tag = None tostring(e) --> b'example accentué' Very handy in a templating context. Also, tostring returns bytes and should be named tobytes, actually :-) If what you really want is a string you should use : tostring(e, encoding='unicode') --> 'example accentué' Hum… Thank you. Quarante-Deux: quelques pages sur la SF Ellen C. Herzfeld - Dominique O. Martel http://www.quarante-deux.org/ - @xlii42 http://www.quarante-deux.org/index.atom

1 0

[issue14901] Python Windows FAQ is Very Outdated
by Ashish Nitin Patil Dec. 6, 2012

Dec. 6, 2012

Ashish Nitin Patil added the comment: Is anyone currently working on this issue? I am a newbie & am really looking forward to contributing, but, quite unsure of what exact changes need to be made to the FAQ documentation. The previous comments are very helpful & I am going to proceed with the same. Senior or Core developer suggestions/corrections are welcome anytime. ---------- nosy: +ashishnitinpatil _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14901> _______________________________________

1 0

sum()
by bob gailer Dec. 6, 2012

Dec. 6, 2012

Currently: sum(iterable[, start]) Sums start and the items of an iterable from left to right and returns the total. start defaults to 0. The iterable‘s items are normally numbers, and the start value is not allowed to be a string I just learned that sum([[1,2],[3,4]],[]) produces: [1, 2, 3, 4] I would never have guessed that from the explanation above! I think the terms "sum" and "total" are misleading. apply(operator.add, [[1,2], [3,4]]) generates the same result, but emphasizes the use of +. I suggest either explaining this explicitly or providing an example. -- Bob Gailer 919-636-4239 Chapel Hill NC

1 0

datetime.time inconsistency
by Sean Munkel Dec. 6, 2012

Dec. 6, 2012

In the 2.x (and 3.0) version of the python documentation, the arguments for datetime.time are listed as follows: datetime.time(hour[, minute[, second[, microsecond[, tzinfo]]]]) While the builtin python help() function says this: time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) The online documentation seems to suggest that "hour" is a required argument, which isn't the case.

2 1

[issue10589] I/O ABC docs should specify which methods have implementations
by Andrew Svetlov Dec. 6, 2012

Dec. 6, 2012

Andrew Svetlov added the comment: Fixed in a58204570a7c, 3cb85250a0a3, 93742b046519. ---------- assignee: stutzbach -> asvetlov resolution: -> fixed stage: patch review -> committed/rejected status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10589> _______________________________________

1 0

PEP 415
by Guth, Dwight Dec. 6, 2012

Dec. 6, 2012

This page: http://docs.python.org/3.3/whatsnew/3.3.html Needs to list PEP 415 in the see also for PEP 409, since PEP 409's implementation is out of date and no longer applies.

1 0

[issue8402] Add a function to escape metacharacters in glob/fnmatch
by Serhiy Storchaka Dec. 5, 2012

Dec. 5, 2012

Serhiy Storchaka added the comment: It is good, if stdlib has function for escaping any special characters, even if this function is simple. There are already escape functions for re and sgml/xml/html. Private function glob.glob1 used in Lib/msilib and Tools/msi to prevent unexpected globbing in parent directory name. ``glob.glob1(dirname, pattern)`` should be replaced by ``glob.glob(os.path.join(fnmatch.escape(dirname), pattern)`` in external code. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8402> _______________________________________

1 0

[issue16609] float loses precision when passed to str()
by Cal Leeming Dec. 4, 2012

Dec. 4, 2012

Changes by Cal Leeming <cal.leeming(a)simplicitymedialtd.co.uk>: ---------- status: open -> pending _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16609> _______________________________________

1 0

[issue16609] float loses precision when passed to str()
by Cal Leeming Dec. 4, 2012

Dec. 4, 2012

Cal Leeming added the comment: Actually, you do have a good point, this should have been using random.getrandbits really. ---------- status: pending -> open _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16609> _______________________________________

1 0

[issue16609] float loses precision when passed to str()
by Antoine Pitrou Dec. 4, 2012

Dec. 4, 2012

Antoine Pitrou added the comment: I agree with Mark here. This isn't specific to random.random() and it's already covered elsewhere in the documentation. Furthermore, I don't know why you're using str() on random.random(). There are better ways to get random strings, such as random.getrandbits() or os.urandom(). Recommend closing. ---------- nosy: +pitrou resolution: -> invalid status: open -> pending _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16609> _______________________________________

1 0

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

Dec. 4, 2012

R. David Murray added the comment: That's why I suggested a glossary entry. The relevant function description *does* contain the phrase "floating point", so a glossary link there would be reasonably natural. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16609> _______________________________________

1 0

[issue16609] float loses precision when passed to str()
by Mark Dickinson Dec. 4, 2012

Dec. 4, 2012

Changes by Mark Dickinson <dickinsm(a)gmail.com>: ---------- title: random.random() / float() loses precision when passed to str() -> float loses precision when passed to str() _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16609> _______________________________________

1 0

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

Dec. 4, 2012

Mark Dickinson added the comment: It is notable that this behaviour isn't described anywhere that I can find in the library manual or the reference manual. As David says, it applies only to 2.7; in 3.2 and later, `str` and `repr` are identical. > a glossary entry be added for 'floating point' which mentions it as a > 2.7 limitation That could work. I *really* don't think it should be linked to from the random docs, though; this has absolutely nothing to do with the random module, except that the random module happens to contain functions that can produce floats. Many other modules do that, too. Another option would be to add the information somewhere in http://docs.python.org/2/library/stdtypes.html#numeric-types-int-float-long… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16609> _______________________________________

1 0

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

Dec. 4, 2012

Cal Leeming added the comment: Many thanks for your lengthy response David. Sorry, my initial bug report stated it was Python 2.7. The tests I performed were actually on Python 2.6.6. I will take a look at how to contribute documentation updates, and once I've familiarized myself with it I'll submit a patch for review. Thanks again ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16609> _______________________________________

1 0

[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

[issue16585] surrogateescape broken w/ multibytecodecs' encode
by Walter Dörwald Dec. 2, 2012

Dec. 2, 2012

Walter Dörwald added the comment: And returning bytes is documented in PEP 383, as an extension to the PEP 293 machinery: """To convert non-decodable bytes, a new error handler ([2]) "surrogateescape" is introduced, which produces these surrogates. On encoding, the error handler converts the surrogate back to the corresponding byte. This error handler will be used in any API that receives or produces file names, command line arguments, or environment variables. The error handler interface is extended to allow the encode error handler to return byte strings immediately, in addition to returning Unicode strings which then get encoded again (also see the discussion below).""" ---------- nosy: +doerwalter _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16585> _______________________________________

1 0

[issue9650] format codes in time.strptime docstrings
by Éric Araujo Dec. 1, 2012

Dec. 1, 2012

Éric Araujo added the comment: Any reason to not backport this? ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9650> _______________________________________

1 0

[issue16589] PrettyPrinter docs is incomplete
by mindrones Dec. 1, 2012

Dec. 1, 2012

New submission from mindrones: Hi, at http://docs.python.org/2.7/library/pprint.html#pprint.PrettyPrinter we see: "class pprint.PrettyPrinter(...)" while at http://docs.python.org/3.3/library/pprint.html#pprint.PrettyPrinter we see: "class pprint.PrettyPrinter(indent=1, width=80, depth=None, stream=None)" I think the first case is a bug. Regards, Luca ---------- assignee: docs@python components: Documentation messages: 176745 nosy: docs@python, mindrones priority: normal severity: normal status: open title: PrettyPrinter docs is incomplete versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16589> _______________________________________

3 2