hooks.py
267 lines
| 8.6 KiB
| text/x-python
|
PythonLexer
Ville M. Vainio
|
r1032 | """hooks for IPython. | ||
In Python, it is possible to overwrite any method of any object if you really | ||||
want to. But IPython exposes a few 'hooks', methods which are _designed_ to | ||||
be overwritten by users for customization purposes. This module defines the | ||||
default versions of all such hooks, which get used by IPython if not | ||||
overridden by the user. | ||||
hooks are simple functions, but they should be declared with 'self' as their | ||||
first argument, because when activated they are registered into IPython as | ||||
instance methods. The self argument will be the IPython running instance | ||||
itself, so hooks have full access to the entire IPython object. | ||||
If you wish to define a new hook and activate it, you need to put the | ||||
necessary code into a python file which can be either imported or execfile()'d | ||||
from within your ipythonrc configuration. | ||||
For example, suppose that you have a module called 'myiphooks' in your | ||||
PYTHONPATH, which contains the following definition: | ||||
import os | ||||
Brian Granger
|
r2027 | from IPython.core import ipapi | ||
ip = ipapi.get() | ||||
Ville M. Vainio
|
r1032 | |||
def calljed(self,filename, linenum): | ||||
"My editor hook calls the jed editor directly." | ||||
print "Calling my own editor, jed ..." | ||||
Ville M. Vainio
|
r1744 | if os.system('jed +%d %s' % (linenum,filename)) != 0: | ||
Brian Granger
|
r2205 | raise TryNext() | ||
Ville M. Vainio
|
r1032 | |||
ip.set_hook('editor', calljed) | ||||
You can then enable the functionality by doing 'import myiphooks' | ||||
somewhere in your configuration files or ipython command line. | ||||
Fernando Perez
|
r1853 | """ | ||
Ville M. Vainio
|
r1032 | |||
#***************************************************************************** | ||||
# Copyright (C) 2005 Fernando Perez. <fperez@colorado.edu> | ||||
# | ||||
# Distributed under the terms of the BSD License. The full license is in | ||||
# the file COPYING, distributed as part of this software. | ||||
#***************************************************************************** | ||||
Brian Granger
|
r2128 | import os, bisect | ||
Robert Kern
|
r1841 | import sys | ||
Brian Granger
|
r2498 | |||
Brian Granger
|
r2781 | from IPython.core.error import TryNext | ||
Brian Granger
|
r2775 | import IPython.utils.io | ||
Brian Granger
|
r2498 | from IPython.utils.process import shell | ||
Ville M. Vainio
|
r1032 | # List here all the default hooks. For now it's just the editor functions | ||
# but over time we'll move here all the public API for user-accessible things. | ||||
Brian Granger
|
r2226 | |||
Brian Granger
|
r2781 | __all__ = ['editor', 'fix_error_editor', 'synchronize_with_editor', | ||
Ville M. Vainio
|
r1032 | 'input_prefilter', 'shutdown_hook', 'late_startup_hook', | ||
Brian Granger
|
r2781 | 'generate_prompt','shell_hook', | ||
Robert Kern
|
r1841 | 'show_in_pager','pre_prompt_hook', 'pre_runcode_hook', | ||
'clipboard_get'] | ||||
Ville M. Vainio
|
r1032 | |||
def editor(self,filename, linenum=None): | ||||
"""Open the default editor at the given filename and linenumber. | ||||
This is IPython's default editor hook, you can use it as an example to | ||||
write your own modified one. To set your own editor function as the | ||||
new editor hook, call ip.set_hook('editor',yourfunc).""" | ||||
# IPython configures a default editor at startup by reading $EDITOR from | ||||
# the environment, and falling back on vi (unix) or notepad (win32). | ||||
Brian Granger
|
r2202 | editor = self.editor | ||
Ville M. Vainio
|
r1032 | |||
# marker for at which line to open the file (for existing objects) | ||||
if linenum is None or editor=='notepad': | ||||
linemark = '' | ||||
else: | ||||
linemark = '+%d' % int(linenum) | ||||
# Enclose in quotes if necessary and legal | ||||
if ' ' in editor and os.path.isfile(editor) and editor[0] != '"': | ||||
editor = '"%s"' % editor | ||||
# Call the actual editor | ||||
Ville M. Vainio
|
r1744 | if os.system('%s %s %s' % (editor,linemark,filename)) != 0: | ||
Brian Granger
|
r2205 | raise TryNext() | ||
Ville M. Vainio
|
r1032 | |||
import tempfile | ||||
def fix_error_editor(self,filename,linenum,column,msg): | ||||
"""Open the editor at the given filename, linenumber, column and | ||||
show an error message. This is used for correcting syntax errors. | ||||
The current implementation only has special support for the VIM editor, | ||||
and falls back on the 'editor' hook if VIM is not used. | ||||
Call ip.set_hook('fix_error_editor',youfunc) to use your own function, | ||||
""" | ||||
def vim_quickfix_file(): | ||||
t = tempfile.NamedTemporaryFile() | ||||
t.write('%s:%d:%d:%s\n' % (filename,linenum,column,msg)) | ||||
t.flush() | ||||
return t | ||||
Brian Granger
|
r2202 | if os.path.basename(self.editor) != 'vim': | ||
Ville M. Vainio
|
r1032 | self.hooks.editor(filename,linenum) | ||
return | ||||
t = vim_quickfix_file() | ||||
try: | ||||
Ville M. Vainio
|
r1744 | if os.system('vim --cmd "set errorformat=%f:%l:%c:%m" -q ' + t.name): | ||
Brian Granger
|
r2205 | raise TryNext() | ||
Ville M. Vainio
|
r1032 | finally: | ||
t.close() | ||||
Brian Granger
|
r2226 | |||
vds
|
r1241 | def synchronize_with_editor(self, filename, linenum, column): | ||
Fernando Perez
|
r2116 | pass | ||
Brian Granger
|
r2226 | |||
Ville M. Vainio
|
r1032 | |||
class CommandChainDispatcher: | ||||
""" Dispatch calls to a chain of commands until some func can handle it | ||||
Usage: instantiate, execute "add" to add commands (with optional | ||||
priority), execute normally via f() calling mechanism. | ||||
""" | ||||
def __init__(self,commands=None): | ||||
if commands is None: | ||||
self.chain = [] | ||||
else: | ||||
self.chain = commands | ||||
def __call__(self,*args, **kw): | ||||
""" Command chain is called just like normal func. | ||||
This will call all funcs in chain with the same args as were given to this | ||||
function, and return the result of first func that didn't raise | ||||
TryNext """ | ||||
for prio,cmd in self.chain: | ||||
#print "prio",prio,"cmd",cmd #dbg | ||||
try: | ||||
Fernando Perez
|
r2370 | return cmd(*args, **kw) | ||
Brian Granger
|
r2205 | except TryNext, exc: | ||
Ville M. Vainio
|
r1032 | if exc.args or exc.kwargs: | ||
args = exc.args | ||||
kw = exc.kwargs | ||||
# if no function will accept it, raise TryNext up to the caller | ||||
Brian Granger
|
r2205 | raise TryNext | ||
Ville M. Vainio
|
r1032 | |||
def __str__(self): | ||||
return str(self.chain) | ||||
def add(self, func, priority=0): | ||||
""" Add a func to the cmd chain with given priority """ | ||||
bisect.insort(self.chain,(priority,func)) | ||||
def __iter__(self): | ||||
""" Return all objects in chain. | ||||
Handy if the objects are not callable. | ||||
""" | ||||
return iter(self.chain) | ||||
Brian Granger
|
r2226 | |||
Ville M. Vainio
|
r1032 | def result_display(self,arg): | ||
""" Default display hook. | ||||
Called for displaying the result to the user. | ||||
""" | ||||
Brian Granger
|
r2202 | if self.pprint: | ||
Ville M. Vainio
|
r1032 | out = pformat(arg) | ||
if '\n' in out: | ||||
# So that multi-line strings line up with the left column of | ||||
# the screen, instead of having the output prompt mess up | ||||
# their first line. | ||||
Brian Granger
|
r2775 | IPython.utils.io.Term.cout.write('\n') | ||
print >>IPython.utils.io.Term.cout, out | ||||
Ville M. Vainio
|
r1032 | else: | ||
# By default, the interactive prompt uses repr() to display results, | ||||
# so we should honor this. Users who'd rather use a different | ||||
# mechanism can easily override this hook. | ||||
Brian Granger
|
r2775 | print >>IPython.utils.io.Term.cout, repr(arg) | ||
Ville M. Vainio
|
r1032 | # the default display hook doesn't manipulate the value to put in history | ||
return None | ||||
Brian Granger
|
r2226 | |||
Ville M. Vainio
|
r1032 | def input_prefilter(self,line): | ||
""" Default input prefilter | ||||
This returns the line as unchanged, so that the interpreter | ||||
knows that nothing was done and proceeds with "classic" prefiltering | ||||
(%magics, !shell commands etc.). | ||||
Note that leading whitespace is not passed to this hook. Prefilter | ||||
can't alter indentation. | ||||
""" | ||||
#print "attempt to rewrite",line #dbg | ||||
return line | ||||
Brian Granger
|
r2226 | |||
Ville M. Vainio
|
r1032 | def shutdown_hook(self): | ||
""" default shutdown hook | ||||
Typically, shotdown hooks should raise TryNext so all shutdown ops are done | ||||
""" | ||||
#print "default shutdown hook ok" # dbg | ||||
return | ||||
Brian Granger
|
r2226 | |||
Ville M. Vainio
|
r1032 | def late_startup_hook(self): | ||
""" Executed after ipython has been constructed and configured | ||||
""" | ||||
#print "default startup hook ok" # dbg | ||||
Brian Granger
|
r2226 | |||
Ville M. Vainio
|
r1032 | def generate_prompt(self, is_continuation): | ||
""" calculate and return a string with the prompt to display """ | ||||
if is_continuation: | ||||
Brian Granger
|
r2781 | return str(self.displayhook.prompt2) | ||
return str(self.displayhook.prompt1) | ||||
Ville M. Vainio
|
r1032 | |||
Brian Granger
|
r2226 | |||
Ville M. Vainio
|
r1032 | def shell_hook(self,cmd): | ||
""" Run system/shell command a'la os.system() """ | ||||
Brian Granger
|
r2202 | shell(cmd, header=self.system_header, verbose=self.system_verbose) | ||
Ville M. Vainio
|
r1032 | |||
Brian Granger
|
r2226 | |||
Ville M. Vainio
|
r1032 | def show_in_pager(self,s): | ||
""" Run a string through pager """ | ||||
# raising TryNext here will use the default paging functionality | ||||
Brian Granger
|
r2205 | raise TryNext | ||
Ville M. Vainio
|
r1032 | |||
Brian Granger
|
r2226 | |||
Ville M. Vainio
|
r1032 | def pre_prompt_hook(self): | ||
""" Run before displaying the next prompt | ||||
Use this e.g. to display output from asynchronous operations (in order | ||||
to not mess up text entry) | ||||
""" | ||||
return None | ||||
Brian Granger
|
r2226 | |||
vivainio2
|
r1036 | def pre_runcode_hook(self): | ||
""" Executed before running the (prefiltered) code in IPython """ | ||||
return None | ||||
Ville M. Vainio
|
r1032 | |||
Brian Granger
|
r2226 | |||
Robert Kern
|
r1841 | def clipboard_get(self): | ||
""" Get text from the clipboard. | ||||
""" | ||||
Brian Granger
|
r2128 | from IPython.lib.clipboard import ( | ||
osx_clipboard_get, tkinter_clipboard_get, | ||||
win32_clipboard_get | ||||
) | ||||
Robert Kern
|
r1841 | if sys.platform == 'win32': | ||
chain = [win32_clipboard_get, tkinter_clipboard_get] | ||||
elif sys.platform == 'darwin': | ||||
chain = [osx_clipboard_get, tkinter_clipboard_get] | ||||
else: | ||||
chain = [tkinter_clipboard_get] | ||||
dispatcher = CommandChainDispatcher() | ||||
for func in chain: | ||||
dispatcher.add(func) | ||||
text = dispatcher() | ||||
return text | ||||