summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2008-05-30 06:27:09 (GMT)
committerGeorg Brandl <georg@python.org>2008-05-30 06:27:09 (GMT)
commit2932d9376e4d89f401ad25f9dfab7fdbf25779cc (patch)
treeb3e631e5f29f1bf6cb38a46e6c3ce340a4dbcd96 /Doc/library
parenteec0d5f8fdba2cc577402b9da5207842eb30b491 (diff)
downloadcpython-2932d9376e4d89f401ad25f9dfab7fdbf25779cc.zip
cpython-2932d9376e4d89f401ad25f9dfab7fdbf25779cc.tar.gz
cpython-2932d9376e4d89f401ad25f9dfab7fdbf25779cc.tar.bz2
#3007: remove stringio docs and fix a few nits in io docs.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/io.rst23
-rw-r--r--Doc/library/stringio.rst117
-rw-r--r--Doc/library/strings.rst1
3 files changed, 20 insertions, 121 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index d80d265..543bb37 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -630,9 +630,9 @@ Text I/O
.. class:: StringIO([initial_value[, encoding[, errors[, newline]]]])
- An in-memory stream for text. It in inherits :class:`TextIOWrapper`.
+ An in-memory stream for text. It inherits :class:`TextIOWrapper`.
- Create a new StringIO stream with an inital value, encoding, error handling,
+ Create a new StringIO stream with an initial value, encoding, error handling,
and newline setting. See :class:`TextIOWrapper`\'s constructor for more
information.
@@ -641,8 +641,25 @@ Text I/O
.. method:: getvalue()
- Return a ``str`` containing the entire contents of the buffer.
+ Return a ``str`` containing the entire contents of the buffer at any
+ time before the :class:`StringIO` object's :meth:`close` method is
+ called.
+ Example usage::
+
+ import io
+
+ output = io.StringIO()
+ output.write('First line.\n')
+ print('Second line.', file=output)
+
+ # Retrieve file contents -- this will be
+ # 'First line.\nSecond line.\n'
+ contents = output.getvalue()
+
+ # Close object and discard memory buffer --
+ # .getvalue() will now raise an exception.
+ output.close()
.. class:: IncrementalNewlineDecoder
diff --git a/Doc/library/stringio.rst b/Doc/library/stringio.rst
deleted file mode 100644
index 15edfba..0000000
--- a/Doc/library/stringio.rst
+++ /dev/null
@@ -1,117 +0,0 @@
-.. XXX this whole file is outdated
-
-:mod:`StringIO` --- Read and write strings as files
-===================================================
-
-.. module:: StringIO
- :synopsis: Read and write strings as if they were files.
-
-
-This module implements a file-like class, :class:`StringIO`, that reads and
-writes a string buffer (also known as *memory files*). See the description of
-file objects for operations (section :ref:`bltin-file-objects`). (For
-standard strings, see :class:`str`.)
-
-
-.. class:: StringIO([buffer])
-
- When a :class:`StringIO` object is created, it can be initialized to an existing
- string by passing the string to the constructor. If no string is given, the
- :class:`StringIO` will start empty. In both cases, the initial file position
- starts at zero.
-
-The following methods of :class:`StringIO` objects require special mention:
-
-
-.. method:: StringIO.getvalue()
-
- Retrieve the entire contents of the "file" at any time before the
- :class:`StringIO` object's :meth:`close` method is called.
-
-
-.. method:: StringIO.close()
-
- Free the memory buffer.
-
-Example usage::
-
- import StringIO
-
- output = StringIO.StringIO()
- output.write('First line.\n')
- print('Second line.', file=output)
-
- # Retrieve file contents -- this will be
- # 'First line.\nSecond line.\n'
- contents = output.getvalue()
-
- # Close object and discard memory buffer --
- # .getvalue() will now raise an exception.
- output.close()
-
-
-:mod:`cStringIO` --- Faster version of :mod:`StringIO`
-======================================================
-
-.. module:: cStringIO
- :synopsis: Faster version of StringIO, but not subclassable.
-.. moduleauthor:: Jim Fulton <jim@zope.com>
-.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
-
-
-The module :mod:`cStringIO` provides an interface similar to that of the
-:mod:`StringIO` module. Heavy use of :class:`StringIO.StringIO` objects can be
-made more efficient by using the function :func:`StringIO` from this module
-instead.
-
-Since this module provides a factory function which returns objects of built-in
-types, there's no way to build your own version using subclassing. Use the
-original :mod:`StringIO` module in that case.
-
-Unlike the memory files implemented by the :mod:`StringIO` module, those
-provided by this module are not able to accept strings that cannot be
-encoded in plain ASCII.
-
-Calling :func:`StringIO` with a string parameter populates
-the object with the buffer representation of the string, instead of
-encoding the string.
-
-Another difference from the :mod:`StringIO` module is that calling
-:func:`StringIO` with a string parameter creates a read-only object. Unlike an
-object created without a string parameter, it does not have write methods.
-These objects are not generally visible. They turn up in tracebacks as
-:class:`StringI` and :class:`StringO`.
-
-The following data objects are provided as well:
-
-
-.. data:: InputType
-
- The type object of the objects created by calling :func:`StringIO` with a string
- parameter.
-
-
-.. data:: OutputType
-
- The type object of the objects returned by calling :func:`StringIO` with no
- parameters.
-
-There is a C API to the module as well; refer to the module source for more
-information.
-
-Example usage::
-
- import cStringIO
-
- output = cStringIO.StringIO()
- output.write('First line.\n')
- print('Second line.', file=output)
-
- # Retrieve file contents -- this will be
- # 'First line.\nSecond line.\n'
- contents = output.getvalue()
-
- # Close object and discard memory buffer --
- # .getvalue() will now raise an exception.
- output.close()
-
diff --git a/Doc/library/strings.rst b/Doc/library/strings.rst
index 4c7f9eb..b5f8345 100644
--- a/Doc/library/strings.rst
+++ b/Doc/library/strings.rst
@@ -21,7 +21,6 @@ string functions based on regular expressions.
re.rst
struct.rst
difflib.rst
- stringio.rst
textwrap.rst
codecs.rst
unicodedata.rst