ConsoleView class. More...

Inheritance diagram for visualizer.ipython_view.ConsoleView:

Collaboration diagram for visualizer.ipython_view.ConsoleView:

Public Member Functions
def	__init__ (self)

def	changeLine (self, text)
	Replace currently entered command line with given text.

def	getCurrentLine (self)
	Get text in current command line.

def	onKeyPress (self, widget, event)
	Key press callback used for correcting behavior for console-like interfaces.

def	onKeyPressExtend (self, event)
	For some reason we can't extend onKeyPress directly (bug #500900).

def	showPrompt (self, prompt)
	Prints prompt at start of line.

def	showReturned (self, text)
	Show returned text from last command and print new prompt.

def	write (self, text, editable=False)
	Write given text to buffer.

Public Attributes
	color_pat
	color pattern

	line_start
	line start

	mark
	scroll mark

	text_buffer
	text buffer

Static Public Attributes
dict	ANSI_COLORS
	color list

Protected Member Functions
def	_changeLine (self, text)
	Replace currently entered command line with given text.

def	_showPrompt (self, prompt)
	Prints prompt at start of line.

def	_showReturned (self, text)
	Show returned text from last command and print new prompt.

def	_write (self, text, editable=False)
	Write given text to buffer.

Detailed Description

ConsoleView class.

Definition at line 348 of file ipython_view.py.

Constructor & Destructor Documentation

◆ init()

def visualizer.ipython_view.ConsoleView.__init__ ( self )

Initialize console view.

Reimplemented in visualizer.ipython_view.IPythonView.

Definition at line 414 of file ipython_view.py.

Member Function Documentation

◆ _changeLine()

visualizer.ipython_view.ConsoleView._changeLine	(	self,
		text
	)

protected

Replace currently entered command line with given text.

_changeLine function

Parameters

text	Text to use as replacement.

Returns: none

Definition at line 508 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._write(), delete, visualizer.ipython_view.ConsoleView.line_start, and visualizer.ipython_view.ConsoleView.text_buffer.

Referenced by visualizer.ipython_view.ConsoleView.changeLine().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _showPrompt()

visualizer.ipython_view.ConsoleView._showPrompt	(	self,
		prompt
	)

protected

Prints prompt at start of line.

_showPrompt function

Parameters

prompt Prompt to print.

Returns: none

Definition at line 489 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._write(), visualizer.ipython_view.ConsoleView.line_start, and visualizer.ipython_view.ConsoleView.text_buffer.

Referenced by visualizer.ipython_view.ConsoleView._showReturned(), and visualizer.ipython_view.ConsoleView.showPrompt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _showReturned()

visualizer.ipython_view.ConsoleView._showReturned	(	self,
		text
	)

protected

Show returned text from last command and print new prompt.

_showReturned function

Parameters

text	Text to show.

Returns: none

Definition at line 542 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._showPrompt(), visualizer.ipython_view.ConsoleView._write(), visualizer.ipython_view.IterableIPShell.indent_spaces, visualizer.ipython_view.IterableIPShell.IP, visualizer.ipython_view.ConsoleView.line_start, visualizer.ipython_view.IterableIPShell.no_input_splitter, visualizer.ipython_view.IterableIPShell.prompt, visualizer.ipython_view.IPythonView.prompt, and visualizer.ipython_view.ConsoleView.text_buffer.

Referenced by visualizer.ipython_view.ConsoleView.showReturned().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _write()

visualizer.ipython_view.ConsoleView._write	(	self,
		text,
		editable = `False`
	)

protected

Write given text to buffer.

_write function

Parameters

text	Text to append.
editable	If true, added text is editable.

Returns: none

Definition at line 450 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView.color_pat, visualizer.ipython_view.ConsoleView.mark, and visualizer.ipython_view.ConsoleView.text_buffer.

Referenced by visualizer.ipython_view.ConsoleView._changeLine(), visualizer.ipython_view.ConsoleView._showPrompt(), visualizer.ipython_view.ConsoleView._showReturned(), and visualizer.ipython_view.ConsoleView.write().

Here is the caller graph for this function:

◆ changeLine()

def visualizer.ipython_view.ConsoleView.changeLine	(	self,
		text
	)

Replace currently entered command line with given text.

Parameters

text	Text to use as replacement.

Returns: none

Definition at line 499 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._changeLine().

Referenced by visualizer.ipython_view.IPythonView.onKeyPressExtend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentLine()

def visualizer.ipython_view.ConsoleView.getCurrentLine ( self )

Get text in current command line.

Returns: Text of current command line.

Definition at line 520 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView.line_start, and visualizer.ipython_view.ConsoleView.text_buffer.

Referenced by visualizer.ipython_view.IPythonView.onKeyPressExtend(), and visualizer.ipython_view.IPythonView.raw_input().

Here is the caller graph for this function:

◆ onKeyPress()

visualizer.ipython_view.ConsoleView.onKeyPress	(	self,
		widget,
		event
	)

Key press callback used for correcting behavior for console-like interfaces.

onKeyPress function

For example 'home' should go to prompt, not to beginning of line.

Parameters

widget	Widget that key press accored in.
event	Event object

Returns: Return True if event should not trickle.

Definition at line 568 of file ipython_view.py.

References delete, visualizer.ipython_view.ConsoleView.line_start, visualizer.ipython_view.ConsoleView.onKeyPressExtend(), visualizer.ipython_view.IPythonView.onKeyPressExtend(), visualizer.ipython_view.IterableIPShell.prompt, visualizer.ipython_view.IPythonView.prompt, and visualizer.ipython_view.ConsoleView.text_buffer.

Here is the call graph for this function:

◆ onKeyPressExtend()

def visualizer.ipython_view.ConsoleView.onKeyPressExtend	(	self,
		event
	)

For some reason we can't extend onKeyPress directly (bug #500900).

Parameters

event key press

Returns: none

Reimplemented in visualizer.ipython_view.IPythonView.

Definition at line 634 of file ipython_view.py.

Referenced by visualizer.ipython_view.ConsoleView.onKeyPress().

Here is the caller graph for this function:

◆ showPrompt()

def visualizer.ipython_view.ConsoleView.showPrompt	(	self,
		prompt
	)

Prints prompt at start of line.

Parameters

prompt Prompt to print.

Returns: none

Definition at line 480 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._showPrompt().

Referenced by visualizer.ipython_view.IPythonView.onKeyPressExtend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showReturned()

def visualizer.ipython_view.ConsoleView.showReturned	(	self,
		text
	)

Show returned text from last command and print new prompt.

Parameters

text	Text to show.

Returns: none

Definition at line 533 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._showReturned().

Here is the call graph for this function:

◆ write()

def visualizer.ipython_view.ConsoleView.write	(	self,
		text,
		editable = `False`
	)

Write given text to buffer.

Parameters

text	Text to append.
editable	If true, added text is editable.

Returns: none

Definition at line 440 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._write().

Referenced by visualizer.ipython_view.IPythonView.onKeyPressExtend().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ ANSI_COLORS

visualizer.ipython_view.ConsoleView.ANSI_COLORS

static

Initial value:

=  {
        "0;30": ("Black", None),
        "0;31": ("Red", None),
        "0;32": ("Green", None),
        "0;33": ("Brown", None),
        "0;34": ("Blue", None),
        "0;35": ("Purple", None),
        "0;36": ("Cyan", None),
        "0;37": ("LightGray", None),
        "1;30": ("DarkGray", None),
        "1;31": ("DarkRed", None),
        "1;32": ("SeaGreen", None),
        "1;33": ("Yellow", None),
        "1;34": ("LightBlue", None),
        "1;35": ("MediumPurple", None),
        "1;36": ("LightCyan", None),
        "1;37": ("White", None),
        "38;5;124;43": ("DarkRed", "Yellow"),
        "38;5;241": ("Gray", None),
        "38;5;241;43": ("Gray", "Yellow"),
        "39": ("Black", None),
        "39;49": ("Red", "White"),
        "43": (None, "Yellow"),
        "49": (None, "White"),
    }

color list

Definition at line 388 of file ipython_view.py.

◆ color_pat

visualizer.ipython_view.ConsoleView.color_pat

color pattern

Definition at line 434 of file ipython_view.py.

Referenced by visualizer.ipython_view.ConsoleView._write().

◆ line_start

visualizer.ipython_view.ConsoleView.line_start

line start

Definition at line 435 of file ipython_view.py.

Referenced by visualizer.ipython_view.ConsoleView._changeLine(), visualizer.ipython_view.ConsoleView._showPrompt(), visualizer.ipython_view.ConsoleView._showReturned(), visualizer.ipython_view.ConsoleView.getCurrentLine(), and visualizer.ipython_view.ConsoleView.onKeyPress().

◆ mark

visualizer.ipython_view.ConsoleView.mark

scroll mark

Definition at line 422 of file ipython_view.py.

Referenced by visualizer.ipython_view.ConsoleView._write().

◆ text_buffer

visualizer.ipython_view.ConsoleView.text_buffer

text buffer

Definition at line 421 of file ipython_view.py.

Referenced by visualizer.ipython_view.ConsoleView._changeLine(), visualizer.ipython_view.ConsoleView._showPrompt(), visualizer.ipython_view.ConsoleView._showReturned(), visualizer.ipython_view.ConsoleView._write(), visualizer.ipython_view.ConsoleView.getCurrentLine(), and visualizer.ipython_view.ConsoleView.onKeyPress().

The documentation for this class was generated from the following file:

src/visualizer/visualizer/ipython_view.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _changeLine()

◆ _showPrompt()

◆ _showReturned()

◆ _write()

◆ changeLine()

◆ getCurrentLine()

◆ onKeyPress()

◆ onKeyPressExtend()

◆ showPrompt()

◆ showReturned()

◆ write()

Member Data Documentation

◆ ANSI_COLORS

◆ color_pat

◆ line_start

◆ mark

◆ text_buffer

◆ init()