mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-31 05:58:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Added docstrings excerpted from Python Library Reference.

Browse source 
Closes patch 556161.
This commit is contained in:
Raymond Hettinger 2002-05-15 02:56:03 +00:00
parent 55956c9361
commit d1fa3db52d
4 changed files with 121 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

23
Lib/StringIO.py
View file

@ -37,6 +37,17 @@ except ImportError:
__all__ = ["StringIO"]
class StringIO:
"""class StringIO([buffer])
When a 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 StringIO will start empty.
The StringIO object can accept either Unicode or 8-bit strings, but
mixing the two may take some care. If both are used, 8-bit strings that
cannot be interpreted as 7-bit ASCII (that use the 8th bit) will cause
a UnicodeError to be raised when getvalue() is called.
"""
def __init__(self, buf = ''):
# Force self.buf to be a string or unicode
if not isinstance(buf, types.StringTypes):
@ -52,6 +63,8 @@ class StringIO:
return iter(self.readline, '')
def close(self):
"""Free the memory buffer.
"""
if not self.closed:
self.closed = 1
del self.buf, self.pos
@ -165,6 +178,16 @@ class StringIO:
raise ValueError, "I/O operation on closed file"
def getvalue(self):
"""
Retrieve the entire contents of the "file" at any time before
the StringIO object's close() method is called.
The StringIO object can accept either Unicode or 8-bit strings,
but mixing the two may take some care. If both are used, 8-bit
strings that cannot be interpreted as 7-bit ASCII (that use the
8th bit) will cause a UnicodeError to be raised when getvalue()
is called.
"""
if self.buflist:
self.buf += ''.join(self.buflist)
self.buflist = []