1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
|
"""
***************************************************************************
ModelerDialog.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"
import os
import re
import sys
from pathlib import Path
from qgis.PyQt.QtCore import (
QCoreApplication,
QDir,
QRectF,
QPoint,
QPointF,
pyqtSignal,
QUrl,
QFileInfo,
)
from qgis.PyQt.QtWidgets import QMessageBox, QFileDialog
from qgis.core import (
Qgis,
QgsApplication,
QgsProcessing,
QgsProject,
QgsProcessingModelParameter,
QgsProcessingModelAlgorithm,
QgsSettings,
QgsProcessingContext,
QgsFileUtils,
)
from qgis.gui import (
QgsProcessingParameterDefinitionDialog,
QgsProcessingParameterWidgetContext,
QgsModelGraphicsScene,
QgsModelDesignerDialog,
QgsProcessingContextGenerator,
QgsProcessingParametersGenerator,
)
from qgis.utils import iface
from processing.gui.AlgorithmDialog import AlgorithmDialog
from processing.modeler.ModelerParameterDefinitionDialog import (
ModelerParameterDefinitionDialog,
)
from processing.modeler.ModelerParametersDialog import ModelerParametersDialog
from processing.modeler.ModelerScene import ModelerScene
from processing.modeler.ModelerUtils import ModelerUtils
from processing.modeler.ProjectProvider import PROJECT_PROVIDER_ID
from processing.script.ScriptEditorDialog import ScriptEditorDialog
from processing.tools.dataobjects import createContext
pluginPath = os.path.split(os.path.dirname(__file__))[0]
class ModelerDialog(QgsModelDesignerDialog):
CANVAS_SIZE = 4000
update_model = pyqtSignal()
dlgs = []
@staticmethod
def create(model=None):
"""
Workaround crappy sip handling of QMainWindow. It doesn't know that we are using the deleteonclose
flag, so happily just deletes dialogs as soon as they go out of scope. The only workaround possible
while we still have to drag around this Python code is to store a reference to the sip wrapper so that
sip doesn't get confused. The underlying object will still be deleted by the deleteonclose flag though!
"""
dlg = ModelerDialog(model)
ModelerDialog.dlgs.append(dlg)
return dlg
def __init__(self, model=None, parent=None):
super().__init__(parent)
if iface is not None:
self.toolbar().setIconSize(iface.iconSize())
self.setStyleSheet(iface.mainWindow().styleSheet())
scene = ModelerScene(self)
scene.setSceneRect(QRectF(0, 0, self.CANVAS_SIZE, self.CANVAS_SIZE))
self.setModelScene(scene)
self.view().ensureVisible(0, 0, 10, 10)
self.view().scale(self.logicalDpiX() / 96, self.logicalDpiY() / 96)
self.actionOpen().triggered.connect(self.openModel)
self.actionSaveInProject().triggered.connect(self.saveInProject)
if model is not None:
_model = model.create()
_model.setSourceFilePath(model.sourceFilePath())
self.setModel(_model)
self.view().centerOn(0, 0)
self.processing_context = createContext()
class ContextGenerator(QgsProcessingContextGenerator):
def __init__(self, context):
super().__init__()
self.processing_context = context
def processingContext(self):
return self.processing_context
self.context_generator = ContextGenerator(self.processing_context)
def createExecutionDialog(self):
dlg = AlgorithmDialog(self.model().create(), parent=self)
return dlg
def saveInProject(self):
if not self.validateSave(QgsModelDesignerDialog.SaveAction.SaveInProject):
return
self.model().setSourceFilePath(None)
project_provider = QgsApplication.processingRegistry().providerById(
PROJECT_PROVIDER_ID
)
project_provider.add_model(self.model())
self.update_model.emit()
self.messageBar().pushMessage(
"",
self.tr("Model was saved inside current project"),
level=Qgis.MessageLevel.Success,
duration=5,
)
self.setDirty(False)
QgsProject.instance().setDirty(True)
def saveModel(self, saveAs) -> bool:
if not self.validateSave(QgsModelDesignerDialog.SaveAction.SaveAsFile):
return False
model_name_matched_file_name = self.model().modelNameMatchesFilePath()
if self.model().sourceFilePath() and not saveAs:
filename = self.model().sourceFilePath()
else:
if self.model().sourceFilePath():
initial_path = Path(self.model().sourceFilePath())
elif self.model().name():
initial_path = Path(ModelerUtils.modelsFolders()[0]) / (
self.model().name() + ".model3"
)
else:
initial_path = Path(ModelerUtils.modelsFolders()[0])
filename, _ = QFileDialog.getSaveFileName(
self,
self.tr("Save Model"),
initial_path.as_posix(),
self.tr("Processing models (*.model3 *.MODEL3)"),
)
if not filename:
return False
filename = QgsFileUtils.ensureFileNameHasExtension(filename, ["model3"])
self.model().setSourceFilePath(filename)
if not self.model().name() or self.model().name() == self.tr("model"):
self.setModelName(Path(filename).stem)
elif saveAs and model_name_matched_file_name:
# if saving as, and the model name used to match the filename, then automatically update the
# model name to match the new file name
self.setModelName(Path(filename).stem)
if not self.model().toFile(filename):
if saveAs:
QMessageBox.warning(
self,
self.tr("I/O error"),
self.tr("Unable to save edits. Reason:\n {0}").format(
str(sys.exc_info()[1])
),
)
else:
QMessageBox.warning(
self,
self.tr("Can't save model"),
self.tr(
"This model can't be saved in its original location (probably you do not "
"have permission to do it). Please, use the 'Save as…' option."
),
)
return False
self.update_model.emit()
if saveAs:
self.messageBar().pushMessage(
"",
self.tr('Model was saved to <a href="{}">{}</a>').format(
QUrl.fromLocalFile(filename).toString(),
QDir.toNativeSeparators(filename),
),
level=Qgis.MessageLevel.Success,
duration=5,
)
self.setDirty(False)
return True
def openModel(self):
if not self.checkForUnsavedChanges():
return
settings = QgsSettings()
last_dir = settings.value("Processing/lastModelsDir", QDir.homePath())
filename, selected_filter = QFileDialog.getOpenFileName(
self,
self.tr("Open Model"),
last_dir,
self.tr("Processing models (*.model3 *.MODEL3)"),
)
if filename:
settings.setValue(
"Processing/lastModelsDir",
QFileInfo(filename).absoluteDir().absolutePath(),
)
self.loadModel(filename)
def repaintModel(self, showControls=True):
scene = ModelerScene(self)
scene.setSceneRect(QRectF(0, 0, self.CANVAS_SIZE, self.CANVAS_SIZE))
if not showControls:
scene.setFlag(QgsModelGraphicsScene.Flag.FlagHideControls)
showComments = QgsSettings().value(
"/Processing/Modeler/ShowComments", True, bool
)
if not showComments:
scene.setFlag(QgsModelGraphicsScene.Flag.FlagHideComments)
context = createContext()
self.setModelScene(scene)
# create items later that setModelScene to setup link to messageBar to the scene
scene.createItems(self.model(), context)
def create_widget_context(self):
"""
Returns a new widget context for use in the model editor
"""
widget_context = QgsProcessingParameterWidgetContext()
widget_context.setProject(QgsProject.instance())
if iface is not None:
widget_context.setMapCanvas(iface.mapCanvas())
widget_context.setActiveLayer(iface.activeLayer())
widget_context.setModel(self.model())
return widget_context
def autogenerate_parameter_name(self, parameter):
"""
Automatically generates and sets a new parameter's name, based on the parameter's
description and ensuring that it is unique for the model.
"""
safeName = QgsProcessingModelAlgorithm.safeName(parameter.description())
name = safeName.lower()
i = 2
while self.model().parameterDefinition(name):
name = safeName.lower() + str(i)
i += 1
parameter.setName(name)
def addInput(self, paramType, pos=None):
if paramType not in [
param.id()
for param in QgsApplication.instance().processingRegistry().parameterTypes()
]:
return
new_param = None
comment = None
if ModelerParameterDefinitionDialog.use_legacy_dialog(paramType=paramType):
dlg = ModelerParameterDefinitionDialog(self.model(), paramType)
if dlg.exec():
new_param = dlg.param
comment = dlg.comments()
else:
# yay, use new API!
context = createContext()
widget_context = self.create_widget_context()
dlg = QgsProcessingParameterDefinitionDialog(
type=paramType,
context=context,
widgetContext=widget_context,
algorithm=self.model(),
)
dlg.registerProcessingContextGenerator(self.context_generator)
if dlg.exec():
new_param = dlg.createParameter()
self.autogenerate_parameter_name(new_param)
comment = dlg.comments()
if new_param is not None:
if pos is None or not pos:
pos = self.getPositionForParameterItem()
if isinstance(pos, QPoint):
pos = QPointF(pos)
component = QgsProcessingModelParameter(new_param.name())
component.setDescription(new_param.name())
component.setPosition(pos)
component.comment().setDescription(comment)
component.comment().setPosition(
component.position()
+ QPointF(component.size().width(), -1.5 * component.size().height())
)
self.beginUndoCommand(self.tr("Add Model Input"))
self.model().addModelParameter(new_param, component)
self.repaintModel()
# self.view().ensureVisible(self.scene.getLastParameterItem())
self.endUndoCommand()
def getPositionForParameterItem(self):
MARGIN = 20
BOX_WIDTH = 200
BOX_HEIGHT = 80
if len(self.model().parameterComponents()) > 0:
maxX = max(
[
i.position().x()
for i in list(self.model().parameterComponents().values())
]
)
newX = min(MARGIN + BOX_WIDTH + maxX, self.CANVAS_SIZE - BOX_WIDTH)
else:
newX = MARGIN + BOX_WIDTH / 2
return QPointF(newX, MARGIN + BOX_HEIGHT / 2)
def addAlgorithm(self, alg_id, pos=None):
alg = QgsApplication.processingRegistry().createAlgorithmById(alg_id)
if not alg:
return
dlg = ModelerParametersDialog(alg, self.model())
if dlg.exec():
alg = dlg.createAlgorithm()
if pos is None or not pos:
alg.setPosition(self.getPositionForAlgorithmItem())
else:
alg.setPosition(pos)
alg.comment().setPosition(
alg.position() + QPointF(alg.size().width(), -1.5 * alg.size().height())
)
output_offset_x = alg.size().width()
output_offset_y = 1.5 * alg.size().height()
for out in alg.modelOutputs():
alg.modelOutput(out).setPosition(
alg.position() + QPointF(output_offset_x, output_offset_y)
)
output_offset_y += 1.5 * alg.modelOutput(out).size().height()
self.beginUndoCommand(self.tr("Add Algorithm"))
id = self.model().addChildAlgorithm(alg)
self.repaintModel()
self.endUndoCommand()
res, errors = self.model().validateChildAlgorithm(id)
if not res:
self.view().scene().showWarning(
QCoreApplication.translate(
"ModelerDialog", "Algorithm “{}” is invalid"
).format(alg.description()),
self.tr("Algorithm is Invalid"),
QCoreApplication.translate(
"ModelerDialog",
"<p>The “{}” algorithm is invalid, because:</p><ul><li>{}</li></ul>",
).format(alg.description(), "</li><li>".join(errors)),
level=Qgis.MessageLevel.Warning,
)
else:
self.view().scene().messageBar().clearWidgets()
def getPositionForAlgorithmItem(self):
MARGIN = 20
BOX_WIDTH = 200
BOX_HEIGHT = 80
if self.model().childAlgorithms():
maxX = max(
[
alg.position().x()
for alg in list(self.model().childAlgorithms().values())
]
)
maxY = max(
[
alg.position().y()
for alg in list(self.model().childAlgorithms().values())
]
)
newX = min(MARGIN + BOX_WIDTH + maxX, self.CANVAS_SIZE - BOX_WIDTH)
newY = min(MARGIN + BOX_HEIGHT + maxY, self.CANVAS_SIZE - BOX_HEIGHT)
else:
newX = MARGIN + BOX_WIDTH / 2
newY = MARGIN * 2 + BOX_HEIGHT + BOX_HEIGHT / 2
return QPointF(newX, newY)
def exportAsScriptAlgorithm(self):
dlg = ScriptEditorDialog(parent=iface.mainWindow())
dlg.editor.setText(
"\n".join(
self.model().asPythonCode(
QgsProcessing.PythonOutputType.PythonQgsProcessingAlgorithmSubclass,
4,
)
)
)
dlg.show()
|