diff src/plugins/plugin_misc_debug.py @ 2037:0f485f1d627d

plugin debug: first draft: this plugin implement some helper tools/bridge method to make development and debugging easier. The first implemented bridge method, debugFakeSignal, allow to send a signal from the backend, simulating some events in the frontends.
author Goffi <goffi@goffi.org>
date Sun, 21 Aug 2016 12:23:09 +0200
parents
children 33c8c4973743
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/plugins/plugin_misc_debug.py	Sun Aug 21 12:23:09 2016 +0200
@@ -0,0 +1,61 @@
+#!/usr/bin/env python2
+# -*- coding: utf-8 -*-
+
+# SàT plugin for managing raw XML log
+# Copyright (C) 2009-2016  Jérôme Poisson (goffi@goffi.org)
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# 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 Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from sat.core.i18n import _
+from sat.core.log import getLogger
+log = getLogger(__name__)
+from sat.core.constants import Const as C
+import json
+
+PLUGIN_INFO = {
+    "name": "Debug Plugin",
+    "import_name": "DEBUG",
+    "type": "Misc",
+    "protocols": [],
+    "dependencies": [],
+    "main": "Debug",
+    "handler": "no",
+    "description": _("""Set of method to make development and debugging easier""")
+}
+
+
+class Debug(object):
+
+    def __init__(self, host):
+        log.info(_("Plugin Debug initialization"))
+        self.host = host
+        host.bridge.addMethod("debugFakeSignal", ".plugin", in_sign='sss', out_sign='', method=self._fakeSignal)
+
+
+    def _fakeSignal(self, signal, arguments, profile_key):
+        """send a signal from backend
+
+        @param signal(str): name of the signal
+        @param arguments(unicode): json encoded list of arguments
+        @parm profile_key(unicode): profile_key to use or C.PROF_KEY_NONE if profile is not needed
+        """
+        args = json.loads(arguments)
+        method = getattr(self.host.bridge, signal)
+        if profile_key != C.PROF_KEY_NONE:
+            profile = self.host.memory.getProfileName(profile_key)
+            args.append(profile)
+        method(*args)
+
+
+