Module: utils.capture

IO capturing utilities.

3 Classes

class IPython.utils.capture.RichOutput(data=None, metadata=None, transient=None, update=False)

Bases: object

__init__(data=None, metadata=None, transient=None, update=False)
class IPython.utils.capture.CapturedIO(stdout: StringIO | None, stderr: StringIO | None, outputs: List[Any] | None = None)

Bases: object

Simple object for containing captured stdout/err and rich display StringIO objects

Each instance c has three attributes:

  • c.stdout : standard output as a string

  • c.stderr : standard error as a string

  • c.outputs: a list of rich display outputs

Additionally, there’s a c.show() method which will print all of the above in the same order, and can be invoked simply via c().

__init__(stdout: StringIO | None, stderr: StringIO | None, outputs: List[Any] | None = None)
property outputs

A list of the captured rich display outputs, if any.

If you have a CapturedIO object c, these can be displayed in IPython using:

from IPython.display import display
for o in c.outputs:
    display(o)
show()

write my output to sys.stdout/err as appropriate

property stderr: str

Captured standard error

property stdout: str

Captured standard output

class IPython.utils.capture.capture_output(stdout: bool = True, stderr: bool = True, display: bool = True)

Bases: object

context manager for capturing stdout/err

__init__(stdout: bool = True, stderr: bool = True, display: bool = True)