IPython Documentation

Table Of Contents

Previous topic

Module: utils.encoding

Next topic

Module: utils.generics

This Page

Note

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

Module: utils.frame

Utilities for working with stack frames.

4 Functions

IPython.utils.frame.extract_vars(*names, **kw)

Extract a set of variables by name from another frame.

Parameters:

*names : str

One or more variable names which will be extracted from the caller’s frame.

depth : integer, optional

How many frames in the stack to walk when looking for your variables. The default is 0, which will use the frame where the call was made.

Examples

In [2]: def func(x):
   ...:     y = 1
   ...:     print(sorted(extract_vars('x','y').items()))
   ...:

In [3]: func('hello')
[('x', 'hello'), ('y', 1)]
IPython.utils.frame.extract_vars_above(*names)

Extract a set of variables by name from another frame.

Similar to extractVars(), but with a specified depth of 1, so that names are exctracted exactly from above the caller.

This is simply a convenience function so that the very common case (for us) of skipping exactly 1 frame doesn’t have to construct a special dict for keyword passing.

IPython.utils.frame.debugx(expr, pre_msg='')

Print the value of an expression from the caller’s frame.

Takes an expression, evaluates it in the caller’s frame and prints both the given expression and the resulting value (as well as a debug mark indicating the name of the calling function. The input must be of a form suitable for eval().

An optional message can be passed, which will be prepended to the printed expr->value pair.

IPython.utils.frame.extract_module_locals(depth=0)

Returns (module, locals) of the funciton depth frames away from the caller