Python プラグインを開発する¶

プラグインファイル¶

これらはサンプルプラグインのディレクトリ構造です

PYTHON_PLUGINS_PATH/
  MyPlugin/
    __init__.py    --> *required*
    mainPlugin.py  --> *required*
    metadata.txt   --> *required*
    resources.qrc  --> *likely useful*
    resources.py   --> *compiled version, likely useful*
    form.ui        --> *likely useful*
    form.py        --> *compiled version, likely useful*

ファイルが意味すること:

• __init__.py = プラグインの開始点。 classFactory() メソッドを持つ必要があります。その他の初期化コードを持つこともできます。

• mainPlugin.py = プラグインの主なワーキングコード。このプラグインの動作に関するすべての情報と主要なコードを含みます。

• resources.qrc = Qtデザイナによって作成された.xmlドキュメント。フォームのリソースへの相対パスが含まれています。

• resources.py = 上記の.qrcファイルがPythonに変換されたもの。

• form.ui = Qtデザイナで作成されたGUI

• form.py = 上記のform.uiがPythonに変換されたもの。

• metadata.txt = QGIS >= 1.8.0 で必要です。全般情報やバージョン、名前、そしてプラグインのウェブサイトやインフラストラクチャによって使用されるいくつかのメタデータが含まれます。QGIS 2.0 以降では __init__.py からのメタデータは受け付けられず、 metadata.txt が必要です。

ここ では典型的なQGISのPythonプラグインの基本的なファイル(スケルトン)をオンラインで自動的に作成することができます。

また、 プラグインビルダー と呼ばれるQGISプラグインがあります。QGISからプラグインテンプレートを作成しますがインターネット接続を必要としません。2.0に互換性のあるソースを生成しますので推奨される選択肢です。

プラグインメタデータ¶

まず、プラグインマネージャは名前や説明などプラグインに関する基本的な情報を取得する必要があります。 metadata.txt ファイルはこの情報を記載するのに適切な場所です。

デフォルトではプラグインは プラグイン メニューに配置されます(次のセクションでプラグインのメニューエントリを追加する方法を見ます)が ラスター や ベクター, データベース, Web メニューに配置することもできます。

対応する”category”のメタデータエントリがそれを指定するためにあり、プラグインはそれに従って分類できます。このメタデータエントリはユーザーのためのヒントとして使用され、どこに(どのメニューに)プラグインがあるかを示しています。”category”として指定できる値は「ベクター」「ラスター」「データベース」「Web」です。たとえば、あなたのプラグインが ラスター メニューから利用できる場合は、 これを metadata.txt に追加します

category=Raster

metadata.txtの例

; the next section is mandatory

[general]
name=HelloWorld
[email protected]
author=Just Me
qgisMinimumVersion=2.0
description=This is an example plugin for greeting the world.
    Multiline is allowed:
    lines starting with spaces belong to the same
    field, in this case to the "description" field.
    HTML formatting is not allowed.
about=This paragraph can contain a detailed description
    of the plugin. Multiline is allowed, HTML is not.
version=version 1.2
tracker=http://bugs.itopen.it
repository=http://www.itopen.it/repo
; end of mandatory metadata

; start of optional metadata
category=Raster
changelog=The changelog lists the plugin versions
    and their changes as in the example below:
    1.0 - First stable release
    0.9 - All features implemented
    0.8 - First testing release

; Tags are in comma separated value format, spaces are allowed within the
; tag name.
; Tags should be in English language. Please also check for existing tags and
; synonyms before creating a new one.
tags=wkt,raster,hello world

; these metadata can be empty, they will eventually become mandatory.
homepage=http://www.itopen.it
icon=icon.png

; experimental flag (applies to the single version)
experimental=True

; deprecated flag (applies to the whole plugin and not only to the uploaded version)
deprecated=False

; if empty, it will be automatically set to major version + .99
qgisMaximumVersion=2.0

__init__.py¶

このファイルはPythonのインポートシステムに必要とされます。QGISにプラグインが読み込まれる時に呼ばれる classFactory() 関数がこのファイルに含まれている必要があります。それは QgisInterface のインスタンスへの参照を受け取って、 mainplugin.py のプラグインクラスのインスタンスを返す必要があります — 私たちの場合はそれは TestPlugin という名前のクラスです(下記参照)。 __init__.py はこんな感じに見えるべきです:

def classFactory(iface):
  from mainPlugin import TestPlugin
  return TestPlugin(iface)

## any other initialisation needed

mainPlugin.py¶

これが魔法が起きるところで、魔法はこのように見えます: (例えば mainPlugin.py)

from PyQt4.QtCore import *
from PyQt4.QtGui import *
from qgis.core import *

# initialize Qt resources from file resources.py
import resources

class TestPlugin:

  def __init__(self, iface):
    # save reference to the QGIS interface
    self.iface = iface

  def initGui(self):
    # create action that will start plugin configuration
    self.action = QAction(QIcon(":/plugins/testplug/icon.png"), "Test plugin", self.iface.mainWindow())
    self.action.setObjectName("testAction")
    self.action.setWhatsThis("Configuration for test plugin")
    self.action.setStatusTip("This is status tip")
    QObject.connect(self.action, SIGNAL("triggered()"), self.run)

    # add toolbar button and menu item
    self.iface.addToolBarIcon(self.action)
    self.iface.addPluginToMenu("&Test plugins", self.action)

    # connect to signal renderComplete which is emitted when canvas
    # rendering is done
    QObject.connect(self.iface.mapCanvas(), SIGNAL("renderComplete(QPainter *)"), self.renderTest)

  def unload(self):
    # remove the plugin menu item and icon
    self.iface.removePluginMenu("&Test plugins", self.action)
    self.iface.removeToolBarIcon(self.action)

    # disconnect form signal of the canvas
    QObject.disconnect(self.iface.mapCanvas(), SIGNAL("renderComplete(QPainter *)"), self.renderTest)

  def run(self):
    # create and show a configuration dialog or something similar
    print "TestPlugin: run called!"

  def renderTest(self, painter):
    # use painter for drawing to map canvas
    print "TestPlugin: renderTest called!"

メインのプラグインのソースファイル(例. mainPlugin.py) に含まれる必要があるプラグイン用の関数は:

• __init__ –> QGIS のインターフェイスとのアクセスを与えます

• initGui() –> プラグインがロードされたときに呼び出されます

• unload() –> プラグインがアンロードされたときに呼び出されます

上記の例では addPluginToMenu() が使用されています。これは対応するメニューアクションを Plugins メニューに追加します。別のメニューにアクションを追加する他の方法も存在します。それらのメソッドの一覧です:

• addPluginToRasterMenu()
• addPluginToVectorMenu()
• addPluginToDatabaseMenu()
• addPluginToWebMenu()

それらはすべて addPluginToMenu() メソッドと同じ構文です。

プラグインエントリの編成の一貫性を保つために、これらの定義済みのメソッドのいずれかでプラグインメニューを追加することが推奨されます。ただし、次の例に示すようにメニューバーに直接カスタムメニューグループを追加することができます:

def initGui(self):
    self.menu = QMenu(self.iface.mainWindow())
    self.menu.setObjectName("testMenu")
    self.menu.setTitle("MyMenu")

    self.action = QAction(QIcon(":/plugins/testplug/icon.png"), "Test plugin", self.iface.mainWindow())
    self.action.setObjectName("testAction")
    self.action.setWhatsThis("Configuration for test plugin")
    self.action.setStatusTip("This is status tip")
    QObject.connect(self.action, SIGNAL("triggered()"), self.run)
    self.menu.addAction(self.action)

    menuBar = self.iface.mainWindow().menuBar()
    menuBar.insertMenu(self.iface.firstRightStandardMenu().menuAction(), self.menu)

def unload(self):
    self.menu.deleteLater()

カスタマイズを可能にするために QAction と QMenu の objectName をプラグイン固有の名前に設定することを忘れないで下さい。

リソースファイル¶

initGui() ではリソースファイル(この場合 resources.qrc )からアイコンを使用したことがわかります

<RCC>
  <qresource prefix="/plugins/testplug" >
     <file>icon.png</file>
  </qresource>
</RCC>

他のプラグインやQGISのいずれかの部分と衝突しない接頭辞を使用するのが良いです。そうでなければあなたが望んでいないリソースを得るかもしれません。そして、リソースを格納するPythonファイルを生成する必要があります。 pyrcc4 コマンドで行います:

pyrcc4 -o resources.py resources.qrc

これで以上です... なにも複雑なものはありません :)

すべてうまくいったらプラグインマネージャであなたのプラグインを見つけてロードすることができるはずです。そしてツールバーアイコンや適切なメニューアイテムが選択された時にコンソールにメッセージが表示されるはずです。

本物のプラグインに取り組んでいる時は別の(作業)ディレクトリでプラグインを書いて、UIとリソースファイルを生成してプラグインをQGISにインストールするmakefileを作成するのが賢明です。

必要なソフトウェア¶

翻訳ファイルを作成及び管理するもっとも簡単な方法は Qt Linguist をインストールすることです。 DebianベースのGNU/Linux 環境では次をタイプすることでインストールできます:

sudo apt-get install qt4-dev-tools

ファイルとディレクトリ¶

プラグインを作成したときにプラグインのメインのディレクトリに i18n フォルダがあるのを見つけることができます。

全ての翻訳ファイルはこのディレクトリにあります。

FORMS = ../form.ui
SOURCES = ../your_plugin.py
TRANSLATIONS = your_plugin_it.ts

FORMS = ../ui/about.ui ../ui/feedback.ui \
        ../ui/main_dialog.ui
SOURCES = ../your_plugin.py ../computation.py \
          ../utils.py

pylupdate4 your_plugin.pro

lrelease your_plugin.ts

Translate using Makefile¶

Alternatively you can use the makefile to extract messages from python code and Qt dialogs, if you created your plugin with Plugin Builder. At the beginning of the Makefile there is a LOCALES variable:

LOCALES = en

Add the abbreviation of the language to this variable, for example for Hungarian language:

LOCALES = en hu

Now you can generate or update the hu.ts file (and the en.ts too) from the sources by:

make transup

After this, you have updated .ts file for all languages set in the LOCALES variable. Use Qt4 Linguist to translate the program messages. Finishing the translation the .qm files can be created by the transcompile:

make transcompile

You have to distribute .ts files with your plugin.

プラグインの読み込み¶

QGISを開いてあなたのプラグインの翻訳を確認するには、言語を変更して ( 設定‣オプション‣言語 ) QGIS を再起動します。

これで的確な言語であなたのプラグインを見ることができます。