Merge pull request #40745 from m-kuhn/qgsmaplayer_project

Add QgsMapLayer::project() utility method

python/core/auto_generated/qgsmaplayer.sip.in

@@ -1488,6 +1488,14 @@ Sets the coordinate transform context to ``transformContext``
     sipRes = PyUnicode_FromString( str.toUtf8().constData() );
 %End
 
+    QgsProject *project() const;
+%Docstring
+Returns the parent project if this map layer is added to a project.
+Otherwise returns ``None``
+
+.. versionadded:: 3.18
+%End
+
   signals:
 
     void beforeResolveReferences( QgsProject *project );

src/core/qgsmaplayer.cpp

@@ -1981,6 +1981,15 @@ void QgsMapLayer::setRefreshOnNotifyEnabled( bool enabled )
   mIsRefreshOnNofifyEnabled = enabled;
 }
 
+QgsProject *QgsMapLayer::project() const
+{
+  if ( QgsMapLayerStore *store = qobject_cast<QgsMapLayerStore *>( parent() ) )
+  {
+    return qobject_cast<QgsProject *>( store->parent() );
+  }
+  return nullptr;
+}
+
 void QgsMapLayer::onNotifiedTriggerRepaint( const QString &message )
 {
   if ( refreshOnNotifyMessage().isEmpty() || refreshOnNotifyMessage() == message )

src/core/qgsmaplayer.h

@@ -1335,6 +1335,14 @@ class CORE_EXPORT QgsMapLayer : public QObject
     % End
 #endif
 
+    /**
+     * Returns the parent project if this map layer is added to a project.
+     * Otherwise returns NULLPTR
+     *
+     * \since QGIS 3.18
+     */
+    QgsProject *project() const;
+
   signals:
 
     /**

tests/src/python/test_qgsmaplayer.py

@@ -15,6 +15,7 @@ import qgis  # NOQA
 import tempfile
 import glob
 import shutil
+import sip
 
 from qgis.core import (QgsReadWriteContext,
                        QgsVectorLayer,
@@ -185,6 +186,20 @@ class TestQgsMapLayer(unittest.TestCase):
         self.assertTrue(rl.isValid())
         self.assertTrue(rl.isTemporary())
 
+    def testQgsMapLayerProject(self):
+        layer = QgsVectorLayer(os.path.join(TEST_DATA_DIR, 'points.shp'), "layer", "ogr")
+        self.assertIsNone(layer.project())
+        project = QgsProject()
+        project.addMapLayer(layer)
+        self.assertEqual(layer.project(), project)
+        project2 = QgsProject()
+        project2.addMapLayer(layer)
+        self.assertEqual(layer.project(), project2)
+        project.removeMapLayer(layer)
+        self.assertFalse(sip.isdeleted(layer))
+        project2.removeMapLayer(layer)
+        self.assertTrue(sip.isdeleted(layer))
+
 
 if __name__ == '__main__':
     unittest.main()