Add python repr for QgsProviderMetadata

qgis · Nov 4, 2020 · 4aa1c2f · 4aa1c2f
1 parent d34d61e
commit 4aa1c2f
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/python/core/auto_generated/qgsprovidermetadata.sip.in b/python/core/auto_generated/qgsprovidermetadata.sip.in
@@ -446,6 +446,12 @@ Stores the connection in the settings
 .. versionadded:: 3.10
 %End
 
+    SIP_PYOBJECT __repr__();
+%MethodCode
+    QString str = QStringLiteral( "<QgsProviderMetadata: %1>" ).arg( sipCpp->key() );
+    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
+%End
+
   signals:
 
     void connectionCreated( const QString &name );

diff --git a/src/core/qgsprovidermetadata.h b/src/core/qgsprovidermetadata.h
@@ -483,6 +483,14 @@ class CORE_EXPORT QgsProviderMetadata : public QObject
      */
     virtual void saveConnection( const QgsAbstractProviderConnection *connection, const QString &name ) SIP_THROW( QgsProviderConnectionException );
 
+#ifdef SIP_RUN
+    SIP_PYOBJECT __repr__();
+    % MethodCode
+    QString str = QStringLiteral( "<QgsProviderMetadata: %1>" ).arg( sipCpp->key() );
+    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
+    % End
+#endif
+
   signals:
 
     /**

diff --git a/tests/src/python/test_python_repr.py b/tests/src/python/test_python_repr.py
@@ -19,7 +19,7 @@
     QgsMimeDataUtils, QgsVector, QgsVector3D, QgsVectorLayer, QgsReferencedPointXY, QgsReferencedRectangle,\
     QgsCoordinateReferenceSystem, QgsCoordinateTransform, QgsProject, QgsClassificationRange, QgsBookmark, \
     QgsLayoutMeasurement, QgsLayoutPoint, QgsLayoutSize, QgsUnitTypes, QgsConditionalStyle, QgsTableCell, QgsProperty, \
-    QgsVertexId, QgsReferencedGeometry
+    QgsVertexId, QgsReferencedGeometry, QgsProviderRegistry
 
 start_app()
 
@@ -254,6 +254,9 @@ def testQgsVertexId(self):
         v = QgsVertexId(1, 2, 3, _type=QgsVertexId.CurveVertex)
         self.assertEqual(v.__repr__(), '<QgsVertexId: 1,2,3 CurveVertex>')
 
+    def testProviderMetadata(self):
+        self.assertEqual(QgsProviderRegistry.instance().providerMetadata('ogr').__repr__(), '<QgsProviderMetadata: ogr>')
+
 
 if __name__ == "__main__":
     unittest.main()