;ò ÎÑAHc@sdZdkZdkZyeWn%ej odkZeiZnXdefd„ƒYZdefd„ƒYZ dfd„ƒYZ dfd „ƒYZ e a eed „Zd fd „ƒYZd fd„ƒYZe e d„Ze d„Ze d„Ze e d„ZdS(s IPython customization API Your one-stop module for configuring & extending ipython The API will probably break when ipython 1.0 is released, but so will the other configuration method (rc files). All names prefixed by underscores are for internal use, not part of the public api. Below is an example that you can just put to a module and import from ipython. A good practice is to install the config script below as e.g. ~/.ipython/my_private_conf.py And do import_mod my_private_conf in ~/.ipython/ipythonrc That way the module is imported at startup and you can have all your personal configuration (as opposed to boilerplate ipythonrc-PROFILENAME stuff) in there. ----------------------------------------------- import IPython.ipapi ip = IPython.ipapi.get() def ankka_f(self, arg): print "Ankka",self,"says uppercase:",arg.upper() ip.expose_magic("ankka",ankka_f) ip.magic('alias sayhi echo "Testing, hi ok"') ip.magic('alias helloworld echo "Hello world"') ip.system('pwd') ip.ex('import re') ip.ex(""" def funcci(a,b): print a+b print funcci(3,4) """) ip.ex("funcci(348,9)") def jed_editor(self,filename, linenum=None): print "Calling my own editor, jed ... via hook!" import os if linenum is None: linenum = 0 os.system('jed +%d %s' % (linenum, filename)) print "exiting jed" ip.set_hook('editor',jed_editor) o = ip.options o.autocall = 2 # FULL autocall mode print "done!" NsTryNextcBstZdZd„ZRS(sTry next hook exception. Raise this in your hook function to indicate that the next hook handler should be used to handle the operation. If you pass arguments to the constructor those arguments will be used by the next hook instead of the original ones. cOs||_||_dS(N(sargssselfskwargs(sselfsargsskwargs((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys__init__Us (s__name__s __module__s__doc__s__init__(((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysTryNextLs s UsageErrorcBstZdZRS(s­ Error in magic function arguments, etc. Something that probably won't warrant a full traceback, but should nevertheless interrupt a macro / batch file. (s__name__s __module__s__doc__(((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys UsageErrorYs s IPyAutocallcBstZdZd„ZRS(s¡ Instances of this class are always autocalled This happens regardless of 'autocall' variable state. Use this to develop macro-like mechanisms. cCs ||_dS(s Will be used to set _ip point to current ipython instance b/f call Override this method if you don't want this to happen. N(sipsselfs_ip(sselfsip((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysset_ipgs(s__name__s __module__s__doc__sset_ip(((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys IPyAutocall`s sIPythonNotRunningcBsDtZdZed„Zd„ZeZd„Zd„Zd„Z RS(sÎDummy do-nothing class. Instances of this class return a dummy attribute on all accesses, which can be called and warns. This makes it easier to write scripts which use the ipapi.get() object for informational purposes to operate both with and without ipython. Obviously code which uses the ipython object for computations will not work, but this allows a wider range of code to transparently work whether ipython is being used or not.cCs'|o|i|_n |i|_dS(N(swarnsselfs _dummy_warnsdummys _dummy_silent(sselfswarn((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys__init__|scCsdSdS(Ns((sself((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys__str__‚scCs |iSdS(N(sselfsdummy(sselfsname((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys __getattr__‡scOs dGHdS(s3Dummy function, which doesn't do anything but warn.s6IPython is not running, this is a dummy no-op functionN((sselfsargsskw((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys _dummy_warnŠscOsdS(s@Dummy function, which doesn't do anything and emits no warnings.N((sselfsargsskw((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys _dummy_silents( s__name__s __module__s__doc__sTrues__init__s__str__s__repr__s __getattr__s _dummy_warns _dummy_silent(((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysIPythonNotRunningrs     cCs'|ot ot|ƒantSdS(sªGet an IPApi object. If allow_dummy is true, returns an instance of IPythonNotRunning instead of None if not running under IPython. If dummy_warn is false, the dummy instance will be completely silent. Running this should be the first thing you do when writing extensions that can be imported as normal modules. You can then direct all the configuration operations against the returned object. N(s allow_dummys_recentsIPythonNotRunnings dummy_warn(s allow_dummys dummy_warn((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysget–s sIPApicBsÂtZdZd„Zd„ZeeeeeiƒZd„ZeeeeeiƒZ d„Z d„Z d„Z d„Z ed„Zd „Zd d „Zd „Zd „Zd„Zd„ZRS(sß The actual API class for configuring IPython You should do all of the IPython configuration by getting an IPApi object with IPython.ipapi.get() and using the attributes and methods of the returned object.cCsŒ|i|_|i|_|i|_|i|_|i|_||id<|i|_|i |_ ||_ h|_ t |ƒ|_ |adS(Ns_ip(sipsipmagicsselfsmagicssystemsset_hooksset_custom_excsuser_nssset_crash_handlersmetasIPs extensionss DebugToolssdbgs_recent(sselfsip((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys__init__®s          cCs|iiSdS(sBA handle to persistent dict-like database (a PickleShareDB object)N(sselfsIPsdb(sself((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysget_dbÓscCs!|iiitƒ|iiSdS(sAll configurable variables.N(sselfsIPsrcsallow_new_attrsFalse(sself((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys get_optionsÙscCs€dk}|i||i|iiƒ}t|id|t ƒ}|o|i i d||fƒnt |id||ƒdS(sl Expose own function as magic function for ipython def foo_impl(self,parameter_s=''): """My very own magic!. (Use docstrings, IPython reads them).""" print 'Magic function. Passed parameter is between < >: <'+parameter_s+'>' print 'The self object is:',self ipapi.expose_magic("foo",foo_impl) Nsmagic_sMagic redefinition '%s', old %s(snewsinstancemethodsfuncsselfsIPs __class__simsgetattrs magicnamesNonesoldsdbgs debug_stackssetattr(sselfs magicnamesfuncsoldsimsnew((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys expose_magicås  cBs||iUdS(s5 Execute a normal python statement in user namespace N(scmdsselfsuser_ns(sselfscmd((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysexùscCst||iƒSdS(se Evaluate python expression expr in user namespace Returns the result of evaluationN(sevalsexprsselfsuser_ns(sselfsexpr((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysevýscCsRd„}t|tƒo |}ndi|ƒ}||ƒ}|ii |ƒdS(s× Run the specified lines in interpreter, honoring ipython directives. This allows %magic and !shell escape notations. Takes either all lines in one string or list of lines. c CsÐg}|iƒ}d}x |D]˜}|iƒ}|iƒ}| oqnt |ƒt |ƒ}d„}|djo|djo ||ƒ o|i dƒn|i |ƒ|}qWdi|ƒdSdS(sË Make a script safe for _ip.runlines() - Removes empty lines - Suffixes all indented blocks that end with unindented lines with empty lines icCse|idƒ otSn|idƒp-|idƒp|idƒp |idƒotSndS(Ns:selifselsesexceptsfinally(sssendswithsFalses startswithsTrue(ss((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysis_secondary_block_starts@ss N(sressscripts splitlinesslinesslevelslslstrips lstrippedsstripsstrippedslensnewlevelsis_secondary_block_startsappendsjoin( sscriptslevelsresslinesslsnewlevelsstrippedsis_secondary_block_starts lstripped((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pyscleanup_ipy_script s"    (  s N( scleanup_ipy_scripts isinstancesliness basestringsscriptsjoinscleansselfsIPsrunlines(sselfslinessscriptscleanup_ipy_scriptsclean((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysrunliness "  cCs$t|tƒo |}nŒt|tƒootidƒ}h}xc|iƒD]E}y t ||i |i ƒ|| _ip.expand_aliases("np myfile.txt") <16> 'q:/opt/np/notepad++.exe myfile.txt' N( sselfsIPssplit_user_inputslinespresfnsrestsexpand_aliasessres(sselfslinespresressrestsfn((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pys expand_aliasŒsicCs|ii||ƒSdS(sµ Expand Itpl format string s. Only callable from command line (i.e. prefilter results); If you use in your scripts, you need to use a bigger depth! N(sselfsIPs var_expandsssdepth(sselfsssdepth((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysitplšscCs|ii|ƒ||iijo+|iid|||ii|fƒnt|ƒo4||ii| '%s' (old '%s')Ns%sis%lsEThe %s and %l specifiers are mutually exclusive in alias definitions.(sselfsdbgs check_hotnamesnamesIPs alias_tables debug_stackscmdscallablesIPython.shadownssIPythonssetattrsshadownss isinstances basestringscountsnargssfinds Exception(sselfsnamescmdsnargssIPython((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysdefalias¢s +  #cGszdk}t|ƒdjo|ii|dƒSnCt|ƒdjo%|ii|dƒ|i|d _ip.set_next_input("Hello Word") [D:\ipython]|2> Hello Word_ # cursor is here N(sssselfsIPs rl_next_input(sselfss((s=/nyx/web/d/b/dbachman/work/src/ipython-0.8.4/IPython/ipapi.pysset_next_inputÛs cCsÐ||ijo|i|Snt|ƒti|}t|dƒo|i|ƒnt|dƒoT|i i dt ƒƒ}||jo+|i |ƒ|i|ƒ||i d