Class: QgsProviderRegistry¶
-
class
qgis.core.
QgsProviderRegistry
¶ Bases:
sip.wrapper
A registry / canonical manager of data providers.
This is a Singleton class that manages data provider access.
Providers can be either loaded via libraries or native providers that are included in the core QGIS installation and accessed through function pointers.
Loaded providers may be restricted using QGIS_PROVIDER_FILE environment variable. QGIS_PROVIDER_FILE is regexp pattern applied to provider file name (not provider key). For example, if the variable is set to gdal|ogr|postgres it will load only providers gdal, ogr and postgres.
Methods
Creates a new instance of a provider.
Returns a new QLibrary for the specified
providerKey
.Returns a new widget for selecting layers from a provider.
Returns a string containing the available database drivers
Returns the components (e.g.
Returns a string containing the available directory drivers
Returns raster file filter string
Returns vector file filter string
Gets pointer to provider function
Means of accessing canonical single instance
Returns path for the library of the provider.
Returns the library directory where plugins are found.
Returns list of provider plugins found
Returns a string containing the available protocol drivers
Returns the provider capabilities
Returns list of available providers by their keys
Returns metadata of the provider or NULL if not found
- param widget
register a new vector data provider from its
providerMetadata
Sets library directory where to search for plugins
Attributes
-
Embedded
= 1¶
-
Manager
= 2¶
-
None
= 0¶
-
class
WidgetMode
¶ Bases:
int
-
createProvider
(self, providerKey: str, dataSource: str, options: QgsDataProvider.ProviderOptions = QgsDataProvider.ProviderOptions()) → QgsDataProvider¶ Creates a new instance of a provider.
- Parameters
providerKey (str) – identifier of the provider
dataSource (str) – string containing data source for the provider
options (QgsDataProvider.ProviderOptions = QgsDataProvider.ProviderOptions()) – provider options
- Return type
- Returns
new instance of provider or NULL on error
-
createProviderLibrary
(self, providerKey: str) → QLibrary¶ Returns a new QLibrary for the specified
providerKey
. Ownership of the returned object is transferred to the caller and the caller is responsible for deleting it.If the provider uses direct provider function pointers instead of a library None will be returned.
- Parameters
providerKey (str) –
- Return type
QLibrary
-
createSelectionWidget
(self, providerKey: str, parent: QWidget = None, fl: Union[Qt.WindowFlags, Qt.WindowType] = Qt.WindowFlags(), widgetMode: QgsProviderRegistry.WidgetMode = QgsProviderRegistry.WidgetMode.None) → QWidget¶ Returns a new widget for selecting layers from a provider. Either the
parent
widget must be set or the caller becomes responsible for deleting the returned widget.- Parameters
providerKey (str) –
parent (QWidget = None) –
fl (Union[Qt.WindowFlags) –
widgetMode (QgsProviderRegistry.WidgetMode = QgsProviderRegistry.WidgetMode.None) –
- Return type
QWidget
-
databaseDrivers
(self) → str¶ Returns a string containing the available database drivers
- Return type
str
-
decodeUri
(self, providerKey: str, uri: str) → Dict[str, Any]¶ Returns the components (e.g. file path, layer name) of a provider uri
- Parameters
providerKey (str) – identifier of the provider
uri (str) – uri string
- Return type
Dict[str, Any]
- Returns
map containing components
Note
this function may not be supported by all providers, an empty map will be returned in such case
New in version 3.4.
-
directoryDrivers
(self) → str¶ Returns a string containing the available directory drivers
- Return type
str
-
fileRasterFilters
(self) → str¶ Returns raster file filter string
Returns a string suitable for a QFileDialog of raster file formats supported by all data providers.
This walks through all data providers appending calls to their buildSupportedRasterFileFilter to a string, which is then returned.
Note
This replaces
QgsRasterLayer.buildSupportedRasterFileFilter()
- Return type
str
-
fileVectorFilters
(self) → str¶ Returns vector file filter string
Returns a string suitable for a QFileDialog of vector file formats supported by all data providers.
This walks through all data providers appending calls to their fileVectorFilters to a string, which is then returned.
note
It’d be nice to eventually be raster/vector neutral.
- Return type
str
-
function
(self, providerKey: str, functionName: str) → sip.voidptr¶ Gets pointer to provider function
- Parameters
providerKey (str) – identifier of the provider
functionName (str) – name of function
- Return type
sip.voidptr
- Returns
pointer to function or NULL on error. If the provider uses direct provider function pointers instead of a library None will be returned.
-
instance
(pluginPath: str = '') → QgsProviderRegistry¶ Means of accessing canonical single instance
- Parameters
pluginPath (str = '') –
- Return type
-
library
(self, providerKey: str) → str¶ Returns path for the library of the provider.
If the provider uses direct provider function pointers instead of a library an empty string will be returned.
- Parameters
providerKey (str) –
- Return type
str
-
libraryDirectory
(self) → QDir¶ Returns the library directory where plugins are found.
- Return type
QDir
-
pluginList
(self, asHtml: bool = False) → str¶ Returns list of provider plugins found
- Parameters
asHtml (bool = False) –
- Return type
str
-
protocolDrivers
(self) → str¶ Returns a string containing the available protocol drivers
- Return type
str
-
providerCapabilities
(self, providerKey: str) → int¶ Returns the provider capabilities
- Parameters
providerKey (str) – identifier of the provider
New in version 2.6.
- Return type
int
-
providerList
(self) → List[str]¶ Returns list of available providers by their keys
- Return type
List[str]
-
providerMetadata
(self, providerKey: str) → QgsProviderMetadata¶ Returns metadata of the provider or NULL if not found
- Parameters
providerKey (str) –
- Return type
-
registerGuis
(self, widget: QWidget)¶ - Parameters
widget (QWidget) –
-
registerProvider
(self, providerMetadata: QgsProviderMetadata) → bool¶ register a new vector data provider from its
providerMetadata
- Return type
bool
- Returns
true on success, false if a provider with the same key was already registered
Note
ownership of the
QgsProviderMetadata
instance is transferred to the registryNew in version 3.2.
- Parameters
providerMetadata (QgsProviderMetadata) –
-
setLibraryDirectory
(self, path: QDir)¶ Sets library directory where to search for plugins
- Parameters
path (QDir) –