mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-24 00:04:42 -04:00
options should be available for certain model outputs and script algorithm outputs We do this by swapping the test for non-file based output support from checking only the algorithm's provider to instead checking on a parameter-by-parameter basis. This is done in order to support models. For models, depending on what child algorithm a model output is based off, an individual model may or may not have support for non-file based outputs. E.g a model may generate outputs from a native qgis alg (supporting these outputs) AND an output from a GDAL alg (with no support for these outputs). In this case we need to enable or disable the ui controls for non-file based outputs on an individual output basis. For scripts (for now) we blindly just say all outputs support non-file based formats. This is going to be the case most of the time, since scripts will usually be written using PyQGIS API. For the exceptions (e.g. scripts which call other algs like GDAL algs) we probably should add some way for the script to indicate whether an individual output supports this, but for now we just say they all do. Fixes #17949
126 lines
5.2 KiB
Python
126 lines
5.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
ModelerAlgorithmProvider.py
|
|
---------------------
|
|
Date : August 2012
|
|
Copyright : (C) 2012 by Victor Olaya
|
|
Email : volayaf at gmail dot com
|
|
***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
***************************************************************************
|
|
"""
|
|
|
|
__author__ = 'Victor Olaya'
|
|
__date__ = 'August 2012'
|
|
__copyright__ = '(C) 2012, Victor Olaya'
|
|
|
|
# This will get replaced with a git SHA1 when you do a git archive
|
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
import os
|
|
|
|
from qgis.PyQt.QtXml import QDomDocument
|
|
|
|
from qgis.core import (QgsApplication,
|
|
QgsProcessingProvider,
|
|
QgsMessageLog,
|
|
QgsProcessingModelAlgorithm,
|
|
QgsProcessingUtils,
|
|
QgsXmlUtils)
|
|
|
|
from processing.core.ProcessingConfig import ProcessingConfig, Setting
|
|
from processing.modeler.ModelerUtils import ModelerUtils
|
|
from processing.modeler.WrongModelException import WrongModelException
|
|
from processing.modeler.EditModelAction import EditModelAction
|
|
from processing.modeler.CreateNewModelAction import CreateNewModelAction
|
|
from processing.modeler.DeleteModelAction import DeleteModelAction
|
|
from processing.modeler.AddModelFromFileAction import AddModelFromFileAction
|
|
from processing.gui.GetScriptsAndModels import GetModelsAction
|
|
from processing.gui.ProviderActions import (ProviderActions,
|
|
ProviderContextMenuActions)
|
|
|
|
pluginPath = os.path.split(os.path.dirname(__file__))[0]
|
|
|
|
|
|
class ModelerAlgorithmProvider(QgsProcessingProvider):
|
|
|
|
def __init__(self):
|
|
super().__init__()
|
|
self.actions = [CreateNewModelAction(), AddModelFromFileAction(), GetModelsAction()]
|
|
self.contextMenuActions = [EditModelAction(), DeleteModelAction()]
|
|
self.algs = []
|
|
|
|
# must reload models if providers list is changed - previously unavailable algorithms
|
|
# which models depend on may now be available
|
|
QgsApplication.processingRegistry().providerAdded.connect(self.refreshAlgorithms)
|
|
|
|
def load(self):
|
|
ProcessingConfig.settingIcons[self.name()] = self.icon()
|
|
ProcessingConfig.addSetting(Setting(self.name(),
|
|
ModelerUtils.MODELS_FOLDER, self.tr('Models folder', 'ModelerAlgorithmProvider'),
|
|
ModelerUtils.defaultModelsFolder(), valuetype=Setting.MULTIPLE_FOLDERS))
|
|
ProviderActions.registerProviderActions(self, self.actions)
|
|
ProviderContextMenuActions.registerProviderContextMenuActions(self.contextMenuActions)
|
|
ProcessingConfig.readSettings()
|
|
self.refreshAlgorithms()
|
|
return True
|
|
|
|
def unload(self):
|
|
ProviderActions.deregisterProviderActions(self)
|
|
ProviderContextMenuActions.deregisterProviderContextMenuActions(self.contextMenuActions)
|
|
|
|
def modelsFolder(self):
|
|
return ModelerUtils.modelsFolders()[0]
|
|
|
|
def name(self):
|
|
return self.tr('Models', 'ModelerAlgorithmProvider')
|
|
|
|
def id(self):
|
|
return 'model'
|
|
|
|
def icon(self):
|
|
return QgsApplication.getThemeIcon("/processingModel.svg")
|
|
|
|
def svgIconPath(self):
|
|
return QgsApplication.iconPath("processingModel.svg")
|
|
|
|
def supportsNonFileBasedOutput(self):
|
|
return True
|
|
|
|
def loadAlgorithms(self):
|
|
self.algs = []
|
|
folders = ModelerUtils.modelsFolders()
|
|
for f in folders:
|
|
self.loadFromFolder(f)
|
|
for a in self.algs:
|
|
self.addAlgorithm(a)
|
|
|
|
def loadFromFolder(self, folder):
|
|
if not os.path.exists(folder):
|
|
return
|
|
for path, subdirs, files in os.walk(folder):
|
|
for descriptionFile in files:
|
|
if descriptionFile.endswith('model3'):
|
|
try:
|
|
fullpath = os.path.join(path, descriptionFile)
|
|
|
|
alg = QgsProcessingModelAlgorithm()
|
|
if alg.fromFile(fullpath):
|
|
if alg.name():
|
|
alg.setSourceFilePath(fullpath)
|
|
self.algs.append(alg)
|
|
else:
|
|
QgsMessageLog.logMessage(self.tr('Could not load model {0}', 'ModelerAlgorithmProvider').format(descriptionFile),
|
|
self.tr('Processing'), QgsMessageLog.CRITICAL)
|
|
except WrongModelException as e:
|
|
QgsMessageLog.logMessage(self.tr('Could not load model {0}\n{1}', 'ModelerAlgorithmProvider').format(descriptionFile, e.msg),
|
|
self.tr('Processing'), QgsMessageLog.CRITICAL)
|