はじめに¶

PYQGIS_STARTUP環境変数¶

You can run Python code just before QGIS initialization completes by setting the PYQGIS_STARTUP environment variable to the path of an existing Python file.

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.

startup.py ファイル¶

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.

スタンドアロンスクリプトでPyQGISを使用する¶

スタンドアロンスクリプトを起動するには、次のコードのようなスクリプトの先頭でQGISのリソースを初期化します。

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

qgis.core モジュールをインポートし、それからプレフィックスパスを設定することから始めます。プレフィックスパスとはQGISがシステムにインストールされている場所です。これはこのスクリプト中で setPrefixPath メソッドを呼び出すことで設定されます。 setPrefixPath の第2引数は true に設定されています。これはデフォルトのパスが使用されているかどうかを制御します。

QGISのインストールパスは、プラットフォームによって異なります。お使いのシステムに対するパスを見つける最も簡単な方法は、QGIS内から Python Console を使用し、実行している QgsApplication.prefixPath() からの出力を見ることです。

プレフィックスパスを設定した後は QgsApplication 変数に qgs への参照を保存します。今書いているのはスタンドアロンスクリプトですので、GUIを使用する予定がないことを示すために第二引数に False を設定します。 QgsApplication が設定されると、 qgs.initQgis() メソッドを呼び出すことでQGISデータプロバイダーとレイヤーのレジストリを読み込みます。QGISが初期化されると、残りのスクリプトを記述する準備が整いました。最後に、 qgs.exitQgis() を呼び出して、メモリからデータプロバイダーとレイヤーのレジストリを削除しておしまいです。

カスタムアプリケーションでPyQGISを使用する¶

スタンドアロンスクリプトでPyQGISを使用する とカスタムPyQGISアプリケーションの唯一の違いは QgsApplication をインスタンス化する際の二番目の引数です。 True を False の代わりに渡し、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()

Now you can work with QGIS API — load layers and do some processing or fire up a GUI with a map canvas. The possibilities are endless :-)

カスタムアプリケーションを実行する¶

QGISのライブラリとPythonモジュールが一般的な場所に置かれて無ければ、システムに適切な場所を伝える必要があるでしょう — そうしないとPythonはエラーを吐きます:

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

This can be fixed by setting the PYTHONPATH environment variable. In the following commands, qgispath should be replaced with your actual QGIS installation path:

• on Linux: export PYTHONPATH=/qgispath/share/qgis/python
• on Windows: set PYTHONPATH=c:\qgispath\python

The path to the PyQGIS modules is now known, however they depend on qgis_core and qgis_gui libraries (the Python modules serve only as wrappers). Path to these libraries is typically unknown for the operating system, so you get an import error again (the message might vary depending on the system):

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

QGISライブラリが存在するディレクトリを動的リンカのパスに追加することでこれを修正します:

• on Linux: export LD_LIBRARY_PATH=/qgispath/lib
• on Windows: set PATH=C:\qgispath;%PATH%

これらのコマンドはブートストラップスクリプトに入れておくことができます。PyQGISを使ったカスタムアプリケーションを配布するには、これらの二つの方法が可能でしょう:

• require user to install QGIS on his platform prior to installing your application. The application installer should look for default locations of QGIS libraries and allow user to set the path if not found. This approach has the advantage of being simpler, however it requires user to do more steps.

• アプリケーションと一緒にQGISのパッケージを配布する方法です。アプリケーションのリリースにはいろいろやることがあるし、パッケージも大きくなりますが、ユーザーを追加ソフトウェアをダウンロードをしてインストールする負荷から避けられるでしょう。

これらのモデルは組み合わせることができます - Windows と Mac OSではスタンドアローンアプリケーションとして配布をして、LinuxではQGISのインストールをユーザーとユーザーが使っているパッケージマネージャに任せるとか。