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
|
"""
***************************************************************************
ProjectProvider.py
------------------------
Date : July 2018
Copyright : (C) 2018 by Nyall Dawson
Email : nyall dot dawson 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__ = "Nyall Dawson"
__date__ = "July 2018"
__copyright__ = "(C) 2018, Nyall Dawson"
from qgis.core import (
Qgis,
QgsApplication,
QgsProcessingProvider,
QgsMessageLog,
QgsProcessingModelAlgorithm,
QgsProject,
QgsXmlUtils,
QgsRuntimeProfiler,
)
PROJECT_PROVIDER_ID = "project"
class ProjectProvider(QgsProcessingProvider):
def __init__(self, project=None):
super().__init__()
if project is None:
self.project = QgsProject.instance()
else:
self.project = project
self.model_definitions = {} # dict of models in project
self.is_loading = False
# must reload models if providers list is changed - previously unavailable algorithms
# which models depend on may now be available
QgsApplication.processingRegistry().providerAdded.connect(
self.on_provider_added
)
self.project.readProject.connect(self.read_project)
self.project.writeProject.connect(self.write_project)
self.project.cleared.connect(self.clear)
def on_provider_added(self, provider_id):
if provider_id == self.id():
return
self.refreshAlgorithms()
def load(self):
with QgsRuntimeProfiler.profile("Project Provider"):
self.refreshAlgorithms()
return True
def clear(self):
"""
Remove all algorithms from the provider
"""
self.model_definitions = {}
self.refreshAlgorithms()
def add_model(self, model):
"""
Adds a model to the provider
:type model: QgsProcessingModelAlgorithm
:param model: model to add
"""
definition = model.toVariant()
self.model_definitions[model.name()] = definition
self.refreshAlgorithms()
def remove_model(self, model):
"""
Removes a model from the project
:type model: QgsProcessingModelAlgorithm
:param model: model to remove
"""
if model is None:
return
if model.name() in self.model_definitions:
del self.model_definitions[model.name()]
self.refreshAlgorithms()
def read_project(self, doc):
"""
Reads the project model definitions from the project DOM document
:param doc: DOM document
"""
self.model_definitions = {}
project_models_nodes = doc.elementsByTagName("projectModels")
if project_models_nodes:
project_models_node = project_models_nodes.at(0)
model_nodes = project_models_node.childNodes()
for n in range(model_nodes.count()):
model_element = model_nodes.at(n).toElement()
definition = QgsXmlUtils.readVariant(model_element)
algorithm = QgsProcessingModelAlgorithm()
if algorithm.loadVariant(definition):
self.model_definitions[algorithm.name()] = definition
self.refreshAlgorithms()
def write_project(self, doc):
"""
Writes out the project model definitions into the project DOM document
:param doc: DOM document
"""
qgis_nodes = doc.elementsByTagName("qgis")
if not qgis_nodes:
return
qgis_node = qgis_nodes.at(0)
project_models_node = doc.createElement("projectModels")
for a in self.algorithms():
definition = a.toVariant()
element = QgsXmlUtils.writeVariant(definition, doc)
project_models_node.appendChild(element)
qgis_node.appendChild(project_models_node)
def name(self):
return self.tr("Project models", "ProjectProvider")
def longName(self):
return self.tr("Models embedded in the current project", "ProjectProvider")
def id(self):
return PROJECT_PROVIDER_ID
def icon(self):
return QgsApplication.getThemeIcon("/mIconQgsProjectFile.svg")
def svgIconPath(self):
return QgsApplication.iconPath("mIconQgsProjectFile.svg")
def supportsNonFileBasedOutput(self):
return True
def loadAlgorithms(self):
if self.is_loading:
return
self.is_loading = True
for definition in self.model_definitions.values():
algorithm = QgsProcessingModelAlgorithm()
if algorithm.loadVariant(definition):
self.addAlgorithm(algorithm)
else:
QgsMessageLog.logMessage(
self.tr("Could not load model from project", "ProjectProvider"),
self.tr("Processing"),
Qgis.MessageLevel.Critical,
)
self.is_loading = False
|