summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2010-01-04 18:50:53 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2010-01-04 18:50:53 (GMT)
commit4adb288f4eaea3a21295c11a3ca49313d7da8cc7 (patch)
tree84821f5b594c91134847979997663ce070cbfc57 /Doc
parent6e40e27ecfe417ab4633c46b8ac99d30ebad6b36 (diff)
downloadcpython-4adb288f4eaea3a21295c11a3ca49313d7da8cc7.zip
cpython-4adb288f4eaea3a21295c11a3ca49313d7da8cc7.tar.gz
cpython-4adb288f4eaea3a21295c11a3ca49313d7da8cc7.tar.bz2
Issue #7631: Fix undefined references to the "built-in file object", which
has ceased to be.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/filesys.rst9
-rw-r--r--Doc/library/socket.rst12
-rw-r--r--Doc/library/tokenize.rst5
-rw-r--r--Doc/reference/datamodel.rst23
-rw-r--r--Doc/using/cmdline.rst5
5 files changed, 26 insertions, 28 deletions
diff --git a/Doc/library/filesys.rst b/Doc/library/filesys.rst
index b341f5f..31eaf0d 100644
--- a/Doc/library/filesys.rst
+++ b/Doc/library/filesys.rst
@@ -26,14 +26,13 @@ in this chapter is:
.. seealso::
- Section :ref:`bltin-file-objects`
- A description of Python's built-in file objects.
-
Module :mod:`os`
Operating system interfaces, including functions to work with files at a lower
level than the built-in file object.
Module :mod:`io`
- Python's framework for dealing with I/O including reading and writing
- files.
+ Python's built-in I/O library, including both abstract classes and
+ some concrete classes such as file I/O.
+ Built-in function :func:`open`
+ The standard way to open files for reading and writing with Python.
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index ec8ff3d..0fee6d5 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -575,14 +575,16 @@ correspond to Unix system calls applicable to sockets.
.. index:: single: I/O control; buffering
- Return a :dfn:`file object` associated with the socket. (File objects are
- described in :ref:`bltin-file-objects`.) The file object references a
- :cfunc:`dup`\ ped version of the socket file descriptor, so the file object
- and socket object may be closed or garbage-collected independently. The
- socket must be in blocking mode (it can not have a timeout). The optional
+ Return a :dfn:`file object` associated with the socket. The exact
+ returned type depends on the arguments given to :meth:`makefile`. These
arguments are interpreted the same way as by the built-in :func:`open`
function.
+ The returned file object references a :cfunc:`dup`\ ped version of the
+ socket file descriptor, so the file object and socket object may be
+ closed or garbage-collected independently. The socket must be in
+ blocking mode (it can not have a timeout).
+
.. method:: socket.recv(bufsize[, flags])
diff --git a/Doc/library/tokenize.rst b/Doc/library/tokenize.rst
index d66b07c..7017045 100644
--- a/Doc/library/tokenize.rst
+++ b/Doc/library/tokenize.rst
@@ -18,9 +18,8 @@ The primary entry point is a :term:`generator`:
The :func:`tokenize` generator requires one argument, *readline*, which
must be a callable object which provides the same interface as the
- :meth:`readline` method of built-in file objects (see section
- :ref:`bltin-file-objects`). Each call to the function should return one
- line of input as bytes.
+ :meth:`io.IOBase.readline` method of file objects. Each call to the
+ function should return one line of input as bytes.
The generator produces 5-tuples with these members: the token type; the
token string; a 2-tuple ``(srow, scol)`` of ints specifying the row and
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 36fc575..78f96df 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -767,10 +767,10 @@ Class instances
Special attributes: :attr:`__dict__` is the attribute dictionary;
:attr:`__class__` is the instance's class.
-Files
+I/O objects (also known as file objects)
.. index::
- object: file
builtin: open
+ module: io
single: popen() (in module os)
single: makefile() (socket method)
single: sys.stdin
@@ -781,14 +781,17 @@ Files
single: stdout (in module sys)
single: stderr (in module sys)
- A file object represents an open file. File objects are created by the
- :func:`open` built-in function, and also by :func:`os.popen`,
- :func:`os.fdopen`, and the :meth:`makefile` method of socket objects (and
- perhaps by other functions or methods provided by extension modules). The
- objects ``sys.stdin``, ``sys.stdout`` and ``sys.stderr`` are initialized to
- file objects corresponding to the interpreter's standard input, output and
- error streams. See :ref:`bltin-file-objects` for complete documentation of
- file objects.
+ A file object represents an open file. Various shortcuts are available
+ to create file objects: the :func:`open` built-in function, and also
+ :func:`os.popen`, :func:`os.fdopen`, and the :meth:`makefile` method
+ of socket objects (and perhaps by other functions or methods provided
+ by extension modules).
+
+ The objects ``sys.stdin``, ``sys.stdout`` and ``sys.stderr`` are
+ initialized to file objects corresponding to the interpreter's standard
+ input, output and error streams; they are all open in text mode and
+ therefore follow the interface defined by the :class:`io.TextIOBase`
+ abstract class.
Internal types
.. index::
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index 5440c20..7c9b511 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -235,11 +235,6 @@ Miscellaneous options
Force stdin, stdout and stderr to be totally unbuffered. On systems where it
matters, also put stdin, stdout and stderr in binary mode.
- Note that there is internal buffering in :meth:`file.readlines` and
- :ref:`bltin-file-objects` (``for line in sys.stdin``) which is not influenced
- by this option. To work around this, you will want to use
- :meth:`file.readline` inside a ``while 1:`` loop.
-
See also :envvar:`PYTHONUNBUFFERED`.