17. كتابة إضافة معالجة (Processing)

بحسب نوع الإضافة التي ستطوّرها، قد يكون من الأفضل إضافة وظيفتها على شكل خوارزمية معالجة (أو مجموعة منها). سيوفر ذلك تكاملًا أفضل داخل QGIS، ووظائف إضافية (لأنه يمكن تشغيلها ضمن مكوّنات المعالجة، مثل مصمّم النماذج أو واجهة المعالجة الدفعية)، ووقت تطوير أقصر (لأن إطار المعالجة سيتولى جزءًا كبيرًا من العمل).

لتوزيع تلك الخوارزميات، عليك إنشاء إضافة جديدة تضيفها إلى صندوق أدوات المعالجة. يجب أن تحتوي الإضافة على مزوّد خوارزميات، يجب تسجيله عند إنشاء نسخة من الإضافة.

17.1. تحديث إضافة

إن أردت إضافة إضافتك الموجودة إلى إطار المعالجة، فعليك إضافة بعض الشيفرة.

1. في ملف metadata.txt عليك إضافة متغير:

   hasProcessingProvider=yes
   

2. في ملف Python الذي تُعَدّ فيه إضافتك بالدالة initGui، عليك تعديل بعض الأسطر على النحو التالي:

   from qgis.core import QgsApplication
   from .processing_provider.provider import Provider
   
   class YourPluginName:
   
       def __init__(self):
           self.provider = None
   
       def initProcessing(self):
           self.provider = Provider()
           QgsApplication.processingRegistry().addProvider(self.provider)
   
       def initGui(self):
           self.initProcessing()
   
       def unload(self):
           QgsApplication.processingRegistry().removeProvider(self.provider)
   

3. يمكنك إنشاء مجلد processing_provider يحتوي على ثلاثة ملفات:

   • __init__.py فارغ. وهو ضروري لإنشاء حزمة Python صالحة.

   • provider.py الذي سينشئ مزوّد المعالجة ويعرض خوارزمياتك.

     from qgis.core import QgsProcessingProvider
     from qgis.PyQt.QtGui import QIcon
     
     from .example_processing_algorithm import ExampleProcessingAlgorithm
     
     class Provider(QgsProcessingProvider):
     
         """ The provider of our plugin. """
     
         def loadAlgorithms(self):
             """ Load each algorithm into the current provider. """
             self.addAlgorithm(ExampleProcessingAlgorithm())
             # add additional algorithms here
             # self.addAlgorithm(MyOtherAlgorithm())
     
         def id(self) -> str:
             """The ID of your plugin, used for identifying the provider.
     
             This string should be a unique, short, character only string,
             eg "qgis" or "gdal". This string should not be localised.
             """
             return 'yourplugin'
     
         def name(self) -> str:
             """The human friendly name of your plugin in Processing.
     
             This string should be as short as possible (e.g. "Lastools", not
             "Lastools version 1.0.1 64-bit") and localised.
             """
             return self.tr('Your plugin')
     
         def icon(self) -> QIcon:
             """Should return a QIcon which is used for your provider inside
             the Processing toolbox.
             """
             return QgsProcessingProvider.icon(self)
     

   • example_processing_algorithm.py الذي يحتوي على ملف الخوارزمية المثال. انسخ محتوى script template file (ملف قالب السكربت) والصقه، ثم حدّثه وفق احتياجاتك.

   يُفترض أن تكون لديك شجرة مشابهة لما يلي:

   └── your_plugin_root_folder
      ├── __init__.py
      ├── LICENSE
      ├── metadata.txt
      └── processing_provider
            ├── example_processing_algorithm.py
            ├── __init__.py
            └── provider.py
   

4. الآن يمكنك إعادة تحميل إضافتك في QGIS، ويُفترض أن ترى سكربتك المثال في صندوق أدوات المعالجة ومصمّم النماذج.

17.1.1. إنشاء خوارزمية مخصصة

إليك مثالًا بسيطًا على خوارزمية نطاق عازل مخصصة:

from qgis.core import (
    QgsProcessingAlgorithm,
    QgsProcessingParameterFeatureSource,
    QgsProcessingParameterNumber,
    QgsProcessingParameterFeatureSink,
    QgsFeatureSink,
)

class BufferAlgorithm(QgsProcessingAlgorithm):

    INPUT = 'INPUT'
    DISTANCE = 'DISTANCE'
    OUTPUT = 'OUTPUT'

    def initAlgorithm(self, config=None):
        self.addParameter(QgsProcessingParameterFeatureSource(self.INPUT, 'Input layer'))
        self.addParameter(QgsProcessingParameterNumber(self.DISTANCE, 'Buffer distance', defaultValue=100.0))
        self.addParameter(QgsProcessingParameterFeatureSink(self.OUTPUT, 'Output layer'))

    def processAlgorithm(self, parameters, context, feedback):
        source = self.parameterAsSource(parameters, self.INPUT, context)
        distance = self.parameterAsDouble(parameters, self.DISTANCE, context)
        (sink, dest_id) = self.parameterAsSink(parameters, self.OUTPUT, context,
                                               source.fields(), source.wkbType(), source.sourceCrs())

        for f in source.getFeatures():
            f.setGeometry(f.geometry().buffer(distance, 5))
            sink.addFeature(f, QgsFeatureSink.FastInsert)

        return {self.OUTPUT: dest_id}

    def name(self):
        return 'buffer'

    def displayName(self):
        return 'Buffer Features'

    def group(self):
        return 'Examples'

    def groupId(self):
        return 'examples'

    def createInstance(self):
        return BufferAlgorithm()