Merge pull request #1023 from compas-dev/proxy-add-location

Add optional search path to proxy

Author: tomvanmele

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added `Polyline.extend`, `Polyline.extended`, `Polyline.shorten`,  `Polyline.shortened`.
 * Added `Data.sha256` for computing a hash value of data objects, for example for comparisons during version control.
+* Added optional `path` parameter to `compas.rpc.Proxy` to allow for non-package calls.
 
 ### Changed
 

src/compas/rpc/dispatcher.py

@@ -86,13 +86,13 @@ def _dispatch(self, name, args):
             * `'profile'` : A profile of the function execution.
 
         """
-        odict = {
-            'data': None,
-            'error': None,
-            'profile': None
-        }
+        odict = {"data": None, "error": None, "profile": None}
 
-        parts = name.split('.')
+        if len(args) > 1:
+            if args[1] not in sys.path:
+                sys.path.insert(0, args[1])
+
+        parts = name.split(".")
 
         functionname = parts[-1]
 
@@ -110,21 +110,24 @@ def _dispatch(self, name, args):
             else:
                 module = self
         except Exception:
-            odict['error'] = traceback.format_exc()
+            odict["error"] = traceback.format_exc()
 
         else:
             try:
                 function = getattr(module, functionname)
             except AttributeError:
-                odict['error'] = "This function is not part of the API: {0}".format(functionname)
+                odict["error"] = "This function is not part of the API: {0}".format(
+                    functionname
+                )
 
             else:
                 try:
                     idict = json.loads(args[0], cls=DataDecoder)
                 except (IndexError, TypeError):
-                    odict['error'] = (
+                    odict["error"] = (
                         "API methods require a single JSON encoded dictionary as input.\n"
-                        "For example: input = json.dumps({'param_1': 1, 'param_2': [2, 3]})")
+                        "For example: input = json.dumps({'param_1': 1, 'param_2': [2, 3]})"
+                    )
 
                 else:
                     self._call(function, idict, odict)
@@ -148,21 +151,20 @@ def _call(self, function, idict, odict):
         The output dictionary will be modified in place.
 
         """
-        args = idict['args']
-        kwargs = idict['kwargs']
+        args = idict["args"]
+        kwargs = idict["kwargs"]
 
         try:
             data = function(*args, **kwargs)
         except Exception:
-            odict['error'] = traceback.format_exc()
+            odict["error"] = traceback.format_exc()
         else:
-            odict['data'] = data
+            odict["data"] = data
 
     def _call_wrapped(self, function, idict, odict):
-        """Does the same as _call, but with profiling enabled.
-        """
-        args = idict['args']
-        kwargs = idict['kwargs']
+        """Does the same as _call, but with profiling enabled."""
+        args = idict["args"]
+        kwargs = idict["kwargs"]
 
         try:
             profile = Profile()
@@ -178,7 +180,7 @@ def _call_wrapped(self, function, idict, odict):
             stats.print_stats(20)
 
         except Exception:
-            odict['error'] = traceback.format_exc()
+            odict["error"] = traceback.format_exc()
         else:
-            odict['data'] = data
-            odict['profile'] = stream.getvalue()
+            odict["data"] = data
+            odict["profile"] = stream.getvalue()

src/compas/rpc/proxy.py

@@ -98,7 +98,18 @@ class Proxy(object):
     Stopping the server proxy.                              # doctest: +SKIP
     """
 
-    def __init__(self, package=None, python=None, url='http://127.0.0.1', port=1753, service=None, max_conn_attempts=100, autoreload=True, capture_output=True):
+    def __init__(
+        self,
+        package=None,
+        python=None,
+        url="http://127.0.0.1",
+        port=1753,
+        service=None,
+        max_conn_attempts=100,
+        autoreload=True,
+        capture_output=True,
+        path=None,
+    ):
         self._package = None
         self._python = compas._os.select_python(python)
         self._url = url
@@ -108,6 +119,7 @@ def __init__(self, package=None, python=None, url='http://127.0.0.1', port=1753,
         self._process = None
         self._function = None
         self._profile = None
+        self._path = path
 
         self.service = service
         self.package = package
@@ -151,7 +163,7 @@ def service(self):
     @service.setter
     def service(self, service):
         if not service:
-            self._service = 'compas.rpc.services.default'
+            self._service = "compas.rpc.services.default"
         else:
             self._service = service
 
@@ -262,14 +274,25 @@ def start_server(self):
             self._process.StartInfo.RedirectStandardOutput = self.capture_output
             self._process.StartInfo.RedirectStandardError = self.capture_output
             self._process.StartInfo.FileName = self.python
-            self._process.StartInfo.Arguments = '-m {0} --port {1} --{2}autoreload'.format(self.service, self._port, '' if self.autoreload else 'no-')
+            self._process.StartInfo.Arguments = (
+                "-m {0} --port {1} --{2}autoreload".format(
+                    self.service, self._port, "" if self.autoreload else "no-"
+                )
+            )
             self._process.Start()
         else:
-            args = [self.python, '-m', self.service, '--port', str(self._port), '--{}autoreload'.format('' if self.autoreload else 'no-')]
+            args = [
+                self.python,
+                "-m",
+                self.service,
+                "--port",
+                str(self._port),
+                "--{}autoreload".format("" if self.autoreload else "no-"),
+            ]
             kwargs = dict(env=env)
             if self.capture_output:
-                kwargs['stdout'] = PIPE
-                kwargs['stderr'] = PIPE
+                kwargs["stdout"] = PIPE
+                kwargs["stderr"] = PIPE
 
             self._process = Popen(args, **kwargs)
         # this starts the client side
@@ -285,7 +308,11 @@ def start_server(self):
             except Exception:
                 time.sleep(0.1)
                 attempt_count += 1
-                print("    {} attempts left.".format(self.max_conn_attempts - attempt_count))
+                print(
+                    "    {} attempts left.".format(
+                        self.max_conn_attempts - attempt_count
+                    )
+                )
             else:
                 success = True
                 break
@@ -374,15 +401,15 @@ def _proxy(self, *args, **kwargs):
         Numpy objects are automatically converted to their built-in Python equivalents.
 
         """
-        idict = {'args': args, 'kwargs': kwargs}
+        idict = {"args": args, "kwargs": kwargs}
         istring = json.dumps(idict, cls=DataEncoder)
         # it makes sense that there is a broken pipe error
         # because the process is not the one receiving the feedback
         # when there is a print statement on the server side
         # this counts as output
         # it should be sent as part of RPC communication
         try:
-            ostring = self._function(istring)
+            ostring = self._function(istring, self._path or '')
         except Exception:
             # not clear what the point of this is
             # self.stop_server()
@@ -395,8 +422,8 @@ def _proxy(self, *args, **kwargs):
 
         result = json.loads(ostring, cls=DataDecoder)
 
-        if result['error']:
-            raise RPCServerError(result['error'])
+        if result["error"]:
+            raise RPCServerError(result["error"])
 
-        self.profile = result['profile']
-        return result['data']
+        self.profile = result["profile"]
+        return result["data"]