Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
cpython
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kirill Smelkov
cpython
Commits
2932d937
Commit
2932d937
authored
May 30, 2008
by
Georg Brandl
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
#3007: remove stringio docs and fix a few nits in io docs.
parent
eec0d5f8
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
20 additions
and
121 deletions
+20
-121
Doc/library/io.rst
Doc/library/io.rst
+20
-3
Doc/library/stringio.rst
Doc/library/stringio.rst
+0
-117
Doc/library/strings.rst
Doc/library/strings.rst
+0
-1
No files found.
Doc/library/io.rst
View file @
2932d937
...
@@ -630,9 +630,9 @@ Text I/O
...
@@ -630,9 +630,9 @@ Text I/O
.. class:: StringIO([initial_value[, encoding[, errors[, newline]]]])
.. class:: StringIO([initial_value[, encoding[, errors[, newline]]]])
An in-memory stream for text. It in
in
herits :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 init
i
al value, encoding, error handling,
and newline setting. See :class:`TextIOWrapper`\'s constructor for more
and newline setting. See :class:`TextIOWrapper`\'s constructor for more
information.
information.
...
@@ -641,8 +641,25 @@ Text I/O
...
@@ -641,8 +641,25 @@ Text I/O
.. method:: getvalue()
.. 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
.. class:: IncrementalNewlineDecoder
...
...
Doc/library/stringio.rst
deleted
100644 → 0
View file @
eec0d5f8
.. 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()
Doc/library/strings.rst
View file @
2932d937
...
@@ -21,7 +21,6 @@ string functions based on regular expressions.
...
@@ -21,7 +21,6 @@ string functions based on regular expressions.
re.rst
re.rst
struct.rst
struct.rst
difflib.rst
difflib.rst
stringio.rst
textwrap.rst
textwrap.rst
codecs.rst
codecs.rst
unicodedata.rst
unicodedata.rst
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment