From 1b77fc5931bf14b2a9e936a8d08334d9e00ffe7e Mon Sep 17 00:00:00 2001 From: Cristian Maureira-Fredes Date: Tue, 8 Jan 2019 17:15:24 +0100 Subject: Add support for parameterNames in Signals There were many uses cases when a proper interaction between Python and Qml was needed, one of them was the case to emit signals from Python an get those values via an argument name in QML. A simple example describing this situation can be found in PYSIDE-634: Python: sumResult = Signal(int, arguments=["sum"]) sumResult.emit(42) Qml: onSumResult: console.log(sum) // will print 42 A test case based on the same example was added. Change-Id: I0908f97d88eaadc0c02d81bc4daca936f72f6c6a Fixes: PYSIDE-634 Reviewed-by: Christian Tismer --- sources/pyside2/libpyside/dynamicqmetaobject.cpp | 13 ++++- sources/pyside2/libpyside/pysidesignal.cpp | 23 +++++++- sources/pyside2/libpyside/pysidesignal_p.h | 3 +- sources/pyside2/tests/QtQml/CMakeLists.txt | 1 + sources/pyside2/tests/QtQml/signal_arguments.py | 67 ++++++++++++++++++++++++ sources/pyside2/tests/QtQml/signal_arguments.qml | 59 +++++++++++++++++++++ 6 files changed, 161 insertions(+), 5 deletions(-) create mode 100755 sources/pyside2/tests/QtQml/signal_arguments.py create mode 100644 sources/pyside2/tests/QtQml/signal_arguments.qml (limited to 'sources/pyside2') diff --git a/sources/pyside2/libpyside/dynamicqmetaobject.cpp b/sources/pyside2/libpyside/dynamicqmetaobject.cpp index c5de54aa0..857d242a2 100644 --- a/sources/pyside2/libpyside/dynamicqmetaobject.cpp +++ b/sources/pyside2/libpyside/dynamicqmetaobject.cpp @@ -467,8 +467,17 @@ void MetaObjectBuilderPrivate::parsePythonType(PyTypeObject *type) data->data->signalName = Shiboken::String::toCString(key); for (const auto &s : data->data->signatures) { const auto sig = data->data->signalName + '(' + s.signature + ')'; - if (m_baseObject->indexOfSignal(sig) == -1) - m_builder->addSignal(sig); + if (m_baseObject->indexOfSignal(sig) == -1) { + // Registering the parameterNames to the QMetaObject (PYSIDE-634) + // from: + // Signal(..., arguments=['...', ...] + // the arguments are now on data-data->signalArguments + if (!data->data->signalArguments->isEmpty()) { + m_builder->addSignal(sig).setParameterNames(*data->data->signalArguments); + } else { + m_builder->addSignal(sig); + } + } } } } diff --git a/sources/pyside2/libpyside/pysidesignal.cpp b/sources/pyside2/libpyside/pysidesignal.cpp index 169028f0c..47a5fff43 100644 --- a/sources/pyside2/libpyside/pysidesignal.cpp +++ b/sources/pyside2/libpyside/pysidesignal.cpp @@ -203,14 +203,15 @@ PyTypeObject *PySideSignalInstanceTypeF(void) int signalTpInit(PyObject *self, PyObject *args, PyObject *kwds) { static PyObject *emptyTuple = nullptr; - static const char *kwlist[] = {"name", nullptr}; + static const char *kwlist[] = {"name", "arguments", nullptr}; char *argName = nullptr; + PyObject *argArguments = nullptr; if (emptyTuple == 0) emptyTuple = PyTuple_New(0); if (!PyArg_ParseTupleAndKeywords(emptyTuple, kwds, - "|s:QtCore." SIGNAL_CLASS_NAME, const_cast(kwlist), &argName)) + "|sO:QtCore." SIGNAL_CLASS_NAME, const_cast(kwlist), &argName, &argArguments)) return 0; bool tupledArgs = false; @@ -220,6 +221,24 @@ int signalTpInit(PyObject *self, PyObject *args, PyObject *kwds) if (argName) data->data->signalName = argName; + data->data->signalArguments = new QByteArrayList(); + if (argArguments && PySequence_Check(argArguments)) { + Py_ssize_t argument_size = PySequence_Size(argArguments); + for (Py_ssize_t i = 0; i < argument_size; ++i) { + PyObject *item = PySequence_GetItem(argArguments, i); +#ifdef IS_PY3K + PyObject *strObj = PyUnicode_AsUTF8String(item); + char *s = PyBytes_AsString(strObj); + Py_DECREF(strObj); +#else + char *s = PyBytes_AsString(item); +#endif + Py_DECREF(item); + if (s != nullptr) + data->data->signalArguments->append(QByteArray(s)); + } + } + for (Py_ssize_t i = 0, i_max = PyTuple_Size(args); i < i_max; i++) { PyObject *arg = PyTuple_GET_ITEM(args, i); if (PySequence_Check(arg) && !Shiboken::String::check(arg)) { diff --git a/sources/pyside2/libpyside/pysidesignal_p.h b/sources/pyside2/libpyside/pysidesignal_p.h index a5cd67f66..8027f4459 100644 --- a/sources/pyside2/libpyside/pysidesignal_p.h +++ b/sources/pyside2/libpyside/pysidesignal_p.h @@ -55,6 +55,7 @@ struct PySideSignalData QByteArray signalName; QVector signatures; + QByteArrayList *signalArguments; }; extern "C" @@ -64,7 +65,7 @@ extern "C" struct PySideSignal { PyObject_HEAD PySideSignalData *data; - PyObject* homonymousMethod; + PyObject *homonymousMethod; }; struct PySideSignalInstance; diff --git a/sources/pyside2/tests/QtQml/CMakeLists.txt b/sources/pyside2/tests/QtQml/CMakeLists.txt index 8460a8f0b..e2beb951e 100755 --- a/sources/pyside2/tests/QtQml/CMakeLists.txt +++ b/sources/pyside2/tests/QtQml/CMakeLists.txt @@ -18,3 +18,4 @@ PYSIDE_TEST(registertype.py) PYSIDE_TEST(javascript_exceptions.py) PYSIDE_TEST(qqmlincubator_incubateWhile.py) PYSIDE_TEST(qquickitem_grabToImage.py) +PYSIDE_TEST(signal_arguments.py) diff --git a/sources/pyside2/tests/QtQml/signal_arguments.py b/sources/pyside2/tests/QtQml/signal_arguments.py new file mode 100755 index 000000000..096fa6882 --- /dev/null +++ b/sources/pyside2/tests/QtQml/signal_arguments.py @@ -0,0 +1,67 @@ +############################################################################# +## +## Copyright (C) 2019 The Qt Company Ltd. +## Contact: https://www.qt.io/licensing/ +## +## This file is part of the test suite of Qt for Python. +## +## $QT_BEGIN_LICENSE:GPL-EXCEPT$ +## Commercial License Usage +## Licensees holding valid commercial Qt licenses may use this file in +## accordance with the commercial license agreement provided with the +## Software or, alternatively, in accordance with the terms contained in +## a written agreement between you and The Qt Company. For licensing terms +## and conditions see https://www.qt.io/terms-conditions. For further +## information use the contact form at https://www.qt.io/contact-us. +## +## GNU General Public License Usage +## Alternatively, this file may be used under the terms of the GNU +## General Public License version 3 as published by the Free Software +## Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT +## included in the packaging of this file. Please review the following +## information to ensure the GNU General Public License requirements will +## be met: https://www.gnu.org/licenses/gpl-3.0.html. +## +## $QT_END_LICENSE$ +## +############################################################################# + +import unittest +from helper import adjust_filename, TimedQApplication +from PySide2.QtQuick import QQuickView +from PySide2.QtCore import QObject, Signal, Slot, QUrl, QTimer, Property + +class Obj(QObject): + def __init__(self): + QObject.__init__(self) + self.value = 0 + + sumResult = Signal(int, name="sumResult", arguments=['sum']) + + @Slot(int, int) + def sum(self, arg1, arg2): + self.sumResult.emit(arg1 + arg2) + + @Slot(str) + def sendValue(self, s): + self.value = int(s) + + +class TestConnectionWithQml(TimedQApplication): + + def testSignalArguments(self): + view = QQuickView() + obj = Obj() + + context = view.rootContext() + context.setContextProperty("o", obj) + view.setSource(QUrl.fromLocalFile(adjust_filename('signal_arguments.qml', __file__))) + root = view.rootObject() + self.assertTrue(root) + button = root.findChild(QObject, "button") + view.show() + button.clicked.emit() + self.assertEqual(obj.value, 42) + +if __name__ == '__main__': + unittest.main() diff --git a/sources/pyside2/tests/QtQml/signal_arguments.qml b/sources/pyside2/tests/QtQml/signal_arguments.qml new file mode 100644 index 000000000..0c65b947f --- /dev/null +++ b/sources/pyside2/tests/QtQml/signal_arguments.qml @@ -0,0 +1,59 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the test suite of Qt for Python. +** +** $QT_BEGIN_LICENSE:GPL-EXCEPT$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3 as published by the Free Software +** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-3.0.html. +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + + +import QtQuick 2.5 +import QtQuick.Controls 1.4 +import QtQuick.Layouts 1.2 + +Rectangle { + visible: true + GridLayout { + Button { + id: "button" + objectName: "button" + text: "sum!" + onClicked: { + o.sum(40, 2) + } + } + Text { + id: sumResultText + } + } + Connections { + target: o + onSumResult: { + // set the value on the Qml side + sumResultText.text = sum + // set internal Python value from the already + // modified value + o.sendValue(sumResultText.text) + } + } +} -- cgit v1.2.3