Warning
This documentation covers a development version of IPython. The development version may differ significantly from the latest stable release.
Important
This documentation covers IPython versions 6.0 and higher. Beginning with version 6.0, IPython stopped supporting compatibility with Python versions lower than 3.3 including all versions of Python 2.7.
If you are looking for an IPython version compatible with Python 2.7, please use the IPython 5.x LTS release and refer to its documentation (LTS is the long term support release).
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)¶ Initialize self. See help(type(self)) for accurate signature.
-
-
class
IPython.utils.capture.
CapturedIO
(stdout, stderr, outputs=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 stringc.stderr
: standard error as a stringc.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 viac()
.-
__init__
(stdout, stderr, outputs=None)¶ Initialize self. See help(type(self)) for accurate signature.
-
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
-
stderr
¶ Captured standard error
-
stdout
¶ Captured standard output