Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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

Project Description

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.
Release History

Release History

This version
History Node

2.0.1

History Node

2.0.0

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
abduct-2.0.1-py2.py3-none-any.whl (3.4 kB) Copy SHA256 Checksum SHA256 2.7 Wheel May 16, 2015
abduct-2.0.1.tar.gz (2.9 kB) Copy SHA256 Checksum SHA256 Source May 16, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting