capturer: Easily capture stdout/stderr of the current process and subprocesses

Welcome to the documentation of capturer version 3.0! The following sections are available:

User documentation

The readme is the best place to start reading:

• capturer: Easily capture stdout/stderr of the current process and subprocesses
  • Status
  • Installation
  • Getting started
  • Design choices
    • Intercepts writes to low level file descriptors
    • Uses a pseudo terminal to emulate a real terminal
    • Relays output to the terminal in real time
  • Contact
  • License

API documentation

The following API documentation is automatically generated from the source code:

• API documentation
  • capturer
    • interpret_carriage_returns
    • DEFAULT_TEXT_ENCODING
    • GRACEFUL_SHUTDOWN_SIGNAL
    • TERMINATION_DELAY
    • PARTIAL_DEFAULT
    • STDOUT_FD
    • STDERR_FD
    • enable_old_api()
    • create_proxy_method()
    • MultiProcessHelper
      • MultiProcessHelper.__init__()
      • MultiProcessHelper.start_child()
      • MultiProcessHelper.stop_children()
      • MultiProcessHelper.wait_for_children()
      • MultiProcessHelper.enable_graceful_shutdown()
      • MultiProcessHelper.raise_shutdown_request()
    • CaptureOutput
      • CaptureOutput.__init__()
      • CaptureOutput.initialize_stream()
      • CaptureOutput.__enter__()
      • CaptureOutput.__exit__()
      • CaptureOutput.is_capturing
      • CaptureOutput.start_capture()
      • CaptureOutput.finish_capture()
      • CaptureOutput.allocate_pty()
      • CaptureOutput.merge_loop()
      • CaptureOutput.get_bytes()
      • CaptureOutput.get_handle()
      • CaptureOutput.get_lines()
      • CaptureOutput.get_text()
      • CaptureOutput.save_to_handle()
      • CaptureOutput.save_to_path()
    • OutputBuffer
      • OutputBuffer.__init__()
      • OutputBuffer.add()
      • OutputBuffer.flush()
    • PseudoTerminal
      • PseudoTerminal.__init__()
      • PseudoTerminal.attach()
      • PseudoTerminal.start_capture()
      • PseudoTerminal.finish_capture()
      • PseudoTerminal.close_pseudo_terminal()
      • PseudoTerminal.restore_streams()
      • PseudoTerminal.get_handle()
      • PseudoTerminal.get_bytes()
      • PseudoTerminal.get_lines()
      • PseudoTerminal.get_text()
      • PseudoTerminal.save_to_handle()
      • PseudoTerminal.save_to_path()
      • PseudoTerminal.capture_loop()
    • Stream
      • Stream.is_redirected
      • Stream.__init__()
      • Stream.redirect()
      • Stream.restore()
    • ShutdownRequested

Change log

The change log lists notable changes to the project:

• Changelog
  • Release 3.0 (2020-03-07)
  • Release 2.4 (2017-05-17)
  • Release 2.3 (2016-11-12)
  • Release 2.2 (2016-10-09)
  • Release 2.1.1 (2015-10-24)
  • Release 2.1 (2015-06-21)
  • Release 2.0 (2015-06-18)
  • Release 1.1 (2015-06-16)
  • Release 1.0 (2015-06-14)