a static class that offers methods for type conversion More...

#include <PythonQtConversion.h>

Static Public Member Functions
static PyObject *	GetPyBool (bool val)
	get a ref counted True or False Python object More...

static PyObject *	ConvertQtValueToPython (const PythonQtMethodInfo::ParameterInfo &info, const void *data)
	converts the Qt parameter given in `data`, interpreting it as a `info` parameter, into a Python object, More...

static void *	ConvertPythonToQt (const PythonQtMethodInfo::ParameterInfo &info, PyObject obj, bool strict, PythonQtClassInfo classInfo, void alreadyAllocatedCPPObject, PythonQtArgumentFrame frame=nullptr)
	convert python object to Qt (according to the given parameter) and if the conversion should be strict (classInfo is currently not used anymore) More...

static void *	CreateQtReturnValue (const PythonQtMethodInfo::ParameterInfo &info, PythonQtArgumentFrame *frame)
	creates a data storage for the passed parameter type and returns a void pointer to be set as arg[0] of qt_metacall More...

static PyObject *	QStringToPyObject (const QString &str)
	converts QString to Python string (unicode!) More...

static PyObject *	QStringListToPyObject (const QStringList &list)
	converts QStringList to Python tuple More...

static PyObject *	QStringListToPyList (const QStringList &list)
	converts QStringList to Python list More...

static QString	PyObjGetRepresentation (PyObject *val)
	get string representation of py object More...

static QString	PyObjGetString (PyObject *val)
	get string value from py object More...

static QString	PyObjGetString (PyObject *val, bool strict, bool &ok)
	get string value from py object More...

static QByteArray	PyObjGetBytes (PyObject *val, bool strict, bool &ok)
	get bytes from py object More...

static QByteArray	PyObjGetBytesAllowString (PyObject *val, bool strict, bool &ok)
	get bytes from py object, also allows Python string More...

static int	PyObjGetInt (PyObject *val, bool strict, bool &ok)
	get int from py object More...

static qint64	PyObjGetLongLong (PyObject *val, bool strict, bool &ok)
	get int64 from py object More...

static quint64	PyObjGetULongLong (PyObject *val, bool strict, bool &ok)
	get int64 from py object More...

static double	PyObjGetDouble (PyObject *val, bool strict, bool &ok)
	get double from py object More...

static bool	PyObjGetBool (PyObject *val, bool strict, bool &ok)
	get bool from py object More...

static QStringList	PyObjToStringList (PyObject *val, bool strict, bool &ok)
	create a string list from python sequence More...

static QVariant	PyObjToQVariant (PyObject *val, int type=-1)

static PyObject *	QVariantToPyObject (const QVariant &v)
	convert QVariant from PyObject More...

static PyObject *	QVariantHashToPyObject (const QVariantHash &m)

static PyObject *	QVariantMapToPyObject (const QVariantMap &m)

static PyObject *	QVariantListToPyObject (const QVariantList &l)

static QString	CPPObjectToString (int type, const void *data)
	get human readable string from CPP object (when the metatype is known) More...

static void	registerPythonToMetaTypeConverter (int metaTypeId, PythonQtConvertPythonToMetaTypeCB *cb)
	register a converter callback from python to cpp for given metatype More...

static void	registerMetaTypeToPythonConverter (int metaTypeId, PythonQtConvertMetaTypeToPythonCB *cb)
	register a converter callback from cpp to python for given metatype More...

static void	setPythonSequenceToQVariantListCallback (PythonQtConvertPythonSequenceToQVariantListCB *cb)

static PyObject *	convertQtValueToPythonInternal (int type, const void *data)
	converts the Qt parameter given in `data`, interpreting it as a `type` registered qvariant/meta type, into a Python object, More...

static PyObject *	createCopyFromMetaType (int type, const void *object)
	creates a copy of given object, using the QMetaType More...

static void *	castWrapperTo (PythonQtInstanceWrapper *wrapper, const QByteArray &className, bool &ok)
	cast wrapper to given className if possible More...

static bool	convertToPythonQtObjectPtr (PyObject obj, void outPtr, int, bool)

static PyObject *	convertFromPythonQtObjectPtr (const void *inObject, int)

static bool	convertToPythonQtSafeObjectPtr (PyObject obj, void outPtr, int, bool)

static PyObject *	convertFromPythonQtSafeObjectPtr (const void *inObject, int)

static bool	convertToQListOfPythonQtObjectPtr (PyObject obj, void outList, int, bool)

static PyObject *	convertFromQListOfPythonQtObjectPtr (const void *inObject, int)

static PyObject *	convertFromStringRef (const void *inObject, int)

static QByteArray	getCPPTypeName (PyObject *type)
	Returns the name of the equivalent CPP type (for signals and slots) More...

static bool	isStringType (PyTypeObject *type)
	Returns if the given object is a string (or unicode string) More...

static void	registerStringViewTypes ()
	Register QStringView like types, that need to be handled specially. More...

Static Protected Member Functions
static void *	handlePythonToQtAutoConversion (int typeId, PyObject obj, void alreadyAllocatedCPPObject, PythonQtArgumentFrame *frame)
	handle automatic conversion of some special types (QColor, QBrush, ...) More...

static PyObject *	ConvertQListOfPointerTypeToPythonList (QList< void * > *list, const PythonQtMethodInfo::ParameterInfo &info)
	converts the list of pointers of given type to Python More...

static bool	ConvertPythonListToQListOfPointerType (PyObject obj, QList< void > *list, const PythonQtMethodInfo::ParameterInfo &info, bool strict)
	tries to convert the python object to a QList of pointers to `type` objects, returns true on success More...

template<typename Map >
static void	pythonToMapVariant (PyObject *val, QVariant &result)
	helper template method for conversion from Python to QVariantMap/Hash More...

template<typename Map >
static PyObject *	mapToPython (const Map &m)
	helper template function for QVariantMapToPyObject/QVariantHashToPyObject More...

Static Protected Attributes
static QHash< int, PythonQtConvertMetaTypeToPythonCB * >	_metaTypeToPythonConverters

static QHash< int, PythonQtConvertPythonToMetaTypeCB * >	_pythonToMetaTypeConverters

static PythonQtConvertPythonSequenceToQVariantListCB *	_pythonSequenceToQVariantListCB

static int	stringRefTypeId

Detailed Description

a static class that offers methods for type conversion

Definition at line 101 of file PythonQtConversion.h.

Member Function Documentation

◆ castWrapperTo()

static void* PythonQtConv::castWrapperTo	(	PythonQtInstanceWrapper *	wrapper,
		const QByteArray &	className,
		bool &	ok
	)

static

cast wrapper to given className if possible

Referenced by PythonQtConvertPythonListToListOfKnownClass().

◆ convertFromPythonQtObjectPtr()

static PyObject* PythonQtConv::convertFromPythonQtObjectPtr	(	const void *	inObject,
		int
	)

static

◆ convertFromPythonQtSafeObjectPtr()

static PyObject* PythonQtConv::convertFromPythonQtSafeObjectPtr	(	const void *	inObject,
		int
	)

static

◆ convertFromQListOfPythonQtObjectPtr()

static PyObject* PythonQtConv::convertFromQListOfPythonQtObjectPtr	(	const void *	inObject,
		int
	)

static

◆ convertFromStringRef()

static PyObject* PythonQtConv::convertFromStringRef	(	const void *	inObject,
		int
	)

static

◆ ConvertPythonListToQListOfPointerType()

static bool PythonQtConv::ConvertPythonListToQListOfPointerType	(	PyObject *	obj,
		QList< void * > *	list,
		const PythonQtMethodInfo::ParameterInfo &	info,
		bool	strict
	)

staticprotected

tries to convert the python object to a QList of pointers to type objects, returns true on success

◆ ConvertPythonToQt()

static void* PythonQtConv::ConvertPythonToQt	(	const PythonQtMethodInfo::ParameterInfo &	info,
		PyObject *	obj,
		bool	strict,
		PythonQtClassInfo *	classInfo,
		void *	alreadyAllocatedCPPObject,
		PythonQtArgumentFrame *	frame = `nullptr`
	)

static

convert python object to Qt (according to the given parameter) and if the conversion should be strict (classInfo is currently not used anymore)

◆ ConvertQListOfPointerTypeToPythonList()

static PyObject* PythonQtConv::ConvertQListOfPointerTypeToPythonList	(	QList< void * > *	list,
		const PythonQtMethodInfo::ParameterInfo &	info
	)

staticprotected

converts the list of pointers of given type to Python

◆ ConvertQtValueToPython()

static PyObject* PythonQtConv::ConvertQtValueToPython	(	const PythonQtMethodInfo::ParameterInfo &	info,
		const void *	data
	)

static

converts the Qt parameter given in data, interpreting it as a info parameter, into a Python object,

◆ convertQtValueToPythonInternal()

static PyObject* PythonQtConv::convertQtValueToPythonInternal	(	int	type,
		const void *	data
	)

static

converts the Qt parameter given in data, interpreting it as a type registered qvariant/meta type, into a Python object,

Referenced by PythonQtConvertIntegerMapToPython(), PythonQtConvertListOfValueTypeToPythonList(), and PythonQtConvertPairToPython().

◆ convertToPythonQtObjectPtr()

static bool PythonQtConv::convertToPythonQtObjectPtr	(	PyObject *	obj,
		void *	outPtr,
		int	,
		bool
	)

static

◆ convertToPythonQtSafeObjectPtr()

static bool PythonQtConv::convertToPythonQtSafeObjectPtr	(	PyObject *	obj,
		void *	outPtr,
		int	,
		bool
	)

static

◆ convertToQListOfPythonQtObjectPtr()

static bool PythonQtConv::convertToQListOfPythonQtObjectPtr	(	PyObject *	obj,
		void *	outList,
		int	,
		bool
	)

static

◆ CPPObjectToString()

static QString PythonQtConv::CPPObjectToString	(	int	type,
		const void *	data
	)

static

get human readable string from CPP object (when the metatype is known)

◆ createCopyFromMetaType()

static PyObject* PythonQtConv::createCopyFromMetaType	(	int	type,
		const void *	object
	)

static

creates a copy of given object, using the QMetaType

◆ CreateQtReturnValue()

static void* PythonQtConv::CreateQtReturnValue	(	const PythonQtMethodInfo::ParameterInfo &	info,
		PythonQtArgumentFrame *	frame
	)

static

creates a data storage for the passed parameter type and returns a void pointer to be set as arg[0] of qt_metacall

◆ getCPPTypeName()

static QByteArray PythonQtConv::getCPPTypeName ( PyObject * type )

static

Returns the name of the equivalent CPP type (for signals and slots)

◆ GetPyBool()

static PyObject* PythonQtConv::GetPyBool ( bool val )

static

get a ref counted True or False Python object

◆ handlePythonToQtAutoConversion()

static void* PythonQtConv::handlePythonToQtAutoConversion	(	int	typeId,
		PyObject *	obj,
		void *	alreadyAllocatedCPPObject,
		PythonQtArgumentFrame *	frame
	)

staticprotected

handle automatic conversion of some special types (QColor, QBrush, ...)

◆ isStringType()

static bool PythonQtConv::isStringType ( PyTypeObject * type )

static

Returns if the given object is a string (or unicode string)

◆ mapToPython()

template<typename Map >

static PyObject* PythonQtConv::mapToPython ( const Map & m )

staticprotected

helper template function for QVariantMapToPyObject/QVariantHashToPyObject

◆ PyObjGetBool()

static bool PythonQtConv::PyObjGetBool	(	PyObject *	val,
		bool	strict,
		bool &	ok
	)

static

get bool from py object

◆ PyObjGetBytes()

static QByteArray PythonQtConv::PyObjGetBytes	(	PyObject *	val,
		bool	strict,
		bool &	ok
	)

static

get bytes from py object

◆ PyObjGetBytesAllowString()

static QByteArray PythonQtConv::PyObjGetBytesAllowString	(	PyObject *	val,
		bool	strict,
		bool &	ok
	)

static

get bytes from py object, also allows Python string

◆ PyObjGetDouble()

static double PythonQtConv::PyObjGetDouble	(	PyObject *	val,
		bool	strict,
		bool &	ok
	)

static

get double from py object

◆ PyObjGetInt()

static int PythonQtConv::PyObjGetInt	(	PyObject *	val,
		bool	strict,
		bool &	ok
	)

static

get int from py object

Referenced by PythonQtConvertPythonToIntegerMap().

◆ PyObjGetLongLong()

static qint64 PythonQtConv::PyObjGetLongLong	(	PyObject *	val,
		bool	strict,
		bool &	ok
	)

static

get int64 from py object

◆ PyObjGetRepresentation()

static QString PythonQtConv::PyObjGetRepresentation ( PyObject * val )

static

get string representation of py object

◆ PyObjGetString() [1/2]

static QString PythonQtConv::PyObjGetString ( PyObject * val )

inlinestatic

get string value from py object

Definition at line 130 of file PythonQtConversion.h.

130 { bool ok; QString s = PyObjGetString(val, false, ok); return s; }

PythonQtConv::PyObjGetString

static QString PyObjGetString(PyObject *val)

get string value from py object

Definition: PythonQtConversion.h:130

References PyObjGetString().

Referenced by PyObjGetString().

◆ PyObjGetString() [2/2]

static QString PythonQtConv::PyObjGetString	(	PyObject *	val,
		bool	strict,
		bool &	ok
	)

static

get string value from py object

◆ PyObjGetULongLong()

static quint64 PythonQtConv::PyObjGetULongLong	(	PyObject *	val,
		bool	strict,
		bool &	ok
	)

static

get int64 from py object

◆ PyObjToQVariant()

static QVariant PythonQtConv::PyObjToQVariant	(	PyObject *	val,
		int	type = `-1`
	)

static

convert python object to qvariant, if type is given it will try to create a qvariant of that type, otherwise it will guess from the python type

Referenced by PythonQtConvertPythonListToListOfValueType(), PythonQtConvertPythonToIntegerMap(), and PythonQtConvertPythonToPair().

◆ PyObjToStringList()

static QStringList PythonQtConv::PyObjToStringList	(	PyObject *	val,
		bool	strict,
		bool &	ok
	)

static

create a string list from python sequence

◆ pythonToMapVariant()

template<typename Map >

static void PythonQtConv::pythonToMapVariant	(	PyObject *	val,
		QVariant &	result
	)

staticprotected

helper template method for conversion from Python to QVariantMap/Hash

◆ QStringListToPyList()

static PyObject* PythonQtConv::QStringListToPyList ( const QStringList & list )

static

converts QStringList to Python list

◆ QStringListToPyObject()

static PyObject* PythonQtConv::QStringListToPyObject ( const QStringList & list )

static

converts QStringList to Python tuple

◆ QStringToPyObject()

static PyObject* PythonQtConv::QStringToPyObject ( const QString & str )

static

converts QString to Python string (unicode!)

◆ QVariantHashToPyObject()

static PyObject* PythonQtConv::QVariantHashToPyObject ( const QVariantHash & m )

static

◆ QVariantListToPyObject()

static PyObject* PythonQtConv::QVariantListToPyObject ( const QVariantList & l )

static

◆ QVariantMapToPyObject()

static PyObject* PythonQtConv::QVariantMapToPyObject ( const QVariantMap & m )

static

◆ QVariantToPyObject()

static PyObject* PythonQtConv::QVariantToPyObject ( const QVariant & v )

static

convert QVariant from PyObject

◆ registerMetaTypeToPythonConverter()

static void PythonQtConv::registerMetaTypeToPythonConverter	(	int	metaTypeId,
		PythonQtConvertMetaTypeToPythonCB *	cb
	)

inlinestatic

register a converter callback from cpp to python for given metatype

Definition at line 169 of file PythonQtConversion.h.

169 { _metaTypeToPythonConverters.insert(metaTypeId, cb); }

PythonQtConv::_metaTypeToPythonConverters

static QHash< int, PythonQtConvertMetaTypeToPythonCB * > _metaTypeToPythonConverters

Definition: PythonQtConversion.h:208

◆ registerPythonToMetaTypeConverter()

static void PythonQtConv::registerPythonToMetaTypeConverter	(	int	metaTypeId,
		PythonQtConvertPythonToMetaTypeCB *	cb
	)

inlinestatic

register a converter callback from python to cpp for given metatype

Definition at line 166 of file PythonQtConversion.h.

166 { _pythonToMetaTypeConverters.insert(metaTypeId, cb); }

PythonQtConv::_pythonToMetaTypeConverters

static QHash< int, PythonQtConvertPythonToMetaTypeCB * > _pythonToMetaTypeConverters

Definition: PythonQtConversion.h:209

◆ registerStringViewTypes()

static void PythonQtConv::registerStringViewTypes ( )

static

Register QStringView like types, that need to be handled specially.

◆ setPythonSequenceToQVariantListCallback()

static void PythonQtConv::setPythonSequenceToQVariantListCallback ( PythonQtConvertPythonSequenceToQVariantListCB * cb )

inlinestatic

set a callback that is called when a Python sequence should be converted to a QVariantList to allow special conversion.

Definition at line 173 of file PythonQtConversion.h.

173 { _pythonSequenceToQVariantListCB = cb; }

PythonQtConv::_pythonSequenceToQVariantListCB

static PythonQtConvertPythonSequenceToQVariantListCB * _pythonSequenceToQVariantListCB

Definition: PythonQtConversion.h:210

Member Data Documentation

◆ _metaTypeToPythonConverters

QHash<int, PythonQtConvertMetaTypeToPythonCB*> PythonQtConv::_metaTypeToPythonConverters

staticprotected

Definition at line 208 of file PythonQtConversion.h.

◆ _pythonSequenceToQVariantListCB

PythonQtConvertPythonSequenceToQVariantListCB* PythonQtConv::_pythonSequenceToQVariantListCB

staticprotected

Definition at line 210 of file PythonQtConversion.h.

◆ _pythonToMetaTypeConverters

QHash<int, PythonQtConvertPythonToMetaTypeCB*> PythonQtConv::_pythonToMetaTypeConverters

staticprotected

Definition at line 209 of file PythonQtConversion.h.

◆ stringRefTypeId

int PythonQtConv::stringRefTypeId

staticprotected

Definition at line 228 of file PythonQtConversion.h.

The documentation for this class was generated from the following file:

PythonQtConversion.h

Static Public Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ castWrapperTo()

◆ convertFromPythonQtObjectPtr()

◆ convertFromPythonQtSafeObjectPtr()

◆ convertFromQListOfPythonQtObjectPtr()

◆ convertFromStringRef()

◆ ConvertPythonListToQListOfPointerType()

◆ ConvertPythonToQt()

◆ ConvertQListOfPointerTypeToPythonList()

◆ ConvertQtValueToPython()

◆ convertQtValueToPythonInternal()

◆ convertToPythonQtObjectPtr()

◆ convertToPythonQtSafeObjectPtr()

◆ convertToQListOfPythonQtObjectPtr()

◆ CPPObjectToString()

◆ createCopyFromMetaType()

◆ CreateQtReturnValue()

◆ getCPPTypeName()

◆ GetPyBool()

◆ handlePythonToQtAutoConversion()

◆ isStringType()

◆ mapToPython()

◆ PyObjGetBool()

◆ PyObjGetBytes()

◆ PyObjGetBytesAllowString()

◆ PyObjGetDouble()

◆ PyObjGetInt()

◆ PyObjGetLongLong()

◆ PyObjGetRepresentation()

◆ PyObjGetString() [1/2]

◆ PyObjGetString() [2/2]

◆ PyObjGetULongLong()

◆ PyObjToQVariant()

◆ PyObjToStringList()

◆ pythonToMapVariant()

◆ QStringListToPyList()

◆ QStringListToPyObject()

◆ QStringToPyObject()

◆ QVariantHashToPyObject()

◆ QVariantListToPyObject()

◆ QVariantMapToPyObject()

◆ QVariantToPyObject()

◆ registerMetaTypeToPythonConverter()

◆ registerPythonToMetaTypeConverter()

◆ registerStringViewTypes()

◆ setPythonSequenceToQVariantListCallback()

Member Data Documentation

◆ _metaTypeToPythonConverters

◆ _pythonSequenceToQVariantListCB

◆ _pythonToMetaTypeConverters

◆ stringRefTypeId