mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
b298c76ee4
Conflicts: python/plugins/processing/core/GeoAlgorithm.py python/plugins/processing/gui/ExtentSelectionPanel.py python/plugins/processing/modeler/ModelerParametersDialog.py
496 lines
20 KiB
Python
496 lines
20 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
ModelerParametersDialog.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. *
|
|
* *
|
|
***************************************************************************
|
|
"""
|
|
from builtins import str
|
|
from builtins import range
|
|
|
|
|
|
__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$'
|
|
|
|
from qgis.PyQt.QtCore import Qt, QUrl, QMetaObject
|
|
from qgis.PyQt.QtWidgets import (QDialog, QDialogButtonBox, QLabel, QLineEdit,
|
|
QFrame, QPushButton, QSizePolicy, QVBoxLayout,
|
|
QHBoxLayout, QTabWidget, QWidget, QScrollArea,
|
|
QComboBox, QTableWidgetItem, QMessageBox,
|
|
QTextBrowser)
|
|
from qgis.PyQt.QtNetwork import QNetworkRequest, QNetworkReply
|
|
|
|
from qgis.core import QgsNetworkAccessManager
|
|
|
|
from qgis.gui import QgsMessageBar
|
|
|
|
from processing.gui.wrappers import NotYetImplementedWidgetWrapper, InvalidParameterValue
|
|
from processing.gui.CrsSelectionPanel import CrsSelectionPanel
|
|
from processing.gui.MultipleInputPanel import MultipleInputPanel
|
|
from processing.gui.FixedTablePanel import FixedTablePanel
|
|
from processing.gui.RangePanel import RangePanel
|
|
from processing.gui.GeometryPredicateSelectionPanel import \
|
|
GeometryPredicateSelectionPanel
|
|
from processing.core.parameters import (ParameterExtent,
|
|
ParameterRaster,
|
|
ParameterVector,
|
|
ParameterTable,
|
|
ParameterFixedTable,
|
|
ParameterMultipleInput,
|
|
ParameterSelection,
|
|
ParameterRange,
|
|
ParameterNumber,
|
|
ParameterString,
|
|
ParameterCrs,
|
|
ParameterTableField,
|
|
ParameterTableMultipleField,
|
|
ParameterFile,
|
|
ParameterPoint,
|
|
ParameterGeometryPredicate)
|
|
from processing.core.outputs import (OutputRaster,
|
|
OutputVector,
|
|
OutputTable,
|
|
OutputHTML,
|
|
OutputFile,
|
|
OutputDirectory,
|
|
OutputNumber,
|
|
OutputString,
|
|
OutputExtent,
|
|
OutputCrs)
|
|
|
|
from processing.modeler.ModelerAlgorithm import (ValueFromInput,
|
|
ValueFromOutput,
|
|
Algorithm,
|
|
ModelerOutput)
|
|
from processing.modeler.MultilineTextPanel import MultilineTextPanel
|
|
from processing.tools import dataobjects
|
|
|
|
from qgis.core import QgsApplication
|
|
from qgis.PyQt.QtGui import QToolButton, QMenu, QAction
|
|
|
|
|
|
class ModelerWidgetWrapper(QWidget):
|
|
|
|
def __init__(self, wrapper, model_values):
|
|
super(ModelerWidgetWrapper, self).__init__()
|
|
|
|
self.wrapper = wrapper
|
|
self.widget = wrapper.widget
|
|
self.implemented = wrapper.implemented
|
|
self.model_values = model_values
|
|
|
|
menu = QMenu()
|
|
fixed_value_action = QAction(self.tr('Fixed value'), menu)
|
|
fixed_value_action.triggered.connect(self.on_fixedValue)
|
|
menu.addAction(fixed_value_action)
|
|
menu.addSeparator()
|
|
for text, value in model_values:
|
|
model_value_action = QAction(text, menu)
|
|
model_value_action.setData(value)
|
|
model_value_action.triggered.connect(self.on_modelValue)
|
|
menu.addAction(model_value_action)
|
|
|
|
self.mIconDataDefine = QgsApplication.getThemeIcon("/mIconDataDefine.svg")
|
|
self.mIconDataDefineOn = QgsApplication.getThemeIcon("/mIconDataDefineOn.svg")
|
|
|
|
button = QToolButton()
|
|
button.setIcon(self.mIconDataDefine)
|
|
button.setPopupMode(QToolButton.InstantPopup)
|
|
button.setMenu(menu)
|
|
self.button = button
|
|
|
|
label = QLabel()
|
|
label.hide()
|
|
self.label = label
|
|
|
|
layout = QHBoxLayout()
|
|
layout.addWidget(button, 0)
|
|
layout.addWidget(label, 1)
|
|
layout.addWidget(wrapper.widget, 1)
|
|
self.setLayout(layout)
|
|
|
|
def on_fixedValue(self):
|
|
self.button.setIcon(self.mIconDataDefine)
|
|
self.label.hide()
|
|
self.wrapper.widget.show()
|
|
|
|
def on_modelValue(self):
|
|
action = self.sender()
|
|
self.setValue(action.data())
|
|
|
|
def setValue(self, value):
|
|
for text, val in self.model_values:
|
|
if val == value:
|
|
self.model_value = value
|
|
self.button.setIcon(self.mIconDataDefineOn)
|
|
self.label.setText(text)
|
|
self.label.show()
|
|
self.wrapper.widget.hide()
|
|
return
|
|
self.wrapper.setValue(value)
|
|
self.on_fixedValue()
|
|
|
|
def value(self):
|
|
if self.label.isVisible():
|
|
return self.model_value
|
|
else:
|
|
return self.wrapper.value()
|
|
|
|
|
|
class ModelerParametersDialog(QDialog):
|
|
|
|
ENTER_NAME = '[Enter name if this is a final result]'
|
|
NOT_SELECTED = '[Not selected]'
|
|
USE_MIN_COVERING_EXTENT = '[Use min covering extent]'
|
|
|
|
def __init__(self, alg, model, algName=None):
|
|
QDialog.__init__(self)
|
|
self.setModal(True)
|
|
# The algorithm to define in this dialog. It is an instance of GeoAlgorithm
|
|
self._alg = alg
|
|
# The resulting algorithm after the user clicks on OK. it is an instance of the container Algorithm class
|
|
self.alg = None
|
|
# The model this algorithm is going to be added to
|
|
self.model = model
|
|
# The name of the algorithm in the model, in case we are editing it and not defining it for the first time
|
|
self._algName = algName
|
|
self.setupUi()
|
|
self.params = None
|
|
|
|
def setupUi(self):
|
|
self.labels = {}
|
|
self.widgets = {}
|
|
self.checkBoxes = {}
|
|
self.showAdvanced = False
|
|
self.wrappers = {}
|
|
self.valueItems = {}
|
|
self.dependentItems = {}
|
|
self.resize(650, 450)
|
|
self.buttonBox = QDialogButtonBox()
|
|
self.buttonBox.setOrientation(Qt.Horizontal)
|
|
self.buttonBox.setStandardButtons(QDialogButtonBox.Cancel
|
|
| QDialogButtonBox.Ok)
|
|
tooltips = self._alg.getParameterDescriptions()
|
|
self.setSizePolicy(QSizePolicy.Expanding,
|
|
QSizePolicy.Expanding)
|
|
self.verticalLayout = QVBoxLayout()
|
|
self.verticalLayout.setSpacing(5)
|
|
self.verticalLayout.setMargin(20)
|
|
|
|
self.bar = QgsMessageBar()
|
|
self.bar.setSizePolicy(QSizePolicy.Minimum, QSizePolicy.Fixed)
|
|
self.verticalLayout.addWidget(self.bar)
|
|
|
|
hLayout = QHBoxLayout()
|
|
hLayout.setSpacing(5)
|
|
hLayout.setMargin(0)
|
|
descriptionLabel = QLabel(self.tr("Description"))
|
|
self.descriptionBox = QLineEdit()
|
|
self.descriptionBox.setText(self._alg.name)
|
|
hLayout.addWidget(descriptionLabel)
|
|
hLayout.addWidget(self.descriptionBox)
|
|
self.verticalLayout.addLayout(hLayout)
|
|
line = QFrame()
|
|
line.setFrameShape(QFrame.HLine)
|
|
line.setFrameShadow(QFrame.Sunken)
|
|
self.verticalLayout.addWidget(line)
|
|
|
|
for param in self._alg.parameters:
|
|
if param.isAdvanced:
|
|
self.advancedButton = QPushButton()
|
|
self.advancedButton.setText(self.tr('Show advanced parameters'))
|
|
self.advancedButton.clicked.connect(
|
|
self.showAdvancedParametersClicked)
|
|
advancedButtonHLayout = QHBoxLayout()
|
|
advancedButtonHLayout.addWidget(self.advancedButton)
|
|
advancedButtonHLayout.addStretch()
|
|
self.verticalLayout.addLayout(advancedButtonHLayout)
|
|
break
|
|
for param in self._alg.parameters:
|
|
if param.hidden:
|
|
continue
|
|
desc = param.description
|
|
if isinstance(param, ParameterExtent):
|
|
desc += self.tr('(xmin, xmax, ymin, ymax)')
|
|
if isinstance(param, ParameterPoint):
|
|
desc += self.tr('(x, y)')
|
|
label = QLabel(desc)
|
|
self.labels[param.name] = label
|
|
|
|
wrapper = param.wrapper(self)
|
|
self.wrappers[param.name] = wrapper
|
|
|
|
widget = wrapper.widget
|
|
self.valueItems[param.name] = widget
|
|
if param.name in list(tooltips.keys()):
|
|
tooltip = tooltips[param.name]
|
|
else:
|
|
tooltip = param.description
|
|
label.setToolTip(tooltip)
|
|
widget.setToolTip(tooltip)
|
|
if param.isAdvanced:
|
|
label.setVisible(self.showAdvanced)
|
|
wrapper.setVisible(self.showAdvanced)
|
|
self.widgets[param.name] = widget
|
|
|
|
self.verticalLayout.addWidget(label)
|
|
self.verticalLayout.addWidget(wrapper.widget)
|
|
|
|
for output in self._alg.outputs:
|
|
if output.hidden:
|
|
continue
|
|
if isinstance(output, (OutputRaster, OutputVector, OutputTable,
|
|
OutputHTML, OutputFile, OutputDirectory)):
|
|
label = QLabel(output.description + '<'
|
|
+ output.__class__.__name__ + '>')
|
|
item = QLineEdit()
|
|
if hasattr(item, 'setPlaceholderText'):
|
|
item.setPlaceholderText(ModelerParametersDialog.ENTER_NAME)
|
|
self.verticalLayout.addWidget(label)
|
|
self.verticalLayout.addWidget(item)
|
|
self.valueItems[output.name] = item
|
|
|
|
label = QLabel(' ')
|
|
self.verticalLayout.addWidget(label)
|
|
label = QLabel(self.tr('Parent algorithms'))
|
|
self.dependenciesPanel = self.getDependenciesPanel()
|
|
self.verticalLayout.addWidget(label)
|
|
self.verticalLayout.addWidget(self.dependenciesPanel)
|
|
|
|
self.verticalLayout.addStretch(1000)
|
|
self.setLayout(self.verticalLayout)
|
|
|
|
self.setPreviousValues()
|
|
self.setWindowTitle(self._alg.name)
|
|
self.verticalLayout2 = QVBoxLayout()
|
|
self.verticalLayout2.setSpacing(2)
|
|
self.verticalLayout2.setMargin(0)
|
|
self.tabWidget = QTabWidget()
|
|
self.tabWidget.setMinimumWidth(300)
|
|
self.paramPanel = QWidget()
|
|
self.paramPanel.setLayout(self.verticalLayout)
|
|
self.scrollArea = QScrollArea()
|
|
self.scrollArea.setWidget(self.paramPanel)
|
|
self.scrollArea.setWidgetResizable(True)
|
|
self.tabWidget.addTab(self.scrollArea, self.tr('Parameters'))
|
|
|
|
self.txtHelp = QTextBrowser()
|
|
|
|
html = None
|
|
isText, algHelp = self._alg.help()
|
|
if algHelp is not None:
|
|
algHelp = algHelp if isText else QUrl(algHelp)
|
|
try:
|
|
if isText:
|
|
self.txtHelp.setHtml(algHelp)
|
|
else:
|
|
html = self.tr('<p>Downloading algorithm help... Please wait.</p>')
|
|
self.txtHelp.setHtml(html)
|
|
self.reply = QgsNetworkAccessManager.instance().get(QNetworkRequest(algHelp))
|
|
self.reply.finished.connect(self.requestFinished)
|
|
except:
|
|
self.txtHelp.setHtml(self.tr('<h2>No help available for this algorithm</h2>'))
|
|
|
|
self.tabWidget.addTab(self.txtHelp, 'Help')
|
|
|
|
self.verticalLayout2.addWidget(self.tabWidget)
|
|
self.verticalLayout2.addWidget(self.buttonBox)
|
|
self.setLayout(self.verticalLayout2)
|
|
self.buttonBox.accepted.connect(self.okPressed)
|
|
self.buttonBox.rejected.connect(self.cancelPressed)
|
|
QMetaObject.connectSlotsByName(self)
|
|
|
|
def requestFinished(self):
|
|
"""Change the webview HTML content"""
|
|
reply = self.sender()
|
|
if reply.error() != QNetworkReply.NoError:
|
|
html = self.tr('<h2>No help available for this algorithm</h2><p>{}</p>'.format(reply.errorString()))
|
|
else:
|
|
html = str(reply.readAll())
|
|
reply.deleteLater()
|
|
self.txtHelp.setHtml(html)
|
|
|
|
def getAvailableDependencies(self):
|
|
if self._algName is None:
|
|
dependent = []
|
|
else:
|
|
dependent = self.model.getDependentAlgorithms(self._algName)
|
|
opts = []
|
|
for alg in list(self.model.algs.values()):
|
|
if alg.name not in dependent:
|
|
opts.append(alg)
|
|
return opts
|
|
|
|
def getDependenciesPanel(self):
|
|
return MultipleInputPanel([alg.algorithm.name for alg in self.getAvailableDependencies()])
|
|
|
|
def showAdvancedParametersClicked(self):
|
|
self.showAdvanced = not self.showAdvanced
|
|
if self.showAdvanced:
|
|
self.advancedButton.setText(self.tr('Hide advanced parameters'))
|
|
else:
|
|
self.advancedButton.setText(self.tr('Show advanced parameters'))
|
|
for param in self._alg.parameters:
|
|
if param.isAdvanced:
|
|
self.labels[param.name].setVisible(self.showAdvanced)
|
|
self.widgets[param.name].setVisible(self.showAdvanced)
|
|
|
|
def getAvailableValuesForParam(self, param):
|
|
outputType = None
|
|
if isinstance(param, ParameterCrs):
|
|
outputType = OutputCrs
|
|
return self.getAvailableValuesOfType(param.__class__, outputType)
|
|
|
|
def getAvailableValuesOfType(self, paramType, outType=None, dataType=None):
|
|
values = []
|
|
inputs = self.model.inputs
|
|
for i in list(inputs.values()):
|
|
param = i.param
|
|
if isinstance(param, paramType):
|
|
if dataType is not None and param.datatype in dataType:
|
|
values.append(ValueFromInput(param.name))
|
|
else:
|
|
values.append(ValueFromInput(param.name))
|
|
if outType is None:
|
|
return values
|
|
if self._algName is None:
|
|
dependent = []
|
|
else:
|
|
dependent = self.model.getDependentAlgorithms(self._algName)
|
|
for alg in list(self.model.algs.values()):
|
|
if alg.name not in dependent:
|
|
for out in alg.algorithm.outputs:
|
|
if isinstance(out, outType):
|
|
if dataType is not None and out.datatype in dataType:
|
|
values.append(ValueFromOutput(alg.name, out.name))
|
|
else:
|
|
values.append(ValueFromOutput(alg.name, out.name))
|
|
|
|
return values
|
|
|
|
def resolveValueDescription(self, value):
|
|
if isinstance(value, ValueFromInput):
|
|
return self.model.inputs[value.name].param.description
|
|
else:
|
|
alg = self.model.algs[value.alg]
|
|
return self.tr("'%s' from algorithm '%s'") % (alg.algorithm.getOutputFromName(value.output).description, alg.description)
|
|
|
|
def canUseAutoExtent(self):
|
|
for param in self._alg.parameters:
|
|
if isinstance(param, (ParameterRaster, ParameterVector, ParameterMultipleInput)):
|
|
return True
|
|
return False
|
|
|
|
def setTableContent(self):
|
|
params = self._alg.parameters
|
|
outputs = self._alg.outputs
|
|
visibleParams = [p for p in params if not p.hidden]
|
|
visibleOutputs = [p for o in outputs if not o.hidden]
|
|
self.tableWidget.setRowCount(len(visibleParams) + len(visibleOutputs))
|
|
|
|
for i, param in visibleParams:
|
|
item = QTableWidgetItem(param.description)
|
|
item.setFlags(Qt.ItemIsEnabled)
|
|
self.tableWidget.setItem(i, 0, item)
|
|
item = self.getWidgetFromParameter(param)
|
|
self.valueItems[param.name] = item
|
|
self.tableWidget.setCellWidget(i, 1, item)
|
|
self.tableWidget.setRowHeight(i, 22)
|
|
|
|
for i, output in visibleOutputs:
|
|
item = QTableWidgetItem(output.description + '<'
|
|
+ output.__module__.split('.')[-1] + '>')
|
|
item.setFlags(Qt.ItemIsEnabled)
|
|
self.tableWidget.setItem(i, 0, item)
|
|
item = QLineEdit()
|
|
if hasattr(item, 'setPlaceholderText'):
|
|
item.setPlaceholderText(ModelerParametersDialog.ENTER_NAME)
|
|
self.valueItems[output.name] = item
|
|
self.tableWidget.setCellWidget(i, 1, item)
|
|
self.tableWidget.setRowHeight(i, 22)
|
|
|
|
def setPreviousValues(self):
|
|
if self._algName is not None:
|
|
alg = self.model.algs[self._algName]
|
|
self.descriptionBox.setText(alg.description)
|
|
for param in alg.algorithm.parameters:
|
|
if param.hidden:
|
|
continue
|
|
if param.name in alg.params:
|
|
value = alg.params[param.name]
|
|
else:
|
|
value = param.default
|
|
|
|
wrapper = self.wrappers[param.name]
|
|
wrapper.setValue(value)
|
|
|
|
for name, out in alg.outputs.items():
|
|
widget = self.valueItems[name].setText(out.description)
|
|
|
|
selected = []
|
|
dependencies = self.getAvailableDependencies()
|
|
for idx, dependency in enumerate(dependencies):
|
|
if dependency.name in alg.dependencies:
|
|
selected.append(idx)
|
|
|
|
self.dependenciesPanel.setSelectedItems(selected)
|
|
|
|
def createAlgorithm(self):
|
|
alg = Algorithm(self._alg.commandLineName())
|
|
alg.setName(self.model)
|
|
alg.description = self.descriptionBox.text()
|
|
params = self._alg.parameters
|
|
outputs = self._alg.outputs
|
|
for param in params:
|
|
if param.hidden:
|
|
continue
|
|
if not self.setParamValue(alg, param, self.wrappers[param.name]):
|
|
self.bar.pushMessage("Error", "Wrong or missing value for parameter '%s'" % param.description,
|
|
level=QgsMessageBar.WARNING)
|
|
return None
|
|
for output in outputs:
|
|
if not output.hidden:
|
|
name = str(self.valueItems[output.name].text())
|
|
if name.strip() != '' and name != ModelerParametersDialog.ENTER_NAME:
|
|
alg.outputs[output.name] = ModelerOutput(name)
|
|
|
|
selectedOptions = self.dependenciesPanel.selectedoptions
|
|
availableDependencies = self.getAvailableDependencies()
|
|
for selected in selectedOptions:
|
|
alg.dependencies.append(availableDependencies[selected].name)
|
|
|
|
return alg
|
|
|
|
def setParamValue(self, alg, param, wrapper):
|
|
try:
|
|
value = wrapper.value()
|
|
alg.params[param.name] = value
|
|
return True
|
|
except InvalidParameterValue:
|
|
return False
|
|
|
|
def okPressed(self):
|
|
self.alg = self.createAlgorithm()
|
|
if self.alg is not None:
|
|
self.close()
|
|
|
|
def cancelPressed(self):
|
|
self.alg = None
|
|
self.close()
|