Tom Kralidis
133 lines
5.4 KiB
Python
133 lines
5.4 KiB
Python
# =================================================================
|
|
#
|
|
# Authors: Tom Kralidis <tomkralidis@gmail.com>
|
|
#
|
|
# Copyright (c) 2024 Tom Kralidis
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person
|
|
# obtaining a copy of this software and associated documentation
|
|
# files (the "Software"), to deal in the Software without
|
|
# restriction, including without limitation the rights to use,
|
|
# copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the
|
|
# Software is furnished to do so, subject to the following
|
|
# conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be
|
|
# included in all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
# OTHER DEALINGS IN THE SOFTWARE.
|
|
#
|
|
# =================================================================
|
|
"""Plugin loader"""
|
|
|
|
import importlib
|
|
import logging
|
|
from typing import Any
|
|
|
|
LOGGER = logging.getLogger(__name__)
|
|
|
|
#: Loads provider plugins to be used by pygeoapi,\
|
|
#: formatters and processes available
|
|
PLUGINS = {
|
|
'provider': {
|
|
'AzureBlobStorage': 'pygeoapi.provider.azure_.AzureBlobStorageProvider', # noqa
|
|
'CSV': 'pygeoapi.provider.csv_.CSVProvider',
|
|
'CSWFacade': 'pygeoapi.provider.csw_facade.CSWFacadeProvider',
|
|
'Elasticsearch': 'pygeoapi.provider.elasticsearch_.ElasticsearchProvider', # noqa
|
|
'ElasticsearchCatalogue': 'pygeoapi.provider.elasticsearch_.ElasticsearchCatalogueProvider', # noqa
|
|
'ERDDAPTabledap': 'pygeoapi.provider.erddap.TabledapProvider',
|
|
'ESRI': 'pygeoapi.provider.esri.ESRIServiceProvider',
|
|
'FileSystem': 'pygeoapi.provider.filesystem.FileSystemProvider',
|
|
'GeoJSON': 'pygeoapi.provider.geojson.GeoJSONProvider',
|
|
'Hateoas': 'pygeoapi.provider.hateoas.HateoasProvider',
|
|
'MapScript': 'pygeoapi.provider.mapscript_.MapScriptProvider',
|
|
'MongoDB': 'pygeoapi.provider.mongo.MongoProvider',
|
|
'MVT-tippecanoe': 'pygeoapi.provider.mvt_tippecanoe.MVTTippecanoeProvider', # noqa: E501
|
|
'MVT-elastic': 'pygeoapi.provider.mvt_elastic.MVTElasticProvider',
|
|
'MVT-proxy': 'pygeoapi.provider.mvt_proxy.MVTProxyProvider',
|
|
'OracleDB': 'pygeoapi.provider.oracle.OracleProvider',
|
|
'OGR': 'pygeoapi.provider.ogr.OGRProvider',
|
|
'OpenSearch': 'pygeoapi.provider.opensearch_.OpenSearchProvider',
|
|
'Parquet': 'pygeoapi.provider.parquet.ParquetProvider',
|
|
'PostgreSQL': 'pygeoapi.provider.postgresql.PostgreSQLProvider',
|
|
'rasterio': 'pygeoapi.provider.rasterio_.RasterioProvider',
|
|
'SensorThings': 'pygeoapi.provider.sensorthings.SensorThingsProvider',
|
|
'SQLiteGPKG': 'pygeoapi.provider.sqlite.SQLiteGPKGProvider',
|
|
'Socrata': 'pygeoapi.provider.socrata.SODAServiceProvider',
|
|
'TinyDB': 'pygeoapi.provider.tinydb_.TinyDBProvider',
|
|
'TinyDBCatalogue': 'pygeoapi.provider.tinydb_.TinyDBCatalogueProvider',
|
|
'WMSFacade': 'pygeoapi.provider.wms_facade.WMSFacadeProvider',
|
|
'WMTSFacade': 'pygeoapi.provider.wmts_facade.WMTSFacadeProvider',
|
|
'xarray': 'pygeoapi.provider.xarray_.XarrayProvider',
|
|
'xarray-edr': 'pygeoapi.provider.xarray_edr.XarrayEDRProvider'
|
|
},
|
|
'formatter': {
|
|
'CSV': 'pygeoapi.formatter.csv_.CSVFormatter'
|
|
},
|
|
'process': {
|
|
'HelloWorld': 'pygeoapi.process.hello_world.HelloWorldProcessor',
|
|
'ShapelyFunctions': 'pygeoapi.process.shapely_functions.ShapelyFunctionsProcessor', # noqa: E501
|
|
'Echo': 'pygeoapi.process.echo.EchoProcessor'
|
|
},
|
|
'process_manager': {
|
|
'Dummy': 'pygeoapi.process.manager.dummy.DummyManager',
|
|
'MongoDB': 'pygeoapi.process.manager.mongodb_.MongoDBManager',
|
|
'TinyDB': 'pygeoapi.process.manager.tinydb_.TinyDBManager',
|
|
'PostgreSQL': 'pygeoapi.process.manager.postgresql.PostgreSQLManager'
|
|
}
|
|
}
|
|
|
|
|
|
def load_plugin(plugin_type: str, plugin_def: dict) -> Any:
|
|
"""
|
|
loads plugin by name
|
|
|
|
:param plugin_type: type of plugin (provider, formatter)
|
|
:param plugin_def: plugin definition
|
|
|
|
:returns: plugin object
|
|
"""
|
|
|
|
name = plugin_def['name']
|
|
|
|
if plugin_type not in PLUGINS.keys():
|
|
msg = f'Plugin type {plugin_type} not found'
|
|
LOGGER.exception(msg)
|
|
raise InvalidPluginError(msg)
|
|
|
|
plugin_list = PLUGINS[plugin_type]
|
|
|
|
LOGGER.debug(f'Plugins: {plugin_list}')
|
|
|
|
if '.' not in name and name not in plugin_list.keys():
|
|
msg = f'Plugin {name} not found'
|
|
LOGGER.exception(msg)
|
|
raise InvalidPluginError(msg)
|
|
|
|
if '.' in name: # dotted path
|
|
packagename, classname = name.rsplit('.', 1)
|
|
else: # core formatter
|
|
packagename, classname = plugin_list[name].rsplit('.', 1)
|
|
|
|
LOGGER.debug(f'package name: {packagename}')
|
|
LOGGER.debug(f'class name: {classname}')
|
|
|
|
module = importlib.import_module(packagename)
|
|
class_ = getattr(module, classname)
|
|
plugin = class_(plugin_def)
|
|
|
|
return plugin
|
|
|
|
|
|
class InvalidPluginError(Exception):
|
|
"""Invalid plugin"""
|
|
pass
|