Merge pull request #1024 from compas-dev/new-rpc-component

Grasshopper component for RPC calls

Author: gonzalocasas

CHANGELOG.md

@@ -13,6 +13,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.
+* Added Grasshopper component to call RPC functions.
 
 ### Changed
 

src/compas_ghpython/components/Compas_RpcCall/code.py

@@ -0,0 +1,30 @@
+"""
+Remote Procedure Call: to invoke Python functions outside of Rhino, in the context of the CPython interpreter.
+"""
+from ghpythonlib.componentbase import executingcomponent as component
+
+from compas.rpc import Proxy
+
+
+class CompasRpcCall(component):
+    def RunScript(self, module, function, parameters, path, restart):
+        if not (module and function):
+            return
+
+        if restart:
+            proxy = Proxy(max_conn_attempts=1)
+            proxy.stop_server()
+
+        proxy = Proxy(module, path=path)
+        fn = getattr(proxy, function)
+        parameters = parameters or []
+
+        try:
+            result = fn(*parameters)
+        except Exception:
+            self.Message = "Error! Check details in stacktrace"
+            raise
+
+        self.Message = ""
+
+        return result

src/compas_ghpython/components/Compas_RpcCall/icon.png

@@ -0,0 +1,46 @@
+{
+    "name": "RPC Call",
+    "nickname": "RPC",
+    "category": "COMPAS",
+    "subcategory": "RPC",
+    "description": "Remote Procedure Call: to invoke Python functions outside of Rhino, in the context of the CPython interpreter.",
+    "exposure": 2,
+
+    "ghpython": {
+        "isAdvancedMode": true,
+        "iconDisplay": 2,
+        "inputParameters": [
+            {
+                "name": "module",
+                "description": "Module name to import.",
+                "typeHintID": "str"
+            },
+            {
+                "name": "function",
+                "description": "Function name to call.",
+                "typeHintID": "str"
+            },
+            {
+                "name": "parameters",
+                "description": "List of parameters to pass to the function.",
+                "scriptParamAccess": "list"
+            },
+            {
+                "name": "path",
+                "description": "Optional. Path where the module can be found (if not a pip installed module).",
+                "typeHintID": "str"
+            },
+            {
+                "name": "restart",
+                "description": "If True, try to restart the RPC server before calling it.",
+                "typeHintID": "bool"
+            }
+        ],
+        "outputParameters": [
+            {
+                "name": "result",
+                "description": "Return value of the function call."
+            }
+        ]
+    }
+}