Mailman 3 October 2012 - docs

Problems with a unittest example and Python 3.3
by Pierazzo Mara Oct. 2, 2012

Oct. 2, 2012

I tried the very first example I found on the Python documentation at this address: http://docs.python.org/py3k/library/unittest.html#module-unittest import random import unittest class TestSequenceFunctions(unittest.TestCase): def setUp(self): self.seq = list(range(10)) def test_shuffle(self): # make sure the shuffled sequence does not lose any elements random.shuffle(self.seq) self.seq.sort() self.assertEqual(self.seq, list(range(10))) # should raise an exception for an immutable sequence self.assertRaises(TypeError, random.shuffle, (1,2,3)) def test_choice(self): element = random.choice(self.seq) self.assertTrue(element in self.seq) def test_sample(self): with self.assertRaises(ValueError): random.sample(self.seq, 20) for element in random.sample(self.seq, 5): self.assertTrue(element in self.seq) if __name__ == '__main__': unittest.main() On Python 2.7.1 this example used to work, as I was getting back this result: > Ran 3 tests in 0.001s > > OK but when I run this code on Python 3.3 I'm getting this error: Traceback (most recent call last): File "/Users/[USERNAME]/Desktop/prova.py", line 29, in <module> unittest.main() File "/Library/Frameworks/Python.framework/Versions/3.3/lib/python3.3/unittest/main.py", line 125, in __init__ self.runTests() File "/Library/Frameworks/Python.framework/Versions/3.3/lib/python3.3/unittest/main.py", line 263, in runTests sys.exit(not self.result.wasSuccessful()) SystemExit: False

2 1

Typo in /reference/datamodel.html
by Josh Helzer Oct. 2, 2012

Oct. 2, 2012

In http://docs.python.org/release/3.2.3/reference/datamodel.html#the-standard-… the description of Bytes sequence type: A bytes object is an immutable array. The items are 8-bit bytes, represented by integers in the range 0 <= x < 256. Bytes literals (like b'abc' and the built-in function bytes() can be used to construct bytes objects. Also, bytes objects can be decoded to strings via the decode() method. Missing closing parenthesis (or rewrite or whatever): A bytes object is an immutable array. The items are 8-bit bytes, represented by integers in the range 0 <= x < 256. Bytes literals (like b'abc'*)* and the built-in function bytes() can be used to construct bytes objects. Also, bytes objects can be decoded to strings via the decode() method. Saw this in 3.2.3, but it also seems to still exist in 3.4.0a0 docs.

2 1

Re: [docs] Small typo error in the ip_address module introduction
by Chris Jerdonek Oct. 2, 2012

Oct. 2, 2012

> Date: Sat, 29 Sep 2012 18:11:25 -0400 > From: Pierre Rouleau <prouleau.pers(a)gmail.com> > To: "docs(a)python.org" <docs(a)python.org> > Subject: [docs] Small typo error in the ip_address module introduction > > I found the following typo error inside the ip_address module introduction (http://docs.python.org/dev/howto/ipaddress.html). > > Inside the Host Interfaces section there is the following example: > >>>> ipaddress.ip_interface('192.0.2.1/24') IPv4Interface('192.0.2.1/24') >>> ipaddress.ip_network('2001:db8::1/96') IPv6Interface('2001:db8::1/96') > the second statement should call the ip_interface method instead of the ip_network one. Hi Pierre, thanks for the report. There is currently an issue for this (and similar errors) here: http://bugs.python.org/issue15888 I expect that a fix will be committed shortly. Thanks, --Chris

1 0

[issue3849] FUD in documentation for urllib.urlopen()
by Chris Jerdonek Oct. 2, 2012

Oct. 2, 2012

Chris Jerdonek added the comment: The section of the Dev Guide on "affirmative tone" should also be applied: "The documentation focuses on affirmatively stating what the language does and how to use it effectively...." http://docs.python.org/devguide/documenting.html#affirmative-tone ---------- nosy: +chris.jerdonek _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue3849> _______________________________________

1 0

[issue3849] FUD in documentation for urllib.urlopen()
by Ezio Melotti Oct. 2, 2012

Oct. 2, 2012

Changes by Ezio Melotti <ezio.melotti(a)gmail.com>: ---------- keywords: +easy versions: +Python 2.7 -Python 2.6, Python 3.0 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue3849> _______________________________________

1 0

[issue15979] Improve timeit documentation
by Ezio Melotti Oct. 2, 2012

Oct. 2, 2012

New submission from Ezio Melotti: The documentation of timeit can be improved in several ways: * it should start with a couple of short and comprehensible examples that show the basic usage from the command-line and from the code; * the 3 convenience functions should be moved before the class documentation (and their order inverted); * the methods in the class should be reordered to show the important one first; * more comprehensive (but still comprehensible) examples should be added at the end; * sh syntax highlight should be used for the command-line usage examples; * the note about Python 2.3 can be removed from 3.x docs; http://docs.python.org/dev/library/timeit.html ---------- assignee: docs@python components: Documentation messages: 170785 nosy: docs@python, ezio.melotti priority: normal severity: normal stage: needs patch status: open title: Improve timeit documentation type: enhancement versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15979> _______________________________________

5 9

Enhancement to http://docs.python.org/py3k/library/readline.html?highlight=readline#readline
by Jonathan Hayward Oct. 1, 2012

Oct. 1, 2012

http://docs.python.org/py3k/library/readline.html?highlight=readline#readli… a number of things about readline. However, it does not tell how to use the readline library as a bigger and better souped-up sys.stdin.readline(). I gave up and asked on StackOverflow, where someone told me that input() will take advantage of any readline import, which helped me but wasn't the answer because I wasn't trying to emulate the Python interpreter and treat lines as automatically Python commands. That documentation referred to me what I needed to know, namely that if I wanted to improve on sys.stdin.readline(), I should import readline and call raw_input(). There are a couple of examples provided on the page, but none of them hints at how to use readline to get a bigger and better sys.stdin.readline(). -- [image: Christos Jonathan Hayward] <http://jonathanscorner.com/> Christos Jonathan Hayward, an Orthodox Christian author. *Amazon <http://amazon.com/author/cjshayward>* • Author Bio<http://jonathanscorner.com/author/> • *Email <christos.jonathan.hayward(a)gmail.com>* • Facebook<http://www.facebook.com/christos.jonathan.hayward> • Google Plus <http://jonathanscorner.com/plus> • *Kindle<http://stornge.com/amazon> * • LinkedIn <http://www.linkedin.com/in/jonathanhayward> • *Professional<http://jonathanhayward.com/> * • Twitter <http://twitter.com/JonathansCorner> • *Web<http://jonathanscorner.com/> * • What's New? <http://jonathanscorner.com/> I invite you to visit my "theology, literature, and other creative works" site. *See one page of my website! <http://random.jonathanscorner.com/>*

1 0

[issue14783] Make int() and str() docstrings correct
by Chris Jerdonek Oct. 1, 2012

Oct. 1, 2012

Chris Jerdonek added the comment: Attaching proposed patch. This updates the docstrings for int() and str(), as well as for range() and slice() in a similar way. It also makes the documentation for str() closer to that of the docstring. The documentation for int(), range(), and slice() has already been updated along the lines of this patch. ---------- keywords: +needs review stage: needs patch -> patch review Added file: http://bugs.python.org/file27370/issue-14783-1-default.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14783> _______________________________________

1 0

Re: [docs] simplify int() signature docs (issue 16036)
by ezio.melotti＠gmail.com Oct. 1, 2012

Oct. 1, 2012

http://bugs.python.org/review/16036/diff/6079/Doc/library/functions.rst File Doc/library/functions.rst (right): http://bugs.python.org/review/16036/diff/6079/Doc/library/functions.rst#new… Doc/library/functions.rst:636: arguments are given. If *x* is a number, return :meth:`x.__int__() On 2012/10/01 01:45:03, cvrebert wrote: > How is "number-ness" determined? Are we just assuming anything with an __int__() > method is a number for purposes of explanation? Yes. http://bugs.python.org/review/16036/diff/6079/Doc/library/functions.rst#new… Doc/library/functions.rst:650: ``int('010')`` is, as well as ``int('010', 8)``. On 2012/10/01 01:45:03, cvrebert wrote: > Shouldn't we mention somewhere that this raises ValueError and TypeError? This paragraph might be rephrased a bit. http://bugs.python.org/review/16036/

1 0