Merged revisions 68776-68777 via svnmerge from

svn+ssh://pythondev@svn.python.org/python/trunk

........
  r68776 | benjamin.peterson | 2009-01-19 17:17:54 +0100 (Mo, 19 Jan 2009) | 1 line

  move BufferedIOBase into the base class section
........
  r68777 | benjamin.peterson | 2009-01-19 17:18:27 +0100 (Mo, 19 Jan 2009) | 1 line

  add email address
........
This commit is contained in:
Georg Brandl 2009-10-27 13:20:10 +00:00
parent 0d97d32a86
commit 4f8084eda1
2 changed files with 54 additions and 54 deletions

View File

@ -329,59 +329,6 @@ I/O Base Classes
``len(b)``, since if the write fails, an :exc:`IOError` will be raised). ``len(b)``, since if the write fails, an :exc:`IOError` will be raised).
Raw File I/O
------------
.. class:: FileIO(name[, mode])
:class:`FileIO` represents a file containing bytes data. It implements
the :class:`RawIOBase` interface (and therefore the :class:`IOBase`
interface, too).
The *mode* can be ``'r'``, ``'w'`` or ``'a'`` for reading (default), writing,
or appending. The file will be created if it doesn't exist when opened for
writing or appending; it will be truncated when opened for writing. Add a
``'+'`` to the mode to allow simultaneous reading and writing.
In addition to the attributes and methods from :class:`IOBase` and
:class:`RawIOBase`, :class:`FileIO` provides the following data
attributes and methods:
.. attribute:: mode
The mode as given in the constructor.
.. attribute:: name
The file name. This is the file descriptor of the file when no name is
given in the constructor.
.. method:: read([n])
Read and return at most *n* bytes. Only one system call is made, so it is
possible that less data than was requested is returned. Use :func:`len`
on the returned bytes object to see how many bytes were actually returned.
(In non-blocking mode, ``None`` is returned when no data is available.)
.. method:: readall()
Read and return the entire file's contents in a single bytes object. As
much as immediately available is returned in non-blocking mode. If the
EOF has been reached, ``b''`` is returned.
.. method:: write(b)
Write the bytes or bytearray object, *b*, to the file, and return
the number actually written. Only one system call is made, so it
is possible that only some of the data is written.
Note that the inherited ``readinto()`` method should not be used on
:class:`FileIO` objects.
Buffered Streams
----------------
.. class:: BufferedIOBase .. class:: BufferedIOBase
Base class for streams that support buffering. It inherits :class:`IOBase`. Base class for streams that support buffering. It inherits :class:`IOBase`.
@ -439,6 +386,59 @@ Buffered Streams
underlying raw stream cannot accept more data at the moment. underlying raw stream cannot accept more data at the moment.
Raw File I/O
------------
.. class:: FileIO(name[, mode])
:class:`FileIO` represents a file containing bytes data. It implements
the :class:`RawIOBase` interface (and therefore the :class:`IOBase`
interface, too).
The *mode* can be ``'r'``, ``'w'`` or ``'a'`` for reading (default), writing,
or appending. The file will be created if it doesn't exist when opened for
writing or appending; it will be truncated when opened for writing. Add a
``'+'`` to the mode to allow simultaneous reading and writing.
In addition to the attributes and methods from :class:`IOBase` and
:class:`RawIOBase`, :class:`FileIO` provides the following data
attributes and methods:
.. attribute:: mode
The mode as given in the constructor.
.. attribute:: name
The file name. This is the file descriptor of the file when no name is
given in the constructor.
.. method:: read([n])
Read and return at most *n* bytes. Only one system call is made, so it is
possible that less data than was requested is returned. Use :func:`len`
on the returned bytes object to see how many bytes were actually returned.
(In non-blocking mode, ``None`` is returned when no data is available.)
.. method:: readall()
Read and return the entire file's contents in a single bytes object. As
much as immediately available is returned in non-blocking mode. If the
EOF has been reached, ``b''`` is returned.
.. method:: write(b)
Write the bytes or bytearray object, *b*, to the file, and return
the number actually written. Only one system call is made, so it
is possible that only some of the data is written.
Note that the inherited ``readinto()`` method should not be used on
:class:`FileIO` objects.
Buffered Streams
----------------
.. class:: BytesIO([initial_bytes]) .. class:: BytesIO([initial_bytes])
A stream implementation using an in-memory bytes buffer. It inherits A stream implementation using an in-memory bytes buffer. It inherits

View File

@ -5,7 +5,7 @@
:synopsis: Interface to the compiler's internal symbol tables. :synopsis: Interface to the compiler's internal symbol tables.
.. moduleauthor:: Jeremy Hylton <jeremy@alum.mit.edu> .. moduleauthor:: Jeremy Hylton <jeremy@alum.mit.edu>
.. sectionauthor:: Benjamin Peterson .. sectionauthor:: Benjamin Peterson <benjamin@python.org>
Symbol tables are generated by the compiler from AST just before bytecode is Symbol tables are generated by the compiler from AST just before bytecode is