Merge lp:~kissiel/checkbox/use-pyotherside1.4 into lp:checkbox

[Maciej Kisielewski]

Migration from PythonObjectHandle to PythonObjectRef (pyotherside-1.4)

[lp:~kissiel/checkbox/use-pyotherside1.4]

3811. By Maciej Kisielewski on 2015-05-27

checkbox-touch: add PythonObjectRef component

This patch adds qml component that handles referencing python objects from qml
side.

Signed-off-by: Maciej Kisielewski <email address hidden>

3812. By Maciej Kisielewski on 2015-05-27

checkbox-touch: migrate CheckboxTouchApplication class to PythonObjectRef

This patch moves main CheckboxTouchApplication class to be used through
PythonObjectRef from QML side.

3813. By Maciej Kisielewski on 2015-05-27

checkbox-touch: migrate PythonLogger to PythonObjectRef

Signed-off-by: Maciej Kisielewski <email address hidden>

3814. By Maciej Kisielewski on 2015-05-27

checkbox-touch: remove PythonObjectHandle

Signed-off-by: Maciej Kisielewski <email address hidden>

[Zygmunt Krynicki (zyga)]

Looks good, thanks for changing this. +1

review: Approve

=== modified file 'checkbox-touch/checkbox-touch.qml'
--- checkbox-touch/checkbox-touch.qml	2015-05-20 07:56:01 +0000
+++ checkbox-touch/checkbox-touch.qml	2015-05-27 06:52:22 +0000
@@ -23,7 +23,7 @@
 import Ubuntu.Components 1.1
 import Ubuntu.Components.Popups 0.1
 import QtQuick.Layouts 1.1
-import io.thp.pyotherside 1.2
+import io.thp.pyotherside 1.4
 import "components"
 import "components/ErrorLogic.js" as ErrorLogic
 import "components/CbtDialogLogic.js" as CbtDialogLogic
@@ -110,9 +110,7 @@
             // create_app_object() function and assign the resulting handle
             // back to the application component.
             py.importModule("checkbox_touch", function() {
-                call("checkbox_touch.create_app_object", [], function(handle) {
-                    app.handle = handle;
-                });
+                app.construct("checkbox_touch.create_app_object", [])
             });
         }
         onError: {
@@ -146,9 +144,7 @@
         Component.onCompleted: {
             py.Component.onCompleted.connect(function() {
                 py.importModule("checkbox_touch", function() {
-                    py.call("checkbox_touch.get_qml_logger", [], function(handle) {
-                        logger.handle = handle;
-                    });
+                    construct("checkbox_touch.get_qml_logger", []);
                 });
             });
         }
 
=== modified file 'checkbox-touch/components/CheckboxTouchApplication.qml'
--- checkbox-touch/components/CheckboxTouchApplication.qml	2015-05-12 09:58:35 +0000
+++ checkbox-touch/components/CheckboxTouchApplication.qml	2015-05-27 06:52:22 +0000
@@ -1,10 +1,11 @@
 /*
  * This file is part of Checkbox
  *
- * Copyright 2014 Canonical Ltd.
+ * Copyright 2014-2015 Canonical Ltd.
  *
  * Authors:
  * - Zygmunt Krynicki <[e-mail]>
+ * - Maciej Kisielewski <[e-mail]>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -24,7 +25,7 @@
 import "ErrorLogic.js" as ErrorLogic
 
 
-PythonObjectHandle {
+PythonObjectRef {
     id: app
     // Version of the application
     property string applicationVersion
@@ -37,7 +38,7 @@
     signal appReady();
 
     // Signal sent when a session becomes ready
-    signal sessionReady();
+    signal sessionReady()
 
     // Create a new session
     //
@@ -168,7 +169,7 @@
 
     // Internal handler that triggers a call to python to query for runtime and
     // application versions.
-    onHandleReady: {
+    onObjectReady: {
         request("get_version_pair", [], function(result) {
             app.applicationVersion = result.application_version;
             app.plainboxVersion = result.plainbox_version;
 
=== modified file 'checkbox-touch/components/PythonLogger.qml'
--- checkbox-touch/components/PythonLogger.qml	2015-02-09 14:19:45 +0000
+++ checkbox-touch/components/PythonLogger.qml	2015-05-27 06:52:22 +0000
@@ -20,7 +20,7 @@
  */
 
 /*! \brief Python-driven logger
-    \inherits PythonObjectHandle
+    \inherits PythonObjectRef
 
     This component uses pyotherside to forward logging events to python.
     It monkey-patches console.log and console.error to capture their calls
@@ -28,7 +28,8 @@
 */
 import QtQuick 2.0
 
-PythonObjectHandle {
+PythonObjectRef {
+    id: pythonLogger
 
     function debug(msg) {
         invoke('debug', [msg], function() {});
@@ -63,13 +64,18 @@
 
     /** Overridden invoke that doesn't log invoke calls */
     function invoke(func, args, callback) {
-        if (py !== null && handle > 0) {
-            py.call("py_invoke", [handle, func, args], function(response) {
+        if (py !== null && object !== null) {
+            var callable = py.getattr(object, func);
+            if (!callable) {
+                console.error("Unable to invoke " + func + " on python logger");
+                throw "trying to invoke not existing method"
+            }
+            py.call(callable, args, function(response) {
                 callback(response);
             });
         } else {
-            _original_console_error("unable to py_invoke: " + handle + ", " + func + ", " + JSON.stringify(args));
-            throw "py_invoke called without ready py and handle";
+            _original_console_error("unable to invoke " + func + " on python logger");
+            throw "invoke called without py initiated and/or object constructed";
         }
     }
 
@@ -79,7 +85,7 @@
         _original_console_error = console.error;
     }
 
-    onHandleReady: {
+    onObjectReady: {
         /* monkey-patch console.log and console.error */
         console.log = function() { debug(_argsToString(arguments)); };
         console.error = function() { error(_argsToString(arguments)); };
 
=== removed file 'checkbox-touch/components/PythonObjectHandle.qml'
--- checkbox-touch/components/PythonObjectHandle.qml	2014-09-29 19:18:47 +0000
+++ checkbox-touch/components/PythonObjectHandle.qml	1970-01-01 00:00:00 +0000
@@ -1,76 +0,0 @@
-/*
- * This file is part of Checkbox
- *
- * Copyright 2014 Canonical Ltd.
- *
- * Authors:
- * - Zygmunt Krynicki <[e-mail]>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-import QtQuick 2.0
-
-
-QtObject {
-    // Reference to pyotherside's Python object
-    property var py: null
-    // Handle to a python object (via RemoteObjectLifecycleManager)
-    // if it is < 0 then it is an error of some kind
-    // if it is 0 (default) then the handle is just invalid
-    // if it is > 0 then it represents a valid object handle
-    property int handle: 0
-    // Flag set just prior to sending the handleReady() signal
-    property bool _ready: false
-
-    // Signal sent when the handle is initially assigned *and* py is already
-    // assigned (so when the python object is ready to be interacted with)
-    signal handleReady();
-
-    // Dereference the python object when we are shutting down
-    Component.onDestruction: _unref()
-    // Maybe send the handleReady signal (once) when handle is changed
-    onHandleChanged: _maybeReady()
-    // Maybe send the handleReady signal (once) when 'py' is changed
-    onPyChanged: _maybeReady()
-
-    /** Send the handleReady() signal (once) if both py and handle are ready */
-    function _maybeReady() {
-        if (handle > 0 && py !== null && _ready == false) {
-            _ready = true;
-            handleReady()
-        }
-    }
-
-    /** Dereference this object */
-    function _unref() {
-        if (py !== null && handle > 0) {
-            // console.log("py_unref: " + handle);
-            py.call("py_unref", [handle]);
-            handle = 0;
-        }
-    }
-
-    /** Call a method on this object */
-    function invoke(func, args, callback) {
-        if (py !== null && handle > 0) {
-            console.log("py_invoke(" + handle + ", " + func + ", " + JSON.stringify(args) + ") ...");
-            py.call("py_invoke", [handle, func, args], function(response) {
-                console.log("py_invoke(" + handle + ", " + func + ", " + JSON.stringify(args) + ") -> " + JSON.stringify(response));
-                callback(response);
-            });
-        } else {
-            console.error("unable to py_invoke: " + handle + ", " + func + ", " + JSON.stringify(args));
-            throw "py_invoke called without ready py and handle";
-        }
-    }
-}
 
=== added file 'checkbox-touch/components/PythonObjectRef.qml'
--- checkbox-touch/components/PythonObjectRef.qml	1970-01-01 00:00:00 +0000
+++ checkbox-touch/components/PythonObjectRef.qml	2015-05-27 06:52:22 +0000
@@ -0,0 +1,69 @@
+/*
+ * This file is part of Checkbox
+ *
+ * Copyright 2015 Canonical Ltd.
+ *
+ * Authors:
+ * - Maciej Kisielewski <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+import QtQuick 2.0
+
+
+QtObject {
+    id: pythonObjectRef
+
+    // Reference to pyotherside's Python object
+    property var py: null
+
+    // PyObjectRef to the object
+    property var object: null
+
+    // Signal sent when the object reference is ready to use
+    signal objectReady()
+
+    // Creation method name that were used to get the reference to the object
+    property var creationMethodName: null
+
+    function construct(creationMethodName, args) {
+        if (!py) {
+            console.error("Trying to get reference to python object without py initiated!");
+        } else {
+            console.info("Getting reference to python object via " + creationMethodName);
+            py.call(creationMethodName, args, function(result) {
+                object = result;
+                pythonObjectRef.creationMethodName = creationMethodName;
+                objectReady();
+            });
+        }
+    }
+    /** Call a method on this object */
+    function invoke(func, args, callback) {
+        if (py !== null && object !== null) {
+            console.log("invoking " + func + " on object created with" + pythonObjectRef.creationMethodName + ", with args: " + JSON.stringify(args) + " ...");
+            var callable = py.getattr(object, func);
+            if (!callable) {
+                console.log("Unable to invoke " + func + " on object " + JSON.stringify(pythonObjectRef));
+                throw "trying to invoke inexistent method"
+            }
+            py.call(callable,  args, function(response) {
+                console.log(func + " on object created with" + pythonObjectRef.creationMethodName + ", with args: " + JSON.stringify(args) + " returned: " + JSON.stringify(response));
+                callback(response);
+            });
+        } else {
+            console.error("Unable to invoke " + func + " on object " + JSON.stringify(pythonObjectRef));
+            throw "invoke called without py initiated and/or object constructed";
+        }
+    }
+}
 
=== modified file 'checkbox-touch/py/checkbox_touch.py'
--- checkbox-touch/py/checkbox_touch.py	2015-05-18 11:20:02 +0000
+++ checkbox-touch/py/checkbox_touch.py	2015-05-27 06:52:22 +0000
@@ -65,72 +65,9 @@
 from embedded_providers import EmbeddedProvider1PlugInCollection
 
 _logger = logging.getLogger('checkbox.touch')
-_manager = None
-
-
-class VerboseLifecycle:
-    """
-    Mix-in class for verbose lifecycle reporting
-    """
-
-    def __new__(cls, *args, **kwargs):
-        self = super().__new__(cls, *args, **kwargs)
-        _logger.debug("new %s %x", cls.__name__, id(self))
-        return self
-
-    def __del__(self):
-        _logger.debug("del %s %x", self.__class__.__name__, id(self))
-
-
-class RemoteObjectLifecycleManager(VerboseLifecycle):
-    """
-    Remote object life-cycle manager
-
-    This class aids in handling non-trivial objects that are referenced from
-    QML (via pyotherside) but really stored on the python side.
-    """
-
-    def __init__(self):
-        self._count = 0
-        self._handle_map = {}
-
-    def unref(self, handle: int):
-        """
-        Remove a reference represented by the specified handle
-        """
-        _logger.debug("unref %s", handle)
-        del self._handle_map[handle]
-
-    def ref(self, obj: object) -> int:
-        """
-        Store a reference to an object and return the handle
-        """
-        self._count += 1
-        handle = self._count
-        self._handle_map[handle] = obj
-        _logger.debug("ref %r -> %s", obj, handle)
-        return handle
-
-    def invoke(self, handle: int, func: str, args):
-        """
-        Call a method on a object represented by the handle
-
-        :param handle:
-            A (numeric) handle to the objecet
-        :param func:
-            The (name of the) function to call
-        :param args:
-            A list of positional arguments to pass
-        :returns:
-            The value returned by the called method
-        """
-        obj = self._handle_map[handle]
-        impl = getattr(obj, func)
-        retval = impl(*args)
-        return retval
-
-
-class PlainboxApplication(VerboseLifecycle, metaclass=abc.ABCMeta):
+
+
+class PlainboxApplication(metaclass=abc.ABCMeta):
     """
     Base class for plainbox-based applications.
 
@@ -141,16 +78,6 @@
     def __repr__(self):
         return "<{}>".format(self.__class__.__name__)
 
-    @classmethod
-    def create_and_get_handle(cls):
-        """
-        Create an instance of the high-level PlainBox object
-
-        :returns:
-            A handle to a fresh instance of :class:`PlainBox`
-        """
-        return _manager.ref(cls())
-
     @abc.abstractmethod
     def get_version_pair(self):
         """
@@ -820,27 +747,8 @@
         self._password = password
 
 
-def bootstrap():
-    logging.basicConfig(level=logging.INFO, stream=sys.stderr)
-    logging.info("environ: %r", os.environ)
-    logging.info("path: %r", sys.path)
-    # from plainbox.impl.logging import adjust_logging
-    # from plainbox.impl.logging import setup_logging
-    # Setup logging
-    # setup_logging()
-    # adjust_logging(logging.DEBUG, ['checkbox.stack'], True)
-    # Create the Javascript <=> Python remote object lifecycle manager
-    manager = RemoteObjectLifecycleManager()
-    # Expose top-level functions for pyotherside's simplicity
-    builtins.py_ref = manager.ref
-    builtins.py_unref = manager.unref
-    builtins.py_invoke = manager.invoke
-    return manager
-
-
 def get_qml_logger():
-    return _manager.ref(logging.getLogger('checkbox.touch.qml'))
-
-
-create_app_object = CheckboxTouchApplication.create_and_get_handle
-_manager = bootstrap()
+    return logging.getLogger('checkbox.touch.qml')
+
+
+create_app_object = CheckboxTouchApplication