Class: QgsProviderUtils¶
Contains utility functions for working with data providers.
Added in version 3.22.
Enums
Flags which control how |
Static Methods
Returns |
|
Suggests a suitable layer name given only a file path. |
- class qgis.core.QgsProviderUtils[source]¶
Bases:
object
- class SublayerCompletenessFlag(*values)¶
Bases:
IntEnum
Flags which control how
QgsProviderUtils.sublayerDetailsAreIncomplete()
tests for completeness.IgnoreUnknownFeatureCount
: Indicates that an unknown feature count should not be considered as incompleteIgnoreUnknownGeometryType
: Indicates that an unknown geometry type should not be considered as incomplete
- IgnoreUnknownFeatureCount = 1¶
- IgnoreUnknownGeometryType = 2¶
- class SublayerCompletenessFlags¶
- class SublayerCompletenessFlags(f: QgsProviderUtils.SublayerCompletenessFlags | QgsProviderUtils.SublayerCompletenessFlag)
- class SublayerCompletenessFlags(a0: QgsProviderUtils.SublayerCompletenessFlags)
Bases:
object
- static sublayerDetailsAreIncomplete(details: Iterable[QgsProviderSublayerDetails], flags: QgsProviderUtils.SublayerCompletenessFlags | QgsProviderUtils.SublayerCompletenessFlag = QgsProviderUtils.SublayerCompletenessFlags()) bool [source]¶
Returns
True
if the sublayerdetails
are incomplete, and require a more in-depth scan.For instance, if the details contain any vector sublayers with unknown geometry types then a query with the
Qgis
.SublayerQueryFlag.ResolveGeometryType flag is required.The
flags
argument can be used to control the level of completeness required during the test.- Parameters:
details (Iterable[QgsProviderSublayerDetails])
flags (Union[QgsProviderUtils.SublayerCompletenessFlags, QgsProviderUtils.SublayerCompletenessFlag] = QgsProviderUtils.SublayerCompletenessFlags())
- Return type:
bool
- static suggestLayerNameFromFilePath(path: str | None) str [source]¶
Suggests a suitable layer name given only a file
path
.Usually this corresponds to the base file name of
path
(e.g. “rivers” for a path of “c:/my data/water/rivers.shp”). However some data formats which use fixed file paths (such as aigrid files) will instead return the parent directory name (e.g. “rivers” for a path of “c:/my data/water/rivers/hdr.adf”).- Parameters:
path (Optional[str])
- Return type:
str