IPython Documentation

Table Of Contents

Previous topic

Module: utils.tempdir

Next topic

Module: utils.text

This Page

Note

This documentation is for a development version of IPython. There may be significant differences from the latest stable release.

Module: utils.terminal

Utilities for working with terminals.

Authors:

  • Brian E. Granger
  • Fernando Perez
  • Alexander Belchenko (e-mail: bialix AT ukr.net)

5 Functions

IPython.utils.terminal.term_clear()
IPython.utils.terminal.toggle_set_term_title(val)

Control whether set_term_title is active or not.

set_term_title() allows writing to the console titlebar. In embedded widgets this can cause problems, so this call can be used to toggle it on or off as needed.

The default state of the module is for the function to be disabled.

Parameters:

val : bool

If True, set_term_title() actually writes to the terminal (using the appropriate platform-specific module). If False, it is a no-op.

IPython.utils.terminal.set_term_title(title)

Set terminal title using the necessary platform-dependent calls.

IPython.utils.terminal.freeze_term_title()
IPython.utils.terminal.get_terminal_size(defaultx=80, defaulty=25)