From report at bugs.python.org  Sun Aug  1 08:40:22 2010
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 01 Aug 2010 06:40:22 +0000
Subject: [docs] [issue4600] __class__ assignment: new-style? heap? ==
	confusing
In-Reply-To: <1228771522.72.0.688992536212.issue4600@psf.upfronthosting.co.za>
Message-ID: <1280644822.41.0.675878870324.issue4600@psf.upfronthosting.co.za>


Changes by Georg Brandl <georg at python.org>:


----------
assignee:  -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue4600>
_______________________________________

From report at bugs.python.org  Sun Aug  1 10:10:44 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Sun, 01 Aug 2010 08:10:44 +0000
Subject: [docs] [issue6128] Consequences of using Py_TPFLAGS_HAVE_GC are
	incompletely	explained
In-Reply-To: <1243457336.14.0.579311647458.issue6128@psf.upfronthosting.co.za>
Message-ID: <1280650244.42.0.760030679356.issue6128@psf.upfronthosting.co.za>


Mark Lawrence <breamoreboy at yahoo.co.uk> added the comment:

Can someone in the know provide a doc patch for this?

----------
assignee: georg.brandl -> docs at python
nosy: +BreamoreBoy, docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6128>
_______________________________________

From report at bugs.python.org  Sun Aug  1 11:01:52 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Sun, 01 Aug 2010 09:01:52 +0000
Subject: [docs] [issue6187] Improvement in doc of "Extending and Embedding
	the Python	Interpreter,
	5.3 Beyond Very High Level Embedding: An overview"
In-Reply-To: <1244028468.87.0.409088876389.issue6187@psf.upfronthosting.co.za>
Message-ID: <1280653311.89.0.353506998843.issue6187@psf.upfronthosting.co.za>


Mark Lawrence <breamoreboy at yahoo.co.uk> added the comment:

I don't see why this needs to be done, the 2nd paragraph of the doc is pretty explicit.

"This document assumes basic knowledge about Python. For an informal introduction to the language, see The Python Tutorial. The Python Language Reference gives a more formal definition of the language. The Python Standard Library documents the existing object types, functions and modules (both built-in and written in Python) that give the language its wide application range."

----------
assignee: georg.brandl -> docs at python
nosy: +BreamoreBoy, docs at python
versions: +Python 3.2 -Python 2.5, Python 2.6, Python 3.0

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6187>
_______________________________________

From report at bugs.python.org  Sun Aug  1 11:13:41 2010
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 01 Aug 2010 09:13:41 +0000
Subject: [docs] [issue6187] Improvement in doc of "Extending and Embedding
	the Python	Interpreter,
	5.3 Beyond Very High Level Embedding: An overview"
In-Reply-To: <1244028468.87.0.409088876389.issue6187@psf.upfronthosting.co.za>
Message-ID: <1280654021.51.0.748353495422.issue6187@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Agreed with Mark.

----------
resolution:  -> works for me
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6187>
_______________________________________

From report at bugs.python.org  Sun Aug  1 13:39:46 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Sun, 01 Aug 2010 11:39:46 +0000
Subject: [docs] [issue6696] Profile objects should be documented
In-Reply-To: <1250182637.82.0.304646827828.issue6696@psf.upfronthosting.co.za>
Message-ID: <1280662786.03.0.691882900141.issue6696@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6696>
_______________________________________

From report at bugs.python.org  Sun Aug  1 16:52:14 2010
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 01 Aug 2010 14:52:14 +0000
Subject: [docs] [issue8602] documentation of bz2 module mildly erroneous
In-Reply-To: <1272870234.45.0.00658969889364.issue8602@psf.upfronthosting.co.za>
Message-ID: <1280674334.67.0.347593104829.issue8602@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Now present in all maintained branches.

----------
nosy: +georg.brandl
resolution:  -> out of date
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8602>
_______________________________________

From report at bugs.python.org  Mon Aug  2 00:53:50 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sun, 01 Aug 2010 22:53:50 +0000
Subject: [docs] [issue9451] Strengthen __*__ system name warning
In-Reply-To: <1280703230.07.0.461844472434.issue9451@psf.upfronthosting.co.za>
Message-ID: <1280703230.07.0.461844472434.issue9451@psf.upfronthosting.co.za>


New submission from Terry J. Reedy <tjreedy at udel.edu>:

Current" 2.3.2. Reserved classes of identifiers
"__*__
    System-defined names. These names are defined by the interpreter and its implementation (including the standard library); applications should not expect to define additional names using this convention. The set of names of this class defined by Python may be extended in future versions. See section Special method names."

Current pydev thread,Is it intentional that "sys.__debug__ = 1" is illegal in Python 2.7?, Guido said;
"But yes, the docs should clarify that *any* use of __*__ names, in
any* context, that does not follow explicitly documented use, is
subject to breakage without warning."

I think I would replace the current "applications ... convention" with Guido's sentence, starting with "*Any* use", though I might put it at the end as the second most important sentence of the paragraph.

Until this thread, I did not understand the import of 'expect to' in that middle sentence. Apparently, it means that if a definition works now, it may become invalid in the future if it becomes not just a system word, but a reserved word like __debug__ did. Guido's sentence covers this case and all others, so the current sentence would no longer be needed.

----------
assignee: docs at python
components: Documentation
messages: 112395
nosy: docs at python, tjreedy
priority: normal
severity: normal
status: open
title: Strengthen __*__ system name warning
versions: Python 2.7, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9451>
_______________________________________

From report at bugs.python.org  Mon Aug  2 01:01:12 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sun, 01 Aug 2010 23:01:12 +0000
Subject: [docs] [issue9451] Strengthen __*__ system name warning
In-Reply-To: <1280703230.07.0.461844472434.issue9451@psf.upfronthosting.co.za>
Message-ID: <1280703672.47.0.572315289523.issue9451@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Suggested rewrite:
"System-defined names. These names are defined by the interpreter and its implementation (including the standard library). Current system names are discussed in the Special method names section and elsewhere. More will likely be defined in future versions of Python. *Any* use of __*__ names, in any* context, that does not follow explicitly documented use, is
subject to breakage without warning.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9451>
_______________________________________

From report at bugs.python.org  Mon Aug  2 01:02:18 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sun, 01 Aug 2010 23:02:18 +0000
Subject: [docs] [issue9451] Strengthen __*__ system name warning
In-Reply-To: <1280703230.07.0.461844472434.issue9451@psf.upfronthosting.co.za>
Message-ID: <1280703738.17.0.00538700386798.issue9451@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
dependencies: +Clarify __debug__ restrictions

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9451>
_______________________________________

From report at bugs.python.org  Mon Aug  2 11:03:03 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Mon, 02 Aug 2010 09:03:03 +0000
Subject: [docs] [issue763043] unable to specify another compiler
Message-ID: <1280739783.01.0.210206549295.issue763043@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

The bug has been fixed in 2.3, apparently it?s a doc bug now, so reassigning.

----------
assignee: tarek -> docs at python
nosy: +docs at python, merwok
versions: +Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue763043>
_______________________________________

From report at bugs.python.org  Mon Aug  2 11:30:45 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Mon, 02 Aug 2010 09:30:45 +0000
Subject: [docs] [issue9106] remove numbers from 3-.. level entries in docs
	toc
In-Reply-To: <1277749704.58.0.992065909356.issue9106@psf.upfronthosting.co.za>
Message-ID: <1280741445.37.0.615585511872.issue9106@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

(Rationale for this resolution: On #3143, it was used to remind us to change a setting in Doc/conf.py after the switch to a new version of Sphinx with the new feature.)

----------
resolution: invalid -> remind

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9106>
_______________________________________

From report at bugs.python.org  Mon Aug  2 15:39:40 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Mon, 02 Aug 2010 13:39:40 +0000
Subject: [docs] [issue1581182] Definition of a "character" is wrong
Message-ID: <1280756380.58.0.496568638474.issue1581182@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
assignee:  -> docs at python
nosy: +docs at python
stage:  -> needs patch
versions: +Python 2.6, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1581182>
_______________________________________

From report at bugs.python.org  Mon Aug  2 18:12:18 2010
From: report at bugs.python.org (Barry A. Warsaw)
Date: Mon, 02 Aug 2010 16:12:18 +0000
Subject: [docs] [issue9264] trace.py documentation is incomplete
In-Reply-To: <1279167085.71.0.92983376648.issue9264@psf.upfronthosting.co.za>
Message-ID: <1280765537.83.0.229473949416.issue9264@psf.upfronthosting.co.za>


Barry A. Warsaw <barry at python.org> added the comment:

You have about 5 hours as of this writing to apply the doc patch for Python 2.6.6 rc1 and then it will be too late to get it into Python 2.6.6 (though I might make an exception for doc-only patches like this, for post rc1).

While I haven't built the docs, I don't have any objections to the patches.  If the docs build and look right, JFDI!

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9264>
_______________________________________

From report at bugs.python.org  Mon Aug  2 18:12:37 2010
From: report at bugs.python.org (Barry A. Warsaw)
Date: Mon, 02 Aug 2010 16:12:37 +0000
Subject: [docs] [issue9264] trace.py documentation is incomplete
In-Reply-To: <1279167085.71.0.92983376648.issue9264@psf.upfronthosting.co.za>
Message-ID: <1280765557.91.0.952836765856.issue9264@psf.upfronthosting.co.za>


Changes by Barry A. Warsaw <barry at python.org>:


----------
priority: release blocker -> high

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9264>
_______________________________________

From report at bugs.python.org  Mon Aug  2 18:22:12 2010
From: report at bugs.python.org (Alexander Belopolsky)
Date: Mon, 02 Aug 2010 16:22:12 +0000
Subject: [docs] [issue9264] trace.py documentation is incomplete
In-Reply-To: <1279167085.71.0.92983376648.issue9264@psf.upfronthosting.co.za>
Message-ID: <1280766131.88.0.426838330257.issue9264@psf.upfronthosting.co.za>


Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

I'll try to meet the deadline. :-)

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9264>
_______________________________________

From report at bugs.python.org  Mon Aug  2 18:23:52 2010
From: report at bugs.python.org (Alexander Belopolsky)
Date: Mon, 02 Aug 2010 16:23:52 +0000
Subject: [docs] [issue9264] trace.py documentation is incomplete
In-Reply-To: <1279167085.71.0.92983376648.issue9264@psf.upfronthosting.co.za>
Message-ID: <1280766232.03.0.863882360652.issue9264@psf.upfronthosting.co.za>


Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

Oh, this is not assigned to me.  Terry, do you need help with this?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9264>
_______________________________________

From report at bugs.python.org  Mon Aug  2 20:22:48 2010
From: report at bugs.python.org (Barry A. Warsaw)
Date: Mon, 02 Aug 2010 18:22:48 +0000
Subject: [docs] [issue9061] cgi.escape Can Lead To XSS Vulnerabilities
In-Reply-To: <1277307995.11.0.923855376948.issue9061@psf.upfronthosting.co.za>
Message-ID: <1280773368.66.0.518332030078.issue9061@psf.upfronthosting.co.za>


Barry A. Warsaw <barry at python.org> added the comment:

Unless someone can upload a specific patch to review in the next couple of hours, I'm going to reduce the priority for 2.6.6rc1.

----------
nosy: +barry

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9061>
_______________________________________

From report at bugs.python.org  Mon Aug  2 20:33:30 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 18:33:30 +0000
Subject: [docs] [issue9061] cgi.escape Can Lead To XSS Vulnerabilities
In-Reply-To: <1277307995.11.0.923855376948.issue9061@psf.upfronthosting.co.za>
Message-ID: <1280774010.25.0.218606622423.issue9061@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Applied doc patch to 2.6 in r83539.

----------
nosy: +georg.brandl
priority: release blocker -> critical
versions:  -Python 2.5, Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9061>
_______________________________________

From report at bugs.python.org  Mon Aug  2 20:34:42 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Mon, 02 Aug 2010 18:34:42 +0000
Subject: [docs] [issue9451] Strengthen __*__ system name warning
In-Reply-To: <1280703230.07.0.461844472434.issue9451@psf.upfronthosting.co.za>
Message-ID: <1280774082.15.0.13790595775.issue9451@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
keywords: +patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9451>
_______________________________________

From report at bugs.python.org  Mon Aug  2 20:52:04 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Mon, 02 Aug 2010 18:52:04 +0000
Subject: [docs] [issue9264] trace.py documentation is incomplete
In-Reply-To: <1279167085.71.0.92983376648.issue9264@psf.upfronthosting.co.za>
Message-ID: <1280775124.86.0.860885285837.issue9264@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

I cannot do commits yet, so please do it. I expected this to be picked up by a doc person.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9264>
_______________________________________

From report at bugs.python.org  Mon Aug  2 21:29:00 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 19:29:00 +0000
Subject: [docs] [issue3849] FUD in documentation for urllib.urlopen()
In-Reply-To: <1221246343.23.0.128587140594.issue3849@psf.upfronthosting.co.za>
Message-ID: <1280777340.98.0.517960824194.issue3849@psf.upfronthosting.co.za>


Changes by Georg Brandl <georg at python.org>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue3849>
_______________________________________

From report at bugs.python.org  Mon Aug  2 21:33:09 2010
From: report at bugs.python.org (Alexander Belopolsky)
Date: Mon, 02 Aug 2010 19:33:09 +0000
Subject: [docs] [issue9264] trace.py documentation is incomplete
In-Reply-To: <1279167085.71.0.92983376648.issue9264@psf.upfronthosting.co.za>
Message-ID: <1280777588.94.0.839010113882.issue9264@psf.upfronthosting.co.za>


Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

Committed in release26-maint, r83549, to beat the rc1 deadline.   I'll comment on a few improvements that we can do for 3.x later.

Eli,

I needed to fix white space issues in your patch before committing.  Please run make patchcheck on your changes before posting a patch.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9264>
_______________________________________

From report at bugs.python.org  Mon Aug  2 21:33:11 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 19:33:11 +0000
Subject: [docs] [issue9451] Strengthen __*__ system name warning
In-Reply-To: <1280703230.07.0.461844472434.issue9451@psf.upfronthosting.co.za>
Message-ID: <1280777591.3.0.271677516864.issue9451@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Thanks, applied in r83550.

----------
dependencies:  -Clarify __debug__ restrictions
nosy: +georg.brandl
resolution:  -> accepted
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9451>
_______________________________________

From report at bugs.python.org  Mon Aug  2 21:50:27 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 19:50:27 +0000
Subject: [docs] [issue8562] hasattr(open,
	'newlines') example gives incorrect results from  PEP0278
In-Reply-To: <1272483941.45.0.330180944367.issue8562@psf.upfronthosting.co.za>
Message-ID: <1280778627.25.0.812241518821.issue8562@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Fixed in r83556.

----------
nosy: +georg.brandl
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8562>
_______________________________________

From report at bugs.python.org  Mon Aug  2 22:05:29 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 20:05:29 +0000
Subject: [docs] [issue8648] The UTF-7 codec functions are undocumented
In-Reply-To: <1273248636.7.0.217932609429.issue8648@psf.upfronthosting.co.za>
Message-ID: <1280779529.0.0.36009581598.issue8648@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Thanks, fixed in r83558.

----------
nosy: +georg.brandl
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8648>
_______________________________________

From report at bugs.python.org  Mon Aug  2 22:21:30 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 20:21:30 +0000
Subject: [docs] [issue9037] Add explanation as to how to raise a custom
	exception in	the extending python intermezzo on exceptions
In-Reply-To: <1277052906.52.0.842872873757.issue9037@psf.upfronthosting.co.za>
Message-ID: <1280780489.91.0.0388144201824.issue9037@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Added in r83563. Thanks!

----------
nosy: +georg.brandl
resolution:  -> accepted
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9037>
_______________________________________

From report at bugs.python.org  Mon Aug  2 22:39:43 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 20:39:43 +0000
Subject: [docs] [issue7797] base64 module docs should indicate that encode
	methods	return bytes, not strings
In-Reply-To: <1264657234.88.0.361902382991.issue7797@psf.upfronthosting.co.za>
Message-ID: <1280781583.51.0.0959201737471.issue7797@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Thanks, fixed in r83569.

----------
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7797>
_______________________________________

From report at bugs.python.org  Mon Aug  2 22:48:06 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 20:48:06 +0000
Subject: [docs] [issue6867] return value of epoll.register
In-Reply-To: <1252461480.6.0.183531606536.issue6867@psf.upfronthosting.co.za>
Message-ID: <1280782086.66.0.180983786719.issue6867@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Thanks, fixed in r83574.

----------
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6867>
_______________________________________

From report at bugs.python.org  Mon Aug  2 22:52:20 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 20:52:20 +0000
Subject: [docs] [issue9238] zipfile incorrectly documented as not supporting
	archive	comments
In-Reply-To: <1278977604.77.0.794237265554.issue9238@psf.upfronthosting.co.za>
Message-ID: <1280782340.38.0.0932935001809.issue9238@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Thanks, fixed in r83575.

----------
nosy: +georg.brandl
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9238>
_______________________________________

From report at bugs.python.org  Mon Aug  2 22:57:19 2010
From: report at bugs.python.org (Uli Kunitz)
Date: Mon, 02 Aug 2010 20:57:19 +0000
Subject: [docs] [issue9457] Wrong URL in Python-3.2a1/README
In-Reply-To: <1280782638.63.0.373315662844.issue9457@psf.upfronthosting.co.za>
Message-ID: <1280782638.63.0.373315662844.issue9457@psf.upfronthosting.co.za>


New submission from Uli Kunitz <uli.kunitz at googlemail.com>:

The URL http://docs.python.org/dev/3.2/whatsnew/3.2.html is wrong. It should be replaced with http://docs.python.org/dev/whatsnew/3.2.html.

----------
assignee: docs at python
components: Documentation
messages: 112548
nosy: docs at python, kune
priority: normal
severity: normal
status: open
title: Wrong URL in Python-3.2a1/README
versions: Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9457>
_______________________________________

From report at bugs.python.org  Mon Aug  2 22:57:57 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 20:57:57 +0000
Subject: [docs] [issue6696] Profile objects should be documented
In-Reply-To: <1250182637.82.0.304646827828.issue6696@psf.upfronthosting.co.za>
Message-ID: <1280782677.19.0.540218942263.issue6696@psf.upfronthosting.co.za>


Changes by Georg Brandl <georg at python.org>:


----------
priority: normal -> high

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6696>
_______________________________________

From report at bugs.python.org  Mon Aug  2 23:07:23 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 02 Aug 2010 21:07:23 +0000
Subject: [docs] [issue9457] Wrong URL in Python-3.2a1/README
In-Reply-To: <1280782638.63.0.373315662844.issue9457@psf.upfronthosting.co.za>
Message-ID: <1280783243.56.0.065321458702.issue9457@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Thanks, fixed in r83584.

----------
nosy: +georg.brandl
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9457>
_______________________________________

From report at bugs.python.org  Tue Aug  3 14:21:25 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 03 Aug 2010 12:21:25 +0000
Subject: [docs] [issue9061] cgi.escape Can Lead To XSS Vulnerabilities
In-Reply-To: <1277307995.11.0.923855376948.issue9061@psf.upfronthosting.co.za>
Message-ID: <1280838084.89.0.565540922743.issue9061@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Are 2.6 docs built by an older Sphinx version? I wonder why the text uses ?the :func:`quoteattr` function in the :mod:`xml.sax.saxutils` module? and not ?:func:`~xml.sax.saxutils.quoteattr? to get a direct link (or even just ?consider using :func:`xml.sax.saxutils.quoteattr`.?).

----------
nosy: +merwok

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9061>
_______________________________________

From report at bugs.python.org  Tue Aug  3 14:25:05 2010
From: report at bugs.python.org (Georg Brandl)
Date: Tue, 03 Aug 2010 12:25:05 +0000
Subject: [docs] [issue9061] cgi.escape Can Lead To XSS Vulnerabilities
In-Reply-To: <1277307995.11.0.923855376948.issue9061@psf.upfronthosting.co.za>
Message-ID: <1280838305.48.0.356769333408.issue9061@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

No, that's just a relic from the olden LaTeX days, and I've not paid attention enough to fix it :)

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9061>
_______________________________________

From report at bugs.python.org  Tue Aug  3 15:13:24 2010
From: report at bugs.python.org (Fred L. Drake, Jr.)
Date: Tue, 03 Aug 2010 13:13:24 +0000
Subject: [docs] [issue9061] cgi.escape Can Lead To XSS Vulnerabilities
In-Reply-To: <1280838305.48.0.356769333408.issue9061@psf.upfronthosting.co.za>
Message-ID: <AANLkTi=OxwQ7-sS9v-F_0XLiy-wWwa2tEdC0EX0b35uJ@mail.gmail.com>


Fred L. Drake, Jr. <fdrake at acm.org> added the comment:

Such constructs are notoriously tedious to grep for; patches are welcome.

----------
nosy: +fdrake

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9061>
_______________________________________

From report at bugs.python.org  Tue Aug  3 18:50:44 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Tue, 03 Aug 2010 16:50:44 +0000
Subject: [docs] [issue7186] Document specialness of __doc__,
	and possibly other "special" attributes
In-Reply-To: <1256240855.61.0.550470965616.issue7186@psf.upfronthosting.co.za>
Message-ID: <1280854244.5.0.467941688977.issue7186@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7186>
_______________________________________

From report at bugs.python.org  Tue Aug  3 18:59:22 2010
From: report at bugs.python.org (Antoine Pitrou)
Date: Tue, 03 Aug 2010 16:59:22 +0000
Subject: [docs] [issue7828] chr() and ord() documentation for wide characters
In-Reply-To: <1264999918.27.0.407460194608.issue7828@psf.upfronthosting.co.za>
Message-ID: <1280854762.84.0.857728537441.issue7828@psf.upfronthosting.co.za>


Changes by Antoine Pitrou <pitrou at free.fr>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python, haypo
versions:  -Python 2.6, Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7828>
_______________________________________

From report at bugs.python.org  Tue Aug  3 22:20:40 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Tue, 03 Aug 2010 20:20:40 +0000
Subject: [docs] [issue5824] SocketServer.DatagramRequestHandler Broken under
	Linux
In-Reply-To: <1240525238.53.0.858571250541.issue5824@psf.upfronthosting.co.za>
Message-ID: <1280866839.94.0.930695295376.issue5824@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Same comment is in 3.1.2 socketserver.py.

Jim, can you at least suggest a specific text change at a specific place for the doc? That would likely be applied.

----------
assignee:  -> docs at python
components: +Documentation -Library (Lib)
nosy: +docs at python, tjreedy
versions: +Python 2.7, Python 3.1, Python 3.2 -Python 2.4, Python 2.5, Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5824>
_______________________________________

From report at bugs.python.org  Tue Aug  3 22:37:34 2010
From: report at bugs.python.org (Yitz Gale)
Date: Tue, 03 Aug 2010 20:37:34 +0000
Subject: [docs] [issue9498] stdtypes.rst should refer to sys.float_info
In-Reply-To: <1280867854.52.0.518299717843.issue9498@psf.upfronthosting.co.za>
Message-ID: <1280867854.52.0.518299717843.issue9498@psf.upfronthosting.co.za>


New submission from Yitz Gale <gale at sefer.org>:

Library docs section 5.4 "Numeric Types" states about floating point numbers that "all bets on their precision are off unless you happen to know the machine you are working with."

That has not been true since Python 2.6, when sys.float_info was added. There should be a reference to that here instead of that statement.

In addition, that paragraph mentions that both float and complex are "implemented using double in C". There is no longer any special reason to mention how those are implemented in C, any more than anything else in Python. Everything you need to know about the implementation is in sys.float_info. (Well, almost everything, see #9192.)

The attached patch is for the Python 3.2 branch.

----------
assignee: docs at python
components: Documentation
files: stdtypes_float_info.patch
keywords: patch
messages: 112670
nosy: docs at python, ygale
priority: normal
severity: normal
status: open
title: stdtypes.rst should refer to sys.float_info
type: behavior
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2
Added file: http://bugs.python.org/file18353/stdtypes_float_info.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9498>
_______________________________________

From report at bugs.python.org  Tue Aug  3 22:39:28 2010
From: report at bugs.python.org (Georg Brandl)
Date: Tue, 03 Aug 2010 20:39:28 +0000
Subject: [docs] [issue9498] stdtypes.rst should refer to sys.float_info
In-Reply-To: <1280867854.52.0.518299717843.issue9498@psf.upfronthosting.co.za>
Message-ID: <1280867968.46.0.170058985652.issue9498@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Mark, does this look ok to you?

----------
assignee: docs at python -> mark.dickinson
nosy: +georg.brandl, mark.dickinson

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9498>
_______________________________________

From report at bugs.python.org  Tue Aug  3 22:45:17 2010
From: report at bugs.python.org (Mark Dickinson)
Date: Tue, 03 Aug 2010 20:45:17 +0000
Subject: [docs] [issue9498] stdtypes.rst should refer to sys.float_info
In-Reply-To: <1280867854.52.0.518299717843.issue9498@psf.upfronthosting.co.za>
Message-ID: <1280868317.53.0.93124908501.issue9498@psf.upfronthosting.co.za>


Mark Dickinson <dickinsm at gmail.com> added the comment:

+1 for the reference to sys.float_info.

I'd prefer to keep the mention of C doubles, though.  You have to know what you're looking for to get this information from looking at sys.float_info.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9498>
_______________________________________

From report at bugs.python.org  Tue Aug  3 23:03:08 2010
From: report at bugs.python.org (Yitz Gale)
Date: Tue, 03 Aug 2010 21:03:08 +0000
Subject: [docs] [issue9498] stdtypes.rst should refer to sys.float_info
In-Reply-To: <1280867854.52.0.518299717843.issue9498@psf.upfronthosting.co.za>
Message-ID: <1280869388.88.0.705245767144.issue9498@psf.upfronthosting.co.za>


Yitz Gale <gale at sefer.org> added the comment:

It's not necessarily true for other than CPython, and it could theoretically not be true someday on some weird platform even for CPython.
 
How about just adding this: "Floating point numbers are usually implemented using double in C." Then at least we're not committing ourselves to anything.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9498>
_______________________________________

From report at bugs.python.org  Tue Aug  3 23:06:33 2010
From: report at bugs.python.org (Mark Dickinson)
Date: Tue, 03 Aug 2010 21:06:33 +0000
Subject: [docs] [issue9498] stdtypes.rst should refer to sys.float_info
In-Reply-To: <1280867854.52.0.518299717843.issue9498@psf.upfronthosting.co.za>
Message-ID: <1280869593.66.0.292381132386.issue9498@psf.upfronthosting.co.za>


Mark Dickinson <dickinsm at gmail.com> added the comment:

> it could theoretically not be true someday on some weird platform even for CPython.

Granted.  Though it would be quite a major change: the 'double' part is heavily hard-coded throughout.

> How about just adding this: "Floating point numbers are usually
> implemented using double in C." Then at least we're not committing 
> ourselves to anything.

That sounds fine to me.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9498>
_______________________________________

From report at bugs.python.org  Tue Aug  3 23:31:47 2010
From: report at bugs.python.org (Yitz Gale)
Date: Tue, 03 Aug 2010 21:31:47 +0000
Subject: [docs] [issue9498] stdtypes.rst should refer to sys.float_info
In-Reply-To: <1280867854.52.0.518299717843.issue9498@psf.upfronthosting.co.za>
Message-ID: <1280871107.14.0.067693846763.issue9498@psf.upfronthosting.co.za>


Changes by Yitz Gale <gale at sefer.org>:


Added file: http://bugs.python.org/file18355/stdtypes_float_info_2.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9498>
_______________________________________

From report at bugs.python.org  Tue Aug  3 23:35:47 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Tue, 03 Aug 2010 21:35:47 +0000
Subject: [docs] [issue6634] sys.exit() called from threads other than the
	main one:	undocumented behaviour
In-Reply-To: <1249327311.32.0.926815032903.issue6634@psf.upfronthosting.co.za>
Message-ID: <1280871347.42.0.772870326706.issue6634@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Please suggest a specific doc change at a specific location.
IE, how *should* they read, not just what is wrong.

----------
assignee: georg.brandl -> docs at python
nosy: +docs at python, tjreedy -georg.brandl
stage:  -> needs patch
versions: +Python 3.2 -Python 2.4, Python 2.5, Python 2.6, Python 3.0

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6634>
_______________________________________

From report at bugs.python.org  Tue Aug  3 23:50:01 2010
From: report at bugs.python.org (=?utf-8?q?=C5=81ukasz_Langa?=)
Date: Tue, 03 Aug 2010 21:50:01 +0000
Subject: [docs] [issue2204] document ConfigParser behaviour when a file has
	same	section multiple times
In-Reply-To: <1204236720.35.0.634026900248.issue2204@psf.upfronthosting.co.za>
Message-ID: <1280872201.28.0.317022871149.issue2204@psf.upfronthosting.co.za>


?ukasz Langa <lukasz at langa.pl> added the comment:

This bug is superseded by #9452 where the patch includes a `strict=` argument to __init__ which enables checking for section duplicates when reading from a single source.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue2204>
_______________________________________

From report at bugs.python.org  Tue Aug  3 23:54:10 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 03 Aug 2010 21:54:10 +0000
Subject: [docs] [issue2204] document ConfigParser behaviour when a file has
	same	section multiple times
In-Reply-To: <1204236720.35.0.634026900248.issue2204@psf.upfronthosting.co.za>
Message-ID: <1280872450.56.0.847528767435.issue2204@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
resolution:  -> duplicate
stage: needs patch -> committed/rejected
status: open -> closed
superseder:  -> configparser support for reading from strings and dictionaries

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue2204>
_______________________________________

From report at bugs.python.org  Wed Aug  4 00:12:15 2010
From: report at bugs.python.org (Campbell Barton)
Date: Tue, 03 Aug 2010 22:12:15 +0000
Subject: [docs] [issue9499] Python C/API Execution namespace undocumented.
	(patch	included)
In-Reply-To: <1280873534.19.0.920563075759.issue9499@psf.upfronthosting.co.za>
Message-ID: <1280873534.19.0.920563075759.issue9499@psf.upfronthosting.co.za>


New submission from Campbell Barton <ideasman42 at gmail.com>:

Some parts of the python api expect __main__ module dictionary to be the namespace when executing a script, this is true when running a python script from the python binary but NOT true when running a compiled script from the C/API which can lead to bugs which are not easy to solve unless the C/API author knows this.

----------
assignee: docs at python
components: Documentation
files: doc_py3_main_mod.diff
keywords: patch
messages: 112706
nosy: docs at python, ideasman42
priority: normal
severity: normal
status: open
title: Python C/API Execution namespace undocumented. (patch included)
type: behavior
versions: Python 3.2
Added file: http://bugs.python.org/file18357/doc_py3_main_mod.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9499>
_______________________________________

From report at bugs.python.org  Wed Aug  4 06:56:51 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Wed, 04 Aug 2010 04:56:51 +0000
Subject: [docs] [issue8267] Tutorial section on dictionary keys recommends
	sort	instead of sorted
In-Reply-To: <1269976733.25.0.679757604507.issue8267@psf.upfronthosting.co.za>
Message-ID: <1280897811.42.0.402800059681.issue8267@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

This amounts to backporting the 3.x change.

----------
assignee: georg.brandl -> docs at python
keywords: +easy -patch
nosy: +docs at python, tjreedy
priority: normal -> low
stage:  -> commit review
versions:  -Python 2.5, Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8267>
_______________________________________

From report at bugs.python.org  Wed Aug  4 09:46:36 2010
From: report at bugs.python.org (Florent Xicluna)
Date: Wed, 04 Aug 2010 07:46:36 +0000
Subject: [docs] [issue7186] Document specialness of __doc__,
	and possibly other "special" attributes
In-Reply-To: <1256240855.61.0.550470965616.issue7186@psf.upfronthosting.co.za>
Message-ID: <1280907995.89.0.502043363215.issue7186@psf.upfronthosting.co.za>


Florent Xicluna <florent.xicluna at gmail.com> added the comment:

This is similar with #9438, about __debug__ being read-only.

----------
nosy: +flox
stage:  -> needs patch
versions: +Python 2.6, Python 2.7, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7186>
_______________________________________

From report at bugs.python.org  Wed Aug  4 09:47:05 2010
From: report at bugs.python.org (Florent Xicluna)
Date: Wed, 04 Aug 2010 07:47:05 +0000
Subject: [docs] [issue7186] Document specialness of __doc__,
	and possibly other "special" attributes
In-Reply-To: <1256240855.61.0.550470965616.issue7186@psf.upfronthosting.co.za>
Message-ID: <1280908025.78.0.627868425828.issue7186@psf.upfronthosting.co.za>


Changes by Florent Xicluna <florent.xicluna at gmail.com>:


----------
keywords: +easy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7186>
_______________________________________

From report at bugs.python.org  Wed Aug  4 11:40:27 2010
From: report at bugs.python.org (Florent Xicluna)
Date: Wed, 04 Aug 2010 09:40:27 +0000
Subject: [docs] [issue9364] some problems with the documentation of pydoc
In-Reply-To: <1279949027.26.0.1869842795.issue9364@psf.upfronthosting.co.za>
Message-ID: <1280914827.82.0.816357778076.issue9364@psf.upfronthosting.co.za>


Changes by Florent Xicluna <florent.xicluna at gmail.com>:


----------
keywords: +easy
nosy: +flox
stage:  -> needs patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9364>
_______________________________________

From report at bugs.python.org  Wed Aug  4 11:45:11 2010
From: report at bugs.python.org (Giampaolo Rodola')
Date: Wed, 04 Aug 2010 09:45:11 +0000
Subject: [docs] [issue8834] Define order of Misc/ACKS entries
In-Reply-To: <1274993181.13.0.347164864235.issue8834@psf.upfronthosting.co.za>
Message-ID: <1280915111.41.0.424596698972.issue8834@psf.upfronthosting.co.za>


Changes by Giampaolo Rodola' <g.rodola at gmail.com>:


----------
nosy: +giampaolo.rodola

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8834>
_______________________________________

From report at bugs.python.org  Wed Aug  4 13:02:20 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Wed, 04 Aug 2010 11:02:20 +0000
Subject: [docs] [issue1635217] Add example of distutils setup() with
	"requires"	argument
Message-ID: <1280919740.2.0.710557060526.issue1635217@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

This report is made obsolete by PEP 345. Be certain that distutils2 docs and tests will contain examples of Requires-Dist and Provides-Dist.

----------
nosy: +merwok
resolution:  -> out of date
stage:  -> committed/rejected
status: open -> closed
versions:  -Python 2.7, Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1635217>
_______________________________________

From report at bugs.python.org  Wed Aug  4 20:39:47 2010
From: report at bugs.python.org (Dan L)
Date: Wed, 04 Aug 2010 18:39:47 +0000
Subject: [docs] [issue9515] vars() dictionary access to generate variables
In-Reply-To: <1280947187.21.0.503447106682.issue9515@psf.upfronthosting.co.za>
Message-ID: <1280947187.21.0.503447106682.issue9515@psf.upfronthosting.co.za>


New submission from Dan L <choralreef at naver.com>:

Perhaps it's assumed that you should know about this by knowing about how the vars dictionary is implemented, but to someone unfamiliar like me it seems like the builtin functions documentation for vars() should mention that you can create a variable name from a string using vars()['string_containing_variable_name'] = value, i.e. 

>>> vars()['hi']=3
>>> hi
3
>>>


Just to include text for a possible fix (to be appended to the existing description):

"You can create a variable name from a string using vars()['string_containing_variable_name'] = value, i.e. 

>>> vars()['hi']=3
>>> hi
3
>>>"

----------
assignee: docs at python
components: Documentation
messages: 112857
nosy: docs at python, jdan
priority: normal
severity: normal
status: open
title: vars() dictionary access to generate variables
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9515>
_______________________________________

From report at bugs.python.org  Wed Aug  4 20:50:00 2010
From: report at bugs.python.org (Mark Dickinson)
Date: Wed, 04 Aug 2010 18:50:00 +0000
Subject: [docs] [issue9498] stdtypes.rst should refer to sys.float_info
In-Reply-To: <1280867854.52.0.518299717843.issue9498@psf.upfronthosting.co.za>
Message-ID: <1280947800.31.0.551411746865.issue9498@psf.upfronthosting.co.za>


Mark Dickinson <dickinsm at gmail.com> added the comment:

Thanks!  Applied in revisions r83732 through r83734.  (The release26-maint branch is frozen except for essential fixes, so not applying it there.)

----------
resolution:  -> accepted
status: open -> closed
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9498>
_______________________________________

From report at bugs.python.org  Wed Aug  4 21:53:15 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Wed, 04 Aug 2010 19:53:15 +0000
Subject: [docs] [issue3216] Scarce msilib documentation
In-Reply-To: <1214577470.61.0.590067451474.issue3216@psf.upfronthosting.co.za>
Message-ID: <1280951595.08.0.00738427070463.issue3216@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Martin cannot write anything until someone answers his question. In the meanwhile, any doc person could, as suggested by Bill, change

class msilib.Directory(database, cab, basedir, physical, logical, default, component[, componentflags]) 

to

class msilib.Directory(database, cab, basedir, physical, logical, default[, componentflags]) 

'conponent' is neither in the doc string or the explanation of the signature.

----------
assignee: loewis -> docs at python
keywords: +easy, patch
nosy: +docs at python, terry.reedy
resolution: fixed -> 
versions: +Python 3.2 -Python 2.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue3216>
_______________________________________

From report at bugs.python.org  Wed Aug  4 23:27:37 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Wed, 04 Aug 2010 21:27:37 +0000
Subject: [docs] [issue7436] Define 'object with assignable attributes'
In-Reply-To: <1259961781.03.0.33355289278.issue7436@psf.upfronthosting.co.za>
Message-ID: <1280957257.5.0.487677787569.issue7436@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7436>
_______________________________________

From report at bugs.python.org  Wed Aug  4 23:28:30 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Wed, 04 Aug 2010 21:28:30 +0000
Subject: [docs] [issue7468] PyErr_Format documentation doesn't mention all
	format	codes
In-Reply-To: <1260444170.83.0.494210811062.issue7468@psf.upfronthosting.co.za>
Message-ID: <1280957310.2.0.278911967349.issue7468@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7468>
_______________________________________

From report at bugs.python.org  Wed Aug  4 23:38:51 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Wed, 04 Aug 2010 21:38:51 +0000
Subject: [docs] [issue7678] subprocess.Popen pipeline example code in
	the	documentation is lacking
In-Reply-To: <1263245210.2.0.116487607425.issue7678@psf.upfronthosting.co.za>
Message-ID: <1280957931.14.0.113258630627.issue7678@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7678>
_______________________________________

From report at bugs.python.org  Wed Aug  4 23:55:12 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Wed, 04 Aug 2010 21:55:12 +0000
Subject: [docs] [issue8318] Deprecation of multifile inappropriate or
	incomplete
In-Reply-To: <1270489322.03.0.368739706632.issue8318@psf.upfronthosting.co.za>
Message-ID: <1280958912.28.0.778164898245.issue8318@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Multifile *is* gone in 3.x; done deal.

If you want 2.7 docs improved, submit suggested change, even as text in message.

----------
assignee:  -> docs at python
components: +Documentation -Library (Lib)
nosy: +docs at python, terry.reedy
versions:  -Python 2.5, Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8318>
_______________________________________

From report at bugs.python.org  Wed Aug  4 23:58:38 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Wed, 04 Aug 2010 21:58:38 +0000
Subject: [docs] [issue8873] Popen uses 333 times as much CPU as a shell pipe
	on Mac	OS X
In-Reply-To: <1275430726.49.0.216093303643.issue8873@psf.upfronthosting.co.za>
Message-ID: <1280959118.11.0.897913098494.issue8873@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
assignee:  -> docs at python
components: +Documentation -Library (Lib)
nosy: +docs at python
resolution:  -> fixed
status: open -> closed
versions: +Python 2.7 -Python 2.5, Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8873>
_______________________________________

From report at bugs.python.org  Thu Aug  5 00:37:03 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Wed, 04 Aug 2010 22:37:03 +0000
Subject: [docs] [issue6251] c++ extension module implementation
	guide/example in	extending/embedding documentation
In-Reply-To: <1244621954.14.0.882115358869.issue6251@psf.upfronthosting.co.za>
Message-ID: <1280961423.59.0.0159474834285.issue6251@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

I suggest you put your example on the Python wiki or even Python cookbook site. Or announce on Python list and you should get some feedback from C++ users. I am closing this until there is some.

Writing it against 3.x capi would be more useful in the long run if not now.

Most reviewers prefer plain text attachments they can open in the browser.

----------
nosy: +terry.reedy
resolution:  -> later
status: open -> closed
versions: +Python 2.7 -Python 2.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6251>
_______________________________________

From report at bugs.python.org  Thu Aug  5 01:28:54 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Wed, 04 Aug 2010 23:28:54 +0000
Subject: [docs] [issue9512] logging.handlers.RotatingFileHandler - mode
	argument not	respected
In-Reply-To: <1280936339.01.0.442982035042.issue9512@psf.upfronthosting.co.za>
Message-ID: <1280964534.58.0.652153352527.issue9512@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

I presume your report is about the fact that the mode is 'a' even though you specified 'a+'. The answer is this block from RotatingFileHandler.__init__ (3.1.2, but presume same for 2.x):

       if maxBytes > 0:
            mode = 'a' # doesn't make sense otherwise!

I do not understand the comment, but there it is. So

DOC PATCH In 15.6.12.5. RotatingFileHandler, replace
"If mode is not specified, 'a' is used." with
"If mode is not specified or if maxBytes > 0, the mode is 'a'."

----------
assignee:  -> docs at python
components: +Documentation -Library (Lib)
keywords: +easy, patch
nosy: +docs at python, terry.reedy
versions: +Python 3.1, Python 3.2 -Python 2.5, Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9512>
_______________________________________

From report at bugs.python.org  Thu Aug  5 05:33:38 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Thu, 05 Aug 2010 03:33:38 +0000
Subject: [docs] [issue8041] No documentation for
	Py_TPFLAGS_HAVE_STACKLESS_EXTENSION	or Py_TPFLAGS_HAVE_VERSION_TAG.
In-Reply-To: <1267544098.65.0.440493208051.issue8041@psf.upfronthosting.co.za>
Message-ID: <1280979218.68.0.70502171824.issue8041@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8041>
_______________________________________

From report at bugs.python.org  Thu Aug  5 14:02:57 2010
From: report at bugs.python.org (Antoine Pitrou)
Date: Thu, 05 Aug 2010 12:02:57 +0000
Subject: [docs] [issue8041] No documentation for
	Py_TPFLAGS_HAVE_STACKLESS_EXTENSION	or Py_TPFLAGS_HAVE_VERSION_TAG.
In-Reply-To: <1267544098.65.0.440493208051.issue8041@psf.upfronthosting.co.za>
Message-ID: <1281009776.74.0.0162082840899.issue8041@psf.upfronthosting.co.za>


Antoine Pitrou <pitrou at free.fr> added the comment:

I don't think these flags need documenting or even deserve mentioning. Py_TPFLAGS_HAVE_STACKLESS_EXTENSION seems to be two bits reserved for use by Stackless, while Py_TPFLAGS_HAVE_VERSION_TAG should be considered by extension authors an internal implementation detail (in normal circumstances, it won't impact how they have to write their code or the semantics of their extension types).

----------
nosy: +pitrou

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8041>
_______________________________________

From report at bugs.python.org  Thu Aug  5 14:30:51 2010
From: report at bugs.python.org (=?utf-8?b?RnJpw7ByaWsgTcOhciBKw7Nuc3Nvbg==?=)
Date: Thu, 05 Aug 2010 12:30:51 +0000
Subject: [docs] [issue9512] logging.handlers.RotatingFileHandler - mode
	argument not	respected
In-Reply-To: <1280936339.01.0.442982035042.issue9512@psf.upfronthosting.co.za>
Message-ID: <1281011451.53.0.492024118679.issue9512@psf.upfronthosting.co.za>


Fri?rik M?r J?nsson <fridrik at pyth.net> added the comment:

Thank you.  I should have been more clear about what I meant.

This this condition was introduced in r38631 by Vinay Sajip having the log
message "Added optional encoding argument to file handlers." I can't easily
see why this piece of code is necessary, which absolutely doesn't mean it
isn't.

I'm going to suggest some cases where other modes may be appropriate for
loggers. This is a little open-ended and devoid of solution-orientation, but I
don't know the rationale well enough to suggest alternatives.

We do know that 'r' (read-only logger) and 'w' (logger rarely rolls over for
traditional maxBytes values, but might -- this mode also makes relatively
little sense with ``logger.FileHandler``) make little sense here. I'm not
aware of a binary log format, so 'b' might make little sense as well. What
about 'U' and '+'?

For instance, the W3C Extended Log File Format draft uses headers at the
beginning of a log file. Ideally, knowing whether to write headers to the file
is done by using the ``handler.stream`` to determine whether the file is
empty. It may be debatable whether supporting such formats is the purpose of
handlers. If not, it's at the cost of writing new libraries that handle
logging for those formats.

I will never be able to exhaustively list use cases. If these modes are safe,
shouldn't the developer decide makes sense, as long as it doesn't break the
functionality of the logger?

I don't know whether it's generally approrpiate to add people to the nosy
list. I apologise, Vinay, if that's not common practice.

----------
nosy: +vinay.sajip

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9512>
_______________________________________

From report at bugs.python.org  Thu Aug  5 14:33:08 2010
From: report at bugs.python.org (=?utf-8?b?RnJpw7ByaWsgTcOhciBKw7Nuc3Nvbg==?=)
Date: Thu, 05 Aug 2010 12:33:08 +0000
Subject: [docs] [issue9512] logging.handlers.RotatingFileHandler - mode
	argument not	respected
In-Reply-To: <1280936339.01.0.442982035042.issue9512@psf.upfronthosting.co.za>
Message-ID: <1281011588.75.0.493317401905.issue9512@psf.upfronthosting.co.za>


Fri?rik M?r J?nsson <fridrik at pyth.net> added the comment:

It may not have been entirely obvious that what I meant with the Extended Log
File Format example is that read access would be optimal.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9512>
_______________________________________

From report at bugs.python.org  Thu Aug  5 18:43:14 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Thu, 05 Aug 2010 16:43:14 +0000
Subject: [docs] [issue9512] logging.handlers.RotatingFileHandler - mode
	argument not	respected
In-Reply-To: <1280936339.01.0.442982035042.issue9512@psf.upfronthosting.co.za>
Message-ID: <1281026593.05.0.956369462862.issue9512@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Given that you decided to argue for a code change (which my comment implicitly invited), adding someone (VS in this case) to nosy to respond is the right thing to do and fairly common. Assigning to someone is not, as least not any more. If someone agrees to change the code, the headers can be changed again.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9512>
_______________________________________

From report at bugs.python.org  Thu Aug  5 21:07:56 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Thu, 05 Aug 2010 19:07:56 +0000
Subject: [docs] [issue6696] Profile objects should be documented
In-Reply-To: <1250182637.82.0.304646827828.issue6696@psf.upfronthosting.co.za>
Message-ID: <1281035276.27.0.700464715896.issue6696@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

I am just responding so this will not show up on the 'unanswered issues' list. It appears that GB has accepted this as something that needs to be done.

----------
nosy: +terry.reedy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6696>
_______________________________________

From report at bugs.python.org  Thu Aug  5 21:48:04 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Thu, 05 Aug 2010 19:48:04 +0000
Subject: [docs] [issue8491] Need readline command and keybinding information
In-Reply-To: <1271879913.89.0.268262009322.issue8491@psf.upfronthosting.co.za>
Message-ID: <1281037684.71.0.368448003507.issue8491@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Can you suggest a specific link and a specific location where to add it?

----------
assignee: georg.brandl -> docs at python
nosy: +docs at python, terry.reedy
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8491>
_______________________________________

From report at bugs.python.org  Fri Aug  6 16:55:28 2010
From: report at bugs.python.org (John Posner)
Date: Fri, 06 Aug 2010 14:55:28 +0000
Subject: [docs] [issue9536] defaultdict doc makes incorrect reference to
	__missing__	method
In-Reply-To: <1281106528.37.0.0435364267174.issue9536@psf.upfronthosting.co.za>
Message-ID: <1281106528.37.0.0435364267174.issue9536@psf.upfronthosting.co.za>


New submission from John Posner <jjposner at optimum.net>:

The documentation for collections.defaultdict is confusing with respect to the __missing__ method. The fact is that a programmer using defaultdict does not need to know anything about __missing__.

The attached patch contains a rewrite of the entire section (but not the "defaultdict Examples" section, which is fine.

----------
assignee: docs at python
components: Documentation
files: defaultdict.patch
keywords: patch
messages: 113105
nosy: docs at python, jjposner
priority: normal
severity: normal
status: open
title: defaultdict doc makes incorrect reference to __missing__ method
versions: Python 2.7
Added file: http://bugs.python.org/file18417/defaultdict.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9536>
_______________________________________

From report at bugs.python.org  Fri Aug  6 19:23:55 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Fri, 06 Aug 2010 17:23:55 +0000
Subject: [docs] [issue7790] struct_time documentation entry should point to
	the table	defining the tuple
In-Reply-To: <1264538314.16.0.129243655657.issue7790@psf.upfronthosting.co.za>
Message-ID: <1281115435.57.0.349409149068.issue7790@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7790>
_______________________________________

From report at bugs.python.org  Fri Aug  6 21:51:40 2010
From: report at bugs.python.org (R. David Murray)
Date: Fri, 06 Aug 2010 19:51:40 +0000
Subject: [docs] [issue9515] vars() dictionary access to generate variables
In-Reply-To: <1280947187.21.0.503447106682.issue9515@psf.upfronthosting.co.za>
Message-ID: <1281124300.42.0.250406093239.issue9515@psf.upfronthosting.co.za>


R. David Murray <rdmurray at bitdance.com> added the comment:

No, the docs are correct as they stand.  They say that without an argument it acts like locals(), and there is even a special note saying you shouldn't modify the returned dictionary because what happens when you do is undefined.  It just so happens that when locals==globals, what you show works, but it is not guaranteed to work even in CPython, and is reasonably likely to not work in other Python interpreters.

----------
nosy: +r.david.murray
resolution:  -> invalid
stage:  -> committed/rejected
status: open -> closed
type:  -> behavior

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9515>
_______________________________________

From report at bugs.python.org  Sat Aug  7 00:02:15 2010
From: report at bugs.python.org (R. David Murray)
Date: Fri, 06 Aug 2010 22:02:15 +0000
Subject: [docs] [issue9536] defaultdict doc makes incorrect reference to
	__missing__	method
In-Reply-To: <1281106528.37.0.0435364267174.issue9536@psf.upfronthosting.co.za>
Message-ID: <1281132135.36.0.266042989285.issue9536@psf.upfronthosting.co.za>


R. David Murray <rdmurray at bitdance.com> added the comment:

I believe the description of __missing__ is there for those who want to subclass defaultdict, but I'll let Raymond confirm.

----------
nosy: +r.david.murray, rhettinger
resolution:  -> invalid
stage:  -> committed/rejected
status: open -> pending
type:  -> behavior

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9536>
_______________________________________

From report at bugs.python.org  Sat Aug  7 15:37:42 2010
From: report at bugs.python.org (Eli Bendersky)
Date: Sat, 07 Aug 2010 13:37:42 +0000
Subject: [docs] [issue9312] Fix usage of :option: markup in stdlib ReST docs
In-Reply-To: <1279599587.56.0.337150515932.issue9312@psf.upfronthosting.co.za>
Message-ID: <1281188262.02.0.141535017532.issue9312@psf.upfronthosting.co.za>


Eli Bendersky <eliben at gmail.com> added the comment:

Following the discussions on pydev and some private correspondence with Georg Brandl, I'm attaching an updated patch.

Things changed:

1. Changes of :option: to ``...`` similar to previous patch

2. :program:`prog` :option:`opt` was changed to ``prog opt``

3. Some modules have a large choice of command line options. Per Georg's suggestions, command line options in these modules can be described with the "cmdoption" directive and later referred to with :option: which inserts a back-link, just like to the Python interpreter options now. I've applied these changes to unittest.rst and timeit.rst. trace.rst also has this problem, but the trace documentation is currently undergoing a major change by issue 9264 (2.6 fix was already committed) and I prefer changing it wholly at once.

In addition, the documentation of optparse underwent a more serious change because it kept referring to options with ``"-o"`` (note the double quotes after the ``), I changed it to ``-o`` for consistency.

--------

P.S. The patch was generated from a fresh pull of py3k from the Hg mirror. The complete list of affected files:

M Doc/library/codecs.rst
M Doc/library/compileall.rst
M Doc/library/doctest.rst
M Doc/library/exceptions.rst
M Doc/library/getopt.rst
M Doc/library/idle.rst
M Doc/library/optparse.rst
M Doc/library/pydoc.rst
M Doc/library/sys.rst
M Doc/library/test.rst
M Doc/library/timeit.rst
M Doc/library/unittest.rst
M Doc/library/webbrowser.rst

----------
nosy: +georg.brandl
Added file: http://bugs.python.org/file18424/issue9312.2.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9312>
_______________________________________

From report at bugs.python.org  Sat Aug  7 16:15:48 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sat, 07 Aug 2010 14:15:48 +0000
Subject: [docs] [issue9312] Fix usage of :option: markup in stdlib ReST docs
In-Reply-To: <1279599587.56.0.337150515932.issue9312@psf.upfronthosting.co.za>
Message-ID: <1281190547.68.0.754234101965.issue9312@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Nice changes! Especially the program/cmdoption directives combo.

Your patch introduces trailing whitespace (good editor settings can show those, as well as hg diff with the color extension) and has one unnecessary change:

-line, ``options.filename`` will be ``"outfile"`` and ``options.verbose`` will be
+line, ``options.filename`` will be ``outfile`` and ``options.verbose`` will be

In this case, the things in ```` are not command line snippets but Python code, so the quotes are regular string notation.

Attached patch fixes that.

----------
Added file: http://bugs.python.org/file18425/issue9312.3.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9312>
_______________________________________

From report at bugs.python.org  Sat Aug  7 16:33:21 2010
From: report at bugs.python.org (Eli Bendersky)
Date: Sat, 07 Aug 2010 14:33:21 +0000
Subject: [docs] [issue9312] Fix usage of :option: markup in stdlib ReST docs
In-Reply-To: <1279599587.56.0.337150515932.issue9312@psf.upfronthosting.co.za>
Message-ID: <1281191601.35.0.154043146491.issue9312@psf.upfronthosting.co.za>


Eli Bendersky <eliben at gmail.com> added the comment:

Eric, thanks for the catch and the fix. If there's anything else, just let me know.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9312>
_______________________________________

From report at bugs.python.org  Sat Aug  7 16:37:20 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sat, 07 Aug 2010 14:37:20 +0000
Subject: [docs] [issue9312] Fix usage of :option: markup in stdlib ReST docs
In-Reply-To: <1279599587.56.0.337150515932.issue9312@psf.upfronthosting.co.za>
Message-ID: <1281191840.01.0.535384521656.issue9312@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Nothing else to say, +1 on commit.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9312>
_______________________________________

From report at bugs.python.org  Sat Aug  7 19:11:27 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 17:11:27 +0000
Subject: [docs] [issue7450] document that os.chmod accepts an octal digit
	mode
In-Reply-To: <1260201260.24.0.734078851389.issue7450@psf.upfronthosting.co.za>
Message-ID: <1281201086.74.0.567180891746.issue7450@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

(3.1.2)
15.1.5. Files and Directories
os.chmode entry: I recommend changing the first sentence
"Change the mode of path to the numeric mode."
to
"Change the mode of path to the integer mode (such as 0x755)."

For 2.7, delete the 'x'.

This should make it clear to Unix users that they can use the usual octal designations.

----------
assignee: georg.brandl -> docs at python
keywords: +easy, patch
nosy: +docs at python, terry.reedy
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7450>
_______________________________________

From report at bugs.python.org  Sat Aug  7 20:18:20 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 18:18:20 +0000
Subject: [docs] [issue9127] subprocess.Popen.communicate() and SIGCHLD
	handlers
In-Reply-To: <1277913297.34.0.963310724242.issue9127@psf.upfronthosting.co.za>
Message-ID: <1281205099.87.0.460838736909.issue9127@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Can you suggest a specific doc patch with new text and location?

----------
nosy: +terry.reedy
versions: +Python 3.2 -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9127>
_______________________________________

From report at bugs.python.org  Sat Aug  7 20:31:32 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 18:31:32 +0000
Subject: [docs] [issue5784] raw deflate format and zlib module
In-Reply-To: <1240006221.86.0.263428051867.issue5784@psf.upfronthosting.co.za>
Message-ID: <1281205892.65.0.219078129731.issue5784@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5784>
_______________________________________

From report at bugs.python.org  Sat Aug  7 20:32:26 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 18:32:26 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281205946.58.0.192873975543.issue6678@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
stage:  -> needs patch
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Sat Aug  7 20:32:51 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 18:32:51 +0000
Subject: [docs] [issue5962] Ambiguity about the semantics of sys.exit()
	and	os._exit() in multithreaded program
In-Reply-To: <1241722395.44.0.880118568656.issue5962@psf.upfronthosting.co.za>
Message-ID: <1281205971.22.0.286457613017.issue5962@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5962>
_______________________________________

From report at bugs.python.org  Sat Aug  7 20:34:32 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 18:34:32 +0000
Subject: [docs] [issue1643712] Emphasize buffering issues when sys.stdin is
	used
Message-ID: <1281206072.97.0.318039804926.issue1643712@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
stage:  -> needs patch
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1643712>
_______________________________________

From report at bugs.python.org  Sat Aug  7 20:37:38 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 18:37:38 +0000
Subject: [docs] [issue7867] Proposed FAQ entry on pass-by-? semantics and
	the meaning	of 'variable' in python
In-Reply-To: <1265490255.73.0.743157337936.issue7867@psf.upfronthosting.co.za>
Message-ID: <1281206258.71.0.407167309858.issue7867@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7867>
_______________________________________

From report at bugs.python.org  Sat Aug  7 20:51:31 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 18:51:31 +0000
Subject: [docs] [issue8387] use universal newline mode in csv module examples
In-Reply-To: <1271193086.18.0.201846291594.issue8387@psf.upfronthosting.co.za>
Message-ID: <1281207091.64.0.516556459981.issue8387@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

In the current 2.7 docs, files are opened with 'rb' or 'wb'.
In msg106210 of #1072404, RDM says "The doc has been fixed;".
I am not sure if this refers a change in the open or just removal of reference to non-working delimiter option.
David?
Any opinion on this request?

----------
assignee: georg.brandl -> docs at python
nosy: +docs at python, r.david.murray, terry.reedy
stage:  -> needs patch
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8387>
_______________________________________

From report at bugs.python.org  Sat Aug  7 21:45:20 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 19:45:20 +0000
Subject: [docs] [issue8722] Documentation for __getattr__
In-Reply-To: <1273896658.97.0.575873001655.issue8722@psf.upfronthosting.co.za>
Message-ID: <1281210320.11.0.132894784105.issue8722@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

The problem with changing 2.7 docs is that object access is different for old- and new-style properties. Does your example work if you remove 'object'? (IE, can old style classes have properties?)

For new-style classes, the example behavior is clear if you 1. know that object has a .__getattribute__ method inherited by everything when not overriden and 2. read the doc for that which says that __getattr__ is called whenever a __getattribute__ call raises AttributeError, which it does here by passing through the .get error.

For 3.x, I think in 3.3.2. Customizing attribute access,
object.__getattr__(self, name) 
"Called when an attribute lookup has not found the attribute in the usual places (i.e. it is not an instance attribute nor is it found in the class tree for self). name is the attribute name. "

might be replaced by

"Called when self.__getattribute__(name) raise AttributeError because name is not an instance attribute, not found in the class tree for self, or is a property attribute whose .get() method raises AttributeError."

But this does not work for 2.7.

----------
keywords: +patch
nosy: +terry.reedy
stage:  -> needs patch
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8722>
_______________________________________

From report at bugs.python.org  Sat Aug  7 21:50:08 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 19:50:08 +0000
Subject: [docs] [issue8722] Documentation for __getattr__
In-Reply-To: <1273896658.97.0.575873001655.issue8722@psf.upfronthosting.co.za>
Message-ID: <1281210608.21.0.571184654706.issue8722@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

/raise/raises/

I am pretty sure that when __getattribute__ is bypassed, so is __getattr__.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8722>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:04:39 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:04:39 +0000
Subject: [docs] [issue9538] Replace confusing pseudoname 'object' in special
	methods	section.
In-Reply-To: <1281211479.21.0.733519342396.issue9538@psf.upfronthosting.co.za>
Message-ID: <1281211479.21.0.733519342396.issue9538@psf.upfronthosting.co.za>


New submission from Terry J. Reedy <tjreedy at udel.edu>:

In 3.3. Special method names, 'object' is used as a pseudo class name to prefix all the special method entries. This conflicts with the usual two Python meanings.

1. 'object' is the name of a specific class. So the entry for object.__getattribute__(self, name) says to avoid circularity by calling
object.__getattribute__(self, name), which looks circular and requires a bit a mental work by the reader to properly understand. Ditto for
object.__setattr__(self, name, value) calling
object.__setattr__(self, name, value)

2. Non-specifically, 'object' is usually understood to mean any Python object, not just a class. But the signatures as written require that 'object' specifically be a class and 'object' does not convey that.

So for both reasons, I propose that the pseudoname 'object' be replaces with 'class' or 'someclass'

----------
assignee: docs at python
components: Documentation
messages: 113194
nosy: docs at python, georg.brandl, terry.reedy
priority: normal
severity: normal
stage: needs patch
status: open
title: Replace confusing pseudoname 'object' in special methods section.
versions: Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9538>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:08:15 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:08:15 +0000
Subject: [docs] [issue9538] Replace confusing pseudoname 'object' in special
	methods	section.
In-Reply-To: <1281211479.21.0.733519342396.issue9538@psf.upfronthosting.co.za>
Message-ID: <1281211695.53.0.0332404981479.issue9538@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

I also think that in "In order to avoid infinite recursion in this method, its implementation should always call the base class method with the same name to access any attributes it needs, for example, object.__getattribute__(self, name).", 'the base class' should be 'a base class' or 'a superclass' since there might be more than one base/super class. Ditto for __setattr__.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9538>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:15:41 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:15:41 +0000
Subject: [docs] [issue9538] Replace confusing pseudoname 'object' in special
	methods	section.
In-Reply-To: <1281211479.21.0.733519342396.issue9538@psf.upfronthosting.co.za>
Message-ID: <1281212141.1.0.330700528139.issue9538@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

I filed this because I just reread the __getattr(ibute)__ entries to respond to #8722 and found myself again stumbling over the 'object' confusion.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9538>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:17:30 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:17:30 +0000
Subject: [docs] [issue8145] Documentation about sqlite3 isolation_level
In-Reply-To: <1268643705.49.0.319902511171.issue8145@psf.upfronthosting.co.za>
Message-ID: <1281212250.55.0.395734897415.issue8145@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
stage:  -> patch review
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8145>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:25:40 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:25:40 +0000
Subject: [docs] [issue8340] bytearray undocumented on trunk
In-Reply-To: <1270682579.64.0.491172746908.issue8340@psf.upfronthosting.co.za>
Message-ID: <1281212740.65.0.690607715865.issue8340@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
stage: needs patch -> patch review
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8340>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:27:48 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:27:48 +0000
Subject: [docs] [issue9105] pickle security note should be more prominent
In-Reply-To: <1277745956.4.0.951690442784.issue9105@psf.upfronthosting.co.za>
Message-ID: <1281212868.33.0.529380604895.issue9105@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
versions: +Python 3.1 -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9105>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:28:51 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:28:51 +0000
Subject: [docs] [issue9105] pickle security note should be more prominent
In-Reply-To: <1277745956.4.0.951690442784.issue9105@psf.upfronthosting.co.za>
Message-ID: <1281212930.56.0.167190551665.issue9105@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

FWIW, I agree too. The current location is a bit odd.

----------
nosy: +terry.reedy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9105>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:35:26 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:35:26 +0000
Subject: [docs] [issue8834] Define order of Misc/ACKS entries
In-Reply-To: <1274993181.13.0.347164864235.issue8834@psf.upfronthosting.co.za>
Message-ID: <1281213325.76.0.593782958857.issue8834@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Only a few days left for 2.6 ;-)

----------
nosy: +terry.reedy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8834>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:37:37 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:37:37 +0000
Subject: [docs] [issue7790] struct_time documentation entry should point to
	the table	defining the tuple
In-Reply-To: <1264538314.16.0.129243655657.issue7790@psf.upfronthosting.co.za>
Message-ID: <1281213457.29.0.635340801401.issue7790@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
nosy: +belopolsky
stage:  -> needs patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7790>
_______________________________________

From report at bugs.python.org  Sat Aug  7 22:39:12 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 20:39:12 +0000
Subject: [docs] [issue1945] Document back ported C functions
In-Reply-To: <1201445858.91.0.21119487494.issue1945@psf.upfronthosting.co.za>
Message-ID: <1281213552.5.0.911140390483.issue1945@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
keywords: +patch
stage:  -> patch review
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1945>
_______________________________________

From report at bugs.python.org  Sat Aug  7 23:32:45 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 07 Aug 2010 21:32:45 +0000
Subject: [docs] [issue7790] struct_time documentation entry should point to
	the table	defining the tuple
In-Reply-To: <1264538314.16.0.129243655657.issue7790@psf.upfronthosting.co.za>
Message-ID: <1281216765.6.0.135067647267.issue7790@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
versions:  -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7790>
_______________________________________

From report at bugs.python.org  Sat Aug  7 23:35:01 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sat, 07 Aug 2010 21:35:01 +0000
Subject: [docs] [issue9538] Replace confusing pseudoname 'object' in special
	methods	section.
In-Reply-To: <1281211479.21.0.733519342396.issue9538@psf.upfronthosting.co.za>
Message-ID: <1281216901.5.0.319677436218.issue9538@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Good catch!

Names listed under language reference section 3.3.1 actually all exist on object, e.g. object.__new__?. It is section 3.3.2 that lists names that *can* be defined but don?t have a default implementation on object, so +1 on using ?someclass? here to be clear. Oh, and let?s change ?class? to ?someclass? too in the examples under 3.3.4, to use valid syntax and consistent naming.

I think we should not change ?the base class?, since even with multiple bases a class still has one most immediate parent, found in cls.__base__ (a.k.a. cls.__bases__[0]).

? with the exception of __bool__ and the lack of __reduce{_ex,}__ and __subclasshook__; I?ll open a bug about those.

----------
nosy: +merwok

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9538>
_______________________________________

From report at bugs.python.org  Sat Aug  7 23:36:08 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sat, 07 Aug 2010 21:36:08 +0000
Subject: [docs] [issue8722] Documentation for __getattr__
In-Reply-To: <1273896658.97.0.575873001655.issue8722@psf.upfronthosting.co.za>
Message-ID: <1281216968.38.0.271290323152.issue8722@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Old-style classes can?t have descriptors, hence no properties, static methods, class methods or super.

----------
nosy: +merwok

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8722>
_______________________________________

From report at bugs.python.org  Sun Aug  8 03:00:11 2010
From: report at bugs.python.org (R. David Murray)
Date: Sun, 08 Aug 2010 01:00:11 +0000
Subject: [docs] [issue8387] use universal newline mode in csv module examples
In-Reply-To: <1271193086.18.0.201846291594.issue8387@psf.upfronthosting.co.za>
Message-ID: <1281229211.27.0.377130243469.issue8387@psf.upfronthosting.co.za>


R. David Murray <rdmurray at bitdance.com> added the comment:

"The doc has been fixed" refers to the fact that the lineterminator dialect option is now documented as applying only to writing, not to reading.

The docs could certainly be improved to discuss using universal newline mode.  I'm not clear on whether or not there are disadvantages to using universal newline mode with the py2 version of the csv module, but I wouldn't be surprised if there are.  Perhaps Skip can comment on whether changing the examples to use rU would be a good idea or not.

Note that the situation for the py3k csv module is different, and it would be helpful if someone could test this issue there.  Though in truth we have no resources to support non-OSX macs any longer, so if it doesn't work it may be just tough luck.

----------
nosy: +skip.montanaro

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8387>
_______________________________________

From report at bugs.python.org  Sun Aug  8 07:37:57 2010
From: report at bugs.python.org (Ezio Melotti)
Date: Sun, 08 Aug 2010 05:37:57 +0000
Subject: [docs] [issue7450] document that os.chmod accepts an octal digit
	mode
In-Reply-To: <1260201260.24.0.734078851389.issue7450@psf.upfronthosting.co.za>
Message-ID: <1281245877.39.0.563992864941.issue7450@psf.upfronthosting.co.za>


Ezio Melotti <ezio.melotti at gmail.com> added the comment:

I guess you mean 0o755.
I think it would be better to mention explicitly octal literals, since they are not so common and, especially in 2.x, 0755 might be confused with a "normal" decimal number.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7450>
_______________________________________

From report at bugs.python.org  Sun Aug  8 12:45:40 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Sun, 08 Aug 2010 10:45:40 +0000
Subject: [docs] [issue1643712] Emphasize buffering issues when sys.stdin is
	used
Message-ID: <1281264338.51.0.291546114681.issue1643712@psf.upfronthosting.co.za>


Mark Lawrence <breamoreboy at yahoo.co.uk> added the comment:

Please note update to #1633941

----------
nosy: +BreamoreBoy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1643712>
_______________________________________

From report at bugs.python.org  Sun Aug  8 16:40:24 2010
From: report at bugs.python.org (John Posner)
Date: Sun, 08 Aug 2010 14:40:24 +0000
Subject: [docs] [issue9536] defaultdict doc makes incorrect reference to
	__missing__	method
In-Reply-To: <1281106528.37.0.0435364267174.issue9536@psf.upfronthosting.co.za>
Message-ID: <1281278424.81.0.0347871045638.issue9536@psf.upfronthosting.co.za>


John Posner <jjposner at optimum.net> added the comment:

I think it would be confusing to create of subclass of defaultdict, defining a __missing__ method in that subclass. The existence of the __missing__ method would cancel the main functionality of the defaultdict object: invoking the "default value factory" callable.

I think it would be better to encourage programmers to subclass dict directly, instead of subclassing defaultdict.

----------
status: pending -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9536>
_______________________________________

From report at bugs.python.org  Sun Aug  8 16:43:57 2010
From: report at bugs.python.org (John Posner)
Date: Sun, 08 Aug 2010 14:43:57 +0000
Subject: [docs] [issue9536] defaultdict doc makes incorrect reference to
	__missing__	method
In-Reply-To: <1281106528.37.0.0435364267174.issue9536@psf.upfronthosting.co.za>
Message-ID: <1281278637.9.0.688182084821.issue9536@psf.upfronthosting.co.za>


John Posner <jjposner at optimum.net> added the comment:

On python-list, Wolfram Hinderer objected to the proposed patch's calling __missing__ a "special method".

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9536>
_______________________________________

From report at bugs.python.org  Sun Aug  8 16:44:40 2010
From: report at bugs.python.org (John Posner)
Date: Sun, 08 Aug 2010 14:44:40 +0000
Subject: [docs] [issue9536] defaultdict doc makes incorrect reference to
	__missing__	method
In-Reply-To: <1281106528.37.0.0435364267174.issue9536@psf.upfronthosting.co.za>
Message-ID: <1281278680.23.0.300370389897.issue9536@psf.upfronthosting.co.za>


Changes by John Posner <jjposner at optimum.net>:


----------
status: open -> pending

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9536>
_______________________________________

From ercanal at gmail.com  Sun Aug  1 19:18:03 2010
From: ercanal at gmail.com (=?UTF-8?Q?Ercan_Altunta=C5=9F?=)
Date: Sun, 1 Aug 2010 20:18:03 +0300
Subject: [docs] 3.1.2 strings in v2.7 tutorial documentation
Message-ID: <AANLkTik62Be3ejYaTB34Y2RX78fMD7b7BtiDujr1ZbfS@mail.gmail.com>

In the section 3.1.2 strings  of python tutorial

You are giving examples of negative index numbers and at the end there is an
view for indexes and the where they correspond
as shown at below. The negative index numbers are showing wrong numbers.

  +---+---+---+---+---+
 | H | e | l | p | A |
 +---+---+---+---+---+
 0   1   2   3   4   5
-5  -4  -3  -2  -1

Best Regards
Ercan ALTUNTAS
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20100801/aed725d4/attachment-0001.html>

From imackinnon at gmail.com  Sat Aug  7 18:31:59 2010
From: imackinnon at gmail.com (Ian Mackinnon)
Date: Sat, 7 Aug 2010 12:31:59 -0400
Subject: [docs] Search result links move when search finishes
Message-ID: <AANLkTi=4pXay-ie_c_mm+C0XxJh6FwZH2szw2Cx-TS4C@mail.gmail.com>

I'd like to suggest an improvement to the python documentation website.

*Problem:*

When a search finishes, a line is inserted above the search results. eg:

Search finished, found 35 page(s) matching the search query.


This causes all the search result links to move downwards, so a user
attempting to click a link at that moment will click on the link above the
one they want.

*Solutions:*

   - Make space for the "Search finished" line before appending search
   results, or
   - Move it somewhere else where it won't affect their position.

Thanks

---
imackinnon at gmail.com
http://ianmackinnon.co.uk
+ 591.73425350 (Bolivia)
---
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20100807/4165d02f/attachment-0001.html>

From amandsin at cisco.com  Sun Aug  8 10:28:58 2010
From: amandsin at cisco.com (Amandeep Singh (amandsin))
Date: Sun, 8 Aug 2010 13:58:58 +0530
Subject: [docs] python tutorial more a reference than a tutorial
In-Reply-To: <4C504C6F.2020802@netwok.org>
References: <F790D9474379664BB03E53DA89E9218F0154E681@XMB-BGL-41A.cisco.com>
	<AANLkTi=taXtg7w=cfh7UmV49COoSe7BudVQowa95o+mP@mail.gmail.com>
	<4C504C6F.2020802@netwok.org>
Message-ID: <F790D9474379664BB03E53DA89E9218F0161AC2E@XMB-BGL-41A.cisco.com>

I can try to point to some pages where I struggled.

Section 9.2 of classes is very tough to read. 

In Chapter 7, Section 7.1, first line says,

"So far we've encountered two ways of writing values: expression statements and the print statement".
I tried to figure out what expression statements were. Went to the index page, found nothing. You might have given definition somewhere else, but just giving an example here could have made the context much simpler.


-----Original Message-----
From: ?ric Araujo [mailto:merwok at netwok.org] 
Sent: Wednesday, July 28, 2010 8:58 PM
To: Amandeep Singh (amandsin)
Cc: docs at python.org
Subject: Re: [docs] python tutorial more a reference than a tutorial

Hello Amandeep

Thank you for your feedback.

>> I tried to study your python tutorial, release 2.6.4. But was very
>> disappointed the way it is written. It is more a reference than a
>> tutorial. Language could have been simpler, giving more examples.

Can you point out examples of complicated language, or maybe give links
to other tutorials that have been better for you so that we can compare?

I remember that Dive Into Python was the accessible thing for me when I
started learning Python, the official tutorial came after. The first two
chapters (?Whetting Your Appetite? and ?Using the Python Interpreter?)
can certainly be off-putting for someone with no prior programming
experience.

Other tutorials may favor a hands-on approach, i.e. starting with a
project and going ahead, which is a very good way to learn. The official
tutorial seems more traditionally structured and less accessible; maybe
there?s room for a new, shorter, practical one (written from scratch or
copied from an external source).

[Anatoly]
> Loss of consistency is always a problem with documentation that is
> maintained in patches.

The documentation is files; editions are made with patches, like
everything else. What is the consistency problem? That people review the
patches and not the whole files maybe? I believe that there are readers
that catch consistency problems while reading the built doc, and I trust
Georg not to commit inconsistent changes.

> The whole Python documentation lacks user submitted scenarios and
> examples.

What are user-submitted scenarios? How are they useful?

Regarding examples, the doc of some modules is already so long that
there is need for a summary table, see for example itertools (other
modules would benefit from that). I don?t know if python-dev explicitly
wants the documentation to stay focused or if more examples are welcome;
at least, links to more detailed resources like
http://www.doughellmann.com/PyMOTW/ and
http://code.activestate.com/recipes/langs/python/ would be a useful
addition.

> I sell this idea for PSF for free. Take a look at online pages at
> http://php.net/ for an inspiration.

This doc has already been mentioned as example on mailing lists, only to
be shot down by other PHP users criticizing the low quality and
staleness of those user-submitted examples.

That said, there is a constant effort to lower the bar for
contributions. There has recently been changes to advertise this mailing
list and the bug tracker more prominently; what more can we do?

Regards


From amandsin at cisco.com  Sun Aug  8 10:54:37 2010
From: amandsin at cisco.com (Amandeep Singh (amandsin))
Date: Sun, 8 Aug 2010 14:24:37 +0530
Subject: [docs] python tutorial more a reference than a tutorial
References: <F790D9474379664BB03E53DA89E9218F0154E681@XMB-BGL-41A.cisco.com>
	<AANLkTi=taXtg7w=cfh7UmV49COoSe7BudVQowa95o+mP@mail.gmail.com>
	<4C504C6F.2020802@netwok.org> 
Message-ID: <F790D9474379664BB03E53DA89E9218F0161AC30@XMB-BGL-41A.cisco.com>

Adding to this,

Page 47, Section 7.1, third paragraph

"The str() function is meant to return representations of values which are fairly human-readable, while repr() is meant to generate representations which can be read by the interpreter (or will force a SyntaxError if there is not equivalent syntax)."

Reader is left to his imagination when SyntaxError will be given. An example from your side could have made thing simpler.

Thanks,
Amandeep


-----Original Message-----
From: Amandeep Singh (amandsin) 
Sent: Sunday, August 08, 2010 1:59 PM
To: '?ric Araujo'
Cc: docs at python.org
Subject: RE: [docs] python tutorial more a reference than a tutorial

I can try to point to some pages where I struggled.

Section 9.2 of classes is very tough to read. 

In Chapter 7, Section 7.1, first line says,

"So far we've encountered two ways of writing values: expression statements and the print statement".
I tried to figure out what expression statements were. Went to the index page, found nothing. You might have given definition somewhere else, but just giving an example here could have made the context much simpler.


-----Original Message-----
From: ?ric Araujo [mailto:merwok at netwok.org] 
Sent: Wednesday, July 28, 2010 8:58 PM
To: Amandeep Singh (amandsin)
Cc: docs at python.org
Subject: Re: [docs] python tutorial more a reference than a tutorial

Hello Amandeep

Thank you for your feedback.

>> I tried to study your python tutorial, release 2.6.4. But was very
>> disappointed the way it is written. It is more a reference than a
>> tutorial. Language could have been simpler, giving more examples.

Can you point out examples of complicated language, or maybe give links
to other tutorials that have been better for you so that we can compare?

I remember that Dive Into Python was the accessible thing for me when I
started learning Python, the official tutorial came after. The first two
chapters (?Whetting Your Appetite? and ?Using the Python Interpreter?)
can certainly be off-putting for someone with no prior programming
experience.

Other tutorials may favor a hands-on approach, i.e. starting with a
project and going ahead, which is a very good way to learn. The official
tutorial seems more traditionally structured and less accessible; maybe
there?s room for a new, shorter, practical one (written from scratch or
copied from an external source).

[Anatoly]
> Loss of consistency is always a problem with documentation that is
> maintained in patches.

The documentation is files; editions are made with patches, like
everything else. What is the consistency problem? That people review the
patches and not the whole files maybe? I believe that there are readers
that catch consistency problems while reading the built doc, and I trust
Georg not to commit inconsistent changes.

> The whole Python documentation lacks user submitted scenarios and
> examples.

What are user-submitted scenarios? How are they useful?

Regarding examples, the doc of some modules is already so long that
there is need for a summary table, see for example itertools (other
modules would benefit from that). I don?t know if python-dev explicitly
wants the documentation to stay focused or if more examples are welcome;
at least, links to more detailed resources like
http://www.doughellmann.com/PyMOTW/ and
http://code.activestate.com/recipes/langs/python/ would be a useful
addition.

> I sell this idea for PSF for free. Take a look at online pages at
> http://php.net/ for an inspiration.

This doc has already been mentioned as example on mailing lists, only to
be shot down by other PHP users criticizing the low quality and
staleness of those user-submitted examples.

That said, there is a constant effort to lower the bar for
contributions. There has recently been changes to advertise this mailing
list and the bug tracker more prominently; what more can we do?

Regards


From caoxingk at gmail.com  Sun Aug  8 11:00:20 2010
From: caoxingk at gmail.com (=?utf-8?B?Y2FveGluZ2s=?=)
Date: Sun, 8 Aug 2010 17:00:20 +0800
Subject: [docs] How to build "Python Documentation" under Windows XP ?
Message-ID: <tencent_7B76CE5F4EE4569567B63E22@qq.com>

Hi,

I get the Python2.5 Documentation source from python's SVN. And I want to build it,
not build python but python documentation (the content under "/python/trunk/doc" ),
with some usefull notes of myself. 

But, I find some shell commands in file: "doc/Makefile".

It means I can not build "Python Documentation" under Windows XP ?  Even I get
the envrionment of Perl, Python, LaTex(CTeX) ready, as the file
"/python/trunk/doc/README"  says.

P.S. My gnu-make environment was under MinGW.

Sorry, my English is not very well.

From report at bugs.python.org  Sun Aug  8 23:13:07 2010
From: report at bugs.python.org (=?utf-8?q?=C5=81ukasz_Langa?=)
Date: Sun, 08 Aug 2010 21:13:07 +0000
Subject: [docs] [issue9101] reference json format in file formats chapter
In-Reply-To: <1277739443.04.0.607128047102.issue9101@psf.upfronthosting.co.za>
Message-ID: <1281301987.5.0.922340634127.issue9101@psf.upfronthosting.co.za>


Changes by ?ukasz Langa <lukasz at langa.pl>:


----------
assignee: docs at python -> lukasz.langa

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9101>
_______________________________________

From report at bugs.python.org  Sun Aug  8 23:26:21 2010
From: report at bugs.python.org (William Mill)
Date: Sun, 08 Aug 2010 21:26:21 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281302780.78.0.344223088704.issue6678@psf.upfronthosting.co.za>


William Mill <bill.mill at gmail.com> added the comment:

This patch is built against trunk, because I'm not sure what branch I should build it against. If that's the wrong branch, I'd be happy to figure it out against the right branch.

I tested both the help() and the doc build, both worked as expected.

I will happily do anything more I can to help.

----------
Added file: http://bugs.python.org/file18443/currentframe.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 00:17:05 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sun, 08 Aug 2010 22:17:05 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281305825.14.0.860280900901.issue6678@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Parameter 'depth' needs to be italicized in the function signature also.

The old 'trunk' is now frozen with the release of 2.7. The py3k branch is now the actual trunk. Please edit, build against that, and retest. I think the word 'trunk' will go away with the switch to hg planned for a few months from now.

----------
stage: needs patch -> patch review

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 00:22:25 2010
From: report at bugs.python.org (Florent Xicluna)
Date: Sun, 08 Aug 2010 22:22:25 +0000
Subject: [docs] [issue2864] etree: Add XPath documentation
In-Reply-To: <1210863012.97.0.696135529968.issue2864@psf.upfronthosting.co.za>
Message-ID: <1281306145.78.0.721042136276.issue2864@psf.upfronthosting.co.za>


Florent Xicluna <florent.xicluna at gmail.com> added the comment:

There's another issue about lack of documentation on this topic.
See #6488.

----------
assignee: docs at python -> 
resolution:  -> duplicate
status: open -> closed
superseder:  -> ElementTree documentation refers to "path" with no explanation, and inconsistently

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue2864>
_______________________________________

From report at bugs.python.org  Mon Aug  9 03:05:32 2010
From: report at bugs.python.org (William Mill)
Date: Mon, 09 Aug 2010 01:05:32 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281315932.27.0.752006789124.issue6678@psf.upfronthosting.co.za>


William Mill <bill.mill at gmail.com> added the comment:

I've updated the patch to be based on the py3k branch, and updated the sys module's documentation for _getframe, since inspect just aliases sys._getframe to currentframe().

I've updated the argument list of both inspect.currentframe and sys._getframe to reflect that depth isn't an optional argument, but one with a default value; this matches more closely with the other documentation in those two modules.

Also, the function signature is automatically italicized; here's a screenshot of what it looks like: http://img.skitch.com/20100809-xddf43hy2ifxc3b2an4ae85fre.jpg

----------
Added file: http://bugs.python.org/file18449/currentframe.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 04:43:47 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Mon, 09 Aug 2010 02:43:47 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281321827.03.0.607692384163.issue6678@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


Removed file: http://bugs.python.org/file18443/currentframe.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 05:04:00 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Mon, 09 Aug 2010 03:04:00 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281323039.76.0.368845899506.issue6678@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

A parameter with a default is very much optional. Makes no sense otherwise. In 3.x docs, the square brackets that were used in 2.x and are still used for optional args without default are left off because they are redundant. So in the example you depict, context is optional with a default of 1, and 'depth=0' is correct and means that is it optional with default 0.

I just realized that I removed the info that depth must me an integer.
>>> inspect.currentframe(0.0)
Traceback (most recent call last):
  File "<pyshell#2>", line 1, in <module>
    inspect.currentframe(0.0)
TypeError: integer argument expected, got float

Although it seems obvious, it also seems that the context count in the preceding 3 funcs does not have to be an int, at least not always,
>>> inspect.getframeinfo(inspect.currentframe(0), context=1.0)
Traceback(filename='<pyshell#3>', lineno=1, function='<module>', code_context=None, index=None)

which surprised me, so I think we should insert 'an integer ' before 'depth'.

Call the revision currentframe_2.diff. Some reviewers prefer unique names for uploaded files, and I think the current one should be left in case whichever doc person who grabs this prefers it.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 05:06:02 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Mon, 09 Aug 2010 03:06:02 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281323161.66.0.791923346686.issue6678@psf.upfronthosting.co.za>


Benjamin Peterson <benjamin at python.org> added the comment:

Technically, inspect.currentframe() doesn't have a depth parameter. It's just implemented by aliasing to sys._getframe() which does.

----------
nosy: +benjamin.peterson

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 05:28:09 2010
From: report at bugs.python.org (William Mill)
Date: Mon, 09 Aug 2010 03:28:09 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281324489.66.0.825569520097.issue6678@psf.upfronthosting.co.za>


William Mill <bill.mill at gmail.com> added the comment:

Terry: fair enough, I'll add that it's required to be an integer. 

I just meant that the brackets seemed not to be around other keyword arguments, not that it's not optional, sorry for being unclear.

Ben and/or Terry: Would you prefer the inspect.currentframe docs to say something like:

Returns an alias to :func:`sys._getframe` if it exists, otherwise returns a function which always returns ``None``

? I see that as more accurate, but perhaps not as useful to a user of the library who then has to go read the documentation for sys._getframe to find out what the function does.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 05:58:49 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Mon, 09 Aug 2010 03:58:49 +0000
Subject: [docs] [issue5416] str.replace does strange things when given a
	negative	count
In-Reply-To: <1236163931.77.0.818123555808.issue5416@psf.upfronthosting.co.za>
Message-ID: <1281326329.28.0.0976820445792.issue5416@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Changing to doc issue as two people suggested. Can anyone suggest new text to add?

----------
assignee: georg.brandl -> docs at python
components: +Documentation -Interpreter Core
nosy: +docs at python, terry.reedy
stage: unit test needed -> needs patch
versions: +Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5416>
_______________________________________

From report at bugs.python.org  Mon Aug  9 11:04:21 2010
From: report at bugs.python.org (Senthil Kumaran)
Date: Mon, 09 Aug 2010 09:04:21 +0000
Subject: [docs] [issue5416] str.replace does strange things when given a
	negative	count
In-Reply-To: <1236163931.77.0.818123555808.issue5416@psf.upfronthosting.co.za>
Message-ID: <1281344661.15.0.0103609286646.issue5416@psf.upfronthosting.co.za>


Senthil Kumaran <orsenthil at gmail.com> added the comment:

Fixed the doc string for release27-maint in revision r83879.
py3k (r83880) and release31-maint in r83881.

----------
resolution:  -> fixed
stage: needs patch -> committed/rejected
status: open -> closed
type: feature request -> behavior

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5416>
_______________________________________

From report at bugs.python.org  Mon Aug  9 15:06:02 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Mon, 09 Aug 2010 13:06:02 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281359161.62.0.932523444883.issue6678@psf.upfronthosting.co.za>


Benjamin Peterson <benjamin at python.org> added the comment:

r83890 no longer produces the extra argument in help().

----------
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 18:19:45 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Mon, 09 Aug 2010 16:19:45 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281370785.25.0.930624058339.issue6678@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Benjamin: Previously, .currentframe() == sys._getframe() == sys._getframe(0) but you redefined it as sys._getframe(1), which is a change in semantics. Is this intentional (ie, was it buggy before)?

William: Benjamin's point was that the bug was not the doc but the implementation of .currentframe, so we were making the wrong fix relative to the intention of .currentframe.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 18:22:22 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Mon, 09 Aug 2010 16:22:22 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1281370785.25.0.930624058339.issue6678@psf.upfronthosting.co.za>
Message-ID: <AANLkTinV8Hfw9GdBizc2TA5F5vNbabWWbGmyZ-j2L82F@mail.gmail.com>


Benjamin Peterson <benjamin at python.org> added the comment:

2010/8/9 Terry J. Reedy <report at bugs.python.org>:
>
> Terry J. Reedy <tjreedy at udel.edu> added the comment:
>
> Benjamin: Previously, .currentframe() == sys._getframe() == sys._getframe(0) but you redefined it as sys._getframe(1), which is a change in semantics. Is this intentional (ie, was it buggy before)?

Yes, currentframe() doesn't take an argument. Whether it should or not
is a feature request.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 18:37:58 2010
From: report at bugs.python.org (Alexander Belopolsky)
Date: Mon, 09 Aug 2010 16:37:58 +0000
Subject: [docs] [issue8834] Define order of Misc/ACKS entries
In-Reply-To: <1274993181.13.0.347164864235.issue8834@psf.upfronthosting.co.za>
Message-ID: <1281371878.23.0.945887660117.issue8834@psf.upfronthosting.co.za>


Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

Committed in release27-maint branch in r83893.  I am not sure this belongs in 2.6 and there is a small practical problem with the merge due to Latin-1 encoding used in the 2.6 version.

I am also not sure whether keeping separate 2.x and 3.x versions serves any useful purpose.

I would like to merge 2.7 and 3.2 lists.   I am about +0.5 on syncing all three versions after that.  If the 2.6 has to stay in Latin-1, I would rather not touch it.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8834>
_______________________________________

From report at bugs.python.org  Mon Aug  9 19:52:53 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Mon, 09 Aug 2010 17:52:53 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281376373.28.0.331997437395.issue6678@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

You ignored my question: why did you change the argument passed on to sys._getframe?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 19:57:00 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Mon, 09 Aug 2010 17:57:00 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1281376373.28.0.331997437395.issue6678@psf.upfronthosting.co.za>
Message-ID: <AANLkTikdU1o4A5hWhkYtYpPFupYAqzgf9_-LbVCig_8j@mail.gmail.com>


Benjamin Peterson <benjamin at python.org> added the comment:

2010/8/9 Terry J. Reedy <report at bugs.python.org>:
>
> Terry J. Reedy <tjreedy at udel.edu> added the comment:
>
> You ignored my question: why did you change the argument passed on to sys._getframe?

Ah, so that the caller's frame is returned and not currentframe's.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Mon Aug  9 20:16:48 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Mon, 09 Aug 2010 18:16:48 +0000
Subject: [docs] [issue8834] Define order of Misc/ACKS entries
In-Reply-To: <1274993181.13.0.347164864235.issue8834@psf.upfronthosting.co.za>
Message-ID: <1281377808.21.0.957063835638.issue8834@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

At this point, I am sure that Barry would prefer leaving things alone for 2.6.

I am surprised that there are separate lists. I thought there was just one which distributions grabbed when made.

I suppose that one could claim that someone who only contributes to a branch after it branches off should not be listed for other branches, but in the absence of an automatic addition mechanism and dependence on hand-addition by committers, that does not work so well.

Certainly, Guido's header does not specify 'this release'.

----------
versions:  -Python 2.6, Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8834>
_______________________________________

From report at bugs.python.org  Mon Aug  9 20:24:56 2010
From: report at bugs.python.org (Alexander Belopolsky)
Date: Mon, 09 Aug 2010 18:24:56 +0000
Subject: [docs] [issue8834] Define order of Misc/ACKS entries
In-Reply-To: <1281377808.21.0.957063835638.issue8834@psf.upfronthosting.co.za>
Message-ID: <AANLkTik0h+EbSTLh0R1NTVhnpxbschA5y=M5qzvRNooN@mail.gmail.com>


Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

On Mon, Aug 9, 2010 at 2:16 PM, Terry J. Reedy <report at bugs.python.org> wrote:
..
> I am surprised that there are separate lists. I thought there was just one which distributions grabbed when made.

I don't think this is intentional.  More likely committers add
acknowledgments in the same commit as the code changes and they end up
in whatever branch the patch is applied to.   I think this is fine,
but from time to time the list should be merged to avoid svnmerge
annoyances.  Whoever is annoyed by svnmerge (like myself :-) should
resync the lists.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8834>
_______________________________________

From report at bugs.python.org  Mon Aug  9 20:48:31 2010
From: report at bugs.python.org (Georg Brandl)
Date: Mon, 09 Aug 2010 18:48:31 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281379711.39.0.0110462616998.issue6678@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Terry: due to the additional indirection by making currentframe() a separate function, _getframe(0) would return the frame in currentframe().

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Tue Aug 10 00:03:41 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Mon, 09 Aug 2010 22:03:41 +0000
Subject: [docs] [issue6678] inspect.currentframe documentation omits
	optional depth	parameter
In-Reply-To: <1249928701.73.0.0206445902812.issue6678@psf.upfronthosting.co.za>
Message-ID: <1281391421.29.0.240862555118.issue6678@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Thank you both. I had missed the subtle difference between aliasing and wrapping in this particular case.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6678>
_______________________________________

From report at bugs.python.org  Tue Aug 10 00:18:19 2010
From: report at bugs.python.org (Daniel Stutzbach)
Date: Mon, 09 Aug 2010 22:18:19 +0000
Subject: [docs] [issue8041] No documentation for
	Py_TPFLAGS_HAVE_STACKLESS_EXTENSION	or Py_TPFLAGS_HAVE_VERSION_TAG.
In-Reply-To: <1267544098.65.0.440493208051.issue8041@psf.upfronthosting.co.za>
Message-ID: <1281392299.67.0.124644070718.issue8041@psf.upfronthosting.co.za>


Daniel Stutzbach <daniel at stutzbachenterprises.com> added the comment:

I think if they are mentioned, they should be documented.  Removing mention of them would be fine with me.

Looking at this again, I think the description of Py_TPFLAGS_DEFAULT is no longer accurate.  It reads: "This is a bitmask of all the bits that pertain to the existence of certain fields in the type object and its extension structures. Currently, it includes the following bits: Py_TPFLAGS_HAVE_STACKLESS_EXTENSION, Py_TPFLAGS_HAVE_VERSION_TAG."

But neither of those flags pertain to the existence of certain fields, do they?

Perhaps it should simply read: "This bitmask should be set by all types to define certain bits used internally by Python."

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8041>
_______________________________________

From report at bugs.python.org  Tue Aug 10 13:32:20 2010
From: report at bugs.python.org (Florent Xicluna)
Date: Tue, 10 Aug 2010 11:32:20 +0000
Subject: [docs] [issue1626300] 'Installing Python Modules' does not work for
	Windows
Message-ID: <1281439940.52.0.971414849407.issue1626300@psf.upfronthosting.co.za>


Changes by Florent Xicluna <florent.xicluna at gmail.com>:


----------
assignee:  -> docs at python
components: +Windows
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1626300>
_______________________________________

From report at bugs.python.org  Tue Aug 10 22:50:03 2010
From: report at bugs.python.org (Mitchell Model)
Date: Tue, 10 Aug 2010 20:50:03 +0000
Subject: [docs] [issue9562] Slightly misleading wording in documentation
	of	dict.update
In-Reply-To: <1281473403.13.0.50491902338.issue9562@psf.upfronthosting.co.za>
Message-ID: <1281473403.13.0.50491902338.issue9562@psf.upfronthosting.co.za>


New submission from Mitchell Model <mlm at acm.org>:

The documentation of dict.update says that it "accepts either another dictionary object or an iterable of key/value pairs (as a tuple or other iterable of length two)" The parenthesized phrase is slightly misleading in that it could be interpreted as requiring the argument to be an iterable of length two, whereas the argument should be an iterable of iterables of length 2 (if not a dictionary). Suggest rewriting in the plural:
    (as tuples or other iterables of length two)

----------
assignee: docs at python
components: Documentation
messages: 113557
nosy: MLModel, docs at python
priority: normal
severity: normal
status: open
title: Slightly misleading wording in documentation of dict.update
versions: Python 2.6, Python 2.7, Python 3.1

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9562>
_______________________________________

From report at bugs.python.org  Wed Aug 11 00:18:19 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 10 Aug 2010 22:18:19 +0000
Subject: [docs] [issue1626300] 'Installing Python Modules' does not work for
	Windows
Message-ID: <1281478699.25.0.855183868521.issue1626300@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
nosy: +merwok

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1626300>
_______________________________________

From report at bugs.python.org  Wed Aug 11 00:22:02 2010
From: report at bugs.python.org (Alexander Belopolsky)
Date: Tue, 10 Aug 2010 22:22:02 +0000
Subject: [docs] [issue8834] Define order of Misc/ACKS entries
In-Reply-To: <1274993181.13.0.347164864235.issue8834@psf.upfronthosting.co.za>
Message-ID: <1281478921.84.0.299231825776.issue8834@psf.upfronthosting.co.za>


Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

Committed in r83937 (py3k) and r83938 (release31-maint).  The py3k version is now a superset of the lists in the maintenance branches. I don't want to generate any more commit traffic by bringing all branches in sync.  I'll leave it to the next committer who encounters a Misc/ACKS merge conflict which is now unlikely.

I am closing with a link to python-dev discussion that r83893 generated.

http://mail.python.org/pipermail/python-dev/2010-August/102960.html

----------
resolution:  -> accepted
stage: patch review -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8834>
_______________________________________

From report at bugs.python.org  Wed Aug 11 04:14:23 2010
From: report at bugs.python.org (R. David Murray)
Date: Wed, 11 Aug 2010 02:14:23 +0000
Subject: [docs] [issue7950] subprocess.Popen documentation should contain a
	good	warning about the security implications when using shell=True
In-Reply-To: <1266401759.12.0.600282213979.issue7950@psf.upfronthosting.co.za>
Message-ID: <1281492863.19.0.599245600422.issue7950@psf.upfronthosting.co.za>


R. David Murray <rdmurray at bitdance.com> added the comment:

Chris, thank you for the patch, sorry I didn't acknowledge it earlier.  I think the core of the patch is good, though I will probably drop the text starting from "To safely use..." when I get time to apply it.  I will also add a note along the lines of "this applies also to Windows, although the details of the exploits differ".

I would like input from others as to whether this should indeed be a red warning box, or is adequate as a note.  We try to minimize the number of red boxes, but this may well be an appropriate case for one (I'm leaning that way myself).

----------
assignee: georg.brandl -> docs at python
nosy: +docs at python
stage: needs patch -> patch review

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7950>
_______________________________________

From report at bugs.python.org  Wed Aug 11 23:23:20 2010
From: report at bugs.python.org (Raymond Hettinger)
Date: Wed, 11 Aug 2010 21:23:20 +0000
Subject: [docs] [issue5416] str.replace does strange things when given a
	negative	count
In-Reply-To: <1236163931.77.0.818123555808.issue5416@psf.upfronthosting.co.za>
Message-ID: <1281561800.13.0.258777652636.issue5416@psf.upfronthosting.co.za>


Raymond Hettinger <rhettinger at users.sourceforge.net> added the comment:

FWIW, we should be cautious about documenting all behaviors.  It is arguable that this was an implementation detail and not a guaranteed behavior.  As soon as you document it, people will rely on the API and all other implementations will need to change in order to comply.

Please consider whether this doc change should be reverted.

----------
nosy: +rhettinger
status: closed -> open

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5416>
_______________________________________

From report at bugs.python.org  Thu Aug 12 00:47:21 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Wed, 11 Aug 2010 22:47:21 +0000
Subject: [docs] [issue1626300] 'Installing Python Modules' does not work for
	Windows
Message-ID: <1281566841.22.0.716305301862.issue1626300@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

My personal taste is that there is virtue in having such simple examples uncluttered by OS-specific variations, but since MvL does not want the python executable to be on the PATH per default, I defer to him and accept your solution. I?ll make a patch with a slightly different wording than the one you proposed.

----------
assignee: docs at python -> eric.araujo

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1626300>
_______________________________________

From report at bugs.python.org  Thu Aug 12 05:36:16 2010
From: report at bugs.python.org (Senthil Kumaran)
Date: Thu, 12 Aug 2010 03:36:16 +0000
Subject: [docs] [issue5416] str.replace does strange things when given a
	negative	count
In-Reply-To: <1236163931.77.0.818123555808.issue5416@psf.upfronthosting.co.za>
Message-ID: <1281584175.95.0.0403202752956.issue5416@psf.upfronthosting.co.za>


Senthil Kumaran <orsenthil at gmail.com> added the comment:

I am fine with your proposal, Raymond. When I went about the change the docstrings, I did notice that it is not an intentional feature to provide negative values in the replace argument. The negative value (-1 as count) was being used somewhat as a sentinel value to denote replace-all.

I have no problem in reverting current documentation fix, but as a fix we can remove the existing reference of -1 in docstrings of str.replace so that it does not cause any confusing, which was the point of the original bug-report.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5416>
_______________________________________

From report at bugs.python.org  Thu Aug 12 09:00:16 2010
From: report at bugs.python.org (Raymond Hettinger)
Date: Thu, 12 Aug 2010 07:00:16 +0000
Subject: [docs] [issue5416] str.replace does strange things when given a
	negative	count
In-Reply-To: <1236163931.77.0.818123555808.issue5416@psf.upfronthosting.co.za>
Message-ID: <1281596416.35.0.598229347008.issue5416@psf.upfronthosting.co.za>


Raymond Hettinger <rhettinger at users.sourceforge.net> added the comment:

Thank you.  Please do the reversion and the docstring fixup.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5416>
_______________________________________

From report at bugs.python.org  Fri Aug 13 00:03:43 2010
From: report at bugs.python.org (Robert Mohr)
Date: Thu, 12 Aug 2010 22:03:43 +0000
Subject: [docs] [issue9582] documentation line needs rewording
In-Reply-To: <1281650622.86.0.310513887463.issue9582@psf.upfronthosting.co.za>
Message-ID: <1281650622.86.0.310513887463.issue9582@psf.upfronthosting.co.za>


New submission from Robert Mohr <python-bugs at mohrr.net>:

The last line of http://docs.python.org/faq/programming.html#is-there-a-scanf-or-sscanf-equivalent is not proper English:

For more complicated input parsing, regular expressions more powerful than C?s sscanf() and better suited for the task.

This also shows up in the 3.2 docs.

----------
assignee: docs at python
components: Documentation
messages: 113711
nosy: docs at python, mohrr
priority: normal
severity: normal
status: open
title: documentation line needs rewording
versions: Python 2.7, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9582>
_______________________________________

From report at bugs.python.org  Fri Aug 13 03:36:21 2010
From: report at bugs.python.org (STINNER Victor)
Date: Fri, 13 Aug 2010 01:36:21 +0000
Subject: [docs] [issue8648] The UTF-7 codec functions are undocumented
In-Reply-To: <1273248636.7.0.217932609429.issue8648@psf.upfronthosting.co.za>
Message-ID: <1281663380.93.0.593287086504.issue8648@psf.upfronthosting.co.za>


STINNER Victor <victor.stinner at haypocalc.com> added the comment:

> Thanks, fixed in r83558.

 .. cfunction:: PyObject* PyUnicode_DecodeUTF8Stateful(...)

UTF-7 or UTF-8?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8648>
_______________________________________

From wvanheddeghem at hotmail.com  Mon Aug  9 11:11:10 2010
From: wvanheddeghem at hotmail.com (Ward Van Heddeghem)
Date: Mon, 09 Aug 2010 11:11:10 +0200
Subject: [docs] datetime - add remark for default Python locale != OS locale
Message-ID: <BLU0-SMTP27A82E9782AE6675762E4AAE940@phx.gbl>

  Hello,

I have a suggestion for the "strftime() and strptime() behaviour 
<http://docs.python.org/library/datetime.html#strftime-and-strptime-behavior>" 
section in the documentation:

I believe it would be informative to *provide a remark that the default 
Python locale is /by default/ not the default OS locale*, with a link to 
e.g. the setlocale() 
<http://docs.python.org/library/locale.html#locale.setlocale> function 
where it is explained how to use the default OS locale.

I find this non-obvious, since descriptions such as "Locale's 
appropriate date representation" (for the %x directive) would make me 
assume that, without any action from my part,  the locale's appropriate 
date representation is the one from the OS.
This made me submit this stackoverflow question:
http://stackoverflow.com/questions/3438120/python-date-formatted-with-x-locale-is-not-as-expected/3438292#3438292

best regards,
Ward van Heddeghem
Belgium
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20100809/85c5683b/attachment.html>

From Raphael.Mankin at rbs.com  Wed Aug 11 13:39:15 2010
From: Raphael.Mankin at rbs.com (Raphael.Mankin at rbs.com)
Date: Wed, 11 Aug 2010 12:39:15 +0100
Subject: [docs] Logging module
Message-ID: <3FD061693071E948A07F24D7CFEF9CC701B63A6F87@LONMC01040.rbsres07.net>

I have just started using 'logging' and had some difficulty understanding the documentation. This was in spite of my knowing log4j, log4perl and so on.

1. It is nowhere stated that all handlers for a logger are called.
2. In http://docs.python.org/release/2.5/lib/module-logging.html the entry for basicConfig()( does not explain that 'filename' and 'stream' are mutually exclusive. This is stated elsewhere, but one has to dig for it.
3. More generally, the distinction between the convenience functions defined at 'logging' level, and the specific functions defined at 'Logger' level is not made clear in the documentation, particularly in the introductory section.
4. The introductory section talks of hierarchies of loggers but does not mention the 'propagate' flag or the idea of naming loggers after the fully qualified class name, leaving the whole hierarchical naming scheme unmotivated.

I hope this helps to improve the documentation.

Raphael Mankin
- 
RBS Global Banking & Markets
135 Bishopsgate, London, EC2M 3UR, GB
Office: +44 20 7085 9080   |  Mobile: +44 20 7085 9080 

***********************************************************************************
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 10, 
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. 

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

***********************************************************************************


From alex at physics.umn.edu  Fri Aug 13 05:56:54 2010
From: alex at physics.umn.edu (Alexander Heger)
Date: Thu, 12 Aug 2010 22:56:54 -0500
Subject: [docs] typo
Message-ID: <4C64C286.3020309@physics.umn.edu>

in
http://docs.python.org/library/functions.html

range([start], stop[, step])

should be written as

range([start,] stop[, step])

same for slice.

EXAMPLE:

In [91]: range(,2)
------------------------------------------------------------
    File "<ipython console>", line 1
      range(,2)
            ^
SyntaxError: invalid syntax


In [92]: range(2)
Out[92]: [0, 1]

From alex at physics.umn.edu  Fri Aug 13 06:28:52 2010
From: alex at physics.umn.edu (Alexander Heger)
Date: Thu, 12 Aug 2010 23:28:52 -0500
Subject: [docs] question on description
In-Reply-To: <4C64C286.3020309@physics.umn.edu>
References: <4C64C286.3020309@physics.umn.edu>
Message-ID: <4C64CA04.3070806@physics.umn.edu>

http://docs.python.org/library/stdtypes.html

lists in 5.4.:

"round(x[, n]) 	x rounded to n digits, rounding half to even. If n is 
omitted, it defaults to 0."

what does "rounding half to even" mean?

In [141]: round(1.5)
Out[141]: 2.0

In [142]: round(0.5)
Out[142]: 1.0


I should have expected (IEEE)

In [141]: round(1.5)
Out[141]: 2.0

In [142]: round(0.5)
Out[142]: 0.0


-Alexander

From report at bugs.python.org  Sat Aug 14 07:12:11 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sat, 14 Aug 2010 05:12:11 +0000
Subject: [docs] [issue9061] cgi.escape Can Lead To XSS Vulnerabilities
In-Reply-To: <1277307995.11.0.923855376948.issue9061@psf.upfronthosting.co.za>
Message-ID: <1281762730.47.0.646675207299.issue9061@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Markup nit fixed in r83999 (py3k) and r84001 (stupid typo), r84002 (3.1), r84003 (2.7).

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9061>
_______________________________________

From report at bugs.python.org  Sun Aug 15 14:23:46 2010
From: report at bugs.python.org (Floris Bruynooghe)
Date: Sun, 15 Aug 2010 12:23:46 +0000
Subject: [docs] [issue9608] Re-phrase best way of using exceptions in
	doanddont.rst
In-Reply-To: <1281875025.64.0.398474348151.issue9608@psf.upfronthosting.co.za>
Message-ID: <1281875025.64.0.398474348151.issue9608@psf.upfronthosting.co.za>


New submission from Floris Bruynooghe <floris.bruynooghe at gmail.com>:

The description of how to best use exceptions is slightly confusing and led me to believe there was an issue when using open() as a context manager.  The main issue is that the wording seems to suggest the example above it is the best and not the very last.

Attached is a patch which uses a slightly different wording which IMHO makes it clearer that the with-statement is the preferred method and does not introduce subtle bugs.

----------
assignee: docs at python
components: Documentation
files: doandont.diff
keywords: patch
messages: 113949
nosy: docs at python, flub
priority: normal
severity: normal
status: open
title: Re-phrase best way of using exceptions in doanddont.rst
type: feature request
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3
Added file: http://bugs.python.org/file18538/doandont.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9608>
_______________________________________

From report at bugs.python.org  Mon Aug 16 00:56:16 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sun, 15 Aug 2010 22:56:16 +0000
Subject: [docs] [issue9582] documentation line needs rewording
In-Reply-To: <1281650622.86.0.310513887463.issue9582@psf.upfronthosting.co.za>
Message-ID: <1281912969.72.0.290099868393.issue9582@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

PATCH add 'are' after 'expressions'.

----------
keywords: +patch
nosy: +terry.reedy
stage:  -> needs patch
type:  -> behavior

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9582>
_______________________________________

From report at bugs.python.org  Mon Aug 16 00:56:26 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sun, 15 Aug 2010 22:56:26 +0000
Subject: [docs] [issue9582] documentation line needs rewording
In-Reply-To: <1281650622.86.0.310513887463.issue9582@psf.upfronthosting.co.za>
Message-ID: <1281912986.31.0.533068297634.issue9582@psf.upfronthosting.co.za>


Changes by Terry J. Reedy <tjreedy at udel.edu>:


----------
keywords: +easy

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9582>
_______________________________________

From report at bugs.python.org  Mon Aug 16 01:16:12 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sun, 15 Aug 2010 23:16:12 +0000
Subject: [docs] [issue9562] Slightly misleading wording in documentation
	of	dict.update
In-Reply-To: <1281473403.13.0.50491902338.issue9562@psf.upfronthosting.co.za>
Message-ID: <1281914172.21.0.930314708075.issue9562@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

I agree with the replacement: 'tuples' and 'interables' modify and must agree with 'pairs', not the initial 'iterable'.

----------
keywords: +easy, patch
nosy: +terry.reedy
stage:  -> needs patch
versions: +Python 3.2 -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9562>
_______________________________________

From report at bugs.python.org  Mon Aug 16 01:55:58 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sun, 15 Aug 2010 23:55:58 +0000
Subject: [docs] [issue9582] documentation line needs rewording
In-Reply-To: <1281650622.86.0.310513887463.issue9582@psf.upfronthosting.co.za>
Message-ID: <1281916558.05.0.617002388393.issue9582@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

+1 on committing this change.

----------
nosy: +eric.araujo

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9582>
_______________________________________

From report at bugs.python.org  Mon Aug 16 02:05:25 2010
From: report at bugs.python.org (Mitchell Model)
Date: Mon, 16 Aug 2010 00:05:25 +0000
Subject: [docs] [issue8491] Need readline command and keybinding information
In-Reply-To: <1281037684.71.0.368448003507.issue8491@psf.upfronthosting.co.za>
Message-ID: <EDD495A7-D932-4870-B112-1014F11E22D8@acm.org>


Mitchell Model <mlm at acm.org> added the comment:

On Aug 5, 2010, at 3:48 PM, Terry J. Reedy wrote:

> 
> Terry J. Reedy <tjreedy at udel.edu> added the comment:
> 
> Can you suggest a specific link and a specific location where to add it?

I would add a sentence to the first paragraph of the readline doc:

	Readline keybindings may be configured via an initialization file, typically .inputrc in your home directory; see 
http://cnswww.cns.cwru.edu/php/chet/readline/readline.html#SEC9 (or http://www.gnu.org/software/bash/manual/html_node/Readline-Init-File.html) for information about the format and allowable constructs of that file and the capabilities of the readline library in general.

I did a few quick tests and convinced myself that the module's C code's call to rl_initialize actually reads .inputrc (or the value of the environment variable INPUTRC if that is set).

> 
> ----------
> assignee: georg.brandl -> docs at python
> nosy: +docs at python, terry.reedy
> versions:  -Python 2.6
> 
> _______________________________________
> Python tracker <report at bugs.python.org>
> <http://bugs.python.org/issue8491>
> _______________________________________

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8491>
_______________________________________

From report at bugs.python.org  Mon Aug 16 19:52:39 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Mon, 16 Aug 2010 17:52:39 +0000
Subject: [docs] [issue9562] Slightly misleading wording in documentation
	of	dict.update
In-Reply-To: <1281473403.13.0.50491902338.issue9562@psf.upfronthosting.co.za>
Message-ID: <1281981159.2.0.813558024732.issue9562@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

+1 on committing this change.

----------
nosy: +eric.araujo

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9562>
_______________________________________

From report at bugs.python.org  Mon Aug 16 22:22:33 2010
From: report at bugs.python.org (Alexander Belopolsky)
Date: Mon, 16 Aug 2010 20:22:33 +0000
Subject: [docs] [issue8983] Docstrings should refer to help(name),
	not name.__doc__
In-Reply-To: <1276356394.26.0.0946047114478.issue8983@psf.upfronthosting.co.za>
Message-ID: <1281990153.19.0.885558608991.issue8983@psf.upfronthosting.co.za>


Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

Committed in r84106.  I left the __init__ docstring issue unresolved because it is orthogonal to the name.__doc__ vs. help(name) issue here.

With redundant help(type(x)), the meaning of the docstring is not changed. I am leaving docstrings on magic methods question for a separate issue.

----------
resolution:  -> accepted
stage: commit review -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8983>
_______________________________________

From report at bugs.python.org  Wed Aug 18 00:02:26 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Tue, 17 Aug 2010 22:02:26 +0000
Subject: [docs] [issue616013] cPickle documentation incomplete
Message-ID: <1282082546.51.0.855300193066.issue616013@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee:  -> docs at python
nosy: +docs at python
versions: +Python 3.1

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue616013>
_______________________________________

From report at bugs.python.org  Wed Aug 18 00:12:15 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Tue, 17 Aug 2010 22:12:15 +0000
Subject: [docs] [issue616013] cPickle documentation incomplete
Message-ID: <1282083135.38.0.239022726037.issue616013@psf.upfronthosting.co.za>


Changes by Benjamin Peterson <benjamin at python.org>:


----------
versions:  -Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue616013>
_______________________________________

From report at bugs.python.org  Wed Aug 18 01:59:00 2010
From: report at bugs.python.org (Guido van Rossum)
Date: Tue, 17 Aug 2010 23:59:00 +0000
Subject: [docs] [issue616013] cPickle documentation incomplete
Message-ID: <1282089540.69.0.37313572093.issue616013@psf.upfronthosting.co.za>


Changes by Guido van Rossum <guido at python.org>:


----------
nosy:  -gvanrossum

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue616013>
_______________________________________

From report at bugs.python.org  Wed Aug 18 02:14:47 2010
From: report at bugs.python.org (David Stanek)
Date: Wed, 18 Aug 2010 00:14:47 +0000
Subject: [docs] [issue8722] Documentation for __getattr__
In-Reply-To: <1273896658.97.0.575873001655.issue8722@psf.upfronthosting.co.za>
Message-ID: <1282090487.53.0.453902613573.issue8722@psf.upfronthosting.co.za>


Changes by David Stanek <dstanek at dstanek.com>:


----------
nosy: +dstanek

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8722>
_______________________________________

From report at bugs.python.org  Wed Aug 18 03:35:29 2010
From: report at bugs.python.org (Georg Brandl)
Date: Wed, 18 Aug 2010 01:35:29 +0000
Subject: [docs] [issue616013] cPickle documentation incomplete
Message-ID: <1282095329.39.0.389341424842.issue616013@psf.upfronthosting.co.za>


Changes by Georg Brandl <georg at python.org>:


----------
nosy:  -georg.brandl

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue616013>
_______________________________________

From report at bugs.python.org  Thu Aug 19 00:30:36 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Wed, 18 Aug 2010 22:30:36 +0000
Subject: [docs] [issue812750] OSA support for properties broken
Message-ID: <1282170636.27.0.902760676686.issue812750@psf.upfronthosting.co.za>


Mark Lawrence <breamoreboy at yahoo.co.uk> added the comment:

All that is needed is the doc patch to be applied and the issue closed.  Or have I missed something?

----------
assignee: jackjansen -> docs at python
nosy: +BreamoreBoy, docs at python
stage: unit test needed -> patch review

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue812750>
_______________________________________

From report at bugs.python.org  Thu Aug 19 01:49:35 2010
From: report at bugs.python.org (Ned Deily)
Date: Wed, 18 Aug 2010 23:49:35 +0000
Subject: [docs] [issue812750] OSA support for properties broken
Message-ID: <1282175375.8.0.172727886192.issue812750@psf.upfronthosting.co.za>


Ned Deily <nad at acm.org> added the comment:

Suggest a different wording to reflect that the 3rd-party appscript package has become the de facto standard for AppleScript support, so something like:

-stopped, and a replacement is expected for Python 2.5.
+stopped. For more up-to-date implementation of AppleScript support for Python, see the third-party py-appscript project: http://pypi.python.org/pypi/appscript/

----------
nosy: +ned.deily

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue812750>
_______________________________________

From report at bugs.python.org  Thu Aug 19 07:44:29 2010
From: report at bugs.python.org (Kirikaza)
Date: Thu, 19 Aug 2010 05:44:29 +0000
Subject: [docs] [issue9637] docs do not say that urllib uses HTTP_PROXY
In-Reply-To: <1282196669.74.0.629180904202.issue9637@psf.upfronthosting.co.za>
Message-ID: <1282196669.74.0.629180904202.issue9637@psf.upfronthosting.co.za>


New submission from Kirikaza <kirikaza at rambler.ru>:

In practice urllib reads HTTP_PROXY firstly and then if HTTP_PROXY is empty urllib reads http_proxy. Documentation (http://docs.python.org/library/urllib.html) says nothing about HTTP_PROXY.

Maybe it affects all the versions of Python.

----------
assignee: docs at python
components: Documentation
messages: 114319
nosy: docs at python, kirikaza
priority: normal
severity: normal
status: open
title: docs do not say that urllib uses HTTP_PROXY
versions: Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9637>
_______________________________________

From report at bugs.python.org  Thu Aug 19 08:01:10 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Thu, 19 Aug 2010 06:01:10 +0000
Subject: [docs] [issue901727] extra_path kwarg to setup() undocumented
Message-ID: <1282197670.97.0.636464032976.issue901727@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: tarek -> docs at python
nosy: +docs at python
stage:  -> patch review
versions: +Python 3.2 -Python 2.6, Python 2.7, Python 3.0

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue901727>
_______________________________________

From report at bugs.python.org  Thu Aug 19 12:55:12 2010
From: report at bugs.python.org (Anders Sandvig)
Date: Thu, 19 Aug 2010 10:55:12 +0000
Subject: [docs] [issue8595] Explain the default timeout in
	http-client-related	libraries
In-Reply-To: <1272768884.43.0.28527344604.issue8595@psf.upfronthosting.co.za>
Message-ID: <1282215312.33.0.929496510635.issue8595@psf.upfronthosting.co.za>


Changes by Anders Sandvig <anders.sandvig at gmail.com>:


----------
nosy: +anders.sandvig

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8595>
_______________________________________

From report at bugs.python.org  Thu Aug 19 13:42:46 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Thu, 19 Aug 2010 11:42:46 +0000
Subject: [docs] [issue901727] extra_path kwarg to setup() undocumented
Message-ID: <1282218165.72.0.137511577853.issue901727@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

The patch has some words missing (?to put between?), but I can add them. I?m also going to include the example that was in Bob?s message, since the bit of doc in the table alone is not enough to understand clearly what this does IMO.

I?m reassigning this to distutils2. distutils only gets bug fixes, and its doc is changed only when it says something that doesn?t work. This lets us put energy on distutils2.

I?ll get to it this week-end or later.

----------
assignee: docs at python -> eric.araujo
components: +Distutils2 -Distutils, Documentation
nosy: +eric.araujo
versions: +Python 2.5, Python 2.6, Python 2.7 -Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue901727>
_______________________________________

From report at bugs.python.org  Thu Aug 19 13:44:37 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Thu, 19 Aug 2010 11:44:37 +0000
Subject: [docs] [issue901727] extra_path kwarg to setup() undocumented
Message-ID: <1282218277.95.0.0964420375574.issue901727@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
versions: +Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue901727>
_______________________________________

From pilferingpanda at gmail.com  Tue Aug 17 15:24:12 2010
From: pilferingpanda at gmail.com (Charles Cihacek)
Date: Tue, 17 Aug 2010 08:24:12 -0500
Subject: [docs] error in section 5.1.3
Message-ID: <AANLkTi=7FSG7HbwZmBAgBMMhgB5AcVMh209aomn1PGku@mail.gmail.com>

I just wanted to point out that the first example of 5.1.3 doesn't correctly
list out prime numbers because both 2 and 3 are primes.  The wording should
probably be changed to numbers not divisible by 2 or 3.

Other than that great work, I'm excited to learn python!

-- 
I would love to change the world, but they won't give me the source code. :(
 --Unknown
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20100817/aa42424e/attachment.html>

From peter_e at gmx.net  Tue Aug 17 20:39:58 2010
From: peter_e at gmx.net (Peter Eisentraut)
Date: Tue, 17 Aug 2010 21:39:58 +0300
Subject: [docs] possible mixup in whatsnew/2.7.html#capsules
Message-ID: <1282070398.25113.8.camel@vanquo.pezone.net>

http://docs.python.org/dev/whatsnew/2.7.html#capsules says that
PyCObject_AsVoidPtr() will signal a PendingDeprecationWarning, but it is
actually PyCObject_FromVoidPtr() that signals the warning.


From report at bugs.python.org  Thu Aug 19 14:10:30 2010
From: report at bugs.python.org (Ronald Oussoren)
Date: Thu, 19 Aug 2010 12:10:30 +0000
Subject: [docs] [issue901727] extra_path kwarg to setup() undocumented
Message-ID: <1282219830.45.0.357339462866.issue901727@psf.upfronthosting.co.za>


Ronald Oussoren <ronaldoussoren at mac.com> added the comment:

I don't understand why distutils won't even get documentation updates.

Bob's report is about undocumented functionality that is used in real life and was the best way to install python distributions in a self-contained way before setuptools was invented.

AFAIK The "options" argument to setup is also not documented an that one is also used (both py2exe and py2app mention this feature in their documentation).

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue901727>
_______________________________________

From report at bugs.python.org  Thu Aug 19 15:14:07 2010
From: report at bugs.python.org (Antoine Pitrou)
Date: Thu, 19 Aug 2010 13:14:07 +0000
Subject: [docs] [issue8595] Explain the default timeout in
	http-client-related	libraries
In-Reply-To: <1272768884.43.0.28527344604.issue8595@psf.upfronthosting.co.za>
Message-ID: <1282223646.81.0.44750727409.issue8595@psf.upfronthosting.co.za>


Antoine Pitrou <pitrou at free.fr> added the comment:

> That way, if _HTTP_DEFAULT_TIMEOUT is never set, it will use the the
> socket timeout. Admittedly I'd rather see all uses of module globals go 
> away, but I think this would be a good compromise.

Why not provide {httplib,urllib}.{set,get}defaulttimeout() instead?

----------
nosy: +pitrou

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8595>
_______________________________________

From report at bugs.python.org  Thu Aug 19 15:16:47 2010
From: report at bugs.python.org (Eric Smith)
Date: Thu, 19 Aug 2010 13:16:47 +0000
Subject: [docs] [issue8595] Explain the default timeout in
	http-client-related	libraries
In-Reply-To: <1282223646.81.0.44750727409.issue8595@psf.upfronthosting.co.za>
Message-ID: <4C6D2E3E.4090602@trueblade.com>


Eric Smith <eric at trueblade.com> added the comment:

On 8/19/2010 9:14 AM, Antoine Pitrou wrote:
> Why not provide {httplib,urllib}.{set,get}defaulttimeout() instead?

Yes, I'm assuming that's how _HTTP_DEFAULT_TIMEOUT would be set and queried.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8595>
_______________________________________

From report at bugs.python.org  Fri Aug 20 17:43:16 2010
From: report at bugs.python.org (Mike Dirolf)
Date: Fri, 20 Aug 2010 15:43:16 +0000
Subject: [docs] [issue9649] wrong default for sort_keys in json module
	documentation
In-Reply-To: <1282318996.73.0.279349248821.issue9649@psf.upfronthosting.co.za>
Message-ID: <1282318996.73.0.279349248821.issue9649@psf.upfronthosting.co.za>


New submission from Mike Dirolf <mike at dirolf.com>:

The json module docs state that sort_keys defaults to True. From the source it looks like it actually defaults to False. Patch attached.

----------
assignee: docs at python
components: Documentation
files: sort_keys_json.patch
keywords: patch
messages: 114426
nosy: docs at python, mdirolf
priority: normal
severity: normal
status: open
title: wrong default for sort_keys in json module documentation
versions: Python 2.7
Added file: http://bugs.python.org/file18584/sort_keys_json.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9649>
_______________________________________

From report at bugs.python.org  Fri Aug 20 19:39:02 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Fri, 20 Aug 2010 17:39:02 +0000
Subject: [docs] [issue9608] Re-phrase best way of using exceptions in
	doanddont.rst
In-Reply-To: <1281875025.64.0.398474348151.issue9608@psf.upfronthosting.co.za>
Message-ID: <1282325942.17.0.01821705162.issue9608@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Doc/howto/doanddont.rst is the source for
Python HOWTOs: Idioms and Anti-Idioms in Python
Moshe Zadka original author (added as nosy)

The gist of the patch is to clarify that using 'with' is best, not the non-with version that is currently called  both 'best' and 'not very good'. I agreed that the current version is confusing and the patch or something like it should be applied.

Floris: 2.6 is closed to non-critical patches. 3.3 is for patches that cannot be applied sooner.

----------
nosy: +moshez, terry.reedy
stage:  -> patch review
type: feature request -> behavior
versions:  -Python 2.6, Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9608>
_______________________________________

From report at bugs.python.org  Fri Aug 20 20:31:42 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Fri, 20 Aug 2010 18:31:42 +0000
Subject: [docs] [issue9637] docs do not say that urllib uses HTTP_PROXY
In-Reply-To: <1282196669.74.0.629180904202.issue9637@psf.upfronthosting.co.za>
Message-ID: <1282329102.79.0.265859014666.issue9637@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Are you talking about top-level code within the urllib module or code within defined functions. If the former, can you quote or point to the place in the file? If the latter, which functions? Just urlopen or others? Does urllib2.urlopen have the same issue? (That replaces urllib.urlopen in 3.x).

Having answered the above, please suggest a specific change in a specific place in the docs.

----------
nosy: +terry.reedy
stage:  -> needs patch
versions: +Python 2.7 -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9637>
_______________________________________

From report at bugs.python.org  Fri Aug 20 21:41:16 2010
From: report at bugs.python.org (Kirikaza)
Date: Fri, 20 Aug 2010 19:41:16 +0000
Subject: [docs] [issue9637] docs do not say that urllib uses HTTP_PROXY
In-Reply-To: <1282196669.74.0.629180904202.issue9637@psf.upfronthosting.co.za>
Message-ID: <1282333275.93.0.444840340032.issue9637@psf.upfronthosting.co.za>


Kirikaza <kirikaza at rambler.ru> added the comment:

> Are you talking about ...
I have read no line of code from urllib module. I just try to use urllib.urlopen() and I see it uses not only http_proxy but also HTTP_PROXY and urlopen() prefers the latter variable.

Let's consider a two-lines sample proxy.py:
import urllib
urllib.urlopen('http://python.org/ftp/').readlines()

Some tests:

$ http_proxy= HTTP_PROXY= proxy.py
['<!DOCTYPE HTML ... \n']

$ http_proxy=lower:80 HTTP_PROXY= proxy.py
IOError: invalid proxy for http: 'lower:80'

$ http_proxy= HTTP_PROXY=UPPER:80 proxy.py
IOError: invalid proxy for http: 'UPPER:80'

$ http_proxy=lower:80 HTTP_PROXY=UPPER:80 proxy.py
IOError: invalid proxy for http: 'UPPER:80'

> a specific change in a specific place
place: 20.5.1, paragraph 7 (the only one where *_proxy are discussed)
change: add some words about HTTP_PROXY and maybe about FTP_PROXY

> does urllib2.urlopen ... (in 3.x)
I don't have Python 3.x so I can't say anything.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9637>
_______________________________________

From report at bugs.python.org  Fri Aug 20 21:56:18 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Fri, 20 Aug 2010 19:56:18 +0000
Subject: [docs] [issue9649] wrong default for sort_keys in json module
	documentation
In-Reply-To: <1282318996.73.0.279349248821.issue9649@psf.upfronthosting.co.za>
Message-ID: <1282334178.43.0.237836525205.issue9649@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

In 3.1, and I presume (please check) 2.7, the signature is given as
class json.JSONEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None) 

I verified by simple experiment that keys are not sorted by default. 
So the later claim "If sort_keys is True (the default)" is wrong and should be corrected. The patch or something much like it should be applied. Thanks for catching this error.

----------
nosy: +terry.reedy
stage:  -> commit review
type:  -> behavior
versions: +Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9649>
_______________________________________

From report at bugs.python.org  Sat Aug 21 08:36:38 2010
From: report at bugs.python.org (Kirikaza)
Date: Sat, 21 Aug 2010 06:36:38 +0000
Subject: [docs] [issue9637] docs do not say that urllib uses HTTP_PROXY
In-Reply-To: <1282196669.74.0.629180904202.issue9637@psf.upfronthosting.co.za>
Message-ID: <1282372597.98.0.673394306937.issue9637@psf.upfronthosting.co.za>


Kirikaza <kirikaza at rambler.ru> added the comment:

I missed the print statement in that example... So I attached the file with correct code.

----------
Added file: http://bugs.python.org/file18594/proxy.py

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9637>
_______________________________________

From report at bugs.python.org  Sat Aug 21 18:39:42 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sat, 21 Aug 2010 16:39:42 +0000
Subject: [docs] [issue8997] Write documentation for
	codecs.readbuffer_encode()
In-Reply-To: <1276543120.6.0.338687874276.issue8997@psf.upfronthosting.co.za>
Message-ID: <1282408782.14.0.295085508572.issue8997@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
nosy: +docs at python
stage:  -> needs patch
versions:  -Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8997>
_______________________________________

From report at bugs.python.org  Sat Aug 21 18:48:43 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sat, 21 Aug 2010 16:48:43 +0000
Subject: [docs] [issue8851] pkgutil document needs more markups
In-Reply-To: <1275107900.09.0.840689685245.issue8851@psf.upfronthosting.co.za>
Message-ID: <1282409323.24.0.715282765324.issue8851@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Thanks for the report. Patch looks good to me. I assume the other function descriptions already have complete markup, since your patch touches only two of them.

If there are no remarks from docs at python or objections from Georg, I will apply this in a week, taking care of all three branches.

----------
assignee: docs at python -> eric.araujo
nosy: +eric.araujo
versions: +Python 2.7, Python 3.1, Python 3.2 -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8851>
_______________________________________

From report at bugs.python.org  Sat Aug 21 18:49:11 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Sat, 21 Aug 2010 16:49:11 +0000
Subject: [docs] [issue8851] pkgutil documentation needs more markup
In-Reply-To: <1275107900.09.0.840689685245.issue8851@psf.upfronthosting.co.za>
Message-ID: <1282409351.47.0.835827347284.issue8851@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
resolution:  -> accepted
stage:  -> patch review
status: open -> pending
title: pkgutil document needs more markups -> pkgutil documentation needs more markup

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8851>
_______________________________________

From report at bugs.python.org  Sat Aug 21 20:46:24 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Sat, 21 Aug 2010 18:46:24 +0000
Subject: [docs] [issue1249749] Encodings and aliases do not match runtime
Message-ID: <1282416384.27.0.10106521457.issue1249749@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python
versions: +Python 3.2 -Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1249749>
_______________________________________

From report at bugs.python.org  Sat Aug 21 21:06:04 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Sat, 21 Aug 2010 19:06:04 +0000
Subject: [docs] [issue1283110] Give __len__() advice for "don't know"
Message-ID: <1282417564.38.0.124904810957.issue1283110@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1283110>
_______________________________________

From report at bugs.python.org  Sat Aug 21 23:31:02 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Sat, 21 Aug 2010 21:31:02 +0000
Subject: [docs] [issue9658] weakref.proxy unequal to its referent in 2.x
In-Reply-To: <1282419862.51.0.264413322839.issue9658@psf.upfronthosting.co.za>
Message-ID: <1282426261.51.0.750718515758.issue9658@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

This is definitely not a critical fix for 2.6 ;-)

The weakref.proxy doc says nothing about comparisons:

"weakref.proxy(object[, callback]) 
Return a proxy to object which uses a weak reference. This supports use of the proxy in most contexts instead of requiring the explicit dereferencing used with weak reference objects. The returned object will have a type of either ProxyType or CallableProxyType, depending on whether object is callable. Proxy objects are not hashable regardless of the referent; this avoids a number of problems related to their fundamentally mutable nature, and prevent their use as dictionary keys. callback is the same as the parameter of the same name to the ref() function."

so this is not a behavior bug.

A patch for 2.7 could include a note that the behavior changes in 3.x. The 3.x patch should only say what the 3.x behavior is. This is assuming that the behavior should be defined as in 3.x for all implementations. Since it seems straightforward, it seems reasonable to me to do so.

The comparison behavior of 'basic' types is actually defined in the ref manual section 5.9 Comparisons (3.1). Cross-type behavior is summarized as "Comparison of objects of the differing types depends on whether either of the types provide explicit support for the comparison." I think the detailed info for weakref proxys belongs with the weakref proxy entry as suggested above.

----------
assignee:  -> docs at python
components: +Documentation
nosy: +docs at python, terry.reedy
stage:  -> needs patch
versions: +Python 3.1, Python 3.2 -Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9658>
_______________________________________

From report at bugs.python.org  Sat Aug 21 23:36:02 2010
From: report at bugs.python.org (Georg Brandl)
Date: Sat, 21 Aug 2010 21:36:02 +0000
Subject: [docs] [issue9658] weakref.proxy unequal to its referent in 2.x
In-Reply-To: <1282419862.51.0.264413322839.issue9658@psf.upfronthosting.co.za>
Message-ID: <1282426562.16.0.126213287356.issue9658@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Duplicate of #1170766 -- the lack of tp_richcompare support is reported among other missing slots there.

----------
nosy: +georg.brandl
resolution:  -> duplicate
status: open -> closed
superseder:  -> weakref.proxy incorrect behaviour

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9658>
_______________________________________

From report at bugs.python.org  Sun Aug 22 02:25:39 2010
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 22 Aug 2010 00:25:39 +0000
Subject: [docs] [issue5028] tokenize.generate_tokens doesn't always return
	logical	line
In-Reply-To: <1232588343.15.0.723713394492.issue5028@psf.upfronthosting.co.za>
Message-ID: <1282436739.16.0.274442666488.issue5028@psf.upfronthosting.co.za>


Changes by Georg Brandl <georg at python.org>:


----------
assignee:  -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5028>
_______________________________________

From report at bugs.python.org  Sun Aug 22 04:01:51 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Sun, 22 Aug 2010 02:01:51 +0000
Subject: [docs] [issue1446619] extended slice behavior inconsistent with docs
Message-ID: <1282442511.86.0.344009906158.issue1446619@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1446619>
_______________________________________

From vincent.leroux at loria.fr  Fri Aug 20 17:02:05 2010
From: vincent.leroux at loria.fr (Vincent Leroux)
Date: Fri, 20 Aug 2010 17:02:05 +0200
Subject: [docs] tables in PDFs
Message-ID: <4C6E98ED.8000503@loria.fr>

Hi,

I spotted some problems in the PDF versions of the Python docs. Some
tables are not rendered correctly. For example, see table 7.1 pp.115-116
from the library.pdf (A4) for Python v2.7.

Best regards,
VL

From dr.sdmoore at gmail.com  Sun Aug 22 18:12:06 2010
From: dr.sdmoore at gmail.com (Sean Moore)
Date: Sun, 22 Aug 2010 12:12:06 -0400
Subject: [docs] Python tutorial Page: errors arise when following examples.
Message-ID: <AANLkTi=pav=vZ_52GYPh4SVLSLhUQKA6CTbs82=v-xdg@mail.gmail.com>

Hello,

I am new to Python and am working my way through the online tutorial:

http://docs.python.org/tutorial/introduction.html

I am using a fresh install of IDLE that came bundled when I installed
Python 3.1.2 on a Win7(64) machine.

In the example, the Unicode examples don't work:
>>>u"abc"
SyntaxError: invalid syntax

Also, the Fibonacci example doesn't work:
the "..." doesn't appear as in the example

instead of:
>>>a, b = 0, 1
>>>while b < 10:
...

I get:
>>>a, b = 0, 1
>>>while b < 10:
    |

(indent, no dots)

and when I type "print b" at the prompt, I also get a Syntax error.

I suspect that I have something set up wrong, or I missed how to make
the ... show up.

Can this be clarified in the tutorial?

From report at bugs.python.org  Sun Aug 22 22:23:59 2010
From: report at bugs.python.org (Georg Brandl)
Date: Sun, 22 Aug 2010 20:23:59 +0000
Subject: [docs] [issue9649] wrong default for sort_keys in json module
	documentation
In-Reply-To: <1282318996.73.0.279349248821.issue9649@psf.upfronthosting.co.za>
Message-ID: <1282508639.67.0.937443822596.issue9649@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Thanks, fixed in r84264.

----------
nosy: +georg.brandl
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9649>
_______________________________________

From merwok at netwok.org  Sun Aug 22 23:53:08 2010
From: merwok at netwok.org (=?UTF-8?B?w4lyaWMgQXJhdWpv?=)
Date: Sun, 22 Aug 2010 23:53:08 +0200
Subject: [docs] Python tutorial Page: errors arise when following
	examples.
In-Reply-To: <AANLkTi=pav=vZ_52GYPh4SVLSLhUQKA6CTbs82=v-xdg@mail.gmail.com>
References: <AANLkTi=pav=vZ_52GYPh4SVLSLhUQKA6CTbs82=v-xdg@mail.gmail.com>
Message-ID: <4C719C44.2040404@netwok.org>

Hello Sean

> I am new to Python and am working my way through the online tutorial:
Welcome!

> http://docs.python.org/tutorial/introduction.html
> 
> I am using a fresh install of IDLE that came bundled when I installed
> Python 3.1.2 on a Win7(64) machine.
You can read ?Release: 2.7? right under the main heading ?The Python
Tutorial?, and also at the top of the page (?Python v2.7
documentation?). If you click on the latter to go back to the root of
the site, you can find a link to the 3.1 docs under ?Docs for other
versions?.

If you want to learn more about the differences between 2.x and 3.x, you
can go to http://docs.python.org/py3k/whatsnew/3.0

> Also, the Fibonacci example doesn't work:
> the "..." doesn't appear as in the example
This is the behavior of the standard command-line interactive
interpreter, not IDLE. This should be clarified somewhere in the
tutorial, probably under tutorial/interpreter#interactive-mode

Regards

From report at bugs.python.org  Tue Aug 24 03:31:39 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Tue, 24 Aug 2010 01:31:39 +0000
Subject: [docs] [issue9061] cgi.escape Can Lead To XSS Vulnerabilities
In-Reply-To: <1277307995.11.0.923855376948.issue9061@psf.upfronthosting.co.za>
Message-ID: <1282613499.4.0.72139173337.issue9061@psf.upfronthosting.co.za>


Changes by Benjamin Peterson <benjamin at python.org>:


----------
resolution:  -> duplicate
status: open -> closed
superseder:  -> Copy cgi.escape() to html

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9061>
_______________________________________

From report at bugs.python.org  Tue Aug 24 04:56:13 2010
From: report at bugs.python.org (Yury Selivanov)
Date: Tue, 24 Aug 2010 02:56:13 +0000
Subject: [docs] [issue9666] 'hasattr' fix to suppress only AttributeError
In-Reply-To: <1282618571.72.0.746588634044.issue9666@psf.upfronthosting.co.za>
Message-ID: <1282618571.72.0.746588634044.issue9666@psf.upfronthosting.co.za>


New submission from Yury Selivanov <yselivanov at gmail.com>:

As discussed on python-dev mailing list (http://mail.python.org/pipermail/python-dev/2010-August/103178.html), 'hasattr' default behaviour should be changed to suppress only AttributeError exceptions.  Other should pass through.

The fix, however, shouldn't change behaviour of existing C API, functions PyObject_HasAttr and PyObject_HasAttrString in particular.

I'm targeting this issue on Python 3.2 version, but probably it may be introduced in the next Python 3.1 maintenance release.

----------
assignee: docs at python
components: Documentation, Library (Lib)
files: hasattr.patch
keywords: patch
messages: 114767
nosy: Yury.Selivanov, docs at python
priority: normal
severity: normal
status: open
title: 'hasattr' fix to suppress only AttributeError
type: behavior
versions: Python 3.2
Added file: http://bugs.python.org/file18622/hasattr.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9666>
_______________________________________

From report at bugs.python.org  Tue Aug 24 05:07:34 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Tue, 24 Aug 2010 03:07:34 +0000
Subject: [docs] [issue9666] 'hasattr' fix to suppress only AttributeError
In-Reply-To: <1282618571.72.0.746588634044.issue9666@psf.upfronthosting.co.za>
Message-ID: <1282619254.96.0.656627318059.issue9666@psf.upfronthosting.co.za>


Changes by Benjamin Peterson <benjamin at python.org>:


----------
assignee: docs at python -> benjamin.peterson
nosy: +benjamin.peterson

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9666>
_______________________________________

From report at bugs.python.org  Tue Aug 24 05:27:53 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Tue, 24 Aug 2010 03:27:53 +0000
Subject: [docs] [issue9666] 'hasattr' fix to suppress only AttributeError
In-Reply-To: <1282618571.72.0.746588634044.issue9666@psf.upfronthosting.co.za>
Message-ID: <1282620473.79.0.127090787821.issue9666@psf.upfronthosting.co.za>


Benjamin Peterson <benjamin at python.org> added the comment:

Fixed in r84294. I will not backport to 3.1. Thanks for the contribution!

----------
keywords: +gsoc -patch
resolution:  -> accepted
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9666>
_______________________________________

From report at bugs.python.org  Tue Aug 24 07:20:58 2010
From: report at bugs.python.org (Brian Curtin)
Date: Tue, 24 Aug 2010 05:20:58 +0000
Subject: [docs] [issue7579] Patch to add docstrings to msvcrt
In-Reply-To: <1261862969.81.0.926821098705.issue7579@psf.upfronthosting.co.za>
Message-ID: <1282627258.23.0.751165530015.issue7579@psf.upfronthosting.co.za>


Brian Curtin <curtin at acm.org> added the comment:

Committed to py3k in r84295.

----------
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7579>
_______________________________________

From syntotic at gmail.com  Tue Aug 24 18:26:09 2010
From: syntotic at gmail.com (me)
Date: Tue, 24 Aug 2010 12:26:09 -0400
Subject: [docs] I just discovered you provide RANDOM VARIABLES,
	is it a template library in C++...?
Message-ID: <2D4CADF9D9534DEAABB6CC888C5BD25B@FRONTIERFAE0D8>

MY programming code was stolen from me, it included a very well tested and functional random variable library (randomer.h) in the form of a hierarchy of templates linked to a random number generator that promised an interval of 200 million numbers before repetition. Now I see you include random variables! The generator is no longer available in the internet and it even seems the assumed author knew nothing about it... but I have some suspicious that the code you used for this language MAY be the code stolen from me, because of the choosing of a distribution that can be implemented easily with one of my classes. Where can I check the SOURCE CODE TO PYTHON? I would only need to see the random variable sources. Of course I fear my code was changed in between the theft and it usage, but I think I would recognize it even then, and it would be to the interest of BOTH your org and I that this suspicion be solved as it may be pointing to a really organized code thief or some other kind of fraud. I am currently beginning to reimplement the library in a provisional way, but I do HOPE to get my original code back.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20100824/411b73f3/attachment.html>

From report at bugs.python.org  Tue Aug 24 22:31:22 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Tue, 24 Aug 2010 20:31:22 +0000
Subject: [docs] [issue1554133] PyOS_InputHook() and related API funcs. not
	documented
Message-ID: <1282681882.9.0.851704557093.issue1554133@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee:  -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1554133>
_______________________________________

From report at bugs.python.org  Tue Aug 24 23:26:03 2010
From: report at bugs.python.org (Brett Cannon)
Date: Tue, 24 Aug 2010 21:26:03 +0000
Subject: [docs] [issue9677] "Global Module Index" link dead
In-Reply-To: <1282685163.07.0.524302094141.issue9677@psf.upfronthosting.co.za>
Message-ID: <1282685163.07.0.524302094141.issue9677@psf.upfronthosting.co.za>


New submission from Brett Cannon <brett at python.org>:

When you build the HTML docs the "Global Module Index" link does not work while the "modules" link in the upper-right corner does.

----------
assignee: docs at python
components: Documentation
messages: 114832
nosy: brett.cannon, docs at python
priority: high
severity: normal
stage: needs patch
status: open
title: "Global Module Index" link dead
versions: Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9677>
_______________________________________

From report at bugs.python.org  Wed Aug 25 00:50:40 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 24 Aug 2010 22:50:40 +0000
Subject: [docs] [issue3565] array documentation,
	method names not 3.x-compliant
In-Reply-To: <1218878053.61.0.879399084038.issue3565@psf.upfronthosting.co.za>
Message-ID: <1282690240.0.0.508080307344.issue3565@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
assignee:  -> docs at python
nosy: +docs at python
stage: unit test needed -> patch review
title: array documentation, method names not 3.0 compliant -> array documentation, method names not 3.x-compliant
versions: +Python 2.7, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue3565>
_______________________________________

From report at bugs.python.org  Wed Aug 25 00:52:09 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 24 Aug 2010 22:52:09 +0000
Subject: [docs] [issue8652] Minor improvements to the "Handling Exceptions"
	part of	the tutorial
In-Reply-To: <1273253134.08.0.147248211976.issue8652@psf.upfronthosting.co.za>
Message-ID: <1282690329.14.0.250176524484.issue8652@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Since there has been no feedback, you could write a patch to get the discussion going.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8652>
_______________________________________

From report at bugs.python.org  Wed Aug 25 00:54:35 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 24 Aug 2010 22:54:35 +0000
Subject: [docs] [issue7353] cporting docs recommend using
	Include/intobject.h, which was removed in 3.1?
In-Reply-To: <1258578341.2.0.19051074218.issue7353@psf.upfronthosting.co.za>
Message-ID: <1282690475.93.0.759578709827.issue7353@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
assignee:  -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7353>
_______________________________________

From report at bugs.python.org  Wed Aug 25 00:56:35 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 24 Aug 2010 22:56:35 +0000
Subject: [docs] [issue8855] Shelve documentation lacks security warning
In-Reply-To: <1275180833.97.0.966181786946.issue8855@psf.upfronthosting.co.za>
Message-ID: <1282690595.26.0.203079926117.issue8855@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Thank you for the report. Would you like to propose a patch against the py3k branch?

----------
nosy: +eric.araujo
stage:  -> needs patch
versions: +Python 2.7, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8855>
_______________________________________

From report at bugs.python.org  Wed Aug 25 01:01:48 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 24 Aug 2010 23:01:48 +0000
Subject: [docs] [issue9677] "Global Module Index" link dead
In-Reply-To: <1282685163.07.0.524302094141.issue9677@psf.upfronthosting.co.za>
Message-ID: <1282690908.77.0.904967810896.issue9677@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Attached patch fixes that. This renaming is due to the introduction of domains (namespaces for roles and directives) in Sphinx 1.0.

----------
keywords: +patch
nosy: +eric.araujo
Added file: http://bugs.python.org/file18635/modindex.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9677>
_______________________________________

From report at bugs.python.org  Wed Aug 25 01:09:20 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 24 Aug 2010 23:09:20 +0000
Subject: [docs] [issue4966] Improving Lib Doc Sequence Types Section
In-Reply-To: <1232149418.64.0.0450574767427.issue4966@psf.upfronthosting.co.za>
Message-ID: <1282691359.9.0.475946221256.issue4966@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

I?m interested in making a series of patches corresponding to your suggestions, unless you or someone else want to do them.

I?m assigning to myself so that I don?t forget (I won?t have time for a couple weeks), if someone wants to do it as an easy first patch (Terry did most of the work :), it?s okay, just remove the assignment from me.

----------
assignee: docs at python -> eric.araujo
nosy: +eric.araujo

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue4966>
_______________________________________

From report at bugs.python.org  Wed Aug 25 01:22:07 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 24 Aug 2010 23:22:07 +0000
Subject: [docs] =?utf-8?q?=5Bissue4783=5D_document_that_json=2Eload/dump_c?=
 =?utf-8?q?an=E2=80=99t_be_used_twice_on_the_same_stream?=
In-Reply-To: <1230657409.93.0.0443603821797.issue4783@psf.upfronthosting.co.za>
Message-ID: <1282692127.43.0.401334900881.issue4783@psf.upfronthosting.co.za>


?ric Araujo <merwok at netwok.org> added the comment:

Bob, what is the status of this bug?

----------
nosy: +docs at python, eric.araujo -georg.brandl
title: json documentation needs a BAWM (Big A** Warning Message) -> document that json.load/dump can?t be used twice on the same stream
versions: +Python 2.7, Python 3.1, Python 3.2 -Python 2.6, Python 3.0

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue4783>
_______________________________________

From report at bugs.python.org  Wed Aug 25 01:27:09 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Tue, 24 Aug 2010 23:27:09 +0000
Subject: [docs] [issue9254] __import__ docstring should
	recommend	importlib.import_module()
In-Reply-To: <1279057769.02.0.398615806235.issue9254@psf.upfronthosting.co.za>
Message-ID: <1282692429.18.0.222675590719.issue9254@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
versions: +Python 2.7, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9254>
_______________________________________

From report at bugs.python.org  Wed Aug 25 02:48:13 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Wed, 25 Aug 2010 00:48:13 +0000
Subject: [docs] [issue4966] Improving Lib Doc Sequence Types Section
In-Reply-To: <1232149418.64.0.0450574767427.issue4966@psf.upfronthosting.co.za>
Message-ID: <1282697293.53.0.55773952008.issue4966@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

Please go ahead. I will gladly review anything you do.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue4966>
_______________________________________

From report at bugs.python.org  Wed Aug 25 17:03:08 2010
From: report at bugs.python.org (R. David Murray)
Date: Wed, 25 Aug 2010 15:03:08 +0000
Subject: [docs] [issue9681] small typo in online documentation
In-Reply-To: <1282743105.63.0.0178074444742.issue9681@psf.upfronthosting.co.za>
Message-ID: <1282748588.48.0.847100627703.issue9681@psf.upfronthosting.co.za>


Changes by R. David Murray <rdmurray at bitdance.com>:


----------
assignee:  -> docs at python
components: +Documentation
nosy: +docs at python
type:  -> behavior

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9681>
_______________________________________

From poltorak at alsenet.com  Wed Aug 25 18:50:59 2010
From: poltorak at alsenet.com (Serguei G. Poltorak)
Date: Wed, 25 Aug 2010 18:50:59 +0200 (CEST)
Subject: [docs] Something to be added to cgi module doc
In-Reply-To: <2039864690.6411.1282753010448.JavaMail.root@z2.alsenet.com>
Message-ID: <890947083.6436.1282755059584.JavaMail.root@z2.alsenet.com>

Dear python documentation maintainer, 

I would like to submit a small text to the cgi module documentation to help other users use this module with BaseHTTPServer.HTTPServer. The current documentation (http://docs.python.org/library/cgi.html) shortly describes the usage of this module as a CGI under Apache. It does not covers at all the usage of cgi with BaseHTTPServer module. I've passed about an hour reading cgi.py sources to make it work, so I would like to share my knowledge with others. 

Be so kind to include (mangled by you) the following text: 
--------------------------------- 
Running with no parameters FieldStorage will read sys.stdin and use os.environ as environment variable. To use this module with BaseHTTPServer you must initialize FieldStorage with the rfile coming from WebHandler, pass headers as is and construct your ow environ to inform FieldStorage about the method used and the query string. Example for do_POST() function: 
form = cgi.FieldStorage(fp=self.rfile, headers=self.headers.dict, environ={"REQUEST_METHOD": "POST", "QUERY_STRING": self.path}) 
See "print cgi.FieldStorage.__doc__" for more information on FieldStorage() parameters. 

To upload files use enctype="multipart/form-data" . For example: 
<form method="post" action="/my/url/to/python/script" enctype="multipart/form-data"> 
<input type="file" name="filename"/> 
<input type="hidden" name="additional params" value="123"/> 
<input type="submit"/> 
</form> 
--------------------------------- 

Thank you for your great work! 

Sincerely yours, 
Poltorak Sergeui 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20100825/18d00710/attachment.html>

From kotenko at gmail.com  Wed Aug 25 20:55:21 2010
From: kotenko at gmail.com (Jason Kotenko)
Date: Wed, 25 Aug 2010 14:55:21 -0400
Subject: [docs] Documentation Search Hard to Use
Message-ID: <4C756719.4010704@gmail.com>

 Hi,

I have an improvement suggestion, which you may or may not agree with. 
I personally find the search function on the docs.python.org site to
pretty difficult to use effectively.  If you do a search, it appears
that you get results first from method/class/package/etc names, ordered
lexicographically, then you get a section of fulltext search results,
also ordered lexicographically, then finally a section of fulltext
results from various HowTo's and FAQs.  There is no indication of the
change between these sections, this is just from observation.

My issue is that I have no way of picking out which results are the most
relevant.  If I use a search term like xml for instance, I first get
every keyword result from the names of things like
classes/packages/methods, which is a lot of things.  Even down in the
fulltext results, I have no indication of relevance, everything is
ordered by lexicography, which means that items in Chapter 1 come first,
then Chapter 10-19, then Chapter 2, then Chapter 20-29, ... , and on and
on.  Same with the FAQ/HowTo results.

I'm wondering if there is a reason for using results such as these and
not a more typical relevance based search?  In fact you could still list
the names of things at the top, put a divider, and do relevance on the
fulltext entries, if you still want the name based things.  I have a
Xapian powered search on a site I manage that does it quite capably and
with lightning speed.

As it stands now, I use the index to find things if I know what they are
called, and otherwise have to open a new tab and use Google.  However,
if I'm looking for docs just on Python 3.x for instance, the query "xml
site:docs.python.org/py3k" yields only one result (I wonder, is
robots.txt set up to not index it?).  So that means I'm more likely to
do "xml site:docs.python.org" and then click the link and change the
path to say "py3k" after the domain.

I know you guys probably have a lot to do - is there any way I can
assist in this area?

Thanks,
Jason

From report at bugs.python.org  Thu Aug 26 00:12:17 2010
From: report at bugs.python.org (Longpoke)
Date: Wed, 25 Aug 2010 22:12:17 +0000
Subject: [docs] [issue8855] Shelve documentation lacks security warning
In-Reply-To: <1275180833.97.0.966181786946.issue8855@psf.upfronthosting.co.za>
Message-ID: <1282774337.8.0.857143392126.issue8855@psf.upfronthosting.co.za>


Longpoke <longpoke at gmail.com> added the comment:

Okay I've attached one for the py3k branch. What about 2.7? Same patch applies there.

----------
keywords: +patch
Added file: http://bugs.python.org/file18645/shelve.rst.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8855>
_______________________________________

From report at bugs.python.org  Thu Aug 26 02:02:13 2010
From: report at bugs.python.org (R. David Murray)
Date: Thu, 26 Aug 2010 00:02:13 +0000
Subject: [docs] [issue9689] threading.Timer poorly documented
In-Reply-To: <1282776354.83.0.958131650001.issue9689@psf.upfronthosting.co.za>
Message-ID: <1282780933.12.0.00712297687158.issue9689@psf.upfronthosting.co.za>


Changes by R. David Murray <rdmurray at bitdance.com>:


----------
assignee:  -> docs at python
components: +Documentation
nosy: +docs at python
type: feature request -> behavior
versions: +Python 3.1, Python 3.2 -Python 2.5, Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9689>
_______________________________________

From report at bugs.python.org  Thu Aug 26 16:30:28 2010
From: report at bugs.python.org (Georg Brandl)
Date: Thu, 26 Aug 2010 14:30:28 +0000
Subject: [docs] [issue9689] threading.Timer poorly documented
In-Reply-To: <1282776354.83.0.958131650001.issue9689@psf.upfronthosting.co.za>
Message-ID: <1282833028.15.0.779155537348.issue9689@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Fixed in r84326.

----------
nosy: +georg.brandl
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9689>
_______________________________________

From report at bugs.python.org  Thu Aug 26 16:31:07 2010
From: report at bugs.python.org (Georg Brandl)
Date: Thu, 26 Aug 2010 14:31:07 +0000
Subject: [docs] [issue9681] small typo in online documentation
In-Reply-To: <1282743105.63.0.0178074444742.issue9681@psf.upfronthosting.co.za>
Message-ID: <1282833067.09.0.23350374746.issue9681@psf.upfronthosting.co.za>


Georg Brandl <georg at python.org> added the comment:

Fixed in r84327.

----------
nosy: +georg.brandl
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9681>
_______________________________________

From report at bugs.python.org  Thu Aug 26 18:22:50 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Thu, 26 Aug 2010 16:22:50 +0000
Subject: [docs] [issue1397474] timeit execution enviroment
Message-ID: <1282839770.37.0.377098315209.issue1397474@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee:  -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1397474>
_______________________________________

From report at bugs.python.org  Thu Aug 26 18:24:30 2010
From: report at bugs.python.org (Mark Lawrence)
Date: Thu, 26 Aug 2010 16:24:30 +0000
Subject: [docs] [issue1398781] Example in section 5.3 "Pure Embedding"
	doesn't work.
Message-ID: <1282839870.46.0.0402130917792.issue1398781@psf.upfronthosting.co.za>


Changes by Mark Lawrence <breamoreboy at yahoo.co.uk>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1398781>
_______________________________________

From report at bugs.python.org  Thu Aug 26 23:22:12 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Thu, 26 Aug 2010 21:22:12 +0000
Subject: [docs] [issue5904] strftime docs do not explain locale effect on
	result	string
In-Reply-To: <1241270739.12.0.286821632978.issue5904@psf.upfronthosting.co.za>
Message-ID: <1282857732.2.0.56168732145.issue5904@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
assignee: georg.brandl -> docs at python
nosy: +docs at python

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue5904>
_______________________________________

From report at bugs.python.org  Fri Aug 27 00:59:59 2010
From: report at bugs.python.org (=?utf-8?q?Martin_v=2E_L=C3=B6wis?=)
Date: Thu, 26 Aug 2010 22:59:59 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code in	Windows installer
In-Reply-To: <1277836658.93.0.259031299275.issue9119@psf.upfronthosting.co.za>
Message-ID: <1282863599.1.0.685437272818.issue9119@psf.upfronthosting.co.za>


Martin v. L?wis <martin at v.loewis.de> added the comment:

Which specific clause of the license do you consider violated?

----------
nosy: +loewis

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 01:31:05 2010
From: report at bugs.python.org (=?utf-8?q?=C3=89ric_Araujo?=)
Date: Thu, 26 Aug 2010 23:31:05 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code in	Windows installer
In-Reply-To: <1277836658.93.0.259031299275.issue9119@psf.upfronthosting.co.za>
Message-ID: <1282865465.71.0.673300735814.issue9119@psf.upfronthosting.co.za>


Changes by ?ric Araujo <merwok at netwok.org>:


----------
nosy: +eric.araujo
versions:  -Python 2.6, Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 09:50:44 2010
From: report at bugs.python.org (Marc-Andre Lemburg)
Date: Fri, 27 Aug 2010 07:50:44 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code	in	Windows installer
In-Reply-To: <1282863599.1.0.685437272818.issue9119@psf.upfronthosting.co.za>
Message-ID: <4C776E50.9070702@egenix.com>


Marc-Andre Lemburg <mal at egenix.com> added the comment:

Martin v. L?wis wrote:
> 
> Martin v. L?wis <martin at v.loewis.de> added the comment:
> 
> Which specific clause of the license do you consider violated?

 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"

 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay at cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh at cryptsoft.com)"

----------
title: Python download page needs to mention crypto code in Windows installer -> Python download page needs to mention crypto code in	Windows installer

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 10:00:48 2010
From: report at bugs.python.org (Marc-Andre Lemburg)
Date: Fri, 27 Aug 2010 08:00:48 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code in	Windows installer
In-Reply-To: <1282863599.1.0.685437272818.issue9119@psf.upfronthosting.co.za>
Message-ID: <4C7770AB.30401@egenix.com>


Marc-Andre Lemburg <mal at egenix.com> added the comment:

I'd suggest to add a paragraph like this to the release pages:

"""
The Python Windows installers include OpenSSL, which provides cryptographic
services to Python. Please note that downloading or using cryptographic
code may not be legal in your country of residence. It is your responsibility
to make sure you meet all local import and use requirements for cryptographic
code when downloading and using the Python Windows installers.

OpenSSL Notice: This product includes cryptographic software written by Eric Young
(eay at cryptsoft.com). This product includes software written by Tim Hudson (tjh at cryptsoft.com). This
product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit.
(http://www.openssl.org/)
"""

----------
title: Python download page needs to mention crypto code in	Windows installer -> Python download page needs to mention crypto code in Windows installer

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 14:19:50 2010
From: report at bugs.python.org (=?utf-8?q?Martin_v=2E_L=C3=B6wis?=)
Date: Fri, 27 Aug 2010 12:19:50 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code	in	Windows installer
In-Reply-To: <4C776E50.9070702@egenix.com>
Message-ID: <4C77AD62.9010303@v.loewis.de>


Martin v. L?wis <martin at v.loewis.de> added the comment:

>> Which specific clause of the license do you consider violated?
> 
>  * 3. All advertising materials mentioning features or use of this
>  *    software must display the following acknowledgment:
>  *    "This product includes software developed by the OpenSSL Project
>  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"

I fail to see the violation, or how changing the download page could
fix that. The download page is *not* "advertising material mentioning
features or use of this software". In fact, the download page doesn't
refer to SSL at all. Hence there is no obligation to mention OpenSSL
on the download page.

>  * 3. All advertising materials mentioning features or use of this software
>  *    must display the following acknowledgement:
>  *    "This product includes cryptographic software written by
>  *     Eric Young (eay at cryptsoft.com)"

Likewise.

>  * 4. If you include any Windows specific code (or a derivative thereof) from
>  *    the apps directory (application code) you must include an acknowledgement:
>  *    "This product includes software written by Tim Hudson (tjh at cryptsoft.com)"

This doesn't apply: we don't include any code (Windows specific or not)
from the apps directory.

----------
title: Python download page needs to mention crypto code in Windows installer -> Python download page needs to mention crypto code in	Windows installer

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 14:21:47 2010
From: report at bugs.python.org (=?utf-8?q?Martin_v=2E_L=C3=B6wis?=)
Date: Fri, 27 Aug 2010 12:21:47 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code	in	Windows installer
In-Reply-To: <4C7770AB.30401@egenix.com>
Message-ID: <4C77ADD8.1050407@v.loewis.de>


Martin v. L?wis <martin at v.loewis.de> added the comment:

> I'd suggest to add a paragraph like this to the release pages:

-1, unless the PSF lawyer advises that such a paragraph is indeed
necessary. It may shy away users from using Python, which is clearly
undesirable.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 16:14:01 2010
From: report at bugs.python.org (Marc-Andre Lemburg)
Date: Fri, 27 Aug 2010 14:14:01 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code in	Windows installer
In-Reply-To: <4C77AD62.9010303@v.loewis.de>
Message-ID: <4C77C825.1030204@egenix.com>


Marc-Andre Lemburg <mal at egenix.com> added the comment:

Martin v. L?wis wrote:
> 
> Martin v. L?wis <martin at v.loewis.de> added the comment:
> 
>>> Which specific clause of the license do you consider violated?
>>
>>  * 3. All advertising materials mentioning features or use of this
>>  *    software must display the following acknowledgment:
>>  *    "This product includes software developed by the OpenSSL Project
>>  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
> 
> I fail to see the violation, or how changing the download page could
> fix that. The download page is *not* "advertising material mentioning
> features or use of this software". In fact, the download page doesn't
> refer to SSL at all. Hence there is no obligation to mention OpenSSL
> on the download page.
> 
>>  * 3. All advertising materials mentioning features or use of this software
>>  *    must display the following acknowledgement:
>>  *    "This product includes cryptographic software written by
>>  *     Eric Young (eay at cryptsoft.com)"
> 
> Likewise.

The license only permits you to use and distribute OpenSSL under
the conditions mentioned in the license.

Since we are not following those old-style BSD license requirements
(which are unfortunate), we are not allowed to use the software:

The python.org site is full of references to OpenSSL. Most
prominently in the documentation of the ssl and hashlib modules,
but also in the release notes/news and other files.
By contrast, the name "Eric Young" does not appear anywhere
on the site (according to a Google search).

We can remedy this easily, but putting the notices on the download
pages. Perhaps just putting them into the documentation is already
good enough.

>>  * 4. If you include any Windows specific code (or a derivative thereof) from
>>  *    the apps directory (application code) you must include an acknowledgement:
>>  *    "This product includes software written by Tim Hudson (tjh at cryptsoft.com)"
> 
> This doesn't apply: we don't include any code (Windows specific or not)
> from the apps directory.

Ok, so we don't have to add this part.

>> I'd suggest to add a paragraph like this to the release pages:
>
> -1, unless the PSF lawyer advises that such a paragraph is indeed
> necessary. It may shy away users from using Python, which is clearly
> undesirable.

So you'd rather have some users get in trouble for downloading
and using crypto software, due import laws or domestic laws
restricting its use in their country ?

Deliberately hiding this information from the user, doesn't
sound like a good approach to the problem. However, I agree
that this is a question to ask the PSF board.

There's probably a better wording for such a text, but some kind of
note of caution needs to go on the website.

----------
title: Python download page needs to mention crypto code in	Windows installer -> Python download page needs to mention crypto code in Windows installer

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 16:39:28 2010
From: report at bugs.python.org (=?utf-8?q?Martin_v=2E_L=C3=B6wis?=)
Date: Fri, 27 Aug 2010 14:39:28 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code	in	Windows installer
In-Reply-To: <4C77C825.1030204@egenix.com>
Message-ID: <4C77CE1D.5040200@v.loewis.de>


Martin v. L?wis <martin at v.loewis.de> added the comment:

> Since we are not following those old-style BSD license requirements

You state that is if it was a fact, which is it not. We, indeed, fully
comply with the license requirements.

> The python.org site is full of references to OpenSSL. Most
> prominently in the documentation of the ssl and hashlib modules,
> but also in the release notes/news and other files.

Sure, but this is not advertising material. It's technical documentation.

> So you'd rather have some users get in trouble for downloading
> and using crypto software, due import laws or domestic laws
> restricting its use in their country ?

I don't believe that users actually will get into troubles for
downloading Python. If they would, a notice is likely not to have
any effect on that - if there is a real risk that users will get
into trouble, most likely, they know before downloading what
that trouble might be.

If you really wanted to post a notice telling people that doing illegal
things may cause problems, for all the illegal things that you can
do with Python, you'll end up with a long list. For example, Python
can be used to break into other computer systems (as can any programming
environment with a networking API) - should we now include a notice
saying

"Python can be used to break into remote computers, using the network
services of Python. Please note that breaking into other computers
may not be legal in your country of residence. It is your responsibility
to make sure you meet all local import and use requirements for
networking code when downloading and using the Python Windows installers."

I hope you agree that would be silly.

----------
title: Python download page needs to mention crypto code in Windows installer -> Python download page needs to mention crypto code in	Windows installer

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 17:06:01 2010
From: report at bugs.python.org (Marc-Andre Lemburg)
Date: Fri, 27 Aug 2010 15:06:01 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code	in	Windows installer
In-Reply-To: <4C77CE1D.5040200@v.loewis.de>
Message-ID: <4C77D454.3020407@egenix.com>


Marc-Andre Lemburg <mal at egenix.com> added the comment:

Martin v. L?wis wrote:
> 
> Martin v. L?wis <martin at v.loewis.de> added the comment:
> 
>> Since we are not following those old-style BSD license requirements
> 
> You state that is if it was a fact, which is it not. We, indeed, fully
> comply with the license requirements.
>
>> The python.org site is full of references to OpenSSL. Most
>> prominently in the documentation of the ssl and hashlib modules,
>> but also in the release notes/news and other files.
> 
> Sure, but this is not advertising material. It's technical documentation.

Ask a lawyer :-)

There's a reason why you get around 688.000 hits when searching for
"This product includes cryptographic software written by Eric Young"
on Google.

Now try that search against www.python.org... not a single hit.

>> So you'd rather have some users get in trouble for downloading
>> and using crypto software, due import laws or domestic laws
>> restricting its use in their country ?
> 
> I don't believe that users actually will get into troubles for
> downloading Python. If they would, a notice is likely not to have
> any effect on that - if there is a real risk that users will get
> into trouble, most likely, they know before downloading what
> that trouble might be.

Right now, they are downloading a file without knowing that
they are in fact possibly importing crypto code. Even if they
know that importing or using crypto code is illegal, they
don't get the needed information from us to decide whether
or not they want to proceed.

And they don't get a choice to download an installer without
crypto code either.

This latter point may actually be a good way
to make them aware without scaring anyone away: put two installers
up on the page, one with OpenSSL, the other without OpenSSL and
then let the users decide which one they want.

> If you really wanted to post a notice telling people that doing illegal
> things may cause problems, for all the illegal things that you can
> do with Python, you'll end up with a long list. For example, Python
> can be used to break into other computer systems (as can any programming
> environment with a networking API) - should we now include a notice
> saying
> 
> "Python can be used to break into remote computers, using the network
> services of Python. Please note that breaking into other computers
> may not be legal in your country of residence. It is your responsibility
> to make sure you meet all local import and use requirements for
> networking code when downloading and using the Python Windows installers."
> 
> I hope you agree that would be silly.

Agreed, but that's not what I'm talking about :-)

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 22:20:45 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Fri, 27 Aug 2010 20:20:45 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code	in	Windows installer
In-Reply-To: <1277836658.93.0.259031299275.issue9119@psf.upfronthosting.co.za>
Message-ID: <1282940445.48.0.568535463229.issue9119@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

This is really two issues: docs and windows builds. As for docs:

Many of the module doc pages mention original authors and give urls for further info. The ssl page already says " This module uses the OpenSSL library." Rather than fuss over whether the doc constitutes 'advertising material' (and a lawyer certain could claim it does), we can easily expand the above to

"This module includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/) and cryptographic software written by Eric Young (eay at cryptsoft.com)."

or whatever would be correct. This wording better meets the attribution requirement *and* is more informative to users.

The download page currently does not contain the word 'license', which I think is an omission that should be filled. I think it should include something like the following reasonably near the top:

"The History and License for each version is included with its document set. In layperson's terms, the license more or less says that you can use Python as you wish as long as you 1) do not claim ownership of the name or code, and 2) assume full legal and moral responsibility for the downloading and use of the code, including the cryptographic modules." 

Builds: have there been multiple overt requests for no-crypto builds? Do any of the other build providers make such? I think this falls under "These re-packagings often include more libraries or are specialized for a particular application:" -- like being so unfortunate as to live in certain countries.

----------
keywords: +patch
nosy: +terry.reedy
stage:  -> needs patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Fri Aug 27 22:33:06 2010
From: report at bugs.python.org (Raymond Hettinger)
Date: Fri, 27 Aug 2010 20:33:06 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code	in	Windows installer
In-Reply-To: <1277836658.93.0.259031299275.issue9119@psf.upfronthosting.co.za>
Message-ID: <1282941186.39.0.0272019053602.issue9119@psf.upfronthosting.co.za>


Raymond Hettinger <rhettinger at users.sourceforge.net> added the comment:

FYI, there is a section of the docs devoted to notifications and attribution licenses:

http://docs.python.org/license.html#licenses-and-acknowledgements-for-incorporated-software

----------
nosy: +rhettinger

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From jrodman at splunk.com  Fri Aug 27 00:30:12 2010
From: jrodman at splunk.com (Joshua Rodman)
Date: Thu, 26 Aug 2010 15:30:12 -0700
Subject: [docs] shutil.copytree error interface is ambiguously docced
Message-ID: <20100826223012.GF209@joshbook.splunk.com>

shutil.copytree() says:

"""
shutil.copytree(src, dst[, symlinks=False[, ignore=None]])?

    Recursively copy an entire directory tree rooted at src. The destination directory, named by dst, must not already exist; it will be created as well as missing parent directories. Permissions and times of directories are copied with copystat(), individual files are copied using copy2().

    If symlinks is true, symbolic links in the source tree are represented as symbolic links in the new tree; if false or omitted, the contents of the linked files are copied to the new tree.

    If ignore is given, it must be a callable that will receive as its arguments the directory being visited by copytree(), and a list of its contents, as returned by os.listdir(). Since copytree() is called recursively, the ignore callable will be called once for each directory that is copied. The callable must return a sequence of directory and file names relative to the current directory (i.e. a subset of the items in its second argument); these names will then be ignored in the copy process. ignore_patterns() can be used to create such a callable that ignores names based on glob-style patterns.

    If exception(s) occur, an Error is raised with a list of reasons.

    The source code for this should be considered an example rather than the ultimate tool.
"""

Naively, this reads as copytree aborting on exception. "If
exceptions(s) occur, an Error is raised with a list of reasons."
This suggests the copy operation does not complete.

I suggest changing this to:

   If exceptions(s) occur during the copy operation, an Error is raised on completion with a list of all the encountered reasons during the copy operation.

Preferably the format of the Error object or a pointer to the error
object defintion would be included as well.

-josh
-- 
scooby snacks.

From johnh2 at email.arizona.edu  Fri Aug 27 22:02:21 2010
From: johnh2 at email.arizona.edu (John Hughes)
Date: Fri, 27 Aug 2010 13:02:21 -0700
Subject: [docs] V2.6 PDF documentation
Message-ID: <1282939341.1475.3.camel@jmh-linux>

Hello,

I can't seem to find the 2.6 version of the Python documentation in PDF
format on the python.org website. Is there some way I could get to it?

Thanks.

John Hughes

Senior Software Engineer
Department of Electrical and Computer Engineering
University of Arizona



From waku at idi.ntnu.no  Sat Aug 28 07:57:58 2010
From: waku at idi.ntnu.no (Wacek Kusnierczyk)
Date: Sat, 28 Aug 2010 00:57:58 -0500
Subject: [docs] transpose of a matrix represented with nested lists
Message-ID: <4C78A566.1060109@idi.ntnu.no>

  Hello,

In section 5.1 [1] of Python 3 online documentation, you discuss ways to 
transpose a matrix represented as a nested list.  The following example 
is given:

mat = [
...        [1, 2, 3],
...        [4, 5, 6],
...        [7, 8, 9],
...       ]

list(zip(*mat))
[(1, 4, 7), (2, 5, 8), (3, 6, 9)]


That's correct only if further code ignores the distinction between 
tuples and lists.  In the code as it is, the 'list' part is actually 
redundant, as zip will return a list anyway.

To transpose a matrix using zip, the following seems more accurate:

map(list, zip(*m))


Regards,
vQ

[1] 
http://docs.python.org/py3k/tutorial/datastructures.html#nested-list-comprehensions

From choralreef at naver.com  Sat Aug 28 16:06:10 2010
From: choralreef at naver.com (=?US-ASCII?B?TEVFIERBTklFTCBKT09O?=)
Date: Sat, 28 Aug 2010 23:06:10 +0900
Subject: [docs] typo
Message-ID: <da90ab29056a8a833f423492c8c693ce@tweb12-2.nm>

http://docs.python.org/tutorial/classes.html
-- (where one at least one of the parent classes can be accessed through multiple paths from the bottommost class). 
++ (where at least one of the parent classes can be accessed through multiple paths from the bottommost class).
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20100828/cb1dcb81/attachment.html>

From report at bugs.python.org  Sun Aug 29 06:51:59 2010
From: report at bugs.python.org (Chris Rebert)
Date: Sun, 29 Aug 2010 04:51:59 +0000
Subject: [docs] [issue7950] subprocess.Popen documentation should contain a
	good	warning about the security implications when using shell=True
In-Reply-To: <1266401759.12.0.600282213979.issue7950@psf.upfronthosting.co.za>
Message-ID: <1283057517.36.0.466068879647.issue7950@psf.upfronthosting.co.za>


Chris Rebert <pybugs at rebertia.com> added the comment:

Adjusted patch per R. David's comment.

I obviously think it should be a full red warning box (that's how it is in my patch), but my opinion clearly isn't an outside one.

Also, Ping/Bump on finally getting this applied.

----------
Added file: http://bugs.python.org/file18670/subprocess.rst.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7950>
_______________________________________

From report at bugs.python.org  Mon Aug 30 10:30:33 2010
From: report at bugs.python.org (Marc-Andre Lemburg)
Date: Mon, 30 Aug 2010 08:30:33 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code	in	Windows installer
In-Reply-To: <1282940445.48.0.568535463229.issue9119@psf.upfronthosting.co.za>
Message-ID: <4C7B6C24.1090506@egenix.com>


Marc-Andre Lemburg <mal at egenix.com> added the comment:

Terry J. Reedy wrote:
> 
> Terry J. Reedy <tjreedy at udel.edu> added the comment:
> 
> This is really two issues: docs and windows builds. As for docs:
> 
> Many of the module doc pages mention original authors and give urls for further info. The ssl page already says " This module uses the OpenSSL library." Rather than fuss over whether the doc constitutes 'advertising material' (and a lawyer certain could claim it does), we can easily expand the above to
> 
> "This module includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/) and cryptographic software written by Eric Young (eay at cryptsoft.com)."
> 
> or whatever would be correct. This wording better meets the attribution requirement *and* is more informative to users.

+1

> The download page currently does not contain the word 'license', which I think is an omission that should be filled. I think it should include something like the following reasonably near the top:
> 
> "The History and License for each version is included with its document set. In layperson's terms, the license more or less says that you can use Python as you wish as long as you 1) do not claim ownership of the name or code, and 2) assume full legal and moral responsibility for the downloading and use of the code, including the cryptographic modules." 

Fine with me. The text should also link to actual current license text:

http://docs.python.org/license.html

BTW: I have a little trouble actually finding the license text on
the python.org web-site. It is not mentioned on the download page,
there's not mention of it in the downloads nav bar, nor in the documentation
section of the site.

Only the "about" section includes a mention of the
license and the "foundation" section even mentions it in the nav bar
(but that's not where people would look to find it). What's worse:
all links point to:

http://www.python.org/psf/license/

and that page refers to the Python 2.6.2 license...

I'll report this to the webmasters.

> Builds: have there been multiple overt requests for no-crypto builds? Do any of the other build providers make such? I think this falls under "These re-packagings often include more libraries or are specialized for a particular application:" -- like being so unfortunate as to live in certain countries.

Many other providers of software builds that include crypto software
either make it obvious that the builds include crypto software in their
licenses (by copying the OpenSSL license into the document) or
on the download page (ticking a checkbox, in case there's an export
issue). Some also put the crypto code into a separate download
(e.g. Java and many Linux distros).

The idea with having a separate download without the crypto code
was just to hint the user at a possible issue without scaring
them away. If we can do the same without requiring a separate
installer that would be even better.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Mon Aug 30 10:32:22 2010
From: report at bugs.python.org (Marc-Andre Lemburg)
Date: Mon, 30 Aug 2010 08:32:22 +0000
Subject: [docs] [issue9119] Python download page needs to mention crypto
	code	in	Windows installer
In-Reply-To: <1282941186.39.0.0272019053602.issue9119@psf.upfronthosting.co.za>
Message-ID: <4C7B6C91.1010404@egenix.com>


Marc-Andre Lemburg <mal at egenix.com> added the comment:

Raymond Hettinger wrote:
> 
> Raymond Hettinger <rhettinger at users.sourceforge.net> added the comment:
> 
> FYI, there is a section of the docs devoted to notifications and attribution licenses:
> 
> http://docs.python.org/license.html#licenses-and-acknowledgements-for-incorporated-software

Good point. We should add the OpenSSL license to that section
and mention that the code is included in the Windows installer
we ship from python.org.

How does one go about getting that page updated ? Is that just a regular
build of the Python documentation, so only a checkin is needed ?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9119>
_______________________________________

From report at bugs.python.org  Mon Aug 30 13:54:42 2010
From: report at bugs.python.org (Antoine Pitrou)
Date: Mon, 30 Aug 2010 11:54:42 +0000
Subject: [docs] [issue9715] io doc improvements
In-Reply-To: <1283169282.13.0.519600528292.issue9715@psf.upfronthosting.co.za>
Message-ID: <1283169282.13.0.519600528292.issue9715@psf.upfronthosting.co.za>


New submission from Antoine Pitrou <pitrou at free.fr>:

This is an improvement patch for the :mod:`io` documentation.
It adds an user-friendly overview, and makes a couple of other fixes/improvements.
There's a problem where I want to make a link to a glossary term while using the plural form ("abstract base classes"), and it doesn't work. Can someone help me?

----------
assignee: docs at python
components: Documentation, IO
files: iodoc.patch
keywords: patch
messages: 115208
nosy: benjamin.peterson, docs at python, pitrou
priority: normal
severity: normal
stage: patch review
status: open
title: io doc improvements
type: behavior
versions: Python 2.7, Python 3.1, Python 3.2
Added file: http://bugs.python.org/file18679/iodoc.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9715>
_______________________________________

From report at bugs.python.org  Mon Aug 30 14:01:51 2010
From: report at bugs.python.org (Antoine Pitrou)
Date: Mon, 30 Aug 2010 12:01:51 +0000
Subject: [docs] [issue9715] io doc improvements
In-Reply-To: <1283169282.13.0.519600528292.issue9715@psf.upfronthosting.co.za>
Message-ID: <1283169711.48.0.0472550611165.issue9715@psf.upfronthosting.co.za>


Changes by Antoine Pitrou <pitrou at free.fr>:


Removed file: http://bugs.python.org/file18679/iodoc.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9715>
_______________________________________

From report at bugs.python.org  Mon Aug 30 14:02:01 2010
From: report at bugs.python.org (Antoine Pitrou)
Date: Mon, 30 Aug 2010 12:02:01 +0000
Subject: [docs] [issue9715] io doc improvements
In-Reply-To: <1283169282.13.0.519600528292.issue9715@psf.upfronthosting.co.za>
Message-ID: <1283169721.67.0.427849453712.issue9715@psf.upfronthosting.co.za>


Changes by Antoine Pitrou <pitrou at free.fr>:


Added file: http://bugs.python.org/file18680/iodoc.patch

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9715>
_______________________________________

From report at bugs.python.org  Mon Aug 30 14:49:58 2010
From: report at bugs.python.org (Antoine Pitrou)
Date: Mon, 30 Aug 2010 12:49:58 +0000
Subject: [docs] [issue9715] io doc improvements
In-Reply-To: <1283169282.13.0.519600528292.issue9715@psf.upfronthosting.co.za>
Message-ID: <1283172598.04.0.04334448013.issue9715@psf.upfronthosting.co.za>


Antoine Pitrou <pitrou at free.fr> added the comment:

Ok, committed in r84357 (py3k) and r84358 (3.1). Backporting to 2.7 would be too much work.

----------
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed
versions:  -Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9715>
_______________________________________

From report at bugs.python.org  Mon Aug 30 15:27:39 2010
From: report at bugs.python.org (Skip Montanaro)
Date: Mon, 30 Aug 2010 13:27:39 +0000
Subject: [docs] [issue9715] io doc improvements
In-Reply-To: <1283169282.13.0.519600528292.issue9715@psf.upfronthosting.co.za>
Message-ID: <1283174858.84.0.744522501572.issue9715@psf.upfronthosting.co.za>


Skip Montanaro <skip at pobox.com> added the comment:

A couple wording comments:

"All streams are careful about the type of data you give to them"
would read better as "All streams accept specific types of data".

"The default mode is ``'r'`` (open for reading text, synonym of
``'rt'``)".  I liked the original wording better.

Finally, not specific to this change, but I wonder if rather than
having distinct io.StringIO and io.BytesIO classes it would be better
to have a single io.MemoryIO class which takes mode arguments just
like io.FileIO?  The correspondence between file-based and memory-
based i/o would be more one-to-one.  Such a class could be added
without breaking existing code by using the StringIO and BytesIO
classes as the back-end for a MemoryIO class.

----------
nosy: +skip.montanaro

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9715>
_______________________________________

From report at bugs.python.org  Mon Aug 30 15:32:34 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Mon, 30 Aug 2010 13:32:34 +0000
Subject: [docs] [issue9715] io doc improvements
In-Reply-To: <1283174858.84.0.744522501572.issue9715@psf.upfronthosting.co.za>
Message-ID: <AANLkTimGdHnz85q4HT2oE+Ri7GqaTcJMU33RujLqod7y@mail.gmail.com>


Benjamin Peterson <benjamin at python.org> added the comment:

2010/8/30 Skip Montanaro <report at bugs.python.org>:
>
> Skip Montanaro <skip at pobox.com> added the comment:
>
> A couple wording comments:
>
> "All streams are careful about the type of data you give to them"
> would read better as "All streams accept specific types of data".
>
> "The default mode is ``'r'`` (open for reading text, synonym of
> ``'rt'``)". ?I liked the original wording better.

Feel free to change it; it's been committed.

>
> Finally, not specific to this change, but I wonder if rather than
> having distinct io.StringIO and io.BytesIO classes it would be better
> to have a single io.MemoryIO class which takes mode arguments just
> like io.FileIO? ?The correspondence between file-based and memory-
> based i/o would be more one-to-one. ?Such a class could be added
> without breaking existing code by using the StringIO and BytesIO
> classes as the back-end for a MemoryIO class.

What advantage would that have?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9715>
_______________________________________

From report at bugs.python.org  Mon Aug 30 15:38:53 2010
From: report at bugs.python.org (Antoine Pitrou)
Date: Mon, 30 Aug 2010 13:38:53 +0000
Subject: [docs] [issue9715] io doc improvements
In-Reply-To: <1283174858.84.0.744522501572.issue9715@psf.upfronthosting.co.za>
Message-ID: <1283175525.3248.5.camel@localhost.localdomain>


Antoine Pitrou <pitrou at free.fr> added the comment:

> "The default mode is ``'r'`` (open for reading text, synonym of
> ``'rt'``)".  I liked the original wording better.

Well, people use "r" in practice, and "rt" is a somewhat rarer
alternative. We could drop the "synonym..." part entirely.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9715>
_______________________________________

From report at bugs.python.org  Mon Aug 30 16:13:40 2010
From: report at bugs.python.org (Skip Montanaro)
Date: Mon, 30 Aug 2010 14:13:40 +0000
Subject: [docs] [issue9715] io doc improvements
In-Reply-To: <AANLkTimGdHnz85q4HT2oE+Ri7GqaTcJMU33RujLqod7y@mail.gmail.com>
Message-ID: <19579.48267.999574.22463@montanaro.dyndns.org>


Skip Montanaro <skip at pobox.com> added the comment:

>> Finally, not specific to this change, but I wonder if rather than
    >> having distinct io.StringIO and io.BytesIO classes it would be better
    >> to have a single io.MemoryIO class which takes mode arguments just
    >> like io.FileIO? ??The correspondence between file-based and memory-
    >> based i/o would be more one-to-one. ??Such a class could be added
    >> without breaking existing code by using the StringIO and BytesIO
    >> classes as the back-end for a MemoryIO class.

    Benjamin> What advantage would that have?

File I/O and memory I/O would have more uniform in their APIs and thus be
easier to document, describe and use.  Currently, one class is used to do
file I/O.  The type of I/O done is controlled by the mode and buffering
flags.  Two distinct classes are used to do memory I/O.

If someone wanted to select between file and memory I/O at runtime it
wouldn't be possible to just swap the class using the current code.

Skip

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9715>
_______________________________________

From report at bugs.python.org  Mon Aug 30 16:23:21 2010
From: report at bugs.python.org (Antoine Pitrou)
Date: Mon, 30 Aug 2010 14:23:21 +0000
Subject: [docs] [issue9715] io doc improvements
In-Reply-To: <19579.48267.999574.22463@montanaro.dyndns.org>
Message-ID: <1283178197.3248.7.camel@localhost.localdomain>


Antoine Pitrou <pitrou at free.fr> added the comment:

> File I/O and memory I/O would have more uniform in their APIs and thus be
> easier to document, describe and use.  Currently, one class is used to do
> file I/O.

That's wrong. Various classes are used for file I/O: FileIO,
Buffered{Reader,Writer,Random}, TextIOWrapper.

> If someone wanted to select between file and memory I/O at runtime it
> wouldn't be possible to just swap the class using the current code.

Why would you swap the class since the constructor arguments would be
different anyway?

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9715>
_______________________________________

From report at bugs.python.org  Mon Aug 30 20:49:34 2010
From: report at bugs.python.org (Arnaud Delobelle)
Date: Mon, 30 Aug 2010 18:49:34 +0000
Subject: [docs] [issue9717] operator module - "in place" operators
	documentation
In-Reply-To: <1283194174.19.0.42398116416.issue9717@psf.upfronthosting.co.za>
Message-ID: <1283194174.19.0.42398116416.issue9717@psf.upfronthosting.co.za>


New submission from Arnaud Delobelle <arnodel at googlemail.com>:

More detailed explanation of how in place operators work, and how they are related to the operator module iadd, isub, ... functions.

Submitted following this message on python-list:

http://mail.python.org/pipermail/python-list/2010-August/1254243.html

----------
assignee: docs at python
components: Documentation
files: operator_inplace.diff
keywords: patch
messages: 115237
nosy: arno, docs at python
priority: normal
severity: normal
status: open
title: operator module - "in place" operators documentation
versions: Python 3.3
Added file: http://bugs.python.org/file18682/operator_inplace.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9717>
_______________________________________

From report at bugs.python.org  Tue Aug 31 15:40:14 2010
From: report at bugs.python.org (Brandon Craig Rhodes)
Date: Tue, 31 Aug 2010 13:40:14 +0000
Subject: [docs] [issue9723] pipes.quote() needs to be documented
In-Reply-To: <1283262014.72.0.527039259842.issue9723@psf.upfronthosting.co.za>
Message-ID: <1283262014.72.0.527039259842.issue9723@psf.upfronthosting.co.za>


New submission from Brandon Craig Rhodes <brandon at rhodesmill.org>:

The only way to safely build shell command lines from inside of Python ? which is necessary when sending commands across SSH, since that behaves like os.system() rather than like subprocess.call() ? is to use the wonderful pipes.call() method to turn possibly-dangerous arguments, like filenames that might have spaces, special characters, and embedded "rm -r" calls, into perfectly quoted strings for an "sh"-like shell (say, bash or zsh).

This call is already recommended on mailing lists, blog posts, and Stack Overflow ? and since it doesn't start with a "_", I think its public use is fair game. But the "pipes" documentation itself doesn't officially mention or support it. I think it should be added to the Standard Library documentation for "pipes". So. Yeah.

----------
assignee: docs at python
components: Documentation
messages: 115263
nosy: brandon-rhodes, docs at python
priority: normal
severity: normal
status: open
title: pipes.quote() needs to be documented
type: feature request
versions: Python 2.5, Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9723>
_______________________________________

From report at bugs.python.org  Tue Aug 31 16:21:46 2010
From: report at bugs.python.org (Cherniavsky Beni)
Date: Tue, 31 Aug 2010 14:21:46 +0000
Subject: [docs] [issue9724] help('nonlocal') missing
In-Reply-To: <1283264506.65.0.891353538251.issue9724@psf.upfronthosting.co.za>
Message-ID: <1283264506.65.0.891353538251.issue9724@psf.upfronthosting.co.za>


New submission from Cherniavsky Beni <cben at users.sf.net>:

>>> help('nonlocal')
no Python documentation found for 'nonlocal'

As a language keyword, it clearly should have documentation.

----------
assignee: docs at python
components: Documentation
messages: 115266
nosy: cben, docs at python
priority: normal
severity: normal
status: open
title: help('nonlocal') missing
versions: Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9724>
_______________________________________

From report at bugs.python.org  Tue Aug 31 16:31:18 2010
From: report at bugs.python.org (Benjamin Peterson)
Date: Tue, 31 Aug 2010 14:31:18 +0000
Subject: [docs] [issue9724] help('nonlocal') missing
In-Reply-To: <1283264506.65.0.891353538251.issue9724@psf.upfronthosting.co.za>
Message-ID: <1283265078.4.0.469233367844.issue9724@psf.upfronthosting.co.za>


Benjamin Peterson <benjamin at python.org> added the comment:

r84376.

----------
nosy: +benjamin.peterson
resolution:  -> fixed
status: open -> closed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9724>
_______________________________________

From report at bugs.python.org  Tue Aug 31 19:38:43 2010
From: report at bugs.python.org (Eric Smith)
Date: Tue, 31 Aug 2010 17:38:43 +0000
Subject: [docs] [issue9723] pipes.quote() needs to be documented
In-Reply-To: <1283262014.72.0.527039259842.issue9723@psf.upfronthosting.co.za>
Message-ID: <1283276322.95.0.261627769588.issue9723@psf.upfronthosting.co.za>


Eric Smith <eric at trueblade.com> added the comment:

I think you mean pipe.quote in your message, not pipe.call. The subject looks correct.

I'm not sure pipes is the best place for this, but I agree it should probably be documented in older versions. It seems to me we've had this discussion before about quoting command lines, how it applies differently between Windows and various shells, and which functions to expose. But having said that, I can't find a previous issue that discusses it.

Not the least of my concerns is that pipes says it's available on Unix systems, despite the fact that I have it on a Windows machine. And I might need the functionality of passing a bash command from a Windows machine to a Unix machine, so we definitely need this cross platform.

----------
nosy: +eric.smith

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9723>
_______________________________________

From justinpeel at gmail.com  Tue Aug 31 06:44:32 2010
From: justinpeel at gmail.com (Justin Peel)
Date: Mon, 30 Aug 2010 22:44:32 -0600
Subject: [docs] multiprocessing doc typo
Message-ID: <AANLkTincXSZYoq+-8YO2c7nxs-FNazkEAGokRfRZs1in@mail.gmail.com>

I guess this is a bug, though I'd call it more of a typo. On the
multiprocessing page, http://docs.python.org/library/multiprocessing.html,
near the bottom of the page there is text that says "An showing how to use
queues" which should be "An example showing how to use queues".

Justin
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20100830/ba77d982/attachment.html>

From report at bugs.python.org  Tue Aug 31 21:57:01 2010
From: report at bugs.python.org (Terry J. Reedy)
Date: Tue, 31 Aug 2010 19:57:01 +0000
Subject: [docs] [issue1397474] timeit execution enviroment
Message-ID: <1283284620.75.0.321229325826.issue1397474@psf.upfronthosting.co.za>


Terry J. Reedy <tjreedy at udel.edu> added the comment:

I agree that the Timer doc is deficient in not saying that timing is done within a function defined within the timeit module. It is also deficient in not mentioning the secret of how to successfully pass user-defined functions until the very bottom instead of where that option is described. (I had missed this very point until recently.)

The discussion of possible new features for 3.2 (more likely later) does not affect 2.7/3.1 and should not stop a change in 3.2 either.  I propose that the Timer doc be revised to the following:

PROPOSED REPLACEMENT
'''
Class for timing execution speed of small code snippets. The constructor creates a function that executes the *setup* statement once and then times some number of executions of the *stmt* statement (see Timer.timeit). Both statements default to 'pass'. The *timer* parameter defaults to a platform-dependent timer function (see the module doc string). Both *stmt* and *setup* may contain multiple statements separated by ; or newlines as long as they don?t contain multi-line string literals.

Both *stmt* and *setup* can also be objects that are callable without arguments. Passing testfunc rather than 'testfunc()' may reduce the timing overhead. However, if testfunc is a Python function, passing its quoted code should have even less overhead because doing so eliminates an extra function call.

To give *stmt* (whether it is a callable name or code string) access to pre-defined user objects, such as testfunc, *setup* must include an import, such as 'from __main__ import testfunc'. Note that 'from __main__ import *' does not work because * imports are not legal within functions.

To measure the execution time of *stmt*, use the timeit() method. The repeat() method is a convenience to call timeit() multiple times and return a list of results.
'''

Note 1. testfunc , 'testfunc()' , and 'from ....' should be marked up as code. Perhaps the first two should be double quoted also, depending of the style convention. What must be clear is the difference between passing an unquoted function name and a string.

Note 2. The 'may reduce' comment: timeit.timeit(str) (for instance) runs noticeably faster than timeit.timeit('str()'). I presume this is because callables get bound to a local name and local name lookup is faster than builtin lookup. This difference does not apply to imported user names. The existing statement "Note that the timing overhead is a little larger in this case because of the extra function calls." is confusing to me because it does not specify the alternative to 'this case' and there are two possibilities, which I specified.

Note 3. The comment about * imports should be deleted for 2.7 version.

ADDITIONAL CHANGE
Add the following to the very bottom as part of the final example:
"
    t = Timer(test, "from __main__ import test")
    print(t.timeit()) # should be nearly the same
"

----------
keywords: +patch
nosy: +terry.reedy
stage:  -> needs patch
type:  -> behavior
versions: +Python 2.7, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue1397474>
_______________________________________