Class: QgsProjectUtils

class qgis.core.QgsProjectUtils

Bases: sip.wrapper

Contains utility functions for working with QGIS projects.

Added in version 3.22:

Methods

layerIsContainedInGroupLayer

Returns True if the specified layer is a child layer from any QgsGroupLayer in the given project.

layersMatchingPath

Returns a list of all layers in the specified project which match the given path.

updateLayerPath

Updates a project, replacing the data source for all layers which match the given oldPath with sources which point to newPath.
layerIsContainedInGroupLayer(project: QgsProject | None, layer: QgsMapLayer | None) → bool

Returns True if the specified layer is a child layer from any QgsGroupLayer in the given project.

Added in version 3.24.

Parameters:
Return type:

bool

layersMatchingPath(project: QgsProject | None, path: str | None) → List[QgsMapLayer]

Returns a list of all layers in the specified project which match the given path.

This method can be used to retrieve a list of layers in a project associated with a file path.

Parameters:

  • project (Optional[QgsProject])

  • path (Optional[str])

Return type:

List[QgsMapLayer]

updateLayerPath(project: QgsProject | None, oldPath: str | None, newPath: str | None) → bool

Updates a project, replacing the data source for all layers which match the given oldPath with sources which point to newPath.

Returns True if any layers were updated as a result.

Parameters:

  • project (Optional[QgsProject])

  • oldPath (Optional[str])

  • newPath (Optional[str])

Return type:

bool