python脚本编写_【PyQGIS】编写用于处理框架（QGIS3）的Python脚本

可以编写可通过QGIS中的Python控制台运行的独立pyqgis脚本。进行一些调整，即可使您的独立脚本通过处理框架运行。这具有几个优点。首先，获取用户输入和写入输出文件要容易得多，因为Processing Framework为这些提供了标准化的用户界面。其次，将脚本放入“处理工具箱”中还可以使其成为任何“处理模型”的一部分，或作为具有多个输入的批处理作业运行。本教程将展示如何编写自定义python脚本，该脚本可以作为QGIS中Processing框架的一部分。

注意

在QGIS3中彻底修改了Processing API。请参考本指南以获取最佳做法和提示。

任务概述

我们的脚本将根据用户选择的字段执行溶解操作。它还将为溶解的特征求和另一个字段的值。在示例中，我们将基于CONTINENT属性分解世界shapefile并求和POP_EST字段以计算溶解区域中的总人口。

获取数据

我们将使用自然地球的Admin 0-国家数据集。

下载Admin 0-国家shapefile。。

资料来源[NATURALEARTH]

为了方便起见，您可以直接从下面下载包含以上图层的地理包：

ne_global.gpkg

程序

在“ QGIS浏览器面板”中，找到保存下载数据的目录。展开zip或gpkg 条目，然后选择ne_10m_admin_0_countries图层。将图层拖到画布上。
转到处理‣工具箱。单击工具栏中的“脚本”按钮，然后选择“从模板创建新脚本”。
该模板包含处理框架将其识别为处理脚本并管理输入/输出所需的所有样板代码。让我们开始根据需要定制示例模板。首先将类名从更改ExampleProcessingAlgorithm为DissolveProcessingAlgorithm。此名称也需要在createInstance方法中更新。在该类中添加一个文档字符串，以解释该算法的作用。
向下滚动时，您将看到为脚本分配名称，组，描述等的方法。更改返回值的名称的方法是dissolve_with_sum，显示名的方法，组方法和的groupId方法。将shortHelpString方法的返回值更改为将显示给用户的描述。单击保存按钮。Dissolve with Sumscripts
命名脚本dissolve_with_sum并将其保存在配置文件‣默认‣处理‣脚本文件夹下的默认位置。

现在，我们将定义脚本的输入。模板已经包含INPUT矢量层和OUTPUT层的定义。我们将添加2个新输入，允许用户选择DISSOLVE_FIELD和SUM_FIELD。在该initAlgorithm方法的顶部和下面的代码中添加一个新的导入。单击运行按钮以预览更改。

from qgis.core import QgsProcessingParameterFieldself.addParameter(        QgsProcessingParameterField(                self.DISSOLVE_FIELD,                'Choose Dissolve Field',                '',                self.INPUT))self.addParameter(        QgsProcessingParameterField(                self.SUM_FIELD,                'Choose Sum Field',                '',                self.INPUT))

您将看到带有新定义的输入的“用总和溶解”对话框。选择ne_10m_admin_0_countries图层作为Input layer`。由于溶解字段和求和字段都是基于输入层进行过滤的，因此它们将被输入层中的现有字段预先填充。单击关闭按钮。

现在，我们定义了用于在该processAlgorithm方法中处理数据的自定义逻辑。该方法通过了名为的字典parameters。它包含用户已选择的输入。有一些帮助程序方法，使您可以接受这些输入并创建适当的对象。我们首先使用parameterAsSource和parameterAsString方法获得输入。接下来，我们要创建一个特征接收器，在其中写入输出。QGIS3有一个新的类QgsFeatureSink，它是创建可以接受新功能的对象的首选方法。输出仅需要2个字段-一个用于溶解字段的值，另一个用于所选字段的总和。

from PyQt5.QtCore import QVariantfrom qgis.core import QgsField, QgsFieldssource = self.parameterAsSource(        parameters,        self.INPUT,        context)dissolve_field = self.parameterAsString(        parameters,        self.DISSOLVE_FIELD,        context)sum_field = self.parameterAsString(        parameters,        self.SUM_FIELD,        context)fields = QgsFields()fields.append(QgsField(dissolve_field, QVariant.String))fields.append(QgsField('SUM_' + sum_field, QVariant.Double))(sink, dest_id) = self.parameterAsSink(        parameters,        self.OUTPUT,        context, fields, source.wkbType(), source.sourceCrs())

现在，我们将准备输入功能，并创建一个字典来保存dissolve_field中的唯一值和sum_field中的值之和。注意使用feedback.pushInfo()方法与用户交流状态。

feedback.pushInfo('Extracting unique values from dissolve_field and computing sum')features = source.getFeatures()unique_values = set(f[dissolve_field] for f in features)# Get Indices of dissolve field and sum fielddissolveIdx = source.fields().indexFromName(dissolve_field)sumIdx = source.fields().indexFromName(sum_field)# Find all unique values for the given dissolve_field and# sum the corresponding values from the sum_fieldsum_unique_values = {}attrs = [{dissolve_field: f[dissolveIdx], sum_field: f[sumIdx]} for f in source.getFeatures()]for unique_value in unique_values:        val_list = [ f_attr[sum_field] for f_attr in attrs if f_attr[dissolve_field] == unique_value]        sum_unique_values[unique_value] = sum(val_list)

接下来，我们将native:dissolve在输入层上调用内置处理算法以生成分解的几何图形。一旦有了可溶的几何形状，我们便会遍历可溶算法的输出，并创建要添加到输出中的新特征。最后，我们返回dest_idFeatureSink作为输出。现在脚本已准备就绪。单击运行按钮。

注意

请注意，使用parameters[self.INPUT]可以直接从参数字典中获取输入层，而无需将其定义为源。由于我们将输入对象传递给算法而不进行任何操作，因此没有必要将其定义为源。

from qgis.core import QgsFeature# Running the processing dissolve algorithmfeedback.pushInfo('Dissolving features')dissolved_layer = processing.run("native:dissolve", {        'INPUT': parameters[self.INPUT],        'FIELD': dissolve_field,        'OUTPUT': 'memory:'        }, context=context, feedback=feedback)['OUTPUT']# Read the dissolved layer and create output featuresfor f in dissolved_layer.getFeatures():        new_feature =  QgsFeature()        # Set geometry to dissolved geometry        new_feature.setGeometry(f.geometry())        # Set attributes from sum_unique_values dictionary that we had computed        new_feature.setAttributes([f[dissolve_field], sum_unique_values[f[dissolve_field]]])        sink.addFeature(new_feature, QgsFeatureSink.FastInsert)return {self.OUTPUT: dest_id}

在“用总和溶解”对话框中，选择ne_10m_admin_0_countries作为“输入”层，CONTINENT“溶解”字段和POP_EST“总和”字段。点击运行。
处理完成后，单击“关闭”按钮，然后切换到QGIS主窗口。
您将看到每个大陆具有一个要素的已分解输出层，以及该大陆各个国家的总人口合计。
编写处理脚本的另一个优点是，处理框架中的方法知道图层选择，并自动过滤输入以仅使用所选功能。发生这种情况是因为我们将输入定义为QgsProcessingParameterFeatureSource。特征源允许使用包含矢量要素的任何对象，而不仅仅是矢量图层，因此，当图层中有选定要素并要求Processing使用选定要素时，输入将作为QgsProcessingFeatureSource包含选定要素的对象传递到脚本中而不是完整的矢量层。这是此功能的快速演示。假设我们只想溶解某些大洲。让我们使用“表达式”工具的“选择”功能来创建选择。
输入以下表达式以选择北美和南美的要素，然后单击“选择”。
```
"CONTINENT" = 'North America' OR "CONTINENT" = 'South America'
```

您将看到以黄色突出显示的所选功能。找到该dissolve_with_sum脚本，然后双击以运行它。
在“用总和溶解”对话框中，选择ne_10m_admin_0_countries作为输入层。这次，请确保选中“仅所选功能”框。选择SUBREGION作为“溶解”字段和POP_EST“求和”字段。
处理完成后，单击“关闭”，然后切换回QGIS主窗口。您会注意到一个新图层，其中仅溶解了选定的要素。单击“标识”按钮，然后单击某个功能以检查并验证脚本是否正常运行。

以下是完整的脚本供参考。您可以修改它以满足您的需求。

# -*- coding: utf-8 -*-"""****************************************************************************                                                                         **   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 PyQt5.QtCore import QCoreApplication, QVariantfrom qgis.core import (QgsProcessing,                       QgsFeatureSink,                       QgsFeature,                       QgsField,                       QgsFields,                       QgsProcessingException,                       QgsProcessingAlgorithm,                       QgsProcessingParameterFeatureSource,                       QgsProcessingParameterFeatureSink,                       QgsProcessingParameterField,                       )import processingclass DissolveProcessingAlgorithm(QgsProcessingAlgorithm):    """    Dissolve algorithm that dissolves features based on selected    attribute and summarizes the selected field by cumputing the    sum of dissolved features.    """    INPUT = 'INPUT'    OUTPUT = 'OUTPUT'    DISSOLVE_FIELD = 'dissolve_field'    SUM_FIELD = 'sum_field'    def tr(self, string):        """        Returns a translatable string with the self.tr() function.        """        return QCoreApplication.translate('Processing', string)    def createInstance(self):        return DissolveProcessingAlgorithm()    def name(self):        """        Returns the algorithm name, used for identifying the algorithm. This        string should be fixed for the algorithm, and must not be localised.        The name should be unique within each provider. Names should contain        lowercase alphanumeric characters only and no spaces or other        formatting characters.        """        return 'dissolve_with_sum'    def displayName(self):        """        Returns the translated algorithm name, which should be used for any        user-visible display of the algorithm name.        """        return self.tr('Dissolve with Sum')    def group(self):        """        Returns the name of the group this algorithm belongs to. This string        should be localised.        """        return self.tr('scripts')    def groupId(self):        """        Returns the unique ID of the group this algorithm belongs to. This        string should be fixed for the algorithm, and must not be localised.        The group id should be unique within each provider. Group id should        contain lowercase alphanumeric characters only and no spaces or other        formatting characters.        """        return 'scripts'    def shortHelpString(self):        """        Returns a localised short helper string for the algorithm. This string        should provide a basic description about what the algorithm does and the        parameters and outputs associated with it..        """        return self.tr("Dissolves selected features and creates and sums values of features that were dissolved")    def initAlgorithm(self, config=None):        """        Here we define the inputs and output of the algorithm, along        with some other properties.        """        # We add the input vector features source. It can have any kind of        # geometry.        self.addParameter(            QgsProcessingParameterFeatureSource(                self.INPUT,                self.tr('Input layer'),                [QgsProcessing.TypeVectorAnyGeometry]            )        )        self.addParameter(            QgsProcessingParameterField(                self.DISSOLVE_FIELD,                'Choose Dissolve Field',                '',                self.INPUT))        self.addParameter(            QgsProcessingParameterField(                self.SUM_FIELD,                'Choose Sum Field',                '',                self.INPUT))        # We add a feature sink in which to store our processed features (this        # usually takes the form of a newly created vector layer when the        # algorithm is run in QGIS).        self.addParameter(            QgsProcessingParameterFeatureSink(                self.OUTPUT,                self.tr('Output layer')            )        )    def processAlgorithm(self, parameters, context, feedback):        """        Here is where the processing itself takes place.        """        source = self.parameterAsSource(            parameters,            self.INPUT,            context        )        dissolve_field = self.parameterAsString(            parameters,            self.DISSOLVE_FIELD,            context)        sum_field = self.parameterAsString(            parameters,            self.SUM_FIELD,            context)                fields = QgsFields()        fields.append(QgsField(dissolve_field, QVariant.String))        fields.append(QgsField('SUM_' + sum_field, QVariant.Double))                (sink, dest_id) = self.parameterAsSink(            parameters,            self.OUTPUT,            context, fields, source.wkbType(), source.sourceCrs())                # Create a dictionary to hold the unique values from the         # dissolve_field and the sum of the values from the sum_field        feedback.pushInfo('Extracting unique values from dissolve_field and computing sum')        features = source.getFeatures()        unique_values = set(f[dissolve_field] for f in features)        # Get Indices of dissolve field and sum field        dissolveIdx = source.fields().indexFromName(dissolve_field)        sumIdx = source.fields().indexFromName(sum_field)                # Find all unique values for the given dissolve_field and        # sum the corresponding values from the sum_field        sum_unique_values = {}        attrs = [{dissolve_field: f[dissolveIdx], sum_field: f[sumIdx]}                for f in source.getFeatures()]        for unique_value in unique_values:            val_list = [ f_attr[sum_field]                 for f_attr in attrs if f_attr[dissolve_field] == unique_value]            sum_unique_values[unique_value] = sum(val_list)                # Running the processing dissolve algorithm        feedback.pushInfo('Dissolving features')        dissolved_layer = processing.run("native:dissolve", {            'INPUT': parameters[self.INPUT],            'FIELD': dissolve_field,            'OUTPUT': 'memory:'        }, context=context, feedback=feedback)['OUTPUT']                # Read the dissolved layer and create output features        for f in dissolved_layer.getFeatures():            new_feature =  QgsFeature()            # Set geometry to dissolved geometry            new_feature.setGeometry(f.geometry())            # Set attributes from sum_unique_values dictionary that we had computed            new_feature.setAttributes([f[dissolve_field], sum_unique_values[f[dissolve_field]]])            sink.addFeature(new_feature, QgsFeatureSink.FastInsert)                return {self.OUTPUT: dest_id}

END

点击下方“阅读原文”查看更多