Promote QgsFeatureRequest enums to enum class, move to Qgis

Author: nyalldawson

python/PyQt6/core/auto_additions/qgis.py

@@ -1671,6 +1671,70 @@
 Qgis.MakeValidMethod.__doc__ = "Algorithms to use when repairing invalid geometries.\n\n.. versionadded:: 3.28\n\n" + '* ``Linework``: ' + Qgis.MakeValidMethod.Linework.__doc__ + '\n' + '* ``Structure``: ' + Qgis.MakeValidMethod.Structure.__doc__
 # --
 Qgis.MakeValidMethod.baseClass = Qgis
+QgsFeatureRequest.Flag = Qgis.FeatureRequestFlag
+# monkey patching scoped based enum
+QgsFeatureRequest.NoFlags = Qgis.FeatureRequestFlag.NoFlags
+QgsFeatureRequest.NoFlags.is_monkey_patched = True
+QgsFeatureRequest.NoFlags.__doc__ = "No flags are set"
+QgsFeatureRequest.NoGeometry = Qgis.FeatureRequestFlag.NoGeometry
+QgsFeatureRequest.NoGeometry.is_monkey_patched = True
+QgsFeatureRequest.NoGeometry.__doc__ = "Geometry is not required. It may still be returned if e.g. required for a filter condition."
+QgsFeatureRequest.SubsetOfAttributes = Qgis.FeatureRequestFlag.SubsetOfAttributes
+QgsFeatureRequest.SubsetOfAttributes.is_monkey_patched = True
+QgsFeatureRequest.SubsetOfAttributes.__doc__ = "Fetch only a subset of attributes (setSubsetOfAttributes sets this flag)"
+QgsFeatureRequest.ExactIntersect = Qgis.FeatureRequestFlag.ExactIntersect
+QgsFeatureRequest.ExactIntersect.is_monkey_patched = True
+QgsFeatureRequest.ExactIntersect.__doc__ = "Use exact geometry intersection (slower) instead of bounding boxes"
+QgsFeatureRequest.IgnoreStaticNodesDuringExpressionCompilation = Qgis.FeatureRequestFlag.IgnoreStaticNodesDuringExpressionCompilation
+QgsFeatureRequest.IgnoreStaticNodesDuringExpressionCompilation.is_monkey_patched = True
+QgsFeatureRequest.IgnoreStaticNodesDuringExpressionCompilation.__doc__ = "If a feature request uses a filter expression which can be partially precalculated due to static nodes in the expression, setting this flag will prevent these precalculated values from being utilized during compilation of the filter for the backend provider. This flag significantly slows down feature requests and should be used for debugging purposes only. (Since QGIS 3.18)"
+QgsFeatureRequest.EmbeddedSymbols = Qgis.FeatureRequestFlag.EmbeddedSymbols
+QgsFeatureRequest.EmbeddedSymbols.is_monkey_patched = True
+QgsFeatureRequest.EmbeddedSymbols.__doc__ = "Retrieve any embedded feature symbology (since QGIS 3.20)"
+Qgis.FeatureRequestFlag.__doc__ = "Flags for controlling feature requests.\n\n.. note::\n\n   Prior to QGIS 3.36 this was available as :py:class:`QgsFeatureRequest`.Flag\n\n.. versionadded:: 3.36\n\n" + '* ``NoFlags``: ' + Qgis.FeatureRequestFlag.NoFlags.__doc__ + '\n' + '* ``NoGeometry``: ' + Qgis.FeatureRequestFlag.NoGeometry.__doc__ + '\n' + '* ``SubsetOfAttributes``: ' + Qgis.FeatureRequestFlag.SubsetOfAttributes.__doc__ + '\n' + '* ``ExactIntersect``: ' + Qgis.FeatureRequestFlag.ExactIntersect.__doc__ + '\n' + '* ``IgnoreStaticNodesDuringExpressionCompilation``: ' + Qgis.FeatureRequestFlag.IgnoreStaticNodesDuringExpressionCompilation.__doc__ + '\n' + '* ``EmbeddedSymbols``: ' + Qgis.FeatureRequestFlag.EmbeddedSymbols.__doc__
+# --
+Qgis.FeatureRequestFlag.baseClass = Qgis
+Qgis.FeatureRequestFlags = lambda flags=0: Qgis.FeatureRequestFlag(flags)
+Qgis.FeatureRequestFlags.baseClass = Qgis
+FeatureRequestFlags = Qgis  # dirty hack since SIP seems to introduce the flags in module
+QgsFeatureRequest.FilterType = Qgis.FeatureRequestFilterType
+# monkey patching scoped based enum
+QgsFeatureRequest.FilterNone = Qgis.FeatureRequestFilterType.NoFilter
+QgsFeatureRequest.FilterType.FilterNone = Qgis.FeatureRequestFilterType.NoFilter
+QgsFeatureRequest.FilterNone.is_monkey_patched = True
+QgsFeatureRequest.FilterNone.__doc__ = "No filter is applied"
+QgsFeatureRequest.FilterFid = Qgis.FeatureRequestFilterType.Fid
+QgsFeatureRequest.FilterType.FilterFid = Qgis.FeatureRequestFilterType.Fid
+QgsFeatureRequest.FilterFid.is_monkey_patched = True
+QgsFeatureRequest.FilterFid.__doc__ = "Filter using feature ID"
+QgsFeatureRequest.FilterExpression = Qgis.FeatureRequestFilterType.Expression
+QgsFeatureRequest.FilterType.FilterExpression = Qgis.FeatureRequestFilterType.Expression
+QgsFeatureRequest.FilterExpression.is_monkey_patched = True
+QgsFeatureRequest.FilterExpression.__doc__ = "Filter using expression"
+QgsFeatureRequest.FilterFids = Qgis.FeatureRequestFilterType.Fids
+QgsFeatureRequest.FilterType.FilterFids = Qgis.FeatureRequestFilterType.Fids
+QgsFeatureRequest.FilterFids.is_monkey_patched = True
+QgsFeatureRequest.FilterFids.__doc__ = "Filter using feature IDs"
+Qgis.FeatureRequestFilterType.__doc__ = "Types of feature request filters.\n\n.. note::\n\n   Prior to QGIS 3.36 this was available as :py:class:`QgsFeatureRequest`.FilterType\n\n.. versionadded:: 3.36\n\n" + '* ``FilterNone``: ' + Qgis.FeatureRequestFilterType.NoFilter.__doc__ + '\n' + '* ``FilterFid``: ' + Qgis.FeatureRequestFilterType.Fid.__doc__ + '\n' + '* ``FilterExpression``: ' + Qgis.FeatureRequestFilterType.Expression.__doc__ + '\n' + '* ``FilterFids``: ' + Qgis.FeatureRequestFilterType.Fids.__doc__
+# --
+Qgis.FeatureRequestFilterType.baseClass = Qgis
+QgsFeatureRequest.InvalidGeometryCheck = Qgis.InvalidGeometryCheck
+# monkey patching scoped based enum
+QgsFeatureRequest.GeometryNoCheck = Qgis.InvalidGeometryCheck.NoCheck
+QgsFeatureRequest.InvalidGeometryCheck.GeometryNoCheck = Qgis.InvalidGeometryCheck.NoCheck
+QgsFeatureRequest.GeometryNoCheck.is_monkey_patched = True
+QgsFeatureRequest.GeometryNoCheck.__doc__ = "No invalid geometry checking"
+QgsFeatureRequest.GeometrySkipInvalid = Qgis.InvalidGeometryCheck.SkipInvalid
+QgsFeatureRequest.InvalidGeometryCheck.GeometrySkipInvalid = Qgis.InvalidGeometryCheck.SkipInvalid
+QgsFeatureRequest.GeometrySkipInvalid.is_monkey_patched = True
+QgsFeatureRequest.GeometrySkipInvalid.__doc__ = "Skip any features with invalid geometry. This requires a slow geometry validity check for every feature."
+QgsFeatureRequest.GeometryAbortOnInvalid = Qgis.InvalidGeometryCheck.AbortOnInvalid
+QgsFeatureRequest.InvalidGeometryCheck.GeometryAbortOnInvalid = Qgis.InvalidGeometryCheck.AbortOnInvalid
+QgsFeatureRequest.GeometryAbortOnInvalid.is_monkey_patched = True
+QgsFeatureRequest.GeometryAbortOnInvalid.__doc__ = "Close iterator on encountering any features with invalid geometry. This requires a slow geometry validity check for every feature."
+Qgis.InvalidGeometryCheck.__doc__ = "Methods for handling of features with invalid geometries\n\n.. note::\n\n   Prior to QGIS 3.36 this was available as :py:class:`QgsFeatureRequest`.InvalidGeometryCheck\n\n.. versionadded:: 3.36\n\n" + '* ``GeometryNoCheck``: ' + Qgis.InvalidGeometryCheck.NoCheck.__doc__ + '\n' + '* ``GeometrySkipInvalid``: ' + Qgis.InvalidGeometryCheck.SkipInvalid.__doc__ + '\n' + '* ``GeometryAbortOnInvalid``: ' + Qgis.InvalidGeometryCheck.AbortOnInvalid.__doc__
+# --
+Qgis.InvalidGeometryCheck.baseClass = Qgis
 # monkey patching scoped based enum
 Qgis.SpatialFilterType.NoFilter.__doc__ = "No spatial filtering of features"
 Qgis.SpatialFilterType.BoundingBox.__doc__ = "Filter using a bounding box"

python/PyQt6/core/auto_additions/qgsfeaturerequest.py

@@ -352,14 +352,14 @@ algorithm or model.
 .. versionadded:: 3.2
 %End
 
-    QgsFeatureRequest::InvalidGeometryCheck invalidGeometryCheck() const /HoldGIL/;
+    Qgis::InvalidGeometryCheck invalidGeometryCheck() const /HoldGIL/;
 %Docstring
 Returns the behavior used for checking invalid geometries in input layers.
 
 .. seealso:: :py:func:`setInvalidGeometryCheck`
 %End
 
-    void setInvalidGeometryCheck( QgsFeatureRequest::InvalidGeometryCheck check );
+    void setInvalidGeometryCheck( Qgis::InvalidGeometryCheck check );
 %Docstring
 Sets the behavior used for checking invalid geometries in input layers.
 Settings this to anything but :py:class:`QgsFeatureRequest`.GeometryNoCheck will also

python/PyQt6/core/auto_generated/processing/qgsprocessingcontext.sip.in

@@ -34,7 +34,7 @@ Encapsulates settings relating to a feature source input to a processing algorit
 
 
     QgsProcessingFeatureSourceDefinition( const QString &source = QString(), bool selectedFeaturesOnly = false, long long featureLimit = -1,
-                                          QgsProcessingFeatureSourceDefinition::Flags flags = QgsProcessingFeatureSourceDefinition::Flags(), QgsFeatureRequest::InvalidGeometryCheck geometryCheck = QgsFeatureRequest::GeometryAbortOnInvalid, const QString &filterExpression = QString() );
+                                          QgsProcessingFeatureSourceDefinition::Flags flags = QgsProcessingFeatureSourceDefinition::Flags(), Qgis::InvalidGeometryCheck geometryCheck = Qgis::InvalidGeometryCheck::AbortOnInvalid, const QString &filterExpression = QString() );
 %Docstring
 Constructor for QgsProcessingFeatureSourceDefinition, accepting a static string ``source``.
 
@@ -53,7 +53,7 @@ the default geometry check method (as dictated by :py:class:`QgsProcessingContex
 %End
 
     QgsProcessingFeatureSourceDefinition( const QgsProperty &source, bool selectedFeaturesOnly = false, long long featureLimit = -1,
-                                          QgsProcessingFeatureSourceDefinition::Flags flags = QgsProcessingFeatureSourceDefinition::Flags(), QgsFeatureRequest::InvalidGeometryCheck geometryCheck = QgsFeatureRequest::GeometryAbortOnInvalid, const QString &filterExpression = QString() );
+                                          QgsProcessingFeatureSourceDefinition::Flags flags = QgsProcessingFeatureSourceDefinition::Flags(), Qgis::InvalidGeometryCheck geometryCheck = Qgis::InvalidGeometryCheck::AbortOnInvalid, const QString &filterExpression = QString() );
 %Docstring
 Constructor for QgsProcessingFeatureSourceDefinition, accepting a QgsProperty source.
 
@@ -81,7 +81,7 @@ the default geometry check method (as dictated by :py:class:`QgsProcessingContex
 
     Flags flags;
 
-    QgsFeatureRequest::InvalidGeometryCheck geometryCheck;
+    Qgis::InvalidGeometryCheck geometryCheck;
 
     QVariant toVariant() const;
 %Docstring

python/PyQt6/core/auto_generated/processing/qgsprocessingparameters.sip.in

@@ -707,7 +707,7 @@ iterator, eg by restricting the returned attributes or geometry.
 Returns an expression context scope suitable for this source.
 %End
 
-    void setInvalidGeometryCheck( QgsFeatureRequest::InvalidGeometryCheck method );
+    void setInvalidGeometryCheck( Qgis::InvalidGeometryCheck method );
 %Docstring
 Overrides the default geometry check method for the source.
 
@@ -716,7 +716,7 @@ Overrides the default geometry check method for the source.
 .. versionadded:: 3.14
 %End
 
-    QgsFeatureRequest::InvalidGeometryCheck invalidGeometryCheck() const;
+    Qgis::InvalidGeometryCheck invalidGeometryCheck() const;
 %Docstring
 Returns the geometry check method for the source.
 

python/PyQt6/core/auto_generated/processing/qgsprocessingutils.sip.in

@@ -981,6 +981,34 @@ The development version
       Structure,
     };
 
+    enum class FeatureRequestFlag /BaseType=IntFlag/
+      {
+      NoFlags,
+      NoGeometry,
+      SubsetOfAttributes,
+      ExactIntersect,
+      IgnoreStaticNodesDuringExpressionCompilation,
+      EmbeddedSymbols,
+    };
+
+    typedef QFlags<Qgis::FeatureRequestFlag> FeatureRequestFlags;
+
+
+    enum class FeatureRequestFilterType /BaseType=IntFlag/
+      {
+      NoFilter,
+      Fid,
+      Expression,
+      Fids
+    };
+
+    enum class InvalidGeometryCheck /BaseType=IntFlag/
+      {
+      NoCheck,
+      SkipInvalid,
+      AbortOnInvalid,
+    };
+
     enum class SpatialFilterType /BaseType=IntFlag/
     {
       NoFilter,
@@ -2560,6 +2588,7 @@ QFlags<Qgis::VectorTileProviderCapability> operator|(Qgis::VectorTileProviderCap
 
 QFlags<Qgis::VectorTileProviderFlag> operator|(Qgis::VectorTileProviderFlag f1, QFlags<Qgis::VectorTileProviderFlag> f2);
 
+QFlags<Qgis::FeatureRequestFlag> operator|(Qgis::FeatureRequestFlag f1, QFlags<Qgis::FeatureRequestFlag> f2);
 
 
 

python/PyQt6/core/auto_generated/qgis.sip.in

@@ -12,7 +12,6 @@
 
 
 
-
 class QgsFeatureFilterProvider
 {
 %Docstring(signature="appended")

python/PyQt6/core/auto_generated/qgsfeaturefilterprovider.sip.in

@@ -64,32 +64,6 @@ Examples:
 #include "qgsfeaturerequest.h"
 %End
   public:
-    enum Flag
-    {
-      NoFlags,
-      NoGeometry,
-      SubsetOfAttributes,
-      ExactIntersect,
-      IgnoreStaticNodesDuringExpressionCompilation,
-      EmbeddedSymbols,
-    };
-    typedef QFlags<QgsFeatureRequest::Flag> Flags;
-
-
-    enum FilterType
-    {
-      FilterNone,
-      FilterFid,
-      FilterExpression,
-      FilterFids
-    };
-
-    enum InvalidGeometryCheck
-    {
-      GeometryNoCheck,
-      GeometrySkipInvalid,
-      GeometryAbortOnInvalid,
-    };
 
     class OrderByClause
 {
@@ -311,7 +285,7 @@ copy constructor
 
     ~QgsFeatureRequest();
 
-    FilterType filterType() const;
+    Qgis::FeatureRequestFilterType filterType() const;
 %Docstring
 Returns the attribute/ID filter type which is currently set on this request.
 
@@ -464,7 +438,7 @@ Returns the feature IDs that should be fetched.
 .. seealso:: :py:func:`filterFid`
 %End
 
-    QgsFeatureRequest &setInvalidGeometryCheck( InvalidGeometryCheck check );
+    QgsFeatureRequest &setInvalidGeometryCheck( Qgis::InvalidGeometryCheck check );
 %Docstring
 Sets invalid geometry checking behavior.
 
@@ -478,7 +452,7 @@ Sets invalid geometry checking behavior.
 .. versionadded:: 3.0
 %End
 
-    InvalidGeometryCheck invalidGeometryCheck() const;
+    Qgis::InvalidGeometryCheck invalidGeometryCheck() const;
 %Docstring
 Returns the invalid geometry checking behavior.
 
@@ -642,14 +616,14 @@ Returns the maximum number of features to request, or -1 if no limit set.
 .. versionadded:: 2.14
 %End
 
-    QgsFeatureRequest &setFlags( QgsFeatureRequest::Flags flags );
+    QgsFeatureRequest &setFlags( Qgis::FeatureRequestFlags flags );
 %Docstring
 Sets ``flags`` that affect how features will be fetched.
 
 .. seealso:: :py:func:`flags`
 %End
 
-    Flags flags() const;
+    Qgis::FeatureRequestFlags flags() const;
 %Docstring
 Returns the flags which affect how features are fetched.
 
@@ -979,9 +953,6 @@ if it should be canceled, if set.
 
 };
 
-QFlags<QgsFeatureRequest::Flag> operator|(QgsFeatureRequest::Flag f1, QFlags<QgsFeatureRequest::Flag> f2);
-
-
 
 
 class QgsAbstractFeatureSource

python/PyQt6/core/auto_generated/qgsfeaturerequest.sip.in

@@ -9,7 +9,6 @@
 
 
 
-
 class QgsFeatureListComboBox : QComboBox
 {
 %Docstring(signature="appended")