; AHc @s:dZdklZdklZdeidZeiZeiZ dk Z dk Z dk l Z lZdklZdd d d d d ddddddg ZeiZedZdkZdZdfdYZdZdZdZdZdZdZdZdZd Z d!Z!dS("s}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 import IPython.ipapi ip = IPython.ipapi.get() def calljed(self,filename, linenum): "My editor hook calls the jed editor directly." print "Calling my own editor, jed ..." os.system('jed +%d %s' % (linenum,filename)) ip.set_hook('editor', calljed) You can then enable the functionality by doing 'import myiphooks' somewhere in your configuration files or ipython command line. $Id: hooks.py 2998 2008-01-31 10:06:04Z vivainio $(sRelease(sipapis%s <%s>sFernandoN(sTermsshell(s PrettyPrinterseditorsfix_error_editorsresult_displaysinput_prefilters shutdown_hookslate_startup_hooksgenerate_promptsgenerate_output_prompts shell_hooks show_in_pagerspre_prompt_hookspre_runcode_hookcCs|ii}|tjp |djo d}ndt|}d|jo!tii |o|ddjod|}nti d|||fd S( s 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).snotepadss+%ds is"s"%s"s%s %s %sN( sselfsrcseditorslinenumsNoneslinemarksintsosspathsisfilessystemsfilename(sselfsfilenameslinenumseditorslinemark((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pyseditor?s  1csd}tii|iidjo|iidSn|}zti d|i Wd|i XdS(s]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, cs;ti}|idf|i|SdS(Ns %s:%d:%d:%s ( stempfilesNamedTemporaryFilestswritesfilenameslinenumscolumnsmsgsflush(st(scolumnsfilenameslinenumsmsg(s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pysvim_quickfix_file`s  svimNs+vim --cmd "set errorformat=%f:%l:%c:%m" -q (svim_quickfix_filesosspathsbasenamesselfsrcseditorshookssfilenameslinenumstssystemsnamesclose(sselfsfilenameslinenumscolumnsmsgsvim_quickfix_filest((sfilenameslinenumscolumnsmsgs=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pysfix_error_editorXs sCommandChainDispatchercBsAtZdZedZdZdZddZdZRS(s 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. cCs'|tjo g|_n ||_dS(N(scommandssNonesselfschain(sselfscommands((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pys__init__vs  cOsxs|iD]h\}}y|||}|SWq tij o3}|ip|i o|i}|i }qrq Xq WtidS(s 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 N( sselfschainsprioscmdsargsskwsretsipapisTryNextsexcskwargs(sselfsargsskwsexcsprioscmdsret((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pys__call__}s  cCst|iSdS(N(sstrsselfschain(sself((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pys__str__sicCsti|i||fdS(s1 Add a func to the cmd chain with given priority N(sbisectsinsortsselfschainsprioritysfunc(sselfsfuncspriority((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pysaddscCst|iSdS(s^ Return all objects in chain. Handy if the objects are not callable. N(sitersselfschain(sself((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pys__iter__s( s__name__s __module__s__doc__sNones__init__s__call__s__str__sadds__iter__(((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pysCommandChainDispatcheros     cCsf|iio>t|}d|jotiidnti|IJntit |IJt SdS(sR Default display hook. Called for displaying the result to the user. s N( sselfsrcspprintspformatsargsoutsTermscoutswritesreprsNone(sselfsargsout((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pysresult_displays   cCs|SdS(s? 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. N(sline(sselfsline((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pysinput_prefilters cCsdSdS(sp default shutdown hook Typically, shotdown hooks should raise TryNext so all shutdown ops are done N((sself((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pys shutdown_hookscCsdS(sF Executed after ipython has been constructed and configured N((sself((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pyslate_startup_hookscCs>|i}|ot|iiiSnt|iiiSdS(s: calculate and return a string with the prompt to display N( sselfsapisipsis_continuationsstrsIPs outputcachesprompt2sprompt1(sselfsis_continuationsip((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pysgenerate_prompts  cCs |i}t|iiiSdS(N(sselfsapisipsstrsIPs outputcaches prompt_out(sselfsip((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pysgenerate_output_prompts cCs&t|d|iid|iidS(s+ Run system/shell command a'la os.system() sheadersverboseN(sshellscmdsselfsrcs system_headerssystem_verbose(sselfscmd((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pys shell_hookscCs tidS(s Run a string through pager N(sipapisTryNext(sselfss((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pys show_in_pagerscCstSdS(s Run before displaying the next prompt Use this e.g. to display output from asynchronous operations (in order to not mess up text entry) N(sNone(sself((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pyspre_prompt_hookscCstSdS(s; Executed before running the (prefiltered) code in IPython N(sNone(sself((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pyspre_runcode_hooks("s__doc__sIPythonsReleasesipapisauthorss __author__slicenses __license__sversions __version__sossbisectsgenutilssTermsshellspprints PrettyPrinters__all__spformatsNoneseditorstempfilesfix_error_editorsCommandChainDispatchersresult_displaysinput_prefilters shutdown_hookslate_startup_hooksgenerate_promptsgenerate_output_prompts shell_hooks show_in_pagerspre_prompt_hookspre_runcode_hook(s shutdown_hooksfix_error_editors shell_hooksinput_prefiltersgenerate_output_prompts show_in_pagerslate_startup_hooks__all__stempfileseditors __version__sipapisTermsshells __license__s __author__sReleases PrettyPrintersbisectsossgenerate_promptspformatsCommandChainDispatcherspre_runcode_hookspre_prompt_hooksresult_display((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/hooks.pys?#s0     *    /