Prepared for PyPI

Author: Luca De Feo

MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE README.rst

README.md README.rst

@@ -1,2 +1,4 @@
-# scscpy
+SCSCP
+=====
+
 SCSCP module for Python

scscpy/__init__.py scscp/__init__.py

@@ -1,6 +1,7 @@
 import logging
 from pexpect import fdpexpect, TIMEOUT, EOF
-from .scscp import ProcessingInstruction as PI, PI_regex, SCSCPError
+from .scscp import SCSCPConnectionError, SCSCPCancel
+from .processing_instruction import ProcessingInstruction as PI
 
 class SCSCPClient():
     """
@@ -30,7 +31,7 @@ def wrapper(self, *args, **kwds):
     def _get_next_PI(self, expect=None, timeout=-1):
         while True:
             try:
-                self.stream.expect(PI_regex, timeout=timeout)
+                self.stream.expect(PI.PI_regex, timeout=timeout)
             except TIMEOUT:
                 self.quit()
                 raise TimeoutError("Server took to long to respond.")
@@ -39,20 +40,20 @@ def _get_next_PI(self, expect=None, timeout=-1):
 
             try:
                 pi = PI.parse(self.stream.after)
-            except SCSCPError:
+            except SCSCPConnectionError:
                 self.quit()
                 raise
             self.log.debug("Received PI: %s" % pi)
 
             if expect is not None and pi.key not in expect:
                 if pi.key == 'quit':
                     self.quit()
-                    raise SCSCPError("Server closed session (reason: %s)." % pi.attrs.get('reason'))
+                    raise SCSCPConnectionError("Server closed session (reason: %s)." % pi.attrs.get('reason'), pi)
                 if pi.key == 'info':
                     self.log.info("SCSCP info: %s " % pi.attrs.get('info'))
                     continue
                 else:
-                    raise SCSCPError("Server sent unexpected message: %s" % pi.key)
+                    raise SCSCPConnectionError("Server sent unexpected message: %s" % pi.key, pi)
             else:
                 return pi
 
@@ -70,7 +71,7 @@ def connect(self):
         if ('scscp_versions' not in pi.attrs
                 or b'1.3' not in pi.attrs['scscp_versions'].split()):
             self.quit()
-            raise SCSCPError("Unsupported SCSCP versions %s." % pi.attrs.get('scscp_versions'))
+            raise SCSCPConnectionError("Unsupported SCSCP versions %s." % pi.attrs.get('scscp_versions'), pi)
 
         self.service_info = pi.attrs
 
@@ -79,7 +80,7 @@ def connect(self):
         pi = self._get_next_PI([''])
         if pi.attrs.get('version') != b'1.3':
             self.quit()
-            raise SCSCPError("Server sent unexpected response.")
+            raise SCSCPConnectionError("Server sent unexpected response.", pi)
 
         self.status = self.CONNECTED
 
@@ -103,7 +104,7 @@ def receive(self, timeout=-1):
         while True:
             pi = self._get_next_PI(['end', 'cancel', 'info'], timeout=timeout)
             if pi.key == 'cancel':
-                raise SCSCPCancel()
+                raise SCSCPCancel('Server canceled transmission')
 
             msg += self.stream.before
             if pi.key == 'info':
@@ -132,4 +133,3 @@ def info(self, info):
     def terminate(self, id):
         """ Send SCSCP terminate message """
         self._send_PI('terminate', call_id=id)
-        

scscpy/client.py scscp/client.py

@@ -1,26 +1,21 @@
 import re
-
-PI_regex = re.compile(b"<\?scscp\s+(.{0,4084}?)\?>", re.S)
-PI_regex_full = re.compile(b'^<\?scscp(?:\s+(?P<key>\w+))?(?P<attrs>(?:\s+\w+=".*?")*)\s*\?>$')
-PI_regex_attr = re.compile(b'(\w+)="(.*?)"')
-
-class SCSCPError(RuntimeError):
-    pass
-class SCSCPCancel(SCSCPError):
-    def __init__(self):
-        super(SCSCPCancel, self).__init__('Server canceled transmission')
+from .scscp import SCSCPConnectionError
 
 class ProcessingInstruction():
+    PI_regex = re.compile(b"<\?scscp\s+(.{0,4084}?)\?>", re.S)
+    PI_regex_full = re.compile(b'^<\?scscp(?:\s+(?P<key>\w+))?(?P<attrs>(?:\s+\w+=".*?")*)\s*\?>$')
+    PI_regex_attr = re.compile(b'(\w+)="(.*?)"')
+
     @classmethod
     def parse(cls, bytes):
-        match = PI_regex_full.match(bytes)
+        match = cls.PI_regex_full.match(bytes)
         if match:
             key = (match.group('key') or b'').decode('ascii')
             attrs = { k.decode('ascii'): v
-                          for k, v in PI_regex_attr.findall(match.group('attrs')) }
+                          for k, v in cls.PI_regex_attr.findall(match.group('attrs')) }
             return cls(key, **attrs)
         else:
-            raise SCSCPError("Bad SCSCP processing instruction %s." % bytes)
+            raise SCSCPConnectionError("Bad SCSCP processing instruction %s." % bytes)
 
     def __init__(self, key='', **attrs):
         self.key = key

scscpy/scscp.py scscp/processing_instruction.py

@@ -0,0 +1,8 @@
+class SCSCPError(RuntimeError):
+    pass
+class SCSCPConnectionError(SCSCPError):
+    def __init__(self, msg, pi=None):
+        super(SCSCPConnectionError, self).__init__(msg)
+        self.pi = pi
+class SCSCPCancel(SCSCPError):
+    pass

scscp/scscp.py

@@ -0,0 +1,2 @@
+[bdist_wheel]
+universal=1

setup.cfg

@@ -0,0 +1,20 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='scscp',
+    version='0.1.0a1',
+    description='Implementation of the SCSCP protocol',
+    url='https://github.com/OpenMath/py-scscp',
+    author='Luca De Feo',
+    license='MIT',
+    classifiers=[
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Science/Research',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 3',
+    ],
+    keywords='openmath scscp',
+    packages=find_packages(),
+    install_requires=['openmath', 'pexpect'],
+)

setup.py

@@ -2,7 +2,7 @@
 import socket
 from threading import Thread
 
-from scscpy.client import SCSCPClient
+from scscp.client import SCSCPClient
 
 class TestConnInit(unittest.TestCase):
     def setUp(self):