model messages initial version

Author: Fedor Baart

DESCRIPTION.rst

@@ -0,0 +1,5 @@
+Model Message Interface
+=======================
+
+This is an implementation of the model message interface for python.
+

MANIFEST.in

@@ -0,0 +1,8 @@
+include DESCRIPTION.rst
+
+# Include the test suite (FIXME: does not work yet)
+# recursive-include tests *
+
+# Explicitly note anything that is in package_data, as Python 2.6 does
+# not include these by default
+# include sample/*.dat

README.md

@@ -1,4 +1,4 @@
-python-mmi
+mmi
 ==========
 
 Model Message Interface. Sending arrays with metadata between processes.

mmi/__init__.py

@@ -0,0 +1,39 @@
+__version__ = '0.1'
+import datetime
+
+import numpy as np
+import zmq
+
+def send_array(socket, A, flags=0, copy=False, track=False, metadata=None):
+    """send a numpy array with metadata"""
+    md = dict(
+        dtype=str(A.dtype),
+        shape=A.shape,
+        timestamp=datetime.datetime.now().isoformat()
+    )
+    if metadata:
+        md.update(metadata)
+    if A is None:
+        # send only json
+        socket.send_json(md, flags)
+    else:
+        # send json, followed by array
+        socket.send_json(md, flags | zmq.SNDMORE)
+    # Make a copy if required and pass along the buffer
+    msg = buffer(np.ascontiguousarray(A))
+    socket.send(msg, flags, copy=copy, track=track)
+    return
+
+
+def recv_array(socket, flags=0, copy=False, track=False):
+    """recv a metadata and an optional numpy array"""
+    md = socket.recv_json(flags=flags)
+    if socket.getsockopt(zmq.RCVMORE):
+        msg = socket.recv(flags=flags, copy=copy, track=track)
+        buf = buffer(msg)
+        A = np.frombuffer(buf, dtype=md['dtype'])
+        A.reshape(md['shape'])
+    else:
+        # No array expected
+        A = None
+    return A, md

setup.cfg

@@ -0,0 +1,5 @@
+[wheel]
+# This flag says that the code is written to work on both Python 2 and Python
+# 3. If at all possible, it is good practice to do this. If you cannot, you
+# will need to generate wheels for each Python version that you support.
+universal=1

setup.py

@@ -0,0 +1,96 @@
+from setuptools import setup, find_packages
+import os
+import re
+import codecs
+# get py3 compatible open
+from io import open
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+# Read the version number from a source file.
+# Code taken from pip's setup.py
+def find_version(*file_paths):
+    # Open in Latin-1 so that we avoid encoding errors.
+    # Use codecs.open for Python 2 compatibility
+    with codecs.open(os.path.join(here, *file_paths), 'r', 'latin1') as f:
+        version_file = f.read()
+
+    # The version line must have the form
+    # __version__ = 'ver'
+    version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]",
+                              version_file, re.M)
+    if version_match:
+        return version_match.group(1)
+    raise RuntimeError("Unable to find version string.")
+
+
+# Get the long description from the relevant file
+with open('DESCRIPTION.rst', encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name="mmi",
+    version=find_version('mmi', '__init__.py'),
+    description="Model Message Interface",
+    long_description=long_description,
+
+    # The project URL.
+    url='http://github.com/pfmoore/sampleproject',
+
+    # Author details
+    author='Fedor Baart',
+    author_email='[email protected]',
+
+    # Choose your license
+    license='GPLv3+',
+
+    classifiers=[
+        # How mature is this project? Common values are
+        #   3 - Alpha
+        #   4 - Beta
+        #   5 - Production/Stable
+        'Development Status :: 3 - Alpha',
+
+        # Indicate who your project is intended for
+        'Intended Audience :: Science/Research',
+        'Intended Audience :: Developers',
+        'Topic :: Scientific/Engineering',
+        'Topic :: System :: Distributed Computing',
+
+        # Pick your license as you wish (should match "license" above)
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)"
+
+        # Specify the Python versions you support here. In particular, ensure
+        # that you indicate whether you support Python 2, Python 3 or both.
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.1',
+        'Programming Language :: Python :: 3.2',
+        'Programming Language :: Python :: 3.3',
+    ],
+
+    # What does your project relate to?
+    keywords='array messages model',
+
+    # You can just specify the packages manually here if your project is
+    # simple. Or you can use find_packages.
+    packages=find_packages(exclude=["contrib", "docs", "tests*"]),
+    # If there are data files included in your packages, specify them here.
+    package_data={
+        # 'sample': ['*.dat'],
+    },
+
+    install_requires = [
+        'numpy',
+        'zmq'
+    ],
+    # To provide executable scripts, use entry points in preference to the
+    # "scripts" keyword. Entry points provide cross-platform support and allow
+    # pip to create the appropriate form of executable for the target platform.
+    entry_points={
+        'console_scripts': [
+            # 'runner=runner:main',
+        ],
+    },
+)

tests/__init__.py

@@ -0,0 +1,23 @@
+import unittest
+import mmi
+
+import numpy as np
+import numpy.testing
+import zmq
+
+
+# global context
+ctx = zmq.Context()
+class TestRecv(unittest.TestCase):
+    def test_sndrcv(self):
+        A = np.array([1,2,3])
+        req = ctx.socket(zmq.REQ)
+        req.connect('tcp://localhost:9002')
+        rep = ctx.socket(zmq.REP)
+        rep.bind('tcp://*:9002')
+        mmi.send_array(req, A)
+        B, metadata = mmi.recv_array(rep)
+        numpy.testing.assert_array_equal(A, B)
+
+
+