[docs] [issue9382] os.popen referenced but not documented in Python 3.x

Chris Rebert report at bugs.python.org
Mon Jul 26 07:24:09 CEST 2010

New submission from Chris Rebert <pybugs at rebertia.com>:

http://docs.python.org/py3k/library/os.html  currently mentions os.popen() in several places. The docs for os.popen() itself say:
'These functions are described in section "File Object Creation"'

However, unlike the 2.x version of that section ( http://docs.python.org/library/os.html#file-object-creation ), the os.popen*() family is not documented there [or indeed anywhere] anymore ( http://docs.python.org/py3k/library/os.html#os-newstreams ); the entire section now only documents os.fdopen().

The 2.7 docs say that the os.popen*() family are deprecated, and indeed, of the family, only os.popen() seems to still exist in Python 3.x (at least based on my testing via ideone.com).

Thus, from what I can see, one of the following is the case:
(A) The entire os.popen*() family is supposed be gone in Python 3.x, so os.popen() should be removed entirely from both the code and the docs.
(B) os.popen() is the sole legitimate survivor of its family, and should be properly documented again.
(C) os.popen() was left in as a kludge, shouldn't be mentioned in the docs, and possibly should be renamed os._popen() to reflect its status.

So, which one of these is it?

assignee: docs at python
components: Documentation
messages: 111597
nosy: cvrebert, docs at python
priority: normal
severity: normal
status: open
title: os.popen referenced but not documented in Python 3.x
versions: Python 3.1

Python tracker <report at bugs.python.org>

More information about the docs mailing list