"""
Functions for capturing and redirecting IO streams with optional
tee-functionality.
The :class:`CaptureStdout` captures all text sent to stdout and optionally
prevents it from actually reaching stdout.
The :class:`TeeStringIO` does the same thing but for arbitrary streams. It is
how the former is implemented.
"""
import sys
import io
__all__ = [
'TeeStringIO',
'CaptureStdout',
'CaptureStream',
]
[docs]
class TeeStringIO(io.StringIO):
"""
An IO object that writes to itself and another IO stream.
Attributes:
redirect (io.IOBase | None): The other stream to write to.
Example:
>>> import ubelt as ub
>>> import io
>>> redirect = io.StringIO()
>>> self = ub.TeeStringIO(redirect)
>>> self.write('spam')
>>> assert self.getvalue() == 'spam'
>>> assert redirect.getvalue() == 'spam'
"""
def __init__(self, redirect=None):
"""
Args:
redirect (io.IOBase): The other stream to write to.
"""
self.redirect = redirect # type: io.IOBase
super().__init__()
# Logic taken from prompt_toolkit/output/vt100.py version 3.0.5 in
# flush I don't have a full understanding of what the buffer
# attribute is supposed to be capturing here, but this seems to
# allow us to embed in IPython while still capturing and Teeing
# stdout
if hasattr(redirect, 'buffer'):
self.buffer = redirect.buffer # Py3.
else:
self.buffer = redirect
# Note: mypy doesn't like this type
# buffer (io.BufferedIOBase | io.IOBase | None): the redirected buffer attribute
[docs]
def isatty(self): # nocover
"""
Returns true of the redirect is a terminal.
Note:
Needed for ``IPython.embed`` to work properly when this class is
used to override stdout / stderr.
SeeAlso:
:meth:`io.IOBase.isatty`
Returns:
bool
"""
return (self.redirect is not None and
hasattr(self.redirect, 'isatty') and self.redirect.isatty())
[docs]
def fileno(self):
"""
Returns underlying file descriptor of the redirected IOBase object
if one exists.
Returns:
int : the integer corresponding to the file descriptor
SeeAlso:
:meth:`io.IOBase.fileno`
Example:
>>> import ubelt as ub
>>> dpath = ub.Path.appdir('ubelt/tests/util_stream').ensuredir()
>>> fpath = dpath / 'fileno-test.txt'
>>> with open(fpath, 'w') as file:
>>> self = ub.TeeStringIO(file)
>>> descriptor = self.fileno()
>>> print(f'descriptor={descriptor}')
>>> assert isinstance(descriptor, int)
Example:
>>> # Test errors
>>> # Not sure the best way to test, this func is important for
>>> # capturing stdout when ipython embedding
>>> import io
>>> import pytest
>>> import ubelt as ub
>>> with pytest.raises(io.UnsupportedOperation):
>>> ub.TeeStringIO(redirect=io.StringIO()).fileno()
>>> with pytest.raises(io.UnsupportedOperation):
>>> ub.TeeStringIO(None).fileno()
"""
if self.redirect is not None:
return self.redirect.fileno()
else:
return super().fileno()
@property
def encoding(self):
"""
Gets the encoding of the `redirect` IO object
FIXME:
My complains that this violates the Liskov substitution principle
because the return type can be str or None, whereas the parent
class always returns a None. In the future we may raise an exception
instead of returning None.
SeeAlso:
:py:obj:`io.TextIOBase.encoding`
Example:
>>> import ubelt as ub
>>> redirect = io.StringIO()
>>> assert ub.TeeStringIO(redirect).encoding is None
>>> assert ub.TeeStringIO(None).encoding is None
>>> assert ub.TeeStringIO(sys.stdout).encoding is sys.stdout.encoding
>>> redirect = io.TextIOWrapper(io.StringIO())
>>> assert ub.TeeStringIO(redirect).encoding is redirect.encoding
"""
# mypy correctly complains if we include the return type, but we need
# to keep this buggy behavior for legacy reasons.
# Returns:
# None | str
if self.redirect is not None:
return self.redirect.encoding
else:
return super().encoding
@encoding.setter
def encoding(self, value):
# Adding a setter to make mypy happy
raise Exception('Cannot set encoding attribute')
[docs]
def write(self, msg):
"""
Write to this and the redirected stream
Args:
msg (str): the data to write
SeeAlso:
:meth:`io.TextIOBase.write`
Example:
>>> import ubelt as ub
>>> dpath = ub.Path.appdir('ubelt/tests/util_stream').ensuredir()
>>> fpath = dpath / 'write-test.txt'
>>> with open(fpath, 'w') as file:
>>> self = ub.TeeStringIO(file)
>>> n = self.write('hello world')
>>> assert n == 11
>>> assert self.getvalue() == 'hello world'
>>> assert fpath.read_text() == 'hello world'
"""
if self.redirect is not None:
self.redirect.write(msg)
return super().write(msg)
[docs]
def flush(self): # nocover
"""
Flush to this and the redirected stream
SeeAlso:
:meth:`io.IOBase.flush`
"""
if self.redirect is not None:
self.redirect.flush()
return super().flush()
[docs]
class CaptureStream(object):
"""
Generic class for capturing streaming output from stdout or stderr
"""
[docs]
class CaptureStdout(CaptureStream):
r"""
Context manager that captures stdout and stores it in an internal stream.
Depending on the value of ``suppress``, the user can control if stdout is
printed (i.e. if stdout is tee-ed or suppressed) while it is being captured.
SeeAlso:
:func:`contextlib.redirect_stdout` - similar, but does not have the
ability to print stdout while it is being captured.
Attributes:
text (str | None): internal storage for the most recent part
parts (List[str]): internal storage for all parts
cap_stdout (None | TeeStringIO): internal stream proxy
orig_stdout (io.TextIOBase):
internal pointer to the original stdout stream
Example:
>>> import ubelt as ub
>>> self = ub.CaptureStdout(suppress=True)
>>> print('dont capture the table flip (╯°□°）╯︵ ┻━┻')
>>> with self:
... text = 'capture the heart ♥'
... print(text)
>>> print('dont capture look of disapproval ಠ_ಠ')
>>> assert isinstance(self.text, str)
>>> assert self.text == text + '\n', 'failed capture text'
Example:
>>> import ubelt as ub
>>> self = ub.CaptureStdout(suppress=False)
>>> with self:
... print('I am captured and printed in stdout')
>>> assert self.text.strip() == 'I am captured and printed in stdout'
Example:
>>> import ubelt as ub
>>> self = ub.CaptureStdout(suppress=True, enabled=False)
>>> with self:
... print('dont capture')
>>> assert self.text is None
"""
def __init__(self, suppress=True, enabled=True):
"""
Args:
suppress (bool):
if True, stdout is not printed while captured.
Defaults to True.
enabled (bool):
does nothing if this is False. Defaults to True.
"""
self.text = None
self._pos = 0 # keep track of how much has been logged
self.parts = []
self.started = False
self.cap_stdout = None
self.enabled = enabled
self.suppress = suppress
self.orig_stdout = sys.stdout
if suppress:
redirect = None
else:
redirect = self.orig_stdout
self.cap_stdout = TeeStringIO(redirect)
[docs]
def log_part(self):
""" Log what has been captured so far """
self.cap_stdout.seek(self._pos)
text = self.cap_stdout.read()
self._pos = self.cap_stdout.tell()
self.parts.append(text)
self.text = text
[docs]
def start(self):
if self.enabled:
self.text = ''
self.started = True
sys.stdout = self.cap_stdout
[docs]
def stop(self):
"""
Example:
>>> import ubelt as ub
>>> ub.CaptureStdout(enabled=False).stop()
>>> ub.CaptureStdout(enabled=True).stop()
"""
if self.enabled:
self.started = False
sys.stdout = self.orig_stdout
def __enter__(self):
self.start()
return self
def __del__(self): # nocover
if self.started:
self.stop()
if self.cap_stdout is not None:
self.close()
[docs]
def close(self):
self.cap_stdout.close()
self.cap_stdout = None
def __exit__(self, ex_type, ex_value, ex_traceback):
"""
Args:
ex_type (Type[BaseException] | None):
ex_value (BaseException | None):
ex_traceback (TracebackType | None):
Returns:
bool | None
"""
if self.enabled:
try:
self.log_part()
finally:
self.stop()
if ex_traceback is not None:
return False # return a falsey value on error