Mercurial > cpython-lru_cache-weakref
diff Lib/StringIO.py @ 23455:68c776ba5ea5 legacy-trunk
Added docstrings excerpted from Python Library Reference.
Closes patch 556161.
| author | Raymond Hettinger <python@rcn.com> |
|---|---|
| date | Wed, 15 May 2002 02:56:03 +0000 |
| parents | 56240bcda88c |
| children | a90faa5f9417 |
line wrap: on
line diff
--- a/Lib/StringIO.py Tue May 14 23:45:14 2002 +0000 +++ b/Lib/StringIO.py Wed May 15 02:56:03 2002 +0000 @@ -37,6 +37,17 @@ __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 @@ 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 @@ 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 = []
