openalea.vpltk.shell package

Submodules

openalea.vpltk.shell.ipythoninterpreter module

class openalea.vpltk.shell.ipythoninterpreter.Interpreter(gui='qt4', locals=None)

Bases: IPython.kernel.inprocess.ipkernel.InProcessKernel

Interpreter is an IPython kernel adapted for OpenAlea.

Parameters:

• gui – GUI to use. Default ‘qt4’.
• locals – namespace to set to the interpreter. Default ‘None’.

openalea.vpltk.shell.ipythoninterpreter.main()

openalea.vpltk.shell.ipythonshell module

class openalea.vpltk.shell.ipythonshell.ShellWidget(interpreter, message='', log='', parent=None)

Bases: IPython.qt.console.rich_ipython_widget.RichIPythonWidget, openalea.vpltk.shell.streamredirection.GraphicalStreamRedirection

ShellWidget is an IPython shell.

get_interpreter()

Returns:the interpreter object

loadcode(source=None, namespace=None)

Load ‘source’ and use ‘namespace’ if it is in parameter. Else use locals.

Parameters:

• source – text (string) to load
• namespace – dict to use to execute the source

push(var)

Push variables in the namespace. :param var: dict of objects

runcode(source=None, hidden=False, interactive=False)

TODO

runsource(source=None, filename='<input>', symbol='single', hidden=False, interactive=False)

TODO

write(txt)

Write a text in the stdout of the shell and flush it. :param txt: String to write.

openalea.vpltk.shell.ipythonshell.main()

openalea.vpltk.shell.scishell module

This module implements a QT4 python interpreter widget.

class openalea.vpltk.shell.scishell.SciShell(interpreter, message='', log='', parent=None)

Bases: PyQt4.Qsci.QsciScintilla, openalea.vpltk.shell.streamredirection.GraphicalStreamRedirection

SciShell is a Python shell based in QScintilla. It is inspired by PyCute (pycute.py) : http://gerard.vermeulen.free.fr (GPL) and Eric4 shell (shell.py) : http://www.die-offenbachs.de/eric/index.html (GPL)

clear()

Clear shell

contextMenuEvent(e)

customEvent(event)

dragEnterEvent(event)

dragMoveEvent(event)

dropEvent(event)

flush()

Simulate stdin, stdout, and stderr.

focusNextPrevChild(next)

Reimplemented to stop Tab moving to the next window.

While the user is entering a multi-line command, the movement to the next window by the Tab key being pressed is suppressed.

@param next next window @return flag indicating the movement

get_interpreter()

Return the interpreter object

isatty()

Simulate stdin, stdout, and stderr.

keyPressEvent(ev)

Re-implemented to handle the user input a key at a time.

@param ev key event (QKeyEvent)

mousePressEvent(event)

Protected method to handle the mouse press event.

@param event the mouse press event (QMouseEvent)

paste()

Reimplemented slot to handle the paste action.

readline()

Simulate stdin, stdout, and stderr.

write(s)

Simulate stdin, stdout, and stderr.

openalea.vpltk.shell.shell module

This module implements a QT4 python interpreter widget.

class openalea.vpltk.shell.shell.PyCutExt(interpreter, message='', log='', parent=None)

Bases: PyQt4.QtGui.QTextEdit, openalea.vpltk.shell.streamredirection.GraphicalStreamRedirection

PyCute is a Python shell for PyQt.

Creating, displaying and controlling PyQt widgets from the Python command line interpreter is very hard, if not, impossible. PyCute solves this problem by interfacing the Python interpreter to a PyQt widget.

This class is inspired by PyCute.py : http://gerard.vermeulen.free.fr (GPL)

clear()

Clear

color_line()

Color the current line

contentsContextMenuEvent(ev)

Suppress the right button context menu.

customEvent(event)

dragEnterEvent(event)

dragMoveEvent(event)

dropEvent(event)

fakeUser(lines)

Simulate a user: lines is a sequence of strings, (Python statements).

flush()

Simulate stdin, stdout, and stderr.

get_interpreter()

Return the interpreter object

isatty()

Simulate stdin, stdout, and stderr.

keyPressEvent(e)

Handle user input a key at a time.

mousePressEvent(e)

Keep the cursor after the last prompt.

moveCursor(operation, mode=0)

Convenience function to move the cursor This function will be present in PyQT4.2

readline()

Simulate stdin, stdout, and stderr.

write(text)

Simulate stdin, stdout, and stderr.

writelines(text)

Simulate stdin, stdout, and stderr.

class openalea.vpltk.shell.shell.SyntaxColor

Allow to color python keywords

get_color(word)

Return a color tuple (R,G,B) depending of the string word

is_python_string(str)

Return True if str is enclosed by a string mark

keywords = set(['and', 'elif', 'is', 'global', 'as', 'in', 'if', 'from', 'raise', 'for', 'except', 'finally', 'print', 'import', 'pass', 'return', 'exec', 'else', 'break', 'not', 'with', 'class', 'assert', 'yield', 'try', 'while', 'continue', 'del', 'or', 'def', 'lambda'])

openalea.vpltk.shell.shell.get_interpreter_class()

Returns:the interpreter class to instantiate the shell

openalea.vpltk.shell.shell.get_shell_class()

Returns:the shell class to instantiate

openalea.vpltk.shell.shell.main()

openalea.vpltk.shell.streamredirection module

class openalea.vpltk.shell.streamredirection.GraphicalStreamRedirection

Bases: object

Redirection of a stream as graphic output

customEvent(event)

custom event processing. Redirection to write

flush()

hasMultipleStdErrRedirection()

hasMultipleStdOutRedirection()

isNoneAsStdErrRedirection()

isNoneAsStdOutRedirection()

isSelfStdErrRedirection()

isSelfStdOutRedirection()

isSysStdErrRedirection()

isSysStdOutRedirection()

multipleStdErrRedirection(enabled=True)

make multiple (sys.stderr/pyconsole) or single (pyconsole) redirection of stderr

multipleStdOutRedirection(enabled=True)

make multiple (sys.stdout/pyconsole) or single (pyconsole) redirection of stdout

noneAsStdErrRedirection()

noneAsStdOutRedirection()

selfAsStdErrRedirection()

selfAsStdOutRedirection()

setOutputRedirection(selfoutput=True, sysoutput=True, outanderr=3)

sysAsStdErrRedirection()

sysAsStdOutRedirection()

class openalea.vpltk.shell.streamredirection.MultipleRedirection(*streams)

Bases: object

Dummy file which redirects stream to multiple file

flush()

write(str)

Emulate write function

class openalea.vpltk.shell.streamredirection.NoneOutput

Bases: object

Dummy file which redirects stream to nothing

write(str)

Emulate write function

class openalea.vpltk.shell.streamredirection.ThreadedRedirection(guistream)

Bases: object

Dummy file which redirects stream to threaded gui output

flush()

write(str)

Emulate write function

Module contents