Merge lp:~ipython-contrib/ipython/ipython-zmq into lp:ipython/0.11

[Fernando Perez]

Google Summer of Code branch proposal for the zmq port.

[lp:~ipython-contrib/ipython/ipython-zmq]

1240. By Omar Andres Zapata Mesa <omazapa@tuxhome> on 2010-05-08

 implementing the server and client in zmq, this module
 init sockets to zmq conecction and let comunication between client and server.
 º

1241. By Omar Andres Zapata Mesa <omazapa@tuxhome> on 2010-05-09

Writing send and receive methods

[Fernando Perez (fdo.perez)]

I merged revisions 1237-1239 and cleaned the text up a little bit, but I did NOT merge 1240-41. The code in there will require further review, and we're now doing the move to github.

So once you start working on github, just remember to add the ipzmq.py file back to your git branch. But that code will need some fixes, which I can tell you about right away so you can start working on them:

- you are using 8 spaces, PEP 8 uses 4
- you are using camelCase, PEP 8 discourages that. Please read PEP 8 and adhere to it.
- do not use self.__X attributes with double underscore, they cause lots of problems in the long run. They are a mis-feature of python and should only be used in rare instances.

- Why aren't you using the code from the pyzmq examples as a starting point? That code already had much of what you are implementing here working...

So in summary: your docs have been merged (after fixing for capitalization and formatting, next time please be careful with that). The code isn't ready for merging.

review: Disapprove

[lp:~ipython-contrib/ipython/ipython-zmq]

1242. By Omar Andres Zapata Mesa <omazapa@tuxhome> on 2010-05-13

-> Corrections in namespacing, using pep8 instead camel case.
-> Implemented send and recieve in ipzmq but it have some errors
-> I started to write ipkernelzmq but it is not functional yet.

Unmerged revisions

1242. By Omar Andres Zapata Mesa <omazapa@tuxhome> on 2010-05-13

-> Corrections in namespacing, using pep8 instead camel case.
-> Implemented send and recieve in ipzmq but it have some errors
-> I started to write ipkernelzmq but it is not functional yet.

1241. By Omar Andres Zapata Mesa <omazapa@tuxhome> on 2010-05-09

Writing send and receive methods

1240. By Omar Andres Zapata Mesa <omazapa@tuxhome> on 2010-05-08

 implementing the server and client in zmq, this module
 init sockets to zmq conecction and let comunication between client and server.
 º

=== added file 'IPython/core/ipzmq.py'
--- IPython/core/ipzmq.py	1970-01-01 00:00:00 +0000
+++ IPython/core/ipzmq.py	2010-05-13 05:47:25 +0000
@@ -0,0 +1,174 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""A class to init a kernels server and client connector over 0MQ.
+
+Autor: Omar Andrés Zapata Mesa
+       Fernando Perez
+
+Things to do:
+-> sendMessage method
+-> getMessage medthod
+-> Message standards
+-> json messages and compresion
+
+"""
+
+
+import __builtin__
+import sys
+import time
+import traceback
+import zmq
+from json import JSONEncoder, JSONDecoder 
+
+json_encoder=JSONEncoder()
+json_decoder=JSONDecoder()
+
+
+class IpZmqServer(object):
+   def __init__(self, ip='127.0.0.1', port_base=5555):
+       """ Init defaults values to class """
+       self._ip=ip
+       self._port_base=port_base
+             
+       self._Status=False
+       #Context default Parameters  zmq.Context(1,1,0)
+       self._app_threads=1
+       self._io_threads=1
+       self._flags=0
+
+       #connection = ('tcp://%s' % ip) + ':%i'
+       self._reply_connection= ('tcp://%s' % self._ip) + ':%i' %self._port_base
+       self._public_connection= ('tcp://%s' % self._ip) + ':%i' %(self._port_base+1)
+                
+   def set_context(self, app_threads=1, io_threads=1, flags=0):
+       """ Write zmq context into class attributes."""         
+       self._app_threads = app_threads
+       self._io_threads = io_threads
+       self._flags = flags
+                
+   def start(self):
+       """ Init sockets connections to listen zmq request and send replies """
+       self._Context = zmq.Context( self._app_threads, self._io_threads, self._flags)
+                
+       self._reply_socket = self._Context.socket(zmq.XREP)
+       try:
+           self._reply_socket.bind(self._reply_connection)
+       except:
+           etype, evalue, tb = sys.exc_info()
+           tb = traceback.format_exception(etype, evalue, tb)
+
+       self._public_socket = self._Context.socket(zmq.PUB)
+       try:
+           self._public_socket.bind( self._public_connection)
+       except:
+           etype, evalue, tb = sys.exc_info()
+           tb = traceback.format_exception(etype, evalue, tb)
+       self._Status=True
+        
+   def stop(self):
+       """Close all sockets and shutdown connections"""
+       self._reply_socket = None
+       self._public_socket = None
+       self._Context = None
+       self._Status == False
+        
+   def get_public_socket(self):
+       """ return public connection socket"""
+       return self._public_socket
+                
+   def get_reply_socket(self):
+       """ return reply connection socket"""
+       return self._reply_socket
+        
+   def send(self,message):
+       """Send messages through public socket
+          message is a callable object or a string
+       """
+       if  self._Status == False :
+           raise ValueError('I/O operation: zmq server is stop')
+       elif self._public_socket == None :
+           raise ValueError('I/O operation on closed socked file')
+       else:
+           msg=json_encoder.encode(message)
+           self._public_socket.send(msg)
+        
+   def receive(self):
+       """receive messages through reply socket """
+       if  self._Status == False :
+           raise ValueError('I/O operation: zmq server is stop')
+       elif self._reply_socket == None :
+           raise ValueError('I/O operation on closed socked file')
+       else: 
+           ident, msg = self._reply_socket.recv_json(True)
+           msg=json_decoder.decode(msg)
+           return ident, msg
+
+
+class IpZmqClient(object):
+   def __init__(self, ip='127.0.0.1', port_base=5555):
+       """ Init defaults values to class, not init connections services, you need call start() method"""
+       self._ip=ip
+       self._port_base=port_base
+                
+       #Context default Parameters  zmq.Context(1,1,0)
+       self._app_threads = 1
+       self._io_threads = 1
+       self._flags = 0
+       self._Status = False
+       self._request_connection = ('tcp://%s' % self._ip) + ':%i' %self._port_base
+       self._sub_connection = ('tcp://%s' % self._ip) + ':%i' %(self._port_base+1)
+                                        
+   def start(self):
+       """ Init sockets connections to send zmq request and rec replies """                
+       self._Context = zmq.Context( self._app_threads, self._io_threads, self._flags)
+       self._request_socket = self._Context.socket(zmq.XREQ)
+       self._request_socket.connect(self._request_connection)
+                
+       self._sub_socket = self._Context.socket(zmq.SUB)
+       self._sub_socket.connect(self._sub_connection)
+       self._sub_socket.setsockopt(zmq.SUBSCRIBE,'')
+       self._Status=True
+   
+   def stop(self):
+       self._request_socket = None
+       self._sub_socket = None
+       self._Context = None
+       self._Status = False
+        
+        
+   def get_sub_socket(self):
+       return self._sub_socket
+                        
+   def get_request_socket(self):
+       return self._request_socket
+        
+   def send(self,message):
+       if  self._Status == False :
+           raise ValueError('I/O operation: zmq server is stop')
+       elif self._sub_socket == None :
+           raise ValueError('I/O operation on closed socked file')
+       else:
+           msg=json_encoder.encode(message)
+           self._sub_socket.send(str(msg))
+                        
+   def receive(self):
+       if  self._Status == False :
+           raise ValueError('I/O operation: zmq server is stop')
+       elif self._request_socket == none :
+           raise ValueError('I/O operation on closed socked file')
+       else:
+           ident, msg = self._request_socket.recv(True)
+           msg=JSONDecoder.decode(msg)
+           return ident, msg
+                     
+                                                                
+if(__name__ == "__main__"):
+   server=IpZmqServer("127.0.0.1",5555)
+   server.start()
+   client=IpZmqClient("127.0.0.1",5555)
+   client.start()
+   client.send("hi server!")
+   server.stop()
+   client.stop()
+   
\ No newline at end of file

=== added file 'IPython/kernel/ipkernelzmq.py'
--- IPython/kernel/ipkernelzmq.py	1970-01-01 00:00:00 +0000
+++ IPython/kernel/ipkernelzmq.py	2010-05-13 05:47:25 +0000
@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+# autors:
+# Omar Andres Zapata Mesa
+# Fernando Perez
+
+"""A interactive kernel that talks to a frontend over 0MQ.
+   
+   
+
+"""
+  
+import __builtin__
+import sys
+import time
+import traceback
+ 
+from code import CommandCompiler
+  
+import zmq
+  
+from IPython.core.ipzmq import IpZmqServer  
+from IPython.core.iplib import InteractiveShell
+from IPython.utils.io import IOTerm
+from IPython.kernel.core.redirector_output_trap import RedirectorOutputTrap
+from IPython.kernel.core.sync_traceback_trap import SyncTracebackTrap
+from IPython.utils.io import Term  
+
+from Queue import Queue
+
+
+class IpKernelZmq(object):
+    """ Ipython Zmq Kernel
+     We start the server using zmq ipzmq, it will be waiting requests in the public socket
+     so that it processes the ipython shell and put it in the output queue to be sent by the zmq`s reply socket.
+     Ipython`s interactive shell will be running in a thread and input and output queues will be working  asynchronously
+     
+    """
+   __init__(self, ip, port):
+       self._input_queue=Queue(-1)
+       self._output_queue=Queue(-1)
+       self._ip_zmq_server=IpZmqServer(ip,port)
+       self._shell=InteractiveShell()
+       self._shell.init_alias()
+       self._shell.init_builtins()
+       self._shell.init_inspector()
+       self._shell.init_magics()
+       self._shell.init_pdb()
+       self._shell.init_sys_modules()
+       self._shell.init_instance_attrs()
+       self._shell.init_user_ns()
+       self._status = False
+    def start(self):
+       if !self._status :
+	   try:
+               self._ip_zmq_server.start()
+           except:
+       else:
+	   print >> sys.stderr , "Kernel is now running"
\ No newline at end of file