重要

翻訳は あなたが参加できる コミュニティの取り組みです。このページは現在 94.74% 翻訳されています。

17. プロセシングプラグインを書く

開発しようとしているプラ​​グインの種類によっては、プロセシングアルゴリズム（またはそれらのセット）として機能を追加する方が良い場合もあるでしょう。そうすれば、QGIS内でのより良い統合がなされ（これは、モデラーやバッチ処理インタフェースといった、「プロセシング」のコンポーネントの中で実行できるためです）、また開発時間の短縮も期待できます（「プロセシング」が作業の大部分を肩代わりしてくれるからです）。

開発したアルゴリズムを配布するためには、アルゴリズムをプロセシングツールボックスに追加するためのプラグインを新しく作る必要があります。このプラグインにはアルゴリズムプロバイダを含ませるとともに、プラグインの初期化の際にアルゴリズムがツールボックスに登録されるようにする必要があります。

17.1. イチから作る

アルゴリズムプロバイダを含むプラグインをイチから作るには、Plugin Builder を使って以下のステップに従います。

  1. Plugin Builder プラグインをインストールする

  2. Plugin Builder を使用して新しくプラグインを作成します。Plugin Builder が使用するテンプレートをきいてきたら、「プロセシングプロバイダ」を選択します。

  3. 生成されたプラグインには、アルゴリズムをひとつ持つプロバイダが含まれています。プロバイダファイルおよびアルゴリズムファイルには両方ともに十分なコメントがついていて、プロバイダを修正したりさらにアルゴリズムを追加する方法についての情報が含まれています。詳細については、それらを参照してください。

17.2. プラグインをアップデートする

すでに作成済みのプラグインをプロセッシングに追加したい場合は、さらにコードを追加する必要があります。

  1. metadata.txt ファイルに以下の変数を追加する必要があります。

    hasProcessingProvider=yes

  2. initGui メソッドによってプラグインのセットアップを担うPythonファイルでは、幾つかのコードを直す必要があります。

     1from qgis.core import QgsApplication
 2from .processing_provider.provider import Provider
 3
 4class YourPluginName:
 5
 6    def __init__(self):
 7        self.provider = None
 8
 9    def initProcessing(self):
10        self.provider = Provider()
11        QgsApplication.processingRegistry().addProvider(self.provider)
12
13    def initGui(self):
14        self.initProcessing()
15
16    def unload(self):
17        QgsApplication.processingRegistry().removeProvider(self.provider)

  3. processing_provider フォルダを作ってそこに次の3つのファイルを納めることもできます。

    • 白紙の __init__.py ファイル。このファイルは妥当なPythonパッケージを作るために必要です。

    • provider.py ファイルはプロセッシングプロバイダを生成しあなたのアルゴリズムを外部から使えるようにします。

       1from qgis.core import QgsProcessingProvider
 2from qgis.PyQt.QtGui import QIcon
 3
 4from .example_processing_algorithm import ExampleProcessingAlgorithm
 5
 6
 7class Provider(QgsProcessingProvider):
 8
 9    """ The provider of our plugin. """
10
11    def loadAlgorithms(self):
12        """ Load each algorithm into the current provider. """
13        self.addAlgorithm(ExampleProcessingAlgorithm())
14        # add additional algorithms here
15        # self.addAlgorithm(MyOtherAlgorithm())
16
17    def id(self) -> str:
18        """The ID of your plugin, used for identifying the provider.
19
20        This string should be a unique, short, character only string,
21        eg "qgis" or "gdal". This string should not be localised.
22        """
23        return 'yourplugin'
24
25    def name(self) -> str:
26        """The human friendly name of your plugin in Processing.
27
28        This string should be as short as possible (e.g. "Lastools", not
29        "Lastools version 1.0.1 64-bit") and localised.
30        """
31        return self.tr('Your plugin')
32
33    def icon(self) -> QIcon:
34        """Should return a QIcon which is used for your provider inside
35        the Processing toolbox.
36        """
37        return QgsProcessingProvider.icon(self)

    • example_processing_algorithm.py ファイルはサンプルアルゴリズムを含みます。 script template file の内容をコピー＆ペーストして、自分の必要に合わせて修正してください。

You should have a tree similar to this :

1└── your_plugin_root_folder
2   ├── __init__.py
3   ├── LICENSE
4   ├── metadata.txt
5   └── processing_provider
6         ├── example_processing_algorithm.py
7         ├── __init__.py
8         └── provider.py

  1. ここまできたらQGISでプラグインをリロードすれば、プロセッシングツールボックスとモデラーの中にあなたのスクリプトを見つけることができるはずです。