Este posibil să se creeze plugin-uri în limbajul de programare Python. În comparație cu plugin-urile clasice scrise în C++ acestea ar trebui să fie mai ușor de scris, de înțeles, de menținut și de distribuit, din cauza naturii dinamice a limbajului Python.
Plugin-urile Python sunt listate, împreună cu plugin-urile C++, în managerul de plugin-uri QGIS. Ele sunt căutate în aceste căi:
Scrierea unui plugin
De la introducerea plugin-urilor Python în QGIS, a apărut un număr de plugin-uri - pe pagina wiki a Depozitelor de Plugin-uri puteți găsi unele dintre ele, le puteți utiliza sursa pentru a afla mai multe despre programarea în PyQGIS sau să aflați dacă nu cumva duplicați efortul de dezvoltare. Echipa QGIS menține, de asemenea, un Depozitul oficial al plugin-urilor python. Sunteți gata de a crea un plugin, dar nu aveți nici o idee despre cum ați putea începe? În pagina wiki cu idei de plugin-uri Python sunt listate dorințele comunității!
Fișierele Plugin-ului
Iată structura de directoare a exemplului nostru de plugin
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*
Care este semnificația fișierelor:
__init__.py = Punctul de plecare al plugin-ului. Acesta trebuie să aibă metoda classFactory() și poate avea orice alt cod de inițializare.
mainPlugin.py = Principalul codul lucrativ al plugin-ului. Conține toate informațiile cu privire la acțiunile plugin-ului și ale codului principal.
resources.qrc = Documentul .xml creat de Qt Designer. Conține căi relative la resursele formelor.
resources.py = Traducerea fișierului .qrc descris mai sus.
form.ui = GUI-ul creat de Qt Designer.
form.py = Traducerea form.ui descris mai sus.
- 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.
Aici este o modalitate on-line, automată, de creare a fișierelor de bază (carcase) pentru un plugin tipic QGIS Python.
De asemenea, există un plugin QGIS numit Plugin Builder care creează un șablon de plugin QGIS și nu are nevoie de conexiune la internet. Aceasta este opțiunea recomandată, atât timp cât produce surse compatibile 2.0.
Conținutul Plugin-ului
Aici puteți găsi informații și exemple despre ceea ce să adăugați în fiecare dintre fișierele din structura de fișiere descrisă mai sus.
__init__.py
Acest fișier este necesar pentru sistemul de import al Python. De asemenea, QGIS necesită ca acest fișier să conțină o funcție classFactory(), care este apelată atunci când plugin-ul se încarcă în QGIS. Acesta primește referirea la o instanță a QgisInterface și trebuie să returneze instanța clasei plugin-ului din mainplugin.py — în cazul nostru numindu-se TestPlugin (a se vedea mai jos). Acesta este modul în care __init__.py ar trebui să arate
def classFactory(iface):
from mainPlugin import TestPlugin
return TestPlugin(iface)
## any other initialisation needed
mainPlugin.py
Aici este locul în care se întâmplă magia, și iată rezultatul acesteia: (de exemplu 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!"
Singurele funcții care trebuie să existe în fișierul sursă al plugin-ului principal (de exemplu mainPlugin.py) sunt:
__init__ –> care oferă acces la interfața QGIS
initGui() –> apelat atunci când plugin-ul este încărcat
unload() –> apelat atunci când plugin-ul este descărcat
Puteți vedea că în exemplul de mai sus se folosește addPluginToMenu(). Aceasta va adăuga acțiunea meniului corespunzător la meniul . Există metode alternative pentru a adăuga acțiunea la un alt meniu. Iată o listă a acestor metode:
- addPluginToRasterMenu()
- addPluginToVectorMenu()
- addPluginToDatabaseMenu()
- addPluginToWebMenu()
Toate acestea au aceeași sintaxă ca metoda addPluginToMenu().
Adăugarea unui meniu la plugin-ul dvs. printr-una din metoldele predefinite este recomandată pentru a păstra coerența în stilul de organizare a plugin-urilor. Cu toate acestea, puteți adăuga grupul dvs. de meniuri personalizate direct în bara de meniu, așa cum demonstrează următorul exemplu :
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()
Nu uitați să stabiliți pentru QAction și QMenu objectName un nume specific plugin-ului dvs, astfel încât acesta să poată fi personalizat.
Fișier de resurse
Puteți vedea că în initGui() am folosit o pictogramă din fișierul de resurse (denumit resources.qrc, în cazul nostru)
<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
Și asta e tot ... nimic complicat :)
Dacă ați făcut totul corect, ar trebui să găsiți și să încărcați plugin-ul în managerul de plugin-uri și să vedeți un mesaj în consolă, atunci când este selectat meniul adecvat sau pictograma din bara de instrumente.
Când lucrați la un plug-in real, este înțelept să stocați plugin-ul într-un alt director (de lucru), și să creați un fișier make care va genera UI + fișierele de resurse și să instalați plugin-ul în instalarea QGIS.
Documentație
Documentația pentru plugin poate fi scrisă ca fișiere HTML. Modulul qgis.utils oferă o funcție, showPluginHelp(), care se va deschide navigatorul de fișiere, în același mod ca și altă fereastră de ajutor 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.
Funcția showPluginHelp() poate lua, de asemenea, parametrii packageName, care identifică plugin-ul specific pentru care va fi afișat ajutorul, numele de fișier, care poate înlocui ‘index’ în numele fișierelor în care se caută, și secțiunea, care este numele unei ancore HTML în documentul în care se va poziționa browser-ul.