themattrix/python-abduct

Capture stdout/stderr and optionally release when an exception occurs.

Abduct

Capture stdout/stderr and optionally release when an exception occurs.

from abduct import captured, out, err

with captured(out()) as stdout:
    ...

with captured(out(), err()) as (stdout, stderr):
    ...

@captured(out(), err())
...

Installation:

$ pip install abduct

When stdout or stderr is captured, the related sys.stdout or sys.stderr object is replaced with a StringIO object for the life of the context.

Examples

It's often useful to capture the output of a block of code. Abduct makes this easy:

with captured(out()) as stdout:
    print('hello!')

assert stdout.getvalue() == 'hello!'

Sometimes you may want to hide the output of some code unless something goes wrong. In this case, simply specify release_on_exception=True:

with captured(out(release_on_exception=True)):
    print('Really important message!')
    if blow_up:
        raise RuntimeError()

In this case, Really important message! will be printed on stdout if the exception is raised.

If you'd like to capture the output, but still write through to stdout or stderr, use the tee=True parameter:

with captured(err(tee=True)) as stderr:
    sys.stderr.write('Error!')

assert stderr.getvalue() == 'Error!'

In this case, Error! is captured and written to stderr at the same time.

Changelog

2.0.1

• Added tests for the decorator usage.

2.0.0

• Feature: "Create a write-through option for output."
• Backwards-incompatible change: stdout and stderr methods are now out and err respectively.

1.0.4

• Fixed Travis release criteria.

1.0.3

• Refactored test runner.

1.0.2

• Fixed README and description.

1.0.1

• Travis config now defers to tox.
• Added examples to README.

1.0.0

• Actual working code. Yay!

0.0.1

• Initial release.