initial import
[vuplus_webkit] / Tools / Scripts / webkitpy / common / array_stream.py
1 #!/usr/bin/python
2 # Copyright (C) 2010 Google Inc. All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions are
6 # met:
7 #
8 #     * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 #     * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following disclaimer
12 # in the documentation and/or other materials provided with the
13 # distribution.
14 #     * Neither the name of Google Inc. nor the names of its
15 # contributors may be used to endorse or promote products derived from
16 # this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 """Package that private an array-based implementation of a stream."""
31
32
33 class ArrayStream(object):
34     """Simple class that implmements a stream interface on top of an array.
35
36     This is used primarily by unit test classes to mock output streams. It
37     performs a similar function to StringIO, but (a) it is write-only, and
38     (b) it can be used to retrieve each individual write(); StringIO 
39     concatenates all of the writes together.
40     """
41
42     def __init__(self, tty=False):
43         self._contents = []
44         self._tty = tty
45
46     def write(self, msg):
47         """Implement stream.write() by appending to the stream's contents."""
48         self._contents.append(msg)
49
50     def get(self):
51         """Return the contents of a stream (as an array)."""
52         return self._contents
53
54     def reset(self):
55         """Empty the stream."""
56         self._contents = []
57
58     def empty(self):
59         """Return whether the stream is empty."""
60         return (len(self._contents) == 0)
61
62     def flush(self):
63         """Flush the stream (a no-op implemented for compatibility)."""
64         pass
65
66     def __repr__(self):
67         return '<ArrayStream: ' + str(self._contents) + '>'
68
69     def isatty(self):
70         return self._tty