IPython Documentation

Table Of Contents

Previous topic

Module: utils.importstring

Next topic

Module: utils.ipstruct

This Page


This documentation is for an old version of IPython. You can find docs for newer versions here.

Module: utils.io

IO related utilities.

5 Classes

class IPython.utils.io.IOStream(stream, fallback=None)
__init__(stream, fallback=None)
class IPython.utils.io.IOTerm(stdin=None, stdout=None, stderr=None)

Term holds the file or file-like objects for handling I/O operations.

These are normally just sys.stdin, sys.stdout and sys.stderr but for Windows they can can replaced to allow editing the strings before they are displayed.

__init__(stdin=None, stdout=None, stderr=None)
class IPython.utils.io.Tee(file_or_name, mode='w', channel='stdout')

Bases: object

A class to duplicate an output stream to stdout/err.

This works in a manner very similar to the Unix ‘tee’ command.

When the object is closed or deleted, it closes the original file given to it for duplication.

__init__(file_or_name, mode='w', channel='stdout')

Construct a new Tee object.


file_or_name : filename or open filehandle (writable)

File that will be duplicated

mode : optional, valid mode for open().

If a filename was give, open with this mode.

channel : str, one of [‘stdout’, ‘stderr’]


Close the file and restore the channel.


Flush both channels.


Write data to both channels.

class IPython.utils.io.CapturedIO(stdout, stderr)

Bases: object

Simple object for containing captured stdout/err StringIO objects

__init__(stdout, stderr)

write my output to sys.stdout/err as appropriate

class IPython.utils.io.capture_output(stdout=True, stderr=True)

Bases: object

context manager for capturing stdout/err

__init__(stdout=True, stderr=True)

5 Functions

IPython.utils.io.ask_yes_no(prompt, default=None)

Asks a question and returns a boolean (y/n) answer.

If default is given (one of ‘y’,’n’), it is used if the user input is empty. Otherwise the question is repeated until an answer is given.

An EOF is treated as the default answer. If there is no default, an exception is raised to prevent infinite loops.

Valid answers are: y/yes/n/no (match is not case sensitive).

IPython.utils.io.temp_pyfile(src, ext='.py')

Make a temporary python file, return filename and filehandle.


src : string or list of strings (no need for ending newlines if list)

Source code to be written to the file.

ext : optional, string

Extension for the generated file.


(filename, open filehandle) :

It is the caller’s responsibility to close the open file and unlink it.

IPython.utils.io.raw_print(*args, **kw)

Raw print to sys.__stdout__, otherwise identical interface to print().

IPython.utils.io.raw_print_err(*args, **kw)

Raw print to sys.__stderr__, otherwise identical interface to print().


Get a wrapper to write unicode to stdout/stderr as UTF-8.

This ignores environment variables and default encodings, to reliably write unicode to stdout or stderr.