Merge pull request #58864 from rouault/fix_58861

QgsJsonUtils: add a way to disable use of field formatters
2025-02-25 00:58:06 -05:00 · 2024-09-26 23:37:12 +02:00 · 2024-09-26 23:37:12 +02:00 · 8335dab269
commit 8335dab269
parent 6a488de21a dc1583bd7c
5 changed files with 92 additions and 6 deletions
--- a/python/PyQt6/core/auto_generated/qgsjsonutils.sip.in
+++ b/python/PyQt6/core/auto_generated/qgsjsonutils.sip.in
@ -220,6 +220,24 @@ take precedence over attributes included via :py:func:`~QgsJsonExporter.attribut
 .. seealso:: :py:func:`setExcludedAttributes`

 .. seealso:: :py:func:`attributes`
+%End
+
+    void setUseFieldFormatters( bool useFieldFormatters );
+%Docstring
+Sets whether field formatters (of type KeyValue, List, ValueRelation,
+ValueMap) are used to export raw values as displayed
+values. The default is true.
+
+.. versionadded:: 3.40
+%End
+
+    bool useFieldFormatters() const;
+%Docstring
+Returned whether field formatters (of type KeyValue, List, ValueRelation,
+ValueMap) are used to export raw values as displayed
+values.
+
+.. versionadded:: 3.40
 %End

    QString exportFeature( const QgsFeature &feature,
--- a/python/core/auto_generated/qgsjsonutils.sip.in
+++ b/python/core/auto_generated/qgsjsonutils.sip.in
@ -220,6 +220,24 @@ take precedence over attributes included via :py:func:`~QgsJsonExporter.attribut
 .. seealso:: :py:func:`setExcludedAttributes`

 .. seealso:: :py:func:`attributes`
+%End
+
+    void setUseFieldFormatters( bool useFieldFormatters );
+%Docstring
+Sets whether field formatters (of type KeyValue, List, ValueRelation,
+ValueMap) are used to export raw values as displayed
+values. The default is true.
+
+.. versionadded:: 3.40
+%End
+
+    bool useFieldFormatters() const;
+%Docstring
+Returned whether field formatters (of type KeyValue, List, ValueRelation,
+ValueMap) are used to export raw values as displayed
+values.
+
+.. versionadded:: 3.40
 %End

    QString exportFeature( const QgsFeature &feature,
--- a/src/core/qgsjsonutils.cpp
+++ b/src/core/qgsjsonutils.cpp
@ -170,7 +170,7 @@ json QgsJsonExporter::exportFeatureToJsonObject( const QgsFeature &feature, cons

        QVariant val = feature.attributes().at( i );

-        if ( mLayer )
+        if ( mUseFieldFormatters && mLayer )
        {
          const QgsEditorWidgetSetup setup = fields.at( i ).editorWidgetSetup();
          const QgsFieldFormatter *fieldFormatter = QgsApplication::fieldFormatterRegistry()->fieldFormatter( setup.type() );
@ -222,7 +222,7 @@ json QgsJsonExporter::exportFeatureToJsonObject( const QgsFeature &feature, cons
          QgsFeature relatedFet;
          while ( it.nextFeature( relatedFet ) )
          {
-            relatedFeatureAttributes += QgsJsonUtils::exportAttributesToJsonObject( relatedFet, childLayer, attributeWidgetCaches );
+            relatedFeatureAttributes += QgsJsonUtils::exportAttributesToJsonObject( relatedFet, childLayer, attributeWidgetCaches, mUseFieldFormatters );
          }
        }
        properties[ relation.name().toStdString() ] = relatedFeatureAttributes;
@ -901,7 +901,7 @@ QVariant QgsJsonUtils::parseJson( const QString &jsonString )
  return parseJson( jsonString.toStdString() );
 }

-json QgsJsonUtils::exportAttributesToJsonObject( const QgsFeature &feature, QgsVectorLayer *layer, const QVector<QVariant> &attributeWidgetCaches )
+json QgsJsonUtils::exportAttributesToJsonObject( const QgsFeature &feature, QgsVectorLayer *layer, const QVector<QVariant> &attributeWidgetCaches, bool useFieldFormatters )
 {
  QgsFields fields = feature.fields();
  json attrs;
@ -909,7 +909,7 @@ json QgsJsonUtils::exportAttributesToJsonObject( const QgsFeature &feature, QgsV
  {
    QVariant val = feature.attributes().at( i );

-    if ( layer )
+    if ( layer && useFieldFormatters )
    {
      QgsEditorWidgetSetup setup = layer->fields().at( i ).editorWidgetSetup();
      QgsFieldFormatter *fieldFormatter = QgsApplication::fieldFormatterRegistry()->fieldFormatter( setup.type() );
--- a/src/core/qgsjsonutils.h
+++ b/src/core/qgsjsonutils.h
@ -197,6 +197,22 @@ class CORE_EXPORT QgsJsonExporter
     */
    QgsAttributeList excludedAttributes() const { return mExcludedAttributeIndexes; }

+    /**
+     * Sets whether field formatters (of type KeyValue, List, ValueRelation,
+     * ValueMap) are used to export raw values as displayed
+     * values. The default is true.
+     * \since QGIS 3.40
+     */
+    void setUseFieldFormatters( bool useFieldFormatters ) { mUseFieldFormatters = useFieldFormatters; }
+
+    /**
+     * Returned whether field formatters (of type KeyValue, List, ValueRelation,
+     * ValueMap) are used to export raw values as displayed
+     * values.
+     * \since QGIS 3.40
+     */
+    bool useFieldFormatters() const { return mUseFieldFormatters; }
+
    /**
     * Returns a GeoJSON string representation of a feature.
     * \param feature feature to convert
@ -291,6 +307,8 @@ class CORE_EXPORT QgsJsonExporter
    bool mTransformGeometries = true;

    QgsCoordinateReferenceSystem mDestinationCrs;
+
+    bool mUseFieldFormatters = true;
 };

 /**
@ -350,11 +368,12 @@ class CORE_EXPORT QgsJsonUtils
     * richer export utilising settings like the layer's fields widget configuration.
     * \param attributeWidgetCaches optional widget configuration cache. Can be used
     * to speed up exporting the attributes for multiple features from the same layer.
+     * \param useFieldFormatters Whether field formatters should be used (since QGIS 3.40)
     * \note Not available in Python bindings
     * \since QGIS 3.8
     */
    static json exportAttributesToJsonObject( const QgsFeature &feature, QgsVectorLayer *layer = nullptr,
-        const QVector<QVariant> &attributeWidgetCaches = QVector<QVariant>() ) SIP_SKIP;
+        const QVector<QVariant> &attributeWidgetCaches = QVector<QVariant>(), bool useFieldFormatters = true ) SIP_SKIP;

    /**
     * Parse a simple array (depth=1)
--- a/tests/src/python/test_qgsjsonutils.py
+++ b/tests/src/python/test_qgsjsonutils.py
@ -726,11 +726,12 @@ class TestQgsJsonUtils(QgisTestCase):
        # with field formatter
        setup = QgsEditorWidgetSetup('ValueMap', {"map": {"apples": 123, "bananas": 124}})
        child.setEditorWidgetSetup(1, setup)
+        parent.setEditorWidgetSetup(1, QgsEditorWidgetSetup('ValueMap', {"map": {"sixty-seven": 67}}))
        expected = """{
  "geometry": null,
  "id": 432,
  "properties": {
-    "fldint": 67,
+    "fldint": "sixty-seven",
    "fldtxt": "test1",
    "foreignkey": 123,
    "relation one": [
@ -750,6 +751,36 @@ class TestQgsJsonUtils(QgisTestCase):
 }"""
        self.assertEqual(exporter.exportFeature(pf1, indent=2), expected)

+        # Use raw values
+        self.assertTrue(exporter.useFieldFormatters())
+        exporter.setUseFieldFormatters(False)
+        self.assertFalse(exporter.useFieldFormatters())
+        expected = """{
+  "geometry": null,
+  "id": 432,
+  "properties": {
+    "fldint": 67,
+    "fldtxt": "test1",
+    "foreignkey": 123,
+    "relation one": [
+      {
+        "x": "foo",
+        "y": 123,
+        "z": 321
+      },
+      {
+        "x": "bar",
+        "y": 123,
+        "z": 654
+      }
+    ]
+  },
+  "type": "Feature"
+}"""
+        self.assertEqual(exporter.exportFeature(pf1, indent=2), expected)
+        exporter.setUseFieldFormatters(True)
+        parent.setEditorWidgetSetup(1, QgsEditorWidgetSetup())
+
        # test excluding related attributes
        exporter.setIncludeRelated(False)
        self.assertEqual(exporter.includeRelated(), False)