/* * * Copyright (C) 2010 MeVis Medical Solutions AG All Rights Reserved. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library 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 * Lesser General Public License for more details. * * Further, this software is distributed without any warranty that it is * free of the rightful claim of any third person regarding infringement * or the like. Any license provided herein, whether implied or * otherwise, applies only to this software file. Patent licenses, if * any, provided herein do not apply to combinations of this program with * other software, or any other product whatsoever. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * * Contact information: MeVis Medical Solutions AG, Universitaetsallee 29, * 28359 Bremen, Germany or: * * http://www.mevis.de * */ //---------------------------------------------------------------------------------- /*! // \file PythonQtInstanceWrapper.cpp // \author Florian Link // \author Last changed by $Author: florian $ // \date 2006-05 */ //---------------------------------------------------------------------------------- #include "PythonQtInstanceWrapper.h" #include #include "PythonQt.h" #include "PythonQtSlot.h" #include "PythonQtSignal.h" #include "PythonQtProperty.h" #include "PythonQtClassInfo.h" #include "PythonQtConversion.h" static void PythonQtInstanceWrapper_deleteObject(PythonQtInstanceWrapper* self, bool force = false) { // is this a C++ wrapper? if (self->_wrappedPtr) { //mlabDebugConst("Python","c++ wrapper removed " << self->_wrappedPtr << " " << self->_obj->className() << " " << self->classInfo()->wrappedClassName().latin1()); PythonQt::priv()->removeWrapperPointer(self->_wrappedPtr); // we own our qobject, so we delete it now: delete self->_obj; self->_obj = nullptr; // if this object is reference counted, we just unref it: PythonQtVoidPtrCB* unrefCB = self->classInfo()->referenceCountingUnrefCB(); if (unrefCB) { (*unrefCB)(self->_wrappedPtr); self->_wrappedPtr = nullptr; } else if (force || self->_ownedByPythonQt) { int type = self->classInfo()->metaTypeId(); if (self->_useQMetaTypeDestroy && type >= 0) { // use QMetaType to destroy the object #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0) QMetaType(type).destroy(self->_wrappedPtr); #else QMetaType::destroy(type, self->_wrappedPtr); #endif } else { PythonQtSlotInfo* slot = self->classInfo()->destructor(); if (slot) { void* args[2]; args[0] = nullptr; args[1] = &self->_wrappedPtr; PythonQtSlotInfo::invokeQtMethod(slot->decorator(), slot, args); self->_wrappedPtr = nullptr; } else { if (type >= 0) { // use QMetaType to destroy the object #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0) QMetaType(type).destroy(self->_wrappedPtr); #else QMetaType::destroy(type, self->_wrappedPtr); #endif } else { // TODO: warn about not being able to destroy the object? } } } } } else { //mlabDebugConst("Python","qobject wrapper removed " << self->_obj->className() << " " << self->classInfo()->wrappedClassName().latin1()); if (self->_objPointerCopy) { PythonQt::priv()->removeWrapperPointer(self->_objPointerCopy); } if (self->_obj) { if (self->_isShellInstance) { PythonQtShellSetInstanceWrapperCB* cb = self->classInfo()->shellSetInstanceWrapperCB(); if (cb) { // remove the pointer to the Python wrapper from the C++ object: (*cb)(self->_obj, nullptr); } } if (force || self->_ownedByPythonQt) { if (force || !self->_obj->parent()) { delete self->_obj; } } else { if (self->_obj->parent() == nullptr) { // tell someone who is interested that the qobject is no longer wrapped, if it has no parent PythonQt::qObjectNoLongerWrappedCB(self->_obj); } } } } self->_obj = nullptr; } static void PythonQtInstanceWrapper_dealloc(PythonQtInstanceWrapper* self) { if (PythonQt::self()) { PythonQtInstanceWrapper_deleteObject(self); } self->_obj.~QPointer(); Py_TYPE(self)->tp_free((PyObject*)self); } static PyObject* PythonQtInstanceWrapper_new(PyTypeObject* type, PyObject* /*args*/, PyObject* /*kwds*/) { //PythonQtClassWrapper *classType = (PythonQtClassWrapper*)type; PythonQtInstanceWrapper* self; static PyObject* emptyTuple = nullptr; if (emptyTuple == nullptr) { emptyTuple = PyTuple_New(0); } self = (PythonQtInstanceWrapper*)PyBaseObject_Type.tp_new(type, emptyTuple, nullptr); if (self != nullptr) { new (&self->_obj) QPointer(); self->_wrappedPtr = nullptr; self->_ownedByPythonQt = false; self->_useQMetaTypeDestroy = false; self->_isShellInstance = false; self->_shellInstanceRefCountsWrapper = false; } return (PyObject*)self; } int PythonQtInstanceWrapper_init(PythonQtInstanceWrapper* self, PyObject* args, PyObject* kwds) { if (args == PythonQtPrivate::dummyTuple()) { // we are called from the internal PythonQt API, so our data will be filled later on... return 0; } // we are called from python, try to construct our object if (self->classInfo()->constructors()) { void* directCPPPointer = nullptr; PythonQtPassThisOwnershipType ownership; PythonQtSlotFunction_CallImpl(self->classInfo(), nullptr, self->classInfo()->constructors(), args, kwds, nullptr, &directCPPPointer, &ownership); if (PyErr_Occurred()) { return -1; } if (directCPPPointer) { // if this object is reference counted, we ref it: PythonQtVoidPtrCB* refCB = self->classInfo()->referenceCountingRefCB(); if (refCB) { (*refCB)(directCPPPointer); } // change ownership flag to be owned by PythonQt self->_ownedByPythonQt = true; self->_useQMetaTypeDestroy = false; bool isQObject = !self->classInfo()->isCPPWrapper(); if (!isQObject) { self->_wrappedPtr = directCPPPointer; // TODO xxx: if there is a wrapper factory, we might want to generate a wrapper for our class?! } else { self->setQObject((QObject*)directCPPPointer); } // register with PythonQt PythonQt::priv()->addWrapperPointer(directCPPPointer, self); PythonQtShellSetInstanceWrapperCB* cb = self->classInfo()->shellSetInstanceWrapperCB(); if (cb) { // if we are a derived python class, we set the wrapper // to activate the shell class, otherwise we just ignore that it is a shell... // we detect it be checking if the type does not have PythonQtInstanceWrapper_Type as direct base class, // which is the case for all non-python derived types if (((PyObject*)self)->ob_type->tp_base != &PythonQtInstanceWrapper_Type) { // set the wrapper and remember that we have a shell instance! (*cb)(directCPPPointer, self); self->_isShellInstance = true; } } // if the constructor has a PythonQtPassThisOwnership parameter and that owner is not NULL, // this wrapper is immediately owned by CPP // (Example: QGraphicsItem(QGraphicsItem* parent), if parent != NULL, ownership needs to be passed // to C++ immediately) // Alternatively, if it is a QObject and the object already has a parent when it is constructed, // the ownership should be moved to C++ as well, so that the shell instance stays alive. if (ownership == PassOwnershipToCPP || (isQObject && self->_obj && self->_obj->parent())) { self->passOwnershipToCPP(); } } } else { QString error = QString("No constructors available for ") + self->classInfo()->className(); PyErr_SetString(PyExc_ValueError, QStringToPythonConstCharPointer(error)); return -1; } return 0; } static PyObject* PythonQtInstanceWrapper_richcompare(PythonQtInstanceWrapper* wrapper, PyObject* other, int code) { if (PythonQt::self() == nullptr || PythonQt::priv() == nullptr) { Py_RETURN_NOTIMPLEMENTED; } bool validPtrs = false; bool areSamePtrs = false; if (PyObject_TypeCheck((PyObject*)wrapper, &PythonQtInstanceWrapper_Type)) { if (PyObject_TypeCheck(other, &PythonQtInstanceWrapper_Type)) { validPtrs = true; PythonQtInstanceWrapper* w1 = wrapper; PythonQtInstanceWrapper* w2 = (PythonQtInstanceWrapper*)other; // check pointers directly if (w1->_wrappedPtr != nullptr) { if (w1->_wrappedPtr == w2->_wrappedPtr) { areSamePtrs = true; } } else if (w1->_obj == w2->_obj) { areSamePtrs = true; } } else if (other == Py_None) { validPtrs = true; if (wrapper->_obj || wrapper->_wrappedPtr) { areSamePtrs = false; } else { areSamePtrs = true; } } } if (!wrapper->classInfo()->supportsRichCompare()) { // shortcut if richcompare is not supported: if (validPtrs && code == Py_EQ) { return PythonQtConv::GetPyBool(areSamePtrs); } else if (validPtrs && code == Py_NE) { return PythonQtConv::GetPyBool(!areSamePtrs); } Py_RETURN_NOTIMPLEMENTED; } QByteArray memberName; switch (code) { case Py_LT: { static QByteArray name = "__lt__"; memberName = name; } break; case Py_LE: { static QByteArray name = "__le__"; memberName = name; } break; case Py_EQ: { static QByteArray name = "__eq__"; memberName = name; } break; case Py_NE: { static QByteArray name = "__ne__"; memberName = name; } break; case Py_GT: { static QByteArray name = "__gt__"; memberName = name; } break; case Py_GE: { static QByteArray name = "__ge__"; memberName = name; } break; } PythonQtMemberInfo opSlot = wrapper->classInfo()->member(memberName); if (opSlot._type == PythonQtMemberInfo::Slot) { PyObject* args = PyTuple_New(1); Py_INCREF(other); PyTuple_SET_ITEM(args, 0, other); PyObject* result = PythonQtSlotFunction_CallImpl(wrapper->classInfo(), wrapper->_obj, opSlot._slot, args, nullptr, wrapper->_wrappedPtr); Py_DECREF(args); if (result == nullptr) { // special handling of EQ and NE, if call fails we just return EQ == false / NE == true. if (code == Py_EQ) { PyErr_Clear(); Py_RETURN_FALSE; } else if (code == Py_NE) { PyErr_Clear(); Py_RETURN_TRUE; } } return result; } else { // not implemented, let python try something else! Py_RETURN_NOTIMPLEMENTED; } } static PyObject* PythonQtInstanceWrapper_classname(PythonQtInstanceWrapper* obj) { return PyUnicode_FromString(Py_TYPE(obj)->tp_name); } PyObject* PythonQtInstanceWrapper_inherits(PythonQtInstanceWrapper* obj, PyObject* args) { if (PythonQt::self() == nullptr || PythonQt::priv() == nullptr) { PyErr_SetString(PyExc_RuntimeError, "PythonQt is not initialized (or has been finalized)"); return nullptr; } char* name = nullptr; if (!PyArg_ParseTuple(args, "s:PythonQtInstanceWrapper.inherits", &name)) { return nullptr; } return PythonQtConv::GetPyBool(obj->classInfo()->inherits(name)); } static PyObject* PythonQtInstanceWrapper_help(PythonQtInstanceWrapper* obj) { if (PythonQt::self() == nullptr || PythonQt::priv() == nullptr) { Py_RETURN_NONE; } return PythonQt::self()->helpCalled(obj->classInfo()); } PyObject* PythonQtInstanceWrapper_delete(PythonQtInstanceWrapper* self) { if (PythonQt::self() == nullptr || PythonQt::priv() == nullptr) { Py_RETURN_NONE; } PythonQtMemberInfo deleteSlot = self->classInfo()->member("py_delete"); if (deleteSlot._type == PythonQtMemberInfo::Slot) { // call the py_delete slot instead of internal C++ destructor... PyObject* resultObj = PythonQtSlotFunction_CallImpl(self->classInfo(), self->_obj, deleteSlot._slot, nullptr, nullptr, self->_wrappedPtr); Py_XDECREF(resultObj); } else { PythonQtInstanceWrapper_deleteObject(self, true); } Py_RETURN_NONE; } static PyMethodDef PythonQtInstanceWrapper_methods[] = { {"className", reinterpret_cast(reinterpret_cast(PythonQtInstanceWrapper_classname)), METH_NOARGS, "Return the classname of the object"}, {"inherits", reinterpret_cast(reinterpret_cast(PythonQtInstanceWrapper_inherits)), METH_VARARGS, "Returns if the class inherits or is of given type name"}, {"help", reinterpret_cast(reinterpret_cast(PythonQtInstanceWrapper_help)), METH_NOARGS, "Shows the help of available methods for this class"}, {"delete", reinterpret_cast(reinterpret_cast(PythonQtInstanceWrapper_delete)), METH_NOARGS, "Deletes the C++ object (at your own risk, my friend!)"}, {nullptr, nullptr, 0, nullptr} /* Sentinel */ }; static PyObject* PythonQtInstanceWrapper_getattro(PyObject* obj, PyObject* name) { if (PythonQt::self() == nullptr || PythonQt::priv() == nullptr) { return PyObject_GenericGetAttr(obj, name); } const char* attributeName; PythonQtInstanceWrapper* wrapper = (PythonQtInstanceWrapper*)obj; if ((attributeName = PyUnicode_AsUTF8(name)) == nullptr) { return nullptr; } if (qstrcmp(attributeName, "__dict__") == 0) { PyObject* objectDict = PyBaseObject_Type.tp_getattro(obj, name); PyObject* dict = PyDict_Copy(objectDict); Py_DECREF(objectDict); if (wrapper->_obj) { // we need to replace the properties with their real values... const QStringList l = wrapper->classInfo()->propertyList(); for (const QString& name : l) { PyObject* o = PyObject_GetAttrString(obj, QStringToPythonConstCharPointer(name)); if (o) { PyDict_SetItemString(dict, QStringToPythonConstCharPointer(name), o); Py_DECREF(o); } else { std::cerr << "PythonQtInstanceWrapper: something is wrong, could not get attribute " << QStringToPythonConstCharPointer(name) << std::endl; } } const QList dynamicProps = wrapper->_obj->dynamicPropertyNames(); for (const QByteArray& name : dynamicProps) { PyObject* o = PyObject_GetAttrString(obj, name.data()); if (o) { PyDict_SetItemString(dict, name.data(), o); Py_DECREF(o); } else { std::cerr << "PythonQtInstanceWrapper: dynamic property could not be read " << name.data(); } } } { static const QByteArray dynamicDictString("py_dynamic_dict"); // check for a dynamic dict getter slot PythonQtMemberInfo member = wrapper->classInfo()->member(dynamicDictString); if (member._type == PythonQtMemberInfo::Slot) { PyObject* args = PyTuple_New(0); PyObject* result = PythonQtSlotFunction_CallImpl(wrapper->classInfo(), wrapper->_obj, member._slot, args, nullptr, wrapper->_wrappedPtr); Py_DECREF(args); if (result) { if (PyDict_Check(result)) { PyDict_Merge(dict, result, false); } else { std::cerr << "py_dynamic_dict() should return a dictionary!" << std::endl; } } } } // Note: we do not put children into the dict, is would look confusing?! return dict; } // first look in super, to return derived methods from base object first PyObject* superAttr = PyBaseObject_Type.tp_getattro(obj, name); if (superAttr) { if (PythonQtProperty_Check(superAttr)) { // call the getter on the property PythonQtProperty* prop = (PythonQtProperty*)superAttr; PyObject* result = prop->data->callGetter(obj); Py_DECREF(superAttr); return result; } else if (PythonQtSignalFunction_Check(superAttr)) { // we need to bind the class signal to the object PythonQtSignalFunctionObject* sig = (PythonQtSignalFunctionObject*)superAttr; if (sig->_dynamicInfo) { if (!wrapper->dynamicClassInfo() || wrapper->dynamicClassInfo()->_dynamicMetaObject == nullptr) { // force creation of meta object: if (wrapper->_obj) { wrapper->_obj->metaObject(); } } if (wrapper->dynamicClassInfo()) { // go through the whole inheritance chain to find a signal in the dynamic class info: PythonQtClassInfo* classInfo = nullptr; PythonQtClassWrapper* classType = (PythonQtClassWrapper*)Py_TYPE(wrapper); while (classType->_dynamicClassInfo) { classInfo = classType->_dynamicClassInfo->_classInfo; if (classInfo) { PythonQtMemberInfo member = classInfo->member(attributeName); if (member._type == PythonQtMemberInfo::Signal) { PyObject* boundSignal = PythonQtSignalFunction_New(member._slot, (PyObject*)wrapper, nullptr); Py_DECREF(superAttr); return boundSignal; } } classType = (PythonQtClassWrapper*)(((PyTypeObject*)classType)->tp_base); } } } } return superAttr; } PyErr_Clear(); // mlabDebugConst("Python","get " << attributeName); PythonQtMemberInfo member = wrapper->classInfo()->member(attributeName); switch (member._type) { case PythonQtMemberInfo::Property: if (wrapper->_obj) { if (member._property.userType() != QMetaType::UnknownType) { PythonQt::ProfilingCB* profilingCB = PythonQt::priv()->profilingCB(); if (profilingCB) { QString methodName = "getProperty('"; methodName += attributeName; methodName += "')"; profilingCB(PythonQt::Enter, wrapper->_obj->metaObject()->className(), QStringToPythonConstCharPointer(methodName), nullptr); } PyObject* value = PythonQtConv::QVariantToPyObject(member._property.read(wrapper->_obj)); if (profilingCB) { profilingCB(PythonQt::Leave, nullptr, nullptr, nullptr); } return value; } else { Py_RETURN_NONE; } } else { QString error = QString("Trying to read property '") + attributeName + "' from a destroyed " + wrapper->classInfo()->className() + " object"; PyErr_SetString(PyExc_ValueError, QStringToPythonConstCharPointer(error)); return nullptr; } break; case PythonQtMemberInfo::Slot: return PythonQtSlotFunction_New(member._slot, obj, nullptr); break; case PythonQtMemberInfo::Signal: return PythonQtSignalFunction_New(member._slot, obj, nullptr); break; case PythonQtMemberInfo::EnumValue: { PyObject* enumValue = member._enumValue; Py_INCREF(enumValue); return enumValue; } break; case PythonQtMemberInfo::EnumWrapper: case PythonQtMemberInfo::NestedClass: { PyObject* enumWrapper = member._pythonType; Py_INCREF(enumWrapper); return enumWrapper; } break; case PythonQtMemberInfo::NotFound: { static const QByteArray getterString("py_get_"); // check for a getter slot PythonQtMemberInfo member = wrapper->classInfo()->member(getterString + attributeName); if (member._type == PythonQtMemberInfo::Slot) { return PythonQtSlotFunction_CallImpl(wrapper->classInfo(), wrapper->_obj, member._slot, nullptr, nullptr, wrapper->_wrappedPtr); } { static const QByteArray dynamicGetterString("py_dynamic_get_attrib"); // check for a dynamic getter slot PythonQtMemberInfo member = wrapper->classInfo()->member(dynamicGetterString); if (member._type == PythonQtMemberInfo::Slot) { PyObject* args = PyTuple_New(1); Py_INCREF(name); PyTuple_SET_ITEM(args, 0, name); PyObject* result = PythonQtSlotFunction_CallImpl(wrapper->classInfo(), wrapper->_obj, member._slot, args, nullptr, wrapper->_wrappedPtr); Py_DECREF(args); if (result) { return result; } else { // in case of result == NULL, expect that the code as thrown a std::exception // and clear the Python error: PyErr_Clear(); } } } // handle dynamic properties if (wrapper->_obj) { QVariant v = wrapper->_obj->property(attributeName); if (v.isValid()) { return PythonQtConv::QVariantToPyObject(v); } } } break; default: // is an invalid type, go on break; } // look for the internal methods (className(), help()) PyObject* internalMethod = PyObject_GenericGetAttr(obj, name); if (internalMethod) { return internalMethod; } PyErr_Clear(); if (wrapper->_obj) { // look for a child QObjectList children = wrapper->_obj->children(); for (int i = 0; i < children.count(); i++) { QObject* child = children.at(i); if (child->objectName() == attributeName) { return PythonQt::priv()->wrapQObject(child); } } } QString error = QString(wrapper->classInfo()->className()) + " has no attribute named '" + QString(attributeName) + "'"; if (wrapper->_obj) { error += PythonQt::self()->qObjectMissingAttributeCallback(wrapper->_obj, QString(attributeName)); } PyErr_SetString(PyExc_AttributeError, QStringToPythonConstCharPointer(error)); return nullptr; } static int PythonQtInstanceWrapper_setattro(PyObject* obj, PyObject* name, PyObject* value) { if (PythonQt::self() == nullptr || PythonQt::priv() == nullptr) { PyErr_SetString(PyExc_AttributeError, "PythonQt is not initialized (or has been finalized); cannot set attributes on this wrapper"); return -1; } QString error; const char* attributeName; PythonQtInstanceWrapper* wrapper = (PythonQtInstanceWrapper*)obj; if ((attributeName = PyUnicode_AsUTF8(name)) == nullptr) return -1; PythonQtMemberInfo member = wrapper->classInfo()->member(attributeName); if (member._type == PythonQtMemberInfo::Property) { if (!wrapper->_obj) { error = QString("Trying to set property '") + attributeName + "' on a destroyed " + wrapper->classInfo()->className() + " object"; PyErr_SetString(PyExc_AttributeError, QStringToPythonConstCharPointer(error)); return -1; } QMetaProperty prop = member._property; if (prop.isWritable()) { QVariant v; if (prop.isEnumType()) { // this will give us either a string or an int, everything else will probably be an error v = PythonQtConv::PyObjToQVariant(value); } else { int t = prop.userType(); v = PythonQtConv::PyObjToQVariant(value, t); } bool success = false; if (v.isValid()) { PythonQt::ProfilingCB* profilingCB = PythonQt::priv()->profilingCB(); if (profilingCB) { QString methodName = "setProperty('"; methodName += attributeName; methodName += "')"; profilingCB(PythonQt::Enter, wrapper->_obj->metaObject()->className(), QStringToPythonConstCharPointer(methodName), nullptr); } success = prop.write(wrapper->_obj, v); if (profilingCB) { profilingCB(PythonQt::Leave, nullptr, nullptr, nullptr); } } if (success) { return 0; } else { error = QString("Property '") + attributeName + "' of type '" + prop.typeName() + "' does not accept an object of type " + QString(value->ob_type->tp_name) + " (" + PythonQtConv::PyObjGetRepresentation(value) + ")"; } } else { error = QString("Property '") + attributeName + "' of " + obj->ob_type->tp_name + " object is not writable"; } } else if (member._type == PythonQtMemberInfo::Slot) { error = QString("Slot '") + attributeName + "' can not be overwritten on " + obj->ob_type->tp_name + " object"; } else if (member._type == PythonQtMemberInfo::Signal) { error = QString("Signal '") + attributeName + "' can not be overwritten on " + obj->ob_type->tp_name + " object"; } else if (member._type == PythonQtMemberInfo::EnumValue) { error = QString("EnumValue '") + attributeName + "' can not be overwritten on " + obj->ob_type->tp_name + " object"; } else if (member._type == PythonQtMemberInfo::EnumWrapper) { error = QString("Enum '") + attributeName + "' can not be overwritten on " + obj->ob_type->tp_name + " object"; } else if (member._type == PythonQtMemberInfo::NestedClass) { error = QString("Nested class '") + attributeName + "' can not be overwritten on " + obj->ob_type->tp_name + " object"; } else if (member._type == PythonQtMemberInfo::NotFound) { // check for a setter slot static const QByteArray setterString("py_set_"); PythonQtMemberInfo setter = wrapper->classInfo()->member(setterString + attributeName); if (setter._type == PythonQtMemberInfo::Slot) { // call the setter and ignore the result value void* result; PyObject* args = PyTuple_New(1); Py_INCREF(value); PyTuple_SET_ITEM(args, 0, value); PythonQtSlotFunction_CallImpl(wrapper->classInfo(), wrapper->_obj, setter._slot, args, nullptr, wrapper->_wrappedPtr, &result); Py_DECREF(args); return 0; } // handle dynamic properties if (wrapper->_obj) { QVariant prop = wrapper->_obj->property(attributeName); if (prop.isValid()) { QVariant v = PythonQtConv::PyObjToQVariant(value); if (v.isValid()) { wrapper->_obj->setProperty(attributeName, v); return 0; } else { error = QString("Dynamic property '") + attributeName + "' does not accept an object of type " + QString(value->ob_type->tp_name) + " (" + PythonQtConv::PyObjGetRepresentation(value) + ")"; PyErr_SetString(PyExc_AttributeError, QStringToPythonConstCharPointer(error)); return -1; } } } // if we are a derived python class, we allow setting attributes. // if we are a direct CPP wrapper, we do NOT allow it, since // it would be confusing to allow it because a wrapper will go away when it is not seen by python anymore // and when it is recreated from a CPP pointer the attributes are gone... if (obj->ob_type->tp_base != &PythonQtInstanceWrapper_Type) { // first check if this is a Property PyObject* superAttr = PyBaseObject_Type.tp_getattro(obj, name); if (superAttr) { // handle QtCore.Propery setter if (PythonQtProperty_Check(superAttr)) { // call the setter on the property PythonQtProperty* prop = (PythonQtProperty*)superAttr; bool ok = prop->data->callSetter(obj, value); Py_DECREF(superAttr); return ok ? 0 : -1; } Py_DECREF(superAttr); } PyErr_Clear(); // otherwise call the default Python setattro return PyBaseObject_Type.tp_setattro(obj, name, value); } else { error = QString("'") + attributeName + "' does not exist on " + obj->ob_type->tp_name + " and creating new attributes on C++ objects is not allowed"; } } PyErr_SetString(PyExc_AttributeError, QStringToPythonConstCharPointer(error)); return -1; } static QString getStringFromObject(PythonQtInstanceWrapper* wrapper) { QString result; if (wrapper->_wrappedPtr) { // first try some manually string conversions for some variants int metaid = wrapper->classInfo()->metaTypeId(); result = PythonQtConv::CPPObjectToString(metaid, wrapper->_wrappedPtr); if (!result.isEmpty()) { return result; } } if (wrapper->_wrappedPtr || wrapper->_obj) { // next, try to call py_toString PythonQtMemberInfo info = wrapper->classInfo()->member("py_toString"); if (info._type == PythonQtMemberInfo::Slot) { PyObject* resultObj = PythonQtSlotFunction_CallImpl(wrapper->classInfo(), wrapper->_obj, info._slot, nullptr, nullptr, wrapper->_wrappedPtr); if (resultObj) { result = PythonQtConv::PyObjGetString(resultObj); Py_DECREF(resultObj); } } } return result; } static PyObject* PythonQtInstanceWrapper_str(PyObject* obj) { if (PythonQt::self() == nullptr || PythonQt::priv() == nullptr) { return PyUnicode_New(0, 0); } PythonQtInstanceWrapper* wrapper = (PythonQtInstanceWrapper*)obj; // QByteArray should be directly returned as a str if (wrapper->classInfo()->metaTypeId() == QMetaType::QByteArray) { QByteArray* b = (QByteArray*)wrapper->_wrappedPtr; // Note: In Python 2, this was used to access the data() of a byte array. // Since in Python 3 str() will return a unicode, this is no longer possible. // The user needs to call .data() to get access to the data as bytes. if (b->data()) { PyObject* buffer = PyBytes_FromStringAndSize(b->data(), b->size()); PyObject* result = PyObject_Repr(buffer); Py_DECREF(buffer); return result; } else { return PyUnicode_New(0, 0); } } const char* typeName = obj->ob_type->tp_name; QObject* qobj = wrapper->_obj; QString str = getStringFromObject(wrapper); if (!str.isEmpty()) { return PyUnicode_FromFormat("%s", QStringToPythonConstCharPointer(str)); } if (wrapper->_wrappedPtr) { if (wrapper->_obj) { return PyUnicode_FromFormat("%s (C++ Object %p wrapped by %s %p))", typeName, wrapper->_wrappedPtr, wrapper->_obj->metaObject()->className(), qobj); } else { return PyUnicode_FromFormat("%s (C++ Object %p)", typeName, wrapper->_wrappedPtr); } } else { return PyUnicode_FromFormat("%s (QObject %p)", typeName, qobj); } } static PyObject* PythonQtInstanceWrapper_repr(PyObject* obj) { if (PythonQt::self() == nullptr || PythonQt::priv() == nullptr) { return PyUnicode_New(0, 0); } PythonQtInstanceWrapper* wrapper = (PythonQtInstanceWrapper*)obj; const char* typeName = obj->ob_type->tp_name; QObject* qobj = wrapper->_obj; QString str = getStringFromObject(wrapper); if (!str.isEmpty()) { if (str.startsWith(typeName)) { return PyUnicode_FromFormat("%s", QStringToPythonConstCharPointer(str)); } else { return PyUnicode_FromFormat("%s (%s, at: %p)", typeName, QStringToPythonConstCharPointer(str), wrapper->_wrappedPtr ? wrapper->_wrappedPtr : qobj); } } if (wrapper->_wrappedPtr) { if (wrapper->_obj) { return PyUnicode_FromFormat("%s (C++ object at: %p wrapped by %s at: %p)", typeName, wrapper->_wrappedPtr, wrapper->_obj->metaObject()->className(), qobj); } else { return PyUnicode_FromFormat("%s (C++ object at: %p)", typeName, wrapper->_wrappedPtr); } } else { return PyUnicode_FromFormat("%s (%s at: %p)", typeName, wrapper->classInfo()->className().constData(), qobj); } } static int PythonQtInstanceWrapper_builtin_bool(PyObject* obj) { PythonQtInstanceWrapper* wrapper = (PythonQtInstanceWrapper*)obj; return (wrapper->_wrappedPtr == nullptr && wrapper->_obj == nullptr) ? 0 : 1; } static long PythonQtInstanceWrapper_hash(PythonQtInstanceWrapper* obj) { if (obj->_wrappedPtr != nullptr) { return static_cast(reinterpret_cast(obj->_wrappedPtr)); } else { QObject* qobj = obj->_obj; // get pointer from QPointer wrapper return static_cast(reinterpret_cast(qobj)); } } // we override nb_nonzero, so that one can do 'if' expressions to test for a NULL ptr static PyNumberMethods PythonQtInstanceWrapper_as_number = { nullptr, /* nb_add */ nullptr, /* nb_subtract */ nullptr, /* nb_multiply */ nullptr, /* nb_remainder */ nullptr, /* nb_divmod */ nullptr, /* nb_power */ nullptr, /* nb_negative */ nullptr, /* nb_positive */ nullptr, /* nb_absolute */ PythonQtInstanceWrapper_builtin_bool, /* nb_bool */ nullptr, /* nb_invert */ nullptr, /* nb_lshift */ nullptr, /* nb_rshift */ nullptr, /* nb_and */ nullptr, /* nb_xor */ nullptr, /* nb_or */ nullptr, /* nb_int */ nullptr, /* nb_reserved */ nullptr, /* nb_float */ nullptr, /* nb_inplace_add */ nullptr, /* nb_inplace_subtract */ nullptr, /* nb_inplace_multiply */ nullptr, /* nb_inplace_remainder */ nullptr, /* nb_inplace_power */ nullptr, /* nb_inplace_lshift */ nullptr, /* nb_inplace_rshift */ nullptr, /* nb_inplace_and */ nullptr, /* nb_inplace_xor */ nullptr, /* nb_inplace_or */ nullptr, /* nb_floor_divide */ nullptr, /* nb_true_divide */ nullptr, /* nb_inplace_floor_divide */ nullptr, /* nb_inplace_true_divide */ nullptr, /* nb_index */ }; PyTypeObject PythonQtInstanceWrapper_Type = { PyVarObject_HEAD_INIT(&PythonQtClassWrapper_Type, 0) /*tp_base*/ "PythonQt.PythonQtInstanceWrapper", /*tp_name*/ sizeof(PythonQtInstanceWrapper), /*tp_basicsize*/ 0, /*tp_itemsize*/ (destructor)PythonQtInstanceWrapper_dealloc, /*tp_dealloc*/ 0, /*tp_vectorcall_offset*/ nullptr, /*tp_getattr*/ nullptr, /*tp_setattr*/ nullptr, /*tp_compare*/ PythonQtInstanceWrapper_repr, /*tp_repr*/ &PythonQtInstanceWrapper_as_number, /*tp_as_number*/ nullptr, /*tp_as_sequence*/ nullptr, /*tp_as_mapping*/ (hashfunc)PythonQtInstanceWrapper_hash, /*tp_hash */ nullptr, /*tp_call*/ PythonQtInstanceWrapper_str, /*tp_str*/ PythonQtInstanceWrapper_getattro, /*tp_getattro*/ PythonQtInstanceWrapper_setattro, /*tp_setattro*/ nullptr, /*tp_as_buffer*/ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ "PythonQtInstanceWrapper object", /* tp_doc */ nullptr, /* tp_traverse */ nullptr, /* tp_clear */ (richcmpfunc)PythonQtInstanceWrapper_richcompare, /* tp_richcompare */ 0, /* tp_weaklistoffset */ nullptr, /* tp_iter */ nullptr, /* tp_iternext */ PythonQtInstanceWrapper_methods, /* tp_methods */ nullptr, /* tp_members */ nullptr, /* tp_getset */ nullptr, /* tp_base */ nullptr, /* tp_dict */ nullptr, /* tp_descr_get */ nullptr, /* tp_descr_set */ 0, /* tp_dictoffset */ (initproc)PythonQtInstanceWrapper_init, /* tp_init */ nullptr, /* tp_alloc */ PythonQtInstanceWrapper_new, /* tp_new */ }; //-------------------------------------------------------