Merge pull request #57217 from signedav/duplicatepolicy

Duplicate policy on QgsFields when duplicate features

python/PyQt6/core/auto_additions/qgis.py

@@ -3215,6 +3215,13 @@
 # --
 Qgis.FieldDomainMergePolicy.baseClass = Qgis
 # monkey patching scoped based enum
+Qgis.FieldDuplicatePolicy.DefaultValue.__doc__ = "Use default field value"
+Qgis.FieldDuplicatePolicy.Duplicate.__doc__ = "Duplicate original value"
+Qgis.FieldDuplicatePolicy.UnsetField.__doc__ = "Clears the field value so that the data provider backend will populate using any backend triggers or similar logic (since QGIS 3.30)"
+Qgis.FieldDuplicatePolicy.__doc__ = "Duplicate policy for fields.\n\nWhen a feature is duplicated, defines how the value of attributes are computed.\n\n.. versionadded:: 3.38\n\n" + '* ``DefaultValue``: ' + Qgis.FieldDuplicatePolicy.DefaultValue.__doc__ + '\n' + '* ``Duplicate``: ' + Qgis.FieldDuplicatePolicy.Duplicate.__doc__ + '\n' + '* ``UnsetField``: ' + Qgis.FieldDuplicatePolicy.UnsetField.__doc__
+# --
+Qgis.FieldDuplicatePolicy.baseClass = Qgis
+# monkey patching scoped based enum
 Qgis.FieldDomainType.Coded.__doc__ = "Coded field domain"
 Qgis.FieldDomainType.Range.__doc__ = "Numeric range field domain (min/max)"
 Qgis.FieldDomainType.Glob.__doc__ = "Glob string pattern field domain"

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

@@ -1826,6 +1826,13 @@ The development version
       GeometryWeighted,
     };
 
+    enum class FieldDuplicatePolicy /BaseType=IntEnum/
+    {
+      DefaultValue,
+      Duplicate,
+      UnsetField,
+    };
+
     enum class FieldDomainType /BaseType=IntEnum/
     {
       Coded,

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

@@ -466,6 +466,26 @@ be handled during a split operation.
 .. seealso:: :py:func:`splitPolicy`
 
 .. versionadded:: 3.30
+%End
+
+    Qgis::FieldDuplicatePolicy duplicatePolicy() const;
+%Docstring
+Returns the field's duplicate policy, which indicates how field values should
+be handled during a duplicate operation.
+
+.. seealso:: :py:func:`setDuplicatePolicy`
+
+.. versionadded:: 3.38
+%End
+
+    void setDuplicatePolicy( Qgis::FieldDuplicatePolicy policy );
+%Docstring
+Sets the field's duplicate ``policy``, which indicates how field values should
+be handled during a duplicate operation.
+
+.. seealso:: :py:func:`duplicatePolicy`
+
+.. versionadded:: 3.38
 %End
 
     SIP_PYOBJECT __repr__();

python/PyQt6/core/auto_generated/vector/qgsvectorlayer.sip.in

@@ -1935,6 +1935,27 @@ Sets a split ``policy`` for the field with the specified index.
     }
 %End
 
+    void setFieldDuplicatePolicy( int index, Qgis::FieldDuplicatePolicy policy );
+%Docstring
+Sets a duplicate ``policy`` for the field with the specified index.
+
+:raises KeyError: if no field with the specified index exists
+
+.. versionadded:: 3.38
+%End
+
+%MethodCode
+    if ( a0 < 0 || a0 >= sipCpp->fields().count() )
+    {
+      PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
+      sipIsErr = 1;
+    }
+    else
+    {
+      sipCpp->setFieldDuplicatePolicy( a0, a1 );
+    }
+%End
+
  QSet<QString> excludeAttributesWms() const /Deprecated/;
 %Docstring
 A set of attributes that are not advertised in WMS requests with QGIS server.

python/core/auto_additions/qgis.py

@@ -3160,6 +3160,13 @@
 # --
 Qgis.FieldDomainMergePolicy.baseClass = Qgis
 # monkey patching scoped based enum
+Qgis.FieldDuplicatePolicy.DefaultValue.__doc__ = "Use default field value"
+Qgis.FieldDuplicatePolicy.Duplicate.__doc__ = "Duplicate original value"
+Qgis.FieldDuplicatePolicy.UnsetField.__doc__ = "Clears the field value so that the data provider backend will populate using any backend triggers or similar logic (since QGIS 3.30)"
+Qgis.FieldDuplicatePolicy.__doc__ = "Duplicate policy for fields.\n\nWhen a feature is duplicated, defines how the value of attributes are computed.\n\n.. versionadded:: 3.38\n\n" + '* ``DefaultValue``: ' + Qgis.FieldDuplicatePolicy.DefaultValue.__doc__ + '\n' + '* ``Duplicate``: ' + Qgis.FieldDuplicatePolicy.Duplicate.__doc__ + '\n' + '* ``UnsetField``: ' + Qgis.FieldDuplicatePolicy.UnsetField.__doc__
+# --
+Qgis.FieldDuplicatePolicy.baseClass = Qgis
+# monkey patching scoped based enum
 Qgis.FieldDomainType.Coded.__doc__ = "Coded field domain"
 Qgis.FieldDomainType.Range.__doc__ = "Numeric range field domain (min/max)"
 Qgis.FieldDomainType.Glob.__doc__ = "Glob string pattern field domain"

python/core/auto_generated/qgis.sip.in

@@ -1826,6 +1826,13 @@ The development version
       GeometryWeighted,
     };
 
+    enum class FieldDuplicatePolicy
+    {
+      DefaultValue,
+      Duplicate,
+      UnsetField,
+    };
+
     enum class FieldDomainType
     {
       Coded,

python/core/auto_generated/qgsfield.sip.in

@@ -466,6 +466,26 @@ be handled during a split operation.
 .. seealso:: :py:func:`splitPolicy`
 
 .. versionadded:: 3.30
+%End
+
+    Qgis::FieldDuplicatePolicy duplicatePolicy() const;
+%Docstring
+Returns the field's duplicate policy, which indicates how field values should
+be handled during a duplicate operation.
+
+.. seealso:: :py:func:`setDuplicatePolicy`
+
+.. versionadded:: 3.38
+%End
+
+    void setDuplicatePolicy( Qgis::FieldDuplicatePolicy policy );
+%Docstring
+Sets the field's duplicate ``policy``, which indicates how field values should
+be handled during a duplicate operation.
+
+.. seealso:: :py:func:`duplicatePolicy`
+
+.. versionadded:: 3.38
 %End
 
     SIP_PYOBJECT __repr__();

python/core/auto_generated/vector/qgsvectorlayer.sip.in

@@ -1935,6 +1935,27 @@ Sets a split ``policy`` for the field with the specified index.
     }
 %End
 
+    void setFieldDuplicatePolicy( int index, Qgis::FieldDuplicatePolicy policy );
+%Docstring
+Sets a duplicate ``policy`` for the field with the specified index.
+
+:raises KeyError: if no field with the specified index exists
+
+.. versionadded:: 3.38
+%End
+
+%MethodCode
+    if ( a0 < 0 || a0 >= sipCpp->fields().count() )
+    {
+      PyErr_SetString( PyExc_KeyError, QByteArray::number( a0 ) );
+      sipIsErr = 1;
+    }
+    else
+    {
+      sipCpp->setFieldDuplicatePolicy( a0, a1 );
+    }
+%End
+
  QSet<QString> excludeAttributesWms() const /Deprecated/;
 %Docstring
 A set of attributes that are not advertised in WMS requests with QGIS server.

src/core/qgis.h

@@ -3218,6 +3218,21 @@ class CORE_EXPORT Qgis
     };
     Q_ENUM( FieldDomainMergePolicy )
 
+    /**
+     * Duplicate policy for fields.
+     *
+     * When a feature is duplicated, defines how the value of attributes are computed.
+     *
+     * \since QGIS 3.38
+     */
+    enum class FieldDuplicatePolicy : int
+    {
+      DefaultValue, //!< Use default field value
+      Duplicate, //!< Duplicate original value
+      UnsetField, //!< Clears the field value so that the data provider backend will populate using any backend triggers or similar logic (since QGIS 3.30)
+    };
+    Q_ENUM( FieldDuplicatePolicy )
+
     /**
      * Types of field domain
      *

src/core/qgsfield.cpp

@@ -706,6 +706,11 @@ bool QgsField::convertCompatible( QVariant &v, QString *errorMessage ) const
   return true;
 }
 
+QgsField::operator QVariant() const
+{
+  return QVariant::fromValue( *this );
+}
+
 void QgsField::setEditorWidgetSetup( const QgsEditorWidgetSetup &v )
 {
   d->editorWidgetSetup = v;
@@ -736,6 +741,16 @@ void QgsField::setSplitPolicy( Qgis::FieldDomainSplitPolicy policy )
   d->splitPolicy = policy;
 }
 
+Qgis::FieldDuplicatePolicy QgsField::duplicatePolicy() const
+{
+  return d->duplicatePolicy;
+}
+
+void QgsField::setDuplicatePolicy( Qgis::FieldDuplicatePolicy policy )
+{
+  d->duplicatePolicy = policy;
+}
+
 /***************************************************************************
  * This class is considered CRITICAL and any change MUST be accompanied with
  * full unit tests in testqgsfield.cpp.
@@ -764,6 +779,7 @@ QDataStream &operator<<( QDataStream &out, const QgsField &field )
   out << field.constraints().constraintDescription();
   out << static_cast< quint32 >( field.subType() );
   out << static_cast< int >( field.splitPolicy() );
+  out << static_cast< int >( field.duplicatePolicy() );
   out << field.metadata();
   return out;
 }
@@ -782,6 +798,7 @@ QDataStream &operator>>( QDataStream &in, QgsField &field )
   quint32 strengthUnique;
   quint32 strengthExpression;
   int splitPolicy;
+  int duplicatePolicy;
 
   bool applyOnUpdate;
 
@@ -796,7 +813,7 @@ QDataStream &operator>>( QDataStream &in, QgsField &field )
 
   in >> name >> type >> typeName >> length >> precision >> comment >> alias
      >> defaultValueExpression >> applyOnUpdate >> constraints >> originNotNull >> originUnique >> originExpression >> strengthNotNull >> strengthUnique >> strengthExpression >>
-     constraintExpression >> constraintDescription >> subType >> splitPolicy >> metadata;
+     constraintExpression >> constraintDescription >> subType >> splitPolicy >> duplicatePolicy >> metadata;
   field.setName( name );
   field.setType( static_cast< QVariant::Type >( type ) );
   field.setTypeName( typeName );
@@ -806,6 +823,7 @@ QDataStream &operator>>( QDataStream &in, QgsField &field )
   field.setAlias( alias );
   field.setDefaultValueDefinition( QgsDefaultValue( defaultValueExpression, applyOnUpdate ) );
   field.setSplitPolicy( static_cast< Qgis::FieldDomainSplitPolicy >( splitPolicy ) );
+  field.setDuplicatePolicy( static_cast< Qgis::FieldDuplicatePolicy >( duplicatePolicy ) );
   QgsFieldConstraints fieldConstraints;
   if ( constraints & QgsFieldConstraints::ConstraintNotNull )
   {

src/core/qgsfield.h

@@ -441,10 +441,7 @@ class CORE_EXPORT QgsField
 #endif
 
     //! Allows direct construction of QVariants from fields.
-    operator QVariant() const
-    {
-      return QVariant::fromValue( *this );
-    }
+    operator QVariant() const;
 
     /**
      * Set the editor widget setup for the field.
@@ -497,6 +494,26 @@ class CORE_EXPORT QgsField
      */
     void setSplitPolicy( Qgis::FieldDomainSplitPolicy policy );
 
+    /**
+     * Returns the field's duplicate policy, which indicates how field values should
+     * be handled during a duplicate operation.
+     *
+     * \see setDuplicatePolicy()
+     *
+     * \since QGIS 3.38
+     */
+    Qgis::FieldDuplicatePolicy duplicatePolicy() const;
+
+    /**
+     * Sets the field's duplicate \a policy, which indicates how field values should
+     * be handled during a duplicate operation.
+     *
+     * \see duplicatePolicy()
+     *
+     * \since QGIS 3.38
+     */
+    void setDuplicatePolicy( Qgis::FieldDuplicatePolicy policy );
+
 #ifdef SIP_RUN
     SIP_PYOBJECT __repr__();
     % MethodCode

src/core/qgsfield_p.h

@@ -84,6 +84,7 @@ class QgsFieldPrivate : public QSharedData
       , constraints( other.constraints )
       , editorWidgetSetup( other.editorWidgetSetup )
       , splitPolicy( other.splitPolicy )
+      , duplicatePolicy( other.duplicatePolicy )
       , isReadOnly( other.isReadOnly )
     {
     }
@@ -99,6 +100,7 @@ class QgsFieldPrivate : public QSharedData
                && ( alias == other.alias ) && ( defaultValueDefinition == other.defaultValueDefinition )
                && ( constraints == other.constraints )  && ( flags == other.flags )
                && ( splitPolicy == other.splitPolicy )
+               && ( duplicatePolicy == other.duplicatePolicy )
                && ( isReadOnly == other.isReadOnly )
                && ( editorWidgetSetup == other.editorWidgetSetup ) );
     }
@@ -144,6 +146,9 @@ class QgsFieldPrivate : public QSharedData
     //! Split policy
     Qgis::FieldDomainSplitPolicy splitPolicy = Qgis::FieldDomainSplitPolicy::Duplicate;
 
+    //! Duplicate policy
+    Qgis::FieldDuplicatePolicy duplicatePolicy = Qgis::FieldDuplicatePolicy::Duplicate;
+
     //! Read-only
     bool isReadOnly = false;