Dezvoltarea plugin-urilor Python¶

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 = Necesar pentru QGIS >= 1.8.0. Conține informații generale, versiunea, numele și alte metadate utilizate de către site-ul de plugin-uri și de către infrastructura plugin-ului. Începând cu QGIS 2.0 metadatele din __init__.py nu mai sunt acceptate, iar metadata.txt este necesar.

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.

|Metadatele plugin-ului¶

În primul rând, managerul de plugin-uri are nevoie de preluarea câtorva informații de bază despre plugin, cum ar fi numele, descrierea etc. Fișierul metadata.txt este locul potrivit pentru a reține această informație.

În mod implicit, plugin-urile sunt plasate în meniul Plugin-uri (vom vedea în secțiunea următoare cum se poate adăuga o intrare de meniu pentru plugin-ul dvs.), dar ele pot fi, de asemenea, plasate și în meniurile Raster, Vector, Database și Web.

Există o “categorie” de intrare de metadate corespunzătoare pentru a preciza că, astfel, plugin-ul poate fi clasificat în consecință. Această intrare este folosită ca indiciu pentru utilizatori și le spune unde (în care meniu), poate fi găsit plugin-ul. Valorile permise pentru “categorie” sunt: ​​Vector, Raster, Baza de date sau Web. De exemplu, dacă plugin-ul va fi disponibil din meniul Raster, adăugați următoarele în metadata.txt

category=Raster

Un exemplu pentru acest metadata.txt

; the next section is mandatory

[general]
name=HelloWorld
email=me@example.com
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
; 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
tracker=http://bugs.itopen.it
repository=http://www.itopen.it/repo
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¶

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 Plugins. 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>

Este bine să folosiți un prefix pentru a evita coliziunile cu alte plugin-uri sau cu oricare alte părți ale QGIS, în caz contrar, s-ar putea obține rezultate nedorite. Trebuie doar să generați un fișier Python care va conține resursele. Acest lucru se face cu comanda pyrcc4

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.