cleanup up interrupt implementation, added docs

ivanov · ivanov · commit cc21ee3803ff · 2013-04-15T18:17:06.000-07:00
diff --git a/README.rst b/README.rst
@@ -164,6 +164,35 @@ the line ``let g:ipy_completefunc = 'local'`` in one's vimrc will activate the
 IPython-based completion only for current buffer. Setting `g:ipy_completefunc`
 to anything other than `'local'` or `'global'` disables it altogether.
 
+**NEW since IPython 0.13**
+
+**Sending ? and ?? now works just like IPython**
+This is only supported for single lines that end with ? and ??, which works
+just the same as it does in IPython (The ?? variant will show the code, not
+just the docstring
+
+**Sending arbitrary signal to IPython kernel**
+`:IPythonInterrupt` now supports sending of arbitrary signals. There's a
+convenience alias for sending SIGTERM via `:IPythonTerminate`, but you can
+also send any signal by just passing an argument to `:IPythonInterrupt`.
+Here's an example. First, send this code (or just run it in your kernel)::
+
+    import signal
+    def greeting_user(signum, stack):
+        import sys
+        sys.stdout.flush()
+        print "Hello, USER!"
+        sys.stdout.flush()
+    signal.signal(signal.SIGUSR1, greeting_user)
+
+Now, proceed to connect up using vim-ipython and run `:IPythonInterrupt 10` -
+where 10 happens to be signal.SIGUSR1 in the POSIX world. This functionality,
+along with the sourcing of profile-dependent code on startup (
+``vi `ipython locate profile default`/startup/README`` ), brings the forgotten
+world of inter-process communication through signals to your favorite text
+editor and REPL combination.
+
+
 ---------------
 Current issues:
 ---------------
@@ -242,6 +271,7 @@ pull request with your attribution.
 * @pielgrzym for setting completefunc locally to a buffer (#32)
 * @flacjacket for pointing out and providing fix for IPython API change
 * @memeplex for fixing the identifier grabbing on e.g. non-PEP8 compliant code
+* @pydave for IPythonTerminate (sending SIGTERM using our hack)
 
 Similar Projects
 ----------------
diff --git a/ftplugin/python/ipy.vim b/ftplugin/python/ipy.vim
@@ -492,19 +492,19 @@ def set_pid():
     return pid
 
 
-def interrupt_kernel_hack():
-    import signal
-    send_kernel_interrupt(signal.SIGINT)
 def terminate_kernel_hack():
+    "Send SIGTERM to our the IPython kernel"
     import signal
-    send_kernel_interrupt(signal.SIGTERM)
-def send_kernel_interrupt(signal_to_send):
+    interrupt_kernel_hack(signal.SIGTERM)
+
+def interrupt_kernel_hack(signal_to_send=None):
     """
     Sends the interrupt signal to the remote kernel.  This side steps the
     (non-functional) ipython interrupt mechanisms.
     Only works on posix.
     """
     global pid
+    import signal
     import os
     if pid is None:
         # Avoid errors if we couldn't get pid originally,
@@ -514,10 +514,13 @@ def send_kernel_interrupt(signal_to_send):
         if pid is None:
             echo("cannot get kernel PID, Ctrl-C will not be supported")
             return
+    if not signal_to_send:
+        signal_to_send = signal.SIGINT
+
     echo("KeyboardInterrupt (sent to ipython: pid " +
-        "%i with signal %i)" % (pid, signal_to_send),"Operator")
+        "%i with signal %s)" % (pid, signal_to_send),"Operator")
     try:
-        os.kill(pid, signal_to_send)
+        os.kill(pid, int(signal_to_send))
     except OSError:
         echo("unable to kill pid %d" % pid)
         pid = None
@@ -650,7 +653,7 @@ endif
 command! -nargs=* IPython :py km_from_string("<args>")
 command! -nargs=0 IPythonClipboard :py km_from_string(vim.eval('@+'))
 command! -nargs=0 IPythonXSelection :py km_from_string(vim.eval('@*'))
-command! -nargs=0 IPythonInterrupt :py interrupt_kernel_hack()
+command! -nargs=* IPythonInterrupt :py interrupt_kernel_hack("<args>")
 command! -nargs=0 IPythonTerminate :py terminate_kernel_hack()
 
 function! IPythonBalloonExpr()
