From 60fa0bf4bdae94275cb186b3266dbfed6007f271 Mon Sep 17 00:00:00 2001 From: Benjamin Peterson Date: Tue, 29 Jun 2010 15:26:43 +0000 Subject: [PATCH] Merged revisions 82368 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r82368 | benjamin.peterson | 2010-06-29 10:18:02 -0500 (Tue, 29 Jun 2010) | 1 line group cStringIO docs under its factory function ........ --- Doc/library/stringio.rst | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/Doc/library/stringio.rst b/Doc/library/stringio.rst index 30a5bac7d4c..0177da48f52 100644 --- a/Doc/library/stringio.rst +++ b/Doc/library/stringio.rst @@ -71,24 +71,29 @@ The module :mod:`cStringIO` provides an interface similar to that of the 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. It's not -possible to set attributes on it. Use the original :mod:`StringIO` module in -those cases. -Unlike the memory files implemented by the :mod:`StringIO` module, those -provided by this module are not able to accept Unicode strings that cannot be -encoded as plain ASCII strings. +.. function:: StringIO([s]) + + Return a StringIO-like stream for reading or writing. + + Since this is a factory function which returns objects of built-in types, + there's no way to build your own version using subclassing. It's not + possible to set attributes on it. Use the original :mod:`StringIO` module in + those cases. + + Unlike the :mod:`StringIO` module, this module is not able to accept Unicode + strings that cannot be encoded as plain ASCII strings. Calling + :func:`StringIO` with a Unicode string parameter populates the object with + the buffer representation of the Unicode 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`. -Calling :func:`StringIO` with a Unicode string parameter populates -the object with the buffer representation of the Unicode 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: