Outdated version of the documentation. Find the latest one here.

Python プラグインの開発

Pythonプログラミング言語でプラグインを作成することが可能です。C++で書かれた古典的なプラグインと比較して、これらはPython言語の動的な性質により、記述や理解、維持、配布が簡単です。

PythonのプラグインはQGISプラグインマネージャで、C++プラグインと一緒にリストされています。それらはこれらのパスの中から検索されています:

  • UNIX/Mac: ~/.qgis2/python/plugins および (qgis_prefix)/share/qgis/python/plugins

  • Windows: ~/.qgis2/python/plugins および (qgis_prefix)/python/plugins

Windowsでのホームディレクトリ(上の ~ で示される)は通常 C:\Documents and Settings\(user) (Windows XPまたはそれ以前) や C:\Users\(user) のようなものです。QGISはPython 2.7を使用しているのでこれらのパスのサブディレクトリは、プラグインとしてインポートできるPythonパッケージと見なされるには __init__.py を含む必要があります。

ノート

既存のディレクトリのパスを QGIS_PLUGINPATH にセットすることによって、このパスをプラグインを検索するパスのリストに追加することができます。

ステップ:

  1. アイデア: 新しいQGISプラグインでやりたいことのアイデアを持ちます。なぜそれを行うのですか? どのような問題を解決しますか? その問題のための別のプラグインは既にありますか?

  2. ファイルの作成: 次に説明するファイルを作成します。開始点は(__init__.py)。 プラグインメタデータ (metadata.txt)に記入します。Pythonプラグインの本体 (mainplugin.py)。QTデザイナのフォーム (form.ui)とその resources.qrc

  3. コードを書く: mainplugin.py 内にコードを記述する

  4. テスト: QGISを閉じて再度開き、あなたのプラグインをインポートします。すべてがOKかチェックして下さい。

  5. 発行: あなたのプラグインをQGISリポジトリに発行するか、個人的な”GISの武器”の”武器庫”として独自のリポジトリを作ります。

プラグインを書く

QGISにPythonプラグインが導入されてから、いくつものプラグインが Plugin Repositories wiki page に登場しています。あなたはそれらのいくつかを見つけることができますし、PyQGISのプログラミングを学ぶためにソースを利用できます。また、開発の努力が重複していないか調べることができます。QGISチームは 公式のpythonプラグインリポジトリ を保持しています。プラグインを作成する準備はできたけれど何をすべきかについてのアイデアがありませんか? Python Plugin Ideas wiki page にはコミュニティからの願いが並べられています!

プラグインファイル

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

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プラグインの基本的なファイル(スケルトン)をオンラインで自動的に作成することができます。

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

警告

あなたのプラグインを 公式のpythonプラグインリポジトリ へアップロードするつもりなら、プラグインがプラグイン 検証 で要求されるいくつかの追加の規則に従っていることをチェックする必要があります

プラグインの内容

上述のファイル構造の中のそれぞれのファイルに何を追加するべきかについての情報および例を示します。

プラグインメタデータ

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

重要

全てのメタデータはUTF-8のエンコーディングでなければいけません。

メタデータ名

必須

注意

name True

プラグインの名前を含んでいる短い文字列

qgisMinimumVersion True

QGISの最小バージョンのドット付き表記

qgisMaximumVersion False

QGISの最大バージョンのドット付き表記

description True

プラグインを説明する短いテキスト。HTMLは使用できません。

about True

プラグインを詳細に説明するより長いテキスト。HTMLは使用できません。

version True

バージョンのドット付き表記の短い文字列

author True

作者名

email True

作者のメールアドレスで、 ユーザがログインしなければ QGIS プラグインマネージャやwebsiteで表示されることはありません、つまり他のプラグイン作者やプラグイン website の管理者のみが見ることができます

changelog False

文字列。複数行でもよいですがHTMLは使用できません。

experimental False

ブール型のフラグ。 True または False

deprecated False

ブール型のフラグ。 True または False. アップロードされたバージョンだけではなくプラグイン全体に適用されます。

tags False

コンマ区切りのリスト。個々のタグの内部にスペースを入れることは可能です。

homepage False

プラグインのホームページを指す有効なURL

repository True

ソースコードリポジトリの有効なURL

tracker False

チケットとバグ報告のための有効なURL

icon False

webに親和性の高い画像(PNG, JPEG)のファイル名または相対パス (プラグインの圧縮されたパッケージのベースフォルダに対する)

category False

Raster, Vector, Database, Web のいずれか

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

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

category=Raster

ノート

qgisMaximumVersion が空の場合、 公式のpythonプラグインリポジトリ にアップロードされた時にメジャーバージョン + .99 に自動的に設定されます。

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()

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

リソースファイル

You can see that in initGui() we’ve used an icon from the resource file (called resources.qrc in our case)

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

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

pyrcc4 -o resources.py resources.qrc

ノート

Windows 環境では、 pyrcc4 をコマンドプロンプトまたは Powershell から実行しようとするとたぶん “Windows cannot access the specified device, path, or file [...]” というエラーを受け取るでしょう。簡単な解決法はたぶん OSGeo4W Shell を使うことですが、あなたがもし PATH 環境変数を書き換えたり実行ファイルのパスをはっきりと指定するのが苦でなければ <Your QGIS Install Directory>\bin\pyrcc4.exe で見つける事ができます。

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

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

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

ドキュメント

プラグインのドキュメントはHTMLヘルプファイルとして記述できます。 qgis.utils モジュールは他のQGISのヘルプと同じ方法でヘルプファイルブラウザを開く showPluginHelp() 関数を提供しています。

showPluginHelp() 関数は呼び出し元のモジュールと同じディレクトリでヘルプファイルを探します。 index-ll_cc.html, index-ll.html, index-en.html, index-en_us.html, index.html の順に探し、はじめに見つけたものを表示します。ここで ll_cc はQGISのロケールです。ドキュメントの複数の翻訳をプラグインに含めることができます。

showPluginHelp() 関数は引数をとることができます。packageName引数はヘルプが表示されるプラグインを識別します。filename引数は検索しているファイル名の”index”を置き換えます。そしてsection引数はブラウザが表示位置を合わせるドキュメント内のHTMLアンカータグの名前です。

翻訳

いくつかのステップでプラグインの翻訳をするための環境がセットアップでき、あなたのコンピュータの言語設定に依存していたプラグインが他の言語環境でも読むことができるでしょう。

必要なソフトウェア

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

sudo apt-get install qt4-dev-tools

ファイルとディレクトリ

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

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

.PROファイル

まず、 `` .pro``ファイルを作成する必要があり、それはQtLinguistによって管理できる*プロジェクト*ファイルです。

この .pro はあなたが翻訳したい全てのファイルとフォームを含めなければいけません。このファイルは翻訳ファイルや変数をセットアップするのに使われます。 pro ファイルの例です:

FORMS = ../ui/*

SOURCES = ../your_plugin.py

TRANSLATIONS = your_plugin_it.ts

今回のケースでは全ての UI は ../ui に配置され、あなたはこれらの全てを翻訳しようとしています。

さらに、 your_plugin.py ファイルは QGIS ツールバーにあるあなたのプラグインの全てのメニューとサブメニューから 呼び出され 、これらも全て翻訳しようとしています。

最後に TRANSLATIONS 変数で翻訳したい言語を特定します。

警告

ts ファイルの名前は your_plugin_ + 言語 + .ts となるように命名するよう気をつけてください、そうでなければ言語の読み込みに失敗するでしょう!2文字の短縮形の言語を使います(it はイタリア語、 de はドイツ語、などなど...)

.ts ファイル

一度 .pro を作ったら、あなたのプラグインの言語(ごと)の .ts ファイル(たち)を生成する準備ができました。

ターミナルを開いて、 your_plugin/i18n に移動して次のように入力します:

lupdate your_plugin.pro

your_plugin_language.ts ファイル(ら)がみつかるはずです。

.tsQt Linguist で開いて翻訳を開始します。

.qm ファイル

あなたのプラグインの翻訳が終わったら (もしいくつかの文字列が終わっていなかったらソースの言語の文字列が使われるでしょう) .qm ファイルを作る必要があります (.ts ファイルをコンパイルしたもので、 QGIS で使われます)。

ターミナルを開いて your_plugin/i18n ディレクトリに cd して、次のように入力します:

lrelease your_plugin.ts

これで、 i18n ディレクトリに your_plugin.qm ファイル(たち)が見つかるでしょう。

プラグインの読み込み

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

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

警告

プラグインで何かを変更した場合(新しいUIに、新しいメニュー、など。)** `` .ts``と `` .qm``ファイルの両方の**更新バージョンを再度生成する必要がありますので、上記のコマンド再度実行します。