Introduzione¶

Variabile di ambiente PYQGIS_STARTUP¶

Si può avviare codice Python subito prima dell’inizializzazione impostando la variabile d’ambiente PYQGIS_STARTUP al percorso di un file Python esistente.

This method is something you will probably rarely need, but worth mentioning here because it is one of the several ways to run Python code within QGIS and because this code will run before QGIS initialization is complete. This method is very useful for cleaning sys.path, which may have undesireable paths, or for isolating/loading the initial environ without requiring a virt env, e.g. homebrew or MacPorts installs on Mac.

The startup.py file¶

Every time QGIS starts, the user’s Python home directory (usually: .qgis2/python) is searched for a file named startup.py, if that file exists, it is executed by the embedded Python interpreter.

Using PyQGIS in standalone scripts¶

To start a standalone script, initialize the QGIS resources at the beginning of the script similar to the following 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 begin by importing the qgis.core module and then configuring the prefix path. The prefix path is the location where QGIS is installed on your system. It is configured in the script by calling the setPrefixPath method. The second argument of setPrefixPath is set to True, which controls whether the default paths are used.

The QGIS install path varies by platform; the easiest way to find it for your your system is to use the Console Python from within QGIS and look at the output from running QgsApplication.prefixPath().

After the prefix path is configured, we save a reference to QgsApplication in the variable qgs. The second argument is set to False, which indicates that we do not plan to use the GUI since we are writing a standalone script. With the QgsApplication configured, we load the QGIS data providers and layer registry by calling the qgs.initQgis() method. With QGIS initialized, we are ready to write the rest of the script. Finally, we wrap up by calling qgs.exitQgis() to remove the data providers and layer registry from memory.

Using PyQGIS in custom applications¶

The only difference between Using PyQGIS in standalone scripts and a custom PyQGIS application is the second argument when instantiating the QgsApplication. Pass True instead of False to indicate that we plan to use a GUI.

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

Adesso puoi lavorare con l’API di QGIS — carica i layer ed esegui un po’ di processamento oppure avvia la GUI con una mappa. Le possibilità sono infinite :-)

Avviare applicazioni personalizzate¶

Avrai bisogno di dire al tuo sistema dove cercare per le librerie di QGIS e i moduli Python appropriati nel caso in cui non si trovino in una posizione conosciuta — altrimenti Python lo chiederà:

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

Ciò può essere fissato impostando la variabile di ambiente PYTHONPATH. Nei comandi seguenti, qgispath dovrebbe essere sostituito con il tuo attuale percorso di installazione di QGIS.

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

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

Il percorso per i moduli PyQGIS è adesso noto, comunque essi dipendono dalle librerie qgis_core e qgis_gui libraries (i moduli Python servono solo come contenitori). Il percorso per tali librerie è tipicamente sconosciuto al sistema operativo, così ottieni di nuovo un errore di importazione (il messaggio potrebbe variare in funzione del sistema):

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

Correggi ciò aggiungendo le cartelle in cui si trovano le librerie di QGIS per cercare il percorso del collegamento dinamico:

• su Linux: export LD_LIBRARY_PATH=/qgispath/lib

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

Questi comandi possono essere inseriti in uno script che se ne occuperà all’avvio del programma. Quando si fa uso di applicazioni personalizzate utilizzando PyQGIS, esistono di solito due possibilità:

• richiedi all’utente di installare QGIS sulla sua piattaforma prima di installare la tua applicazione. L’installatore dell’applicazione dovrebbe guardare le posizioni predefinite delle librerie di QGIS e consentire all’utente di impostarne il percorso se non trovato. Questo approccio ha il vantaggio di essere più semplice, ma richiede all’utente di eseguier più passaggi.

• impacchetta QGIS insieme alla tua applicazione. Rilasciare l’applicazione può essere più impegnativo e il pacchetto sarà più grande, ma l’utente sarà risparmiato dall’onere di scaricare e installare parti addizionali del programma.

The two deployment models can be mixed - deploy standalone application on Windows and Mac OS X, for Linux leave the installation of QGIS up to user and his package manager.