allow caching custom function

Author: Licini

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* Allow caching custom function to cloud.
+
 ### Changed
 
 ### Removed

examples/cache_function.py

@@ -0,0 +1,33 @@
+from compas_cloud import Proxy
+from compas.geometry import Point
+
+
+p = Proxy()
+
+def move_point(point):
+    from compas.geometry import Translation
+    return point.transformed(Translation.from_vector([1, 0, 0]))
+
+
+# save the custom function to cloud
+# cache=True means the function will return a cache object instead of the actual data
+move_point_cloud = p.function(move_point, cache=True)
+
+# Cache the input object to cloud
+point = Point(0, 0, 0)
+point_cache = p.cache(point)
+
+# Call the function on cloud
+# In this case, both input and output are cached objects, which is not sent back to client unless explicitly requested 
+result_cache = move_point_cloud(point_cache)
+print(result_cache)
+result = p.get(result_cache)
+print(result)
+
+# The cached output object can then be used as input directly on cloud
+for i in range(3):
+    result_cache = move_point_cloud(result_cache)
+    print(result_cache)
+    result = p.get(result_cache)
+    print(result)
+

src/compas_cloud/proxy.py

@@ -119,20 +119,23 @@ def __init__(self, host='127.0.0.1', port=9009, background=True, errorHandler=No
     def package(self, function, cache=False):
         raise RuntimeError("Proxy.package() has been deprecated, please use Proxy.function() instead.")
 
-    def function(self, function, cache=False):
+    def function(self, package, cache=False):
         """returns wrapper of function that will be executed on server side"""
 
+        if callable(package):
+            package = self.cache(package)
+
         if self.errorHandler:
             @self.errorHandler
             @retry_if_exception(Exception, 5, wait=0.5)
             def run_function(*args, **kwargs):
-                return self.run(function, cache, *args, **kwargs)
+                return self.run(package, cache, *args, **kwargs)
 
             return run_function
         else:
             @retry_if_exception(Exception, 5, wait=0.5)
             def run_function(*args, **kwargs):
-                return self.run(function, cache, *args, **kwargs)
+                return self.run(package, cache, *args, **kwargs)
 
             return run_function
 

src/compas_cloud/server.py

@@ -66,10 +66,14 @@ def load_cached(self, data):
     def execute(self, data):
         """execute corresponding binded functions with received arguments"""
         package = data['package']
-        names = package.split('.')
-        name = '.'.join(names[:-1])
-        module = importlib.import_module(name)
-        function = getattr(module, names[-1])
+
+        if isinstance(package, dict):
+            function = self.cached[package['cached_func']]
+        else:
+            names = package.split('.')
+            name = '.'.join(names[:-1])
+            module = importlib.import_module(name)
+            function = getattr(module, names[-1])
 
         start = time.time()
         print('running:', package)