ipapi decorators ashook, asmagic; ipapi.options() for __IP.rc access

IPython/ipapi.py

@@ -1,14 +1,28 b''
 ''' IPython customization API
 
-Your one-stop module for configuring ipython
+Your one-stop module for configuring & extending ipython
 
-This is experimental, use at your own risk.
+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.
 
-No formal doc yet, here's an example that you can just put 
-to a module and import from ipython.
+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 as ip
@@ -38,12 +52,13 b' def jed_editor(self,filename, linenum=None):'
     print "exiting jed"
 
 ip.set_hook('editor',jed_editor)
-print "done!"
-    
-'''
  
+o = ip.options()
+o.autocall = 2  # FULL autocall mode
   
+print "done!"
  
+'''
  
 def _init_with_shell(ip):
     global magic
@@ -52,9 +67,14 b' def _init_with_shell(ip):'
     system = ip.ipsystem
     global set_hook
     set_hook = ip.set_hook
+    
     global __IP
     __IP = ip
 
+def options():
+    """ All configurable variables """
+    return __IP.rc
+
 def user_ns():
     return __IP.user_ns
 
@@ -73,6 +93,42 b' def expose_magic(magicname, func):'
     
     setattr(Magic.Magic, "magic_" + magicname, func)
     
+class asmagic:
+    """ Decorator for exposing magics in a friendly 2.4 decorator form 
+    
+    @ip.asmagic("foo")
+    def f(self,arg):
+        pring "arg given:",arg
+    
+    After this, %foo is a magic function.
+    """
+    
+    def __init__(self,magicname):
+        self.name = magicname
+        
+    def __call__(self,f):
+        expose_magic(self.name, f)
+        return f
+
+class ashook:
+    """ Decorator for exposing magics in a friendly 2.4 decorator form 
+    
+    @ip.ashook("editor")
+    def jed_editor(self,filename, linenum=None):
+        import os
+        if linenum is None: linenum = 0
+        os.system('jed +%d %s' % (linenum, filename))
+    
+    """
+    
+    def __init__(self,name):
+        self.name = name
+        
+    def __call__(self,f):
+        set_hook(self.name, f)
+        return f
+
+
 def ex(cmd):
     """ Execute a normal python statement """
     exec cmd in user_ns()
  No newline at end of file

IPython/iplib.py

@@ -6,7 +6,7 b' Requires Python 2.3 or newer.'
 
 This file contains all the classes and helper functions specific to IPython.
 
-$Id: iplib.py 1016 2006-01-14 00:54:23Z vivainio $
+$Id: iplib.py 1017 2006-01-14 09:46:45Z vivainio $
 """
 
 #*****************************************************************************
@@ -192,7 +192,7 b' class InteractiveShell(object,Magic):'
                  custom_exceptions=((),None),embedded=False):
 
         # first thing: introduce ourselves to IPython.ipapi which is uncallable
-        # before it knows an InteractiveShell object. Uninitialized state is ok
+        # before it knows an InteractiveShell object. 
         IPython.ipapi._init_with_shell(self)
         
         # some minimal strict typechecks.  For some core data structures, I

IPython/ipmaker.py

@@ -6,7 +6,7 b' Requires Python 2.1 or better.'
 
 This file contains the main make_IPython() starter function.
 
-$Id: ipmaker.py 1005 2006-01-12 08:39:26Z fperez $"""
+$Id: ipmaker.py 1017 2006-01-14 09:46:45Z vivainio $"""
 
 #*****************************************************************************
 #       Copyright (C) 2001-2006 Fernando Perez. <[e-mail]>
@@ -415,6 +415,7 b" object? -> Details about 'object'. ?object also works, ?? prints more."
            warn('Profile configuration file %s not found. Ignoring request.'
                 % (opts_all.profile) )
 
+
     # load the config file
     rcfiledata = None
     if opts_all.quick:

doc/ChangeLog

@@ -1,3 +1,10 b''
[phone]  Ville Vainio  <[e-mail]>
+
+	* IPython/ipapi.py (ashook, asmagic, options): Added convenience 
+	ipapi decorators for python 2.4 users, options() provides access to rc 
+	data.
+
+
 2006-01-13  Ville Vainio  <[e-mail]>
 
 	* IPython/platutils*.py: platform specific utility functions,