PyObjectInterface 0.0.2__py3-none-any.whl → 0.1.0__py3-none-any.whl

PyObjectInterface/WebController.py

@@ -1,5 +1,6 @@
 from PyObjectInterface import PyObjectInterface
 from os import path
+import traceback
 import flask
 
 def generate_html(poi: PyObjectInterface, font_size=2.5):
@@ -17,6 +18,8 @@ def generate_html(poi: PyObjectInterface, font_size=2.5):
             className = 'py_' + stack
             elemID = className + '|' + arg_name
             buttons += f"<span class='input_label'>{arg_name}</span>"
+            if len(default) > 0 and default[0] == "'":
+                default = '"' + default[1:-1] + '"'
             buttons += f"<input id='{elemID}' class='{className}' value='{default}'>"
         if func_desc.desc is not None:
             desc = func_desc.desc.strip().replace('\n','<br>')
@@ -44,6 +47,15 @@ def generate_html(poi: PyObjectInterface, font_size=2.5):
     </details>
     """)
 
+def smart_arg_parse(x):
+    if x == 'None':
+        return None
+    if x[0] == '"' or x[0] == "'":
+        return x[1:-1] #strip trailing and leading quotes
+    if '.' in x:
+        return float(x)
+    return int(x)
+
 def create_WebController(obj, name, flask_app, recursion_depth = 5, create_private_interface=True):
     with open(path.dirname(__file__) + '/web_controller.tpl.html') as f:
         tpl = f.read()
@@ -57,12 +69,21 @@ def create_WebController(obj, name, flask_app, recursion_depth = 5, create_priva
 
         @flask_app.route(baseurl + '/call_method/<stack>', endpoint=baseurl + '_call_method')
         def call_method(stack):
-            kwargs = {argname: int(arg) for argname, arg in flask.request.args.items()} #TODO - better kwarg handling
-            retval = poi.call_method(stack, kwargs)
-            if retval is None:
-                return "OK"
-            else:
-                return retval
+            kwargs = {argname: smart_arg_parse(arg) for argname, arg in flask.request.args.items()}
+
+            try:
+                retval = poi.call_method(stack, kwargs)
+                if retval is None:
+                    return ''
+                else:
+                    return str(retval)
+            except (Exception,):
+                traces = traceback.format_exc().split('\n')
+                for i in range(6):
+                    traces.pop(1) #remove the webcontroller call from the trace
+                trace = '\n'.join(traces)
+                return "Internal Error:\n" + trace
+
 
         @flask_app.route(baseurl + '/get_attributes', endpoint=baseurl + '_get_attributes')
         def get_attributes():

PyObjectInterface/examples/example.py

@@ -0,0 +1,8 @@
+from PyObjectInterface.WebController import create_WebController
+from robot import Robot
+import flask
+
+app = flask.Flask('Demo')
+robot = Robot()
+create_WebController(robot, 'robot', app)
+app.run()

PyObjectInterface/examples/robot.py

@@ -0,0 +1,31 @@
+class DriveMotor:
+    def __init__(self, pin):
+        self.pin = pin
+        self.speed = 0
+
+    def forward(self):
+        self.speed = 50
+
+    def stop(self):
+        self.speed = 0
+
+class Robot:
+    def __init__(self):
+        self.left_motor = DriveMotor(1)
+        self.right_motor = DriveMotor(2)
+
+    def forward(self):
+        self.left_motor.forward()
+        self.right_motor.forward()
+
+    def stop(self):
+        self.left_motor.stop()
+        self.right_motor.stop()
+
+    def left(self):
+        self.left_motor.stop()
+        self.right_motor.forward()
+
+    def right(self):
+        self.left_motor.forward()
+        self.right_motor.stop()

PyObjectInterface/web_controller.tpl.html

@@ -92,18 +92,21 @@
   }
 
   function call_method_handler(retval) {
-    console.log(retval) //#TODO - handle this
+    if (retval != '') {
+      console.log(retval);
+      alert(retval);
+    }
   }
 
   function call_method(stack) {
-    var elems = document.getElementsByClassName("py_" + stack)
-    url = new URL(location.href + '/call_method/' + stack)
+    var elems = document.getElementsByClassName("py_" + stack);
+    url = new URL(location.href + '/call_method/' + stack);
 
     for (var e of elems) {
       url.searchParams.append(e.id.split('|')[1], e.value);
     }
-
-    get_request_async(url, call_method_handler)
+    console.log("Calling " + url);
+    get_request_async(url, call_method_handler);
   }
 
   function update_vars(json) {
@@ -116,10 +119,10 @@
   }
 
   function update_vars_async() {
-    get_request_async(location.href + '/get_attributes', update_vars)
+    get_request_async(location.href + '/get_attributes', update_vars);
   }
 
-  setInterval(update_vars_async, 500)
+  setInterval(update_vars_async, 500);
   update_vars_async();
 </script>
 

PyObjectInterface-0.1.0.dist-info/METADATA

@@ -0,0 +1,79 @@
+Metadata-Version: 2.1
+Name: PyObjectInterface
+Version: 0.1.0
+Summary: Create a web interface to interact with a class
+Home-page: https://github.com/RobertJN64/PyObjectInterface
+Author: Robert Nies
+Author-email: robertjnies@gmail.com
+License: MIT
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing-extensions
+Requires-Dist: flask
+
+# PyObjectInterface
+
+![Tests Badge](https://github.com/RobertJN64/PyObjectInterface/actions/workflows/tests.yml/badge.svg)
+![Python Version Badge](https://img.shields.io/pypi/pyversions/PyObjectInterface)
+![License Badge](https://img.shields.io/github/license/RobertJN64/PyObjectInterface)
+
+Quickly control any python object through an async web interface.
+
+`pip install PyObjectInterface`
+```python
+from PyObjectInterface.WebController import create_WebController
+import flask
+
+app = flask.Flask('Demo')
+any_python_object = ...
+create_WebController(any_python_object, 'any_python_object', app)
+app.run()
+```
+
+Go to `http://127.0.0.1:5000/webcontroller`
+
+## Example: Async Robot Control
+![async_robot_control.png](async_robot_control.png)
+
+The above interface was automatically created from:
+```python
+class DriveMotor:
+    def __init__(self, pin):
+        self.pin = pin
+        self.speed = 0
+
+    def forward(self): ...
+    def stop(self): ...
+
+class Robot:
+    def __init__(self):
+        self.left_motor = DriveMotor(1)
+        self.right_motor = DriveMotor(2)
+
+    def forward(self): ...
+    def stop(self): ...
+    def left(self): ...
+    def right(self): ...
+```
+
+Look at [PyObjectInterface/examples/example.py](PyObjectInterface/examples/example.py) for more information.
+
+## Advanced Usage and Settings
+
+You can use PyObjectInterface without the WebController.
+
+### create_WebController
+ - `obj`: Any python object
+ - `name: str`: Friendly name for object, generally the name of the variable that refers to the object
+ - `flask_app`: return value of flask.Flask()
+ - `recursion_depth = 5`: maximum layers of subobjects to include
+ - `create_private_interface = True`: if `True` creates a `/webcontroller/private` page that includes private methods and attributes

PyObjectInterface-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+PyObjectInterface/WebController.py,sha256=YMQSaugLIKEwDxHkPTGjD4zAuIjk4X0ANf_UxtbSAbU,3820
+PyObjectInterface/__init__.py,sha256=4524Z5al5Bwx4EsmPW7UldGaexNUMGCv0cldb3uobuQ,3674
+PyObjectInterface/web_controller.tpl.html,sha256=KiNOmUGwsyAmkV9yol2X15G6uoAPjf2JHa6tnoCe_kw,2432
+PyObjectInterface/examples/example.py,sha256=QhAcJJnh6LU923TL7MHwYU5keur1hgfn7Elt5nh8c-E,196
+PyObjectInterface/examples/robot.py,sha256=qvDhIwvCtseA0AlEdZbR7RJkpbOMMw0F1C3UWNMs--M,655
+PyObjectInterface-0.1.0.dist-info/LICENSE,sha256=_UXYaTVmtWrJCpKEgCz66EUsoFfLfn0CY4mEmuI5_zA,1054
+PyObjectInterface-0.1.0.dist-info/METADATA,sha256=qtK66t-YQGBfpofNpMDFhVWuMxhujmu64YFVYlRH7PY,2559
+PyObjectInterface-0.1.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+PyObjectInterface-0.1.0.dist-info/top_level.txt,sha256=5kOSl8l5D5IGWoWz9nkn_lQispA3D8qyPM9SvIC4LSU,18
+PyObjectInterface-0.1.0.dist-info/RECORD,,

{PyObjectInterface-0.0.2.dist-info → PyObjectInterface-0.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.3)
+Generator: bdist_wheel (0.42.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

PyObjectInterface-0.0.2.dist-info/METADATA

@@ -1,29 +0,0 @@
-Metadata-Version: 2.1
-Name: PyObjectInterface
-Version: 0.0.2
-Summary: Create a web interface to interact with a class
-Home-page: https://github.com/RobertJN64/PyObjectInterface
-Author: Robert Nies
-Author-email: robertjnies@gmail.com
-License: MIT
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: typing-extensions
-Requires-Dist: flask
-
-# PyObjectInterface
-
-![Tests Badge](https://github.com/RobertJN64/PyObjectInterface/actions/workflows/tests.yml/badge.svg)
-![Python Version Badge](https://img.shields.io/pypi/pyversions/PyObjectInterface)
-![License Badge](https://img.shields.io/github/license/RobertJN64/PyObjectInterface)
-
-`#TODO - good desc`

PyObjectInterface-0.0.2.dist-info/RECORD

@@ -1,8 +0,0 @@
-PyObjectInterface/WebController.py,sha256=_7J3iHyEvG4sttKYkr1w9pGcLDk8PI15MM7IGCWXeDA,3154
-PyObjectInterface/__init__.py,sha256=4524Z5al5Bwx4EsmPW7UldGaexNUMGCv0cldb3uobuQ,3674
-PyObjectInterface/web_controller.tpl.html,sha256=hc77J32kMO3S9EQ3VofI9bCO_0m8yCavROxWc1MmHmw,2361
-PyObjectInterface-0.0.2.dist-info/LICENSE,sha256=_UXYaTVmtWrJCpKEgCz66EUsoFfLfn0CY4mEmuI5_zA,1054
-PyObjectInterface-0.0.2.dist-info/METADATA,sha256=lyl0iU6MlOqCHNjuAHgwv973_ucVFa3KvgeB98ERCA8,1097
-PyObjectInterface-0.0.2.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-PyObjectInterface-0.0.2.dist-info/top_level.txt,sha256=5kOSl8l5D5IGWoWz9nkn_lQispA3D8qyPM9SvIC4LSU,18
-PyObjectInterface-0.0.2.dist-info/RECORD,,