Deprecate QgsGeometry::set for usage in Python

m-kuhn · m-kuhn · commit 612576ca8ef9 · 2019-02-03T19:47:01.000+01:00
When a new QgsAbstractGeometry is set on a geometry object, the previous child is deleted. If the previous object was constructed by Python, it's wrapper will still be alive for as long as the QgsGeometry is alive. If a new QgsAbstractGeometry is constructed at the same memory address as the old one, the wrapper will be reused with wrong type (and other) information, leading to all kind of weird issues. See also https://www.riverbankcomputing.com/pipermail/pyqt/2019-January/041251.html
diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in
@@ -133,6 +133,12 @@ Sets the underlying geometry store. Ownership of geometry is transferred.
 
    In QGIS 2.x this method was named setGeometry().
 
+.. note::
+
+   This method is deprecated for usage in Python and will be removed from Python bindings with QGIS 4.
+   Using this method will confuse Python's memory management and type information system.
+   Better create a new QgsGeometry object instead.
+
 .. seealso:: :py:func:`get`
 
 .. seealso:: :py:func:`constGet`
diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h
@@ -196,6 +196,9 @@ class CORE_EXPORT QgsGeometry
      * Sets the underlying geometry store. Ownership of geometry is transferred.
      *
      * \note In QGIS 2.x this method was named setGeometry().
+     * \note This method is deprecated for usage in Python and will be removed from Python bindings with QGIS 4.
+     *       Using this method will confuse Python's memory management and type information system.
+     *       Better create a new QgsGeometry object instead.
      *
      * \see get()
      * \see constGet()

Original file line number	Diff line number	Diff line change
`@@ -196,6 +196,9 @@ class CORE_EXPORT QgsGeometry`
`196`	`196`	`* Sets the underlying geometry store. Ownership of geometry is transferred.`
`197`	`197`	`*`
`198`	`198`	`* \note In QGIS 2.x this method was named setGeometry().`
	`199`	`+ * \note This method is deprecated for usage in Python and will be removed from Python bindings with QGIS 4.`
	`200`	`+ * Using this method will confuse Python's memory management and type information system.`
	`201`	`+ * Better create a new QgsGeometry object instead.`
`199`	`202`	`*`
`200`	`203`	`* \see get()`
`201`	`204`	`* \see constGet()`