Для розробки плаґінів можна використовувати мову програмування Python. У порівнянні з класичними плаґінами, написаними на C++, їх легше розробляти, розуміти, підтримувати та розповсюджувати через динамічну природу мови Python.
Плаґіни, написані на Python, відображаються разом з плаґінами, написаними на C++, у Менеджері плаґінів. Пошук плаґінів виконується у наступних каталогах:
Розробка плаґіна
З моменту введення підтримки плаґінів на Python у QGIS з’явилось багато плаґінів — на сторінці Plugin Repositories можна знайти деякі з них. Вихідний код цих плаґінів можна використовувати, щоб дізнатися більше про розробку з використанням PyQGIS або для того, щоб переконатися, що розробка не дублюється. Команда розробників QGIS також підтримує Офіційний репозиторій плаґінів. Готові до розробки плаґіна, але не маєте ідей? На сторінці Python Plugin Ideas зібрано багато ідей та побажань!
Створення необхідних файлів
Нижче наведено вміст каталогу нашого демонстраційного плаґіна
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 = XML-документ, створений Qt Designer. Тут зберігаються відносні шляхи до ресурсів форм.
resources.py = адаптована для Python версія вищеописаного файлу.
form.ui = графічний інтерфейс (GUI), створений у Qt Designer.
form.py = адаптована для Python версія вищеописаного файлу.
- metadata.txt = Required for QGIS >= 1.8.0. Containts general info,
version, name and some other metadata used by plugins website and plugin
infrastructure. Since QGIS 2.0 the metadata from __init__.py are not
accepted anymore and the metadata.txt is required.
Тут знаходиться онлайновий генератор базових файлів (основи) типового плаґіна для QGIS.
Також можна скористатися плаґіном Plugin Builder, який дозволяє створювати шаблон плаґінів прямо з QGIS та не потребує доступу до інтернету. Рекомендуємо використовувати саме цей варіант, оскільки він генерує файли, сумісні з QGIS 2.0.
Файли плаґіна
Тут ви знайдете інформацію та приклади вмісти кожного необхідного файлу.
__init__.py
This file is required by Python’s import system. Also, QGIS requires that this
file contains a classFactory() function, which is called when the
plugin gets loaded to QGIS. It receives reference to instance of
QgisInterface and must return instance of your plugin’s class from the
mainplugin.py — in our case it’s called TestPlugin (see below).
This is how __init__.py should look like
def classFactory(iface):
from mainPlugin import TestPlugin
return TestPlugin(iface)
## any other initialisation needed
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) aлe обов’язково повинні буди два методи:
Ви можете бачити, що у нашому прикладі використовується метод ``:func:`addPluginToMenu`<http://qgis.org/api/classQgisInterface.html#ad1af604ed4736be2bf537df58d1399c3>`_. Він відповідає за створення вкладеного меню плаґіна в основному меню . Список цих методів:
- 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()
Don’t forget to set QAction and QMenu objectName to a name
specific to your plugin so that it can be customized.
Файл ресурсів
Як ви бачили, в коді метода initGui() ми використовували іконку з файлу ресурсів (в нашому випадку resources.qrc)
<RCC>
<qresource prefix="/plugins/testplug" >
<file>icon.png</file>
</qresource>
</RCC>
It is good to use a prefix that will not collide with other plugins or any
parts of QGIS, otherwise you might get resources you did not want. Now you
just need to generate a Python file that will contain the resources. It’s
done with pyrcc4 command
pyrcc4 -o resources.py resources.qrc
Ось і все... нічого особливого :-).
Якщо ви все зробили правильно, то можете побачити свій плаґін у Менеджері плаґінів, активувати його та спостерігати повідомлення у консолі після натискання на кнопку або після вибору відповідного пункту меню.
Під час розробки реальних плаґінів краще працювати в окремому (робочому) каталозі та створити makefile, який буде генерувати інтерфейс та ресурси і копіювати плаґін до каталогу плаґінів QGIS.
Документація
Документацію до плаґінів можна писати в форматі HTML. У модулі qgis.utils є функція showPluginHelp(), яка відкриває вікно перегляду довідки, аналогічне до того, що використовується в QGIS.
The showPluginHelp`() function looks for help files in the same
directory as the calling module. It will look for, in turn,
index-ll_cc.html, index-ll.html, index-en.html,
index-en_us.html and index.html, displaying whichever it finds
first. Here ll_cc is the QGIS locale. This allows multiple translations of
the documentation to be included with the plugin.
Також showPluginHelp() може приймати додаткові параметри: packageName — задає назву плаґіна, документацію якого необхідно показати, filename — ім’я файлу, який слід шукати замість index та section — назву якоря HTML, на який необхідно перейти після відкриття документу.