pyqgisコンソールの外部にいる場合、このページのコードスニペットでは以下のインポートが必要になります：

from qgis.core import (
    QgsProject,
    QgsPathResolver
)

from qgis.gui import (
    QgsLayerTreeMapCanvasBridge,
)

2. プロジェクトをロードする¶

時々プラグインから、または（しばしば）スタンドアローンのQGIS Pythonアプリケーションを開発する時に既存のプロジェクトをロードする必要があります（参照： Python アプリケーション）。

プロジェクトを現在のQGISアプリケーションにロードするには、 QgsProject クラスのインスタンスを作成する必要があります。これはシングルトンクラスなので、それを行うには instance() メソッドを使わなければなりません。 read() メソッドを呼び出して、読み込むプロジェクトのパスを渡すことができます。

# If you are not inside a QGIS console you first need to import
# qgis and PyQt classes you will use in this script as shown below:
from qgis.core import QgsProject
# Get the project instance
project = QgsProject.instance()
# Print the current project file name (might be empty in case no projects have been loaded)
# print(project.fileName())

# Load another project
project.read('testdata/01_project.qgs')
print(project.fileName())

testdata/01_project.qgs

プロジェクトに変更（たとえばレイヤーの追加や削除）を加え、その変更を保存する必要がある場合は、プロジェクトインスタンスの write() メソッドを呼び出します。 write() メソッドにパスを指定すれば、プロジェクトを新しい場所に保存することもできます。

# Save the project to the same
project.write()
# ... or to a new file
project.write('testdata/my_new_qgis_project.qgs')

read() と write() の両方の関数は操作が成功したかどうかをチェックするために使用できるブール値を返します。

注釈

QGISスタンドアロンアプリケーションを作成している場合は、ロードされたプロジェクトをキャンバスと同期させるために、 QgsLayerTreeMapCanvasBridge を以下の例のようにインスタンス化する必要があります:

bridge = QgsLayerTreeMapCanvasBridge( \
         QgsProject.instance().layerTreeRoot(), canvas)
# Now you can safely load your project and see it in the canvas
project.read('testdata/my_new_qgis_project.qgs')

2.1. 正しくないパスを解決する¶

プロジェクトにロードされたレイヤーが別の場所に移動される場合があります。プロジェクトが再度ロードされると、すべてのレイヤーパスが壊れます。

QgsPathResolver クラスと setPathPreprocessor() を使用するとカスタムのパス前処理関数を設定できます。これにより、ファイル参照またはレイヤーソースに解決する前にパスとデータソースの操作ができます。

処理関数は、文字列引数（元のファイルパスまたはデータソースを表す）を1つ受け取り、このパスの処理済バージョンを返す必要があります。

パス前処理関数は、不良レイヤーハンドラの前に呼び出されます。

使用例：

旧パスを置き換え：

def my_processor(path):
    return path.replace('c:/Users/ClintBarton/Documents/Projects', 'x:/Projects/')

QgsPathResolver.setPathPreprocessor(my_processor)

データベースのホストアドレスを新しいもので置き換え：

def my_processor(path):
    return path.replace('host=10.1.1.115', 'host=10.1.1.116')

QgsPathResolver.setPathPreprocessor(my_processor)

保存されているデータベースのクレデンシャルを新しいものに置き換え：

def my_processor(path):
    path= path.replace("user='gis_team'", "user='team_awesome'")
    path = path.replace("password='cats'", "password='g7as!m*'")
    return path

QgsPathResolver.setPathPreprocessor(my_processor)