Add flag to QgsProviderSublayerDetails to indicate that the uri

may be a container for other sublayers but that indepth scanning of the container was skipped
qgis · Jul 23, 2021 · e28a0b7 · e28a0b7
1 parent e6f0c92
commit e28a0b7
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 0 deletions.
diff --git a/python/core/auto_generated/providers/qgsprovidersublayerdetails.sip.in b/python/core/auto_generated/providers/qgsprovidersublayerdetails.sip.in
@@ -227,6 +227,22 @@ Returns the associated layer number, for providers which order sublayers.
 Sets the associated layer ``number``, for providers which order sublayers.
 
 .. seealso:: :py:func:`layerNumber`
+%End
+
+    void setSkippedContainerScan( bool skipped );
+%Docstring
+Set to ``True`` if the layer is a potential dataset container and an in-depth scan
+of its contents was skipped.
+
+.. seealso:: :py:func:`skippedContainerScan`
+%End
+
+    bool skippedContainerScan() const;
+%Docstring
+Returns ``True`` if the layer is a potential dataset container and an in-depth scan
+of its contents was skipped.
+
+.. seealso:: :py:func:`setSkippedContainerScan`
 %End
 
     bool operator==( const QgsProviderSublayerDetails &other ) const;

diff --git a/src/core/providers/qgsprovidersublayerdetails.cpp b/src/core/providers/qgsprovidersublayerdetails.cpp
@@ -38,6 +38,7 @@ bool QgsProviderSublayerDetails::operator==( const QgsProviderSublayerDetails &o
          && mGeometryColumnName == other.mGeometryColumnName
          && mPath == other.mPath
          && mWkbType == other.mWkbType
+         && mSkippedContainerScan == other.mSkippedContainerScan
          && mDriverName == other.mDriverName;
 }
 

diff --git a/src/core/providers/qgsprovidersublayerdetails.h b/src/core/providers/qgsprovidersublayerdetails.h
@@ -250,6 +250,22 @@ class CORE_EXPORT QgsProviderSublayerDetails
      */
     void setLayerNumber( int number ) { mLayerNumber = number; }
 
+    /**
+     * Set to TRUE if the layer is a potential dataset container and an in-depth scan
+     * of its contents was skipped.
+     *
+     * \see skippedContainerScan();
+     */
+    void setSkippedContainerScan( bool skipped ) { mSkippedContainerScan = skipped; }
+
+    /**
+     * Returns TRUE if the layer is a potential dataset container and an in-depth scan
+     * of its contents was skipped.
+     *
+     * \see setSkippedContainerScan();
+     */
+    bool skippedContainerScan() const { return mSkippedContainerScan; }
+
     // TODO c++20 - replace with = default
     bool operator==( const QgsProviderSublayerDetails &other ) const;
     bool operator!=( const QgsProviderSublayerDetails &other ) const;
@@ -267,6 +283,7 @@ class CORE_EXPORT QgsProviderSublayerDetails
     QStringList mPath;
     QgsWkbTypes::Type mWkbType = QgsWkbTypes::Unknown;
     QString mDriverName;
+    bool mSkippedContainerScan = false;
 
 };
 

diff --git a/tests/src/python/test_qgsprovidersublayerdetails.py b/tests/src/python/test_qgsprovidersublayerdetails.py
@@ -72,6 +72,11 @@ def testGettersSetters(self):
         d.setDriverName('drv')
         self.assertEqual(d.driverName(), 'drv')
 
+        d.setSkippedContainerScan(True)
+        self.assertTrue(d.skippedContainerScan())
+        d.setSkippedContainerScan(False)
+        self.assertFalse(d.skippedContainerScan())
+
     def test_equality(self):
         """
         Test equality operator
@@ -133,6 +138,11 @@ def test_equality(self):
         d2.setDriverName('drv')
         self.assertEqual(d, d2)
 
+        d.setSkippedContainerScan(True)
+        self.assertNotEqual(d, d2)
+        d2.setSkippedContainerScan(True)
+        self.assertEqual(d, d2)
+
     def test_to_layer(self):
         """
         Test converting sub layer details to a layer