2. Carregando projetos

Dica

Os trechos de código desta página precisam das seguintes importações se você estiver fora do console do pyqgis:

from qgis.core import (
    Qgis,
    QgsProject,
    QgsPathResolver
)

from qgis.gui import (
    QgsLayerTreeMapCanvasBridge,
)

Às vezes, você precisa carregar um projeto existente a partir de um complemento ou (com mais frequência) ao desenvolver um aplicativo QGIS Python independente (veja: Aplicações Python).

Para carregar um projeto no aplicativo QGIS atual, você precisa criar uma instância da classe QgsProject. Esta é uma classe singleton, portanto você deve usar o método instance() para fazer isso. Você pode chamar o método read(), passando o caminho do projeto a ser carregado:

# 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

Se você precisar fazer modificações no projeto (por exemplo, adicionar ou remover algumas camadas) e salvar suas alterações, chame o método write() da sua instância do projeto. O método write() também aceita um caminho opcional para salvar o projeto em um novo local:

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

Ambas as funções read() e write() retornam um valor booleano que você pode usar para verificar se a operação foi bem sucedida.

Nota

Se você estiver escrevendo um aplicativo independente do QGIS, para sincronizar o projeto carregado com a tela, é necessário instanciar uma :class:QgsLayerTreeMapCanvasBridge <qgis.gui.QgsLayerTreeMapCanvasBridge> `como no exemplo abaixo:

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. Resolvendo caminhos errados

It can happen that layers loaded in the project are moved to another location. When the project is loaded again all the layer paths are broken. The QgsPathResolver class helps you rewrite layers path within the project.

Its setPathPreprocessor() method allows setting a custom path pre-processor function to manipulate paths and data sources prior to resolving them to file references or layer sources.

The processor function must accept a single string argument (representing the original file path or data source) and return a processed version of this path. The path pre-processor function is called before any bad layer handler. If multiple preprocessors are set, they will be called in sequence based on the order in which they were originally set.

Alguns casos de uso:

1. replace an outdated path:

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

2. replace a database host address with a new one:

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

3. replace stored database credentials with new ones:

   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)
   

Likewise, a setPathWriter() method is available for a path writer function.

Um exemplo para substituir o caminho por uma variável:

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

QgsPathResolver.setPathWriter(my_processor)

Both methods return an id that can be used to remove the pre-processor or writer they added. See removePathPreprocessor() and removePathWriter().

2.2. Uso de referências para acelerar as coisas

In some instances where you may not need to use a fully functional project, but only want to access it for a specific reason, flags may be helpful. A full list of flags is available under ProjectReadFlag. Multiple flags can be added together.

As an example, if we do not care about actual layers and data and simply want to access a project (e.g. for layout or 3D view settings), we can use DontResolveLayers flag to bypass the data validation step and prevent the bad layer dialog from appearing. The following can be done:

readflags = Qgis.ProjectReadFlags()
readflags |= Qgis.ProjectReadFlag.DontResolveLayers
project = QgsProject()
project.read('C:/Users/ClintBarton/Documents/Projects/mysweetproject.qgs', readflags)

Para acrescentar mais bandeiras, deve-se utilizar o operador Bitwise python OR (|).