Add initial support for coroutines

- when a signal calls a Python function and it is a coroutine, it will be scheduled
(patch by Florian Link)

Author: mrbean-bremen

.github/workflows/dockerfiles/Dockerfile_centos7

@@ -25,7 +25,7 @@ WORKDIR work
 ARG QT_SELECT=qt5
 RUN uname -a; gcc --version | grep "gcc"; python --version; qmake-qt5 --version
 
-RUN qmake-qt5 -r PythonQt.pro \
+RUN qmake-qt5 DEFINES+=PYTHON2 -r PythonQt.pro \
     PYTHON_VERSION=$(python --version | cut -d " " -f 2 | cut -d "." -f1,2) \
     PYTHON_DIR=$(which python | xargs dirname | xargs dirname)
 

src/PythonQt.cpp

@@ -88,6 +88,16 @@ void PythonQt::init(int flags, const QByteArray& pythonQtModuleName)
       _self->_p->_pySourcelessFileLoader = importlib.getVariable("SourcelessFileLoader");
     }
 
+#ifndef PYTHON2
+    PythonQtObjectPtr asyncio;
+    asyncio.setNewRef(PyImport_ImportModule("asyncio"));
+    if (asyncio)
+    {
+      _self->_p->_pyEnsureFuture = asyncio.getVariable("ensure_future");
+      _self->_p->_pyFutureClass = asyncio.getVariable("Future");
+    }
+#endif
+
     PythonQt::priv()->setupSharedLibrarySuffixes();
 
     PythonQtMethodInfo::addParameterTypeAlias("QObjectList", "QList<QObject*>");
@@ -402,6 +412,46 @@ void PythonQtPrivate::setTaskDoneCallback(const PythonQtObjectPtr & callable)
   _pyTaskDoneCallback = callable;
 }
 
+PythonQtObjectPtr PythonQtPrivate::checkAndRunCoroutine(const PythonQtObjectPtr& object)
+{
+  PythonQtObjectPtr result;
+#ifndef PYTHON2
+  if (!PyCoro_CheckExact(object))
+  {
+    return result;
+  }
+
+  if (!_pyEnsureFuture)
+  {
+    std::cerr << "PythonQt: ensure_future not initialized" << std::endl;
+    return PythonQtObjectPtr();
+  }
+  PyObject* args = PyTuple_New(1);
+  PyObject* coro = object.object();
+  Py_INCREF(coro);
+  PyTuple_SetItem(args, 0, coro);
+  PyObject* r = PyObject_CallObject(_pyEnsureFuture, args);
+  result.setNewRef(r);
+  if (_pyTaskDoneCallback) {
+    PyObject* methodName = PyUnicode_FromString("add_done_callback");
+    PyObject_CallMethodObjArgs(r, methodName, _pyTaskDoneCallback.object(), nullptr);
+    Py_XDECREF(methodName);
+  }
+  Py_XDECREF(args);
+#endif
+  return result;
+}
+
+PythonQtObjectPtr PythonQtPrivate::createAsyncioFuture()
+{
+  if (!_pyFutureClass)
+  {
+    std::cerr << "PythonQt: _pyFutureClass not initialized" << std::endl;
+    return nullptr;
+  }
+  return _pyFutureClass.call();
+}
+
 void PythonQt::setRedirectStdInCallback(PythonQtInputChangedCB* callback, void * callbackData)
 {
   if (!callback) {

src/PythonQt.h

@@ -674,6 +674,12 @@ class PYTHONQT_EXPORT PythonQtPrivate : public QObject {
   //! created by checkAndRunCoroutine
   void setTaskDoneCallback(const PythonQtObjectPtr& callable);
 
+  //! Runs the given coroutine (via asyncio), returns a scheduled task if it object is a coroutine.
+  PythonQtObjectPtr checkAndRunCoroutine(const PythonQtObjectPtr& object);
+
+  //! Creates a new asyncio.Future object
+  PythonQtObjectPtr createAsyncioFuture();
+
   //! get the suffixes that are used for shared libraries
   const QStringList& sharedLibrarySuffixes() { return _sharedLibrarySuffixes; }
 
@@ -853,6 +859,8 @@ class PYTHONQT_EXPORT PythonQtPrivate : public QObject {
 
   PythonQtObjectPtr _pySourceFileLoader;
   PythonQtObjectPtr _pySourcelessFileLoader;
+  PythonQtObjectPtr _pyEnsureFuture;
+  PythonQtObjectPtr _pyFutureClass;
 
   PythonQtObjectPtr _pyTaskDoneCallback;
 

src/PythonQtSignalReceiver.cpp

@@ -55,6 +55,7 @@ void PythonQtSignalTarget::call(void **arguments) const {
   PYTHONQT_GIL_SCOPE
   PyObject* result = call(_callable, methodInfo(), arguments);
   if (result) {
+    PythonQt::priv()->checkAndRunCoroutine(result);
     Py_DECREF(result);
   }
 }