Note

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

Module: utils.tokenutil

Token-related utilities

3 Functions

IPython.utils.tokenutil.generate_tokens(readline)

wrap generate_tokens to catch EOF errors

IPython.utils.tokenutil.line_at_cursor(cell, cursor_pos=0)

Return the line in a cell at a given cursor position

Used for calling line-based APIs that don’t support multi-line input, yet.

Parameters:

cell: text :

multiline block of text

cursor_pos: integer :

the cursor position

Returns:

(line, offset): (text, integer) :

The line with the current cursor, and the character offset of the start of the line.

IPython.utils.tokenutil.token_at_cursor(cell, cursor_pos=0)

Get the token at a given cursor

Used for introspection.

Parameters:

cell : unicode

A block of Python code

cursor_pos : int

The location of the cursor in the block where the token should be found