fix Python API compatibility (qgis#58860)

* fix Python API compatibility * Update qgis.h
nicogodet · Sep 25, 2024 · eafa4b4 · eafa4b4
1 parent 6d4e343
commit eafa4b4
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 14 deletions.
diff --git a/python/PyQt6/core/auto_additions/qgis.py b/python/PyQt6/core/auto_additions/qgis.py
@@ -727,12 +727,23 @@
 Qgis.VectorLayerTypeFlags = lambda flags=0: Qgis.VectorLayerTypeFlag(flags)
 Qgis.VectorLayerTypeFlags.baseClass = Qgis
 VectorLayerTypeFlags = Qgis  # dirty hack since SIP seems to introduce the flags in module
-# monkey patching scoped based enum
-Qgis.PythonEmbeddedMode.Never.__doc__ = "Python embedded never run"
-Qgis.PythonEmbeddedMode.Ask.__doc__ = "User is prompt before running"
-Qgis.PythonEmbeddedMode.SessionOnly.__doc__ = "Only during this session"
-Qgis.PythonEmbeddedMode.Always.__doc__ = "Python embedded is always run"
-Qgis.PythonEmbeddedMode.NotForThisSession.__doc__ = "Python embedded will not be run for this session"
+Qgis.PythonMacroMode = Qgis.PythonEmbeddedMode
+# monkey patching scoped based enum
+Qgis.Never = Qgis.PythonEmbeddedMode.Never
+Qgis.Never.is_monkey_patched = True
+Qgis.Never.__doc__ = "Python embedded never run"
+Qgis.Ask = Qgis.PythonEmbeddedMode.Ask
+Qgis.Ask.is_monkey_patched = True
+Qgis.Ask.__doc__ = "User is prompt before running"
+Qgis.SessionOnly = Qgis.PythonEmbeddedMode.SessionOnly
+Qgis.SessionOnly.is_monkey_patched = True
+Qgis.SessionOnly.__doc__ = "Only during this session"
+Qgis.Always = Qgis.PythonEmbeddedMode.Always
+Qgis.Always.is_monkey_patched = True
+Qgis.Always.__doc__ = "Python embedded is always run"
+Qgis.NotForThisSession = Qgis.PythonEmbeddedMode.NotForThisSession
+Qgis.NotForThisSession.is_monkey_patched = True
+Qgis.NotForThisSession.__doc__ = "Python embedded will not be run for this session"
 Qgis.PythonEmbeddedMode.__doc__ = """Authorisation to run Python Embedded in projects
 
 .. versionadded:: 3.40

diff --git a/python/core/__init__.py.in b/python/core/__init__.py.in
@@ -98,6 +98,8 @@ QgsProviderMetadata = PyProviderMetadata
 
 # monkey patch deprecated enum values to maintain API
 # TODO - remove for QGIS 4.0
+Qgis.PythonMacroMode = Qgis.PythonEmbeddedMode
+
 QgsMarkerLineSymbolLayer.Interval = Qgis.MarkerLinePlacement.Interval
 QgsMarkerLineSymbolLayer.Vertex = Qgis.MarkerLinePlacement.Vertex
 QgsMarkerLineSymbolLayer.LastVertex = Qgis.MarkerLinePlacement.LastVertex

diff --git a/python/core/auto_additions/qgis.py b/python/core/auto_additions/qgis.py
@@ -718,12 +718,23 @@
 Qgis.VectorLayerTypeFlag.baseClass = Qgis
 Qgis.VectorLayerTypeFlags.baseClass = Qgis
 VectorLayerTypeFlags = Qgis  # dirty hack since SIP seems to introduce the flags in module
-# monkey patching scoped based enum
-Qgis.PythonEmbeddedMode.Never.__doc__ = "Python embedded never run"
-Qgis.PythonEmbeddedMode.Ask.__doc__ = "User is prompt before running"
-Qgis.PythonEmbeddedMode.SessionOnly.__doc__ = "Only during this session"
-Qgis.PythonEmbeddedMode.Always.__doc__ = "Python embedded is always run"
-Qgis.PythonEmbeddedMode.NotForThisSession.__doc__ = "Python embedded will not be run for this session"
+Qgis.PythonMacroMode = Qgis.PythonEmbeddedMode
+# monkey patching scoped based enum
+Qgis.Never = Qgis.PythonEmbeddedMode.Never
+Qgis.Never.is_monkey_patched = True
+Qgis.Never.__doc__ = "Python embedded never run"
+Qgis.Ask = Qgis.PythonEmbeddedMode.Ask
+Qgis.Ask.is_monkey_patched = True
+Qgis.Ask.__doc__ = "User is prompt before running"
+Qgis.SessionOnly = Qgis.PythonEmbeddedMode.SessionOnly
+Qgis.SessionOnly.is_monkey_patched = True
+Qgis.SessionOnly.__doc__ = "Only during this session"
+Qgis.Always = Qgis.PythonEmbeddedMode.Always
+Qgis.Always.is_monkey_patched = True
+Qgis.Always.__doc__ = "Python embedded is always run"
+Qgis.NotForThisSession = Qgis.PythonEmbeddedMode.NotForThisSession
+Qgis.NotForThisSession.is_monkey_patched = True
+Qgis.NotForThisSession.__doc__ = "Python embedded will not be run for this session"
 Qgis.PythonEmbeddedMode.__doc__ = """Authorisation to run Python Embedded in projects
 
 .. versionadded:: 3.40

diff --git a/src/core/qgis.h b/src/core/qgis.h
@@ -399,8 +399,8 @@ class CORE_EXPORT Qgis
      * Authorisation to run Python Embedded in projects
      * \since QGIS 3.40
      */
-    enum class PythonEmbeddedMode : int
-    {
+    enum class PythonEmbeddedMode SIP_MONKEYPATCH_SCOPEENUM_UNNEST( Qgis, PythonMacroMode ) : int
+      {
       Never = 0, //!< Python embedded never run
       Ask = 1, //!< User is prompt before running
       SessionOnly = 2, //!< Only during this session