Introductie¶

Omgevingsvariabele PYQGIS_STARTUP¶

U kunt Python-code uitvoeren kort voor de initialisatie van QGIS wordt voltooid door de omgevingsvariabele PYQGIS_STARTUP in te stellen op het pad van een bestaand bestand van Python.

Deze methode is iets wat u vermoedelijk zelden nodig heeft, maar is het waard vermeld te worden omdat het één van de manieren is om Python-code uit te voeren binnen QGIS en omdat deze code zal worden uitgevoerd vóórdat de initialisatie van QGIS is voltooid. Deze methode is zeer handig voor het opschonen van sys.path, wat ongewenste paden zou kunnen bevatten, of voor het isoleren/laden van de initiële omgeving zonder een virtuele omgeving te vereisen, bijv. homebrew of installaties van MacPorts op Mac.

Het bestand startup.py¶

Elke keer als QGIS start, wordt in de eigen map van de gebruiker voor Python (gewoonlijk: .qgis2/python) naar een bestand genaamd startup.py gezocht. Als dat bestand bestaat wordt het uitgevoerd door de ingebedde interpreter voor Python.

PyQGIS gebruiken in zelfstandige scripts¶

Initialiseer, om een zelfstandig script te starten, de bronnen voor QGIS aan het begin van het script, soortgelijk aan de volgende code:

from qgis.core import *

# supply path to qgis install location
QgsApplication.setPrefixPath("/path/to/qgis/installation", True)

# create a reference to the QgsApplication, setting the
# second argument to False disables the GUI
qgs = QgsApplication([], False)

# load providers
qgs.initQgis()

# Write your code here to load some layers, use processing algorithms, etc.

# When your script is complete, call exitQgis() to remove the provider and
# layer registries from memory
qgs.exitQgis()

We beginnen door de module qgis.core te importeren en dan het pad voor het voorvoegsel te configureren. Het pad voor het voorvoegsel is de locatie waar QGIS is geïnstalleerd op uw systeem. Het wordt in het script geconfigureerd door de methode setPrefixPath aan te roepen. Het tweede argument van setPrefixPath is om de True in te stellen, die beheert of de standaard paden worden gebruikt.

Het pad voor de installatie van QGIS varieert per platform; de eenvoudigste manier om het voor uw systeem te vinden is door de Python-console te gebruiken vanuit QGIS en te kijken naar de uitvoer bij het uitvoeren van QgsApplication.prefixPath().

Nadat het pad voor het voorvoegsel is geconfigureerd slaan we een verwijzing naar QgsApplication op in de variabele qgs. Het tweede argument wordt ingesteld op False, wat aangeeft dat we niet van plan zijn om de GUI te gebruiken omdat we een zelfstandig script schrijven. Met QgsApplication geconfigureerd laden we de gegevensproviders en registratie van lagen voor QGIS door de methode qgs.initQgis() aan te roepen. Met QGIS geïnitialiseerd zijn we klaar om de rest van het script te schrijven. Tenslotte sluiten we af door qgs.exitQgis() aan te roepen om de gegevensproviders en registratie van lagen uit het geheugen te verwijderen.

PyQGIS gebruiken in aangepaste toepassing¶

Het enige verschil tussen PyQGIS gebruiken in zelfstandige scripts en een aangepaste toepassing van PyQGIS is het tweede argument bij het instantiëren van QgsApplication. Geef op True in plaats van False om aan te geven dat we van plan zijn om een GUI te gaan gebruiken.

from qgis.core import *

# supply path to qgis install location
QgsApplication.setPrefixPath("/path/to/qgis/installation", True)

# create a reference to the QgsApplication
# setting the second argument to True enables the GUI, which we need to do
# since this is a custom application
qgs = QgsApplication([], True)

# load providers
qgs.initQgis()

# Write your code here to load some layers, use processing algorithms, etc.

# When your script is complete, call exitQgis() to remove the provider and
# layer registries from memory
qgs.exitQgis()

Nu kunt u werken met de API van QGIS — lagen laden en enige verwerking doen of een GUI met een kaartvenster opstarten. De mogelijkheden zijn eindeloos :-)

Aangepaste toepassingen uitvoeren¶

U zult uw systeem moeten vertellen waar te zoeken naar de bibliotheken van QGIS en de toepasselijke modules voor Python als zij nog niet op ene bekende locatie staan — anders zal Python gana klagen:

>>> import qgis.core
ImportError: No module named qgis.core

Dit kan worden opgelost door de omgevingsvariabele PYTHONPATH in te stellen. In de volgende opdrachten zou qgispath moeten worden vervangen door uw actuele pad voor de installatie van QGIS:

• op Linux: export PYTHONPATH=/qgispath/share/qgis/python

• op Windows: set PYTHONPATH=c:\qgispath\python

Het pad naar de modules van PyQGIS is nu bekend, zij zijn echter afhankelijk van de bibliotheken qgis_core en qgis_gui (de modules van Python dienen slechts als verpakkingen). Het pad naar deze bibliotheken is meestal onbekend voor het besturingssysteem, dus krijgt u opnieuw een fout bij het importeren (het bericht kan variëren, afhankelijk van het systeem):

>>> import qgis.core
ImportError: libqgis_core.so.1.5.0: cannot open shared object file: No such file or directory

Los dit op door de mappen waar de bibliotheken van QGIS zijn opgeslagen toe te voegen aan het zoekpad van de dynamische linker:

• op Linux: export LD_LIBRARY_PATH=/qgispath/lib

• op Windows: set PATH=C:\qgispath;%PATH%

Deze opdrachten kunnen worden geplaatst in een bootstrap-script dat het opstarten voor zijn rekening zal nemen. Bij het uitrollen van toepaste toepassingen met behulp van PyQGIS, zijn er gewoonlijk twee mogelijkheden:

• eis dat de gebruiker QGIS op zijn platform installeert, voorafgaand aan het installeren van uw toepassing. Het installatieprogramma van de zou moeten zoeken naar standaardlocaties voor de bibliotheken van QGIS en de gebruiker moeten toestaan het pad in te vullen als dat niet werd gevonden. Deze benadering heeft het voordeel dat het eenvoudiger is, het vereist echter dat de gebruiker meer stappen uitvoert.

• verpak QGIS tezamen met uw toepassing. Uitgeven van de toepassing ka uitdagender zijn en het pakket zal groter zijn, maar de gebruiker zal verlost zijn van de last van het downloaden en installeren van aanvullende stukken software.

De twee modellen van uitrollen kunnen worden gemixt - rol een zelfstandige toepassing uit op Windows en Mac OS X, laat voor Linux de installatie van QGIS over aan de gebruiker en diens pakketbeheer.