PyQGIS开发者手册-2 加载项目

2 加载项目

有时你需要从插件加载现有项目，或者在开发独立的QGIS Python应用程序时加载（请参阅：Python应用程序）。

将项目加载到当前QGIS应用程序中，需要创建QgsProject类的实例。这是一个单例类，因此你必须使用其instance()方法来执行此操作。你可以调用read()方法，传递加载的项目的路径：

# 如果您不在QGIS控制台内，首先需要导入qgis和PyQt类，如下所示：
from qgis.core import QgsProject
# 获取项目实例
project = QgsProject.instance()
# 打印当前项目的文件名（可能为空，因为没有项目加载）
print(project.fileName())
'/home/user/projects/my_qgis_project.qgs'
# 加载另一个项目
project.read('/home/user/projects/my_other_qgis_project.qgs')
print(project.fileName())
# '/home/user/projects/my_other_qgis_project.qgs'

如果需要对项目进行修改（例如添加或删除某些图层）并保存更改，请调用write()方法。该方法还支持将项目保存到新的位置：

# 将项目保存到同一个文件
project.write()
# ...或新文件
project.write('/home/user/projects/my_new_qgis_project.qgs')

read()和write() 函数都返回一个布尔值，你可以使用它来检查操作是否成功。

---

小贴士：如果你正在编写QGIS独立应用程序，为了将加载的项目与画布同步，您需要实例化QgsLayerTreeMapCanvasBridge，如下例所示：

---

bridge = QgsLayerTreeMapCanvasBridge(QgsProject.instance().layerTreeRoot(), canvas)
# 现在你可以安全地加载项目，并在画布上看到它
project.read('/home/user/projects/my_other_qgis_project.qgs')

---

写在最后：文中难免有翻译错误，欢迎您的指正。完整版翻译请移步PyQGIS开发者手册-完整版