Aufbau einer QGIS3 Python-Plug-In-Entwicklungsumgebung mit VSCode (macOS)

Dies ist ein Memo beim Erstellen einer Umgebung zum Entwickeln und Remote-Debuggen von QGIS-Plug-Ins in VSCode. Die Umgebung ist wie folgt.

• macOS Catalina 10.15.5
• Visual Studio Code 1.45.1
• Python-Erweiterung ist bereits installiert
• Verwenden Sie Homebrew nach Bedarf

Es ist nicht sehr hell für QGIS oder Python, also ist das eine gute Sache.

Installieren Sie QGIS

Installieren Sie mit dem Installationsprogramm, das von Official Site oder Homebrew Cask heruntergeladen wurde.

$ brew cask install qgis

Ich habe die neueste Version (Version 3.12.3) installiert.

Versuchen Sie plötzlich, ein QGIS-Plug-In zu erstellen

Plugin-Entwicklung von GIS Practice Open Teaching Material Verwenden Sie Plugin Builder 3, um ein Test-Plug-In zu erstellen, indem Sie auf die Seite materialien / python / 10 / 10.html) verweisen.

Der Speicherort für das Exportieren des Plug-Ins ist das Plug-In-Verzeichnis des Standardprofils (* / Benutzer / Benutzername / Bibliothek / Anwendungsunterstützung / QGIS / QGIS3 / Profile / Standard / Python / Plugins *).

In der Phase der Plug-Generierung wird ein Fehler angezeigt, der besagt, dass kein Ressourcen-Compiler vorhanden ist, der jedoch vorerst ausgeschrieben wird.

Installieren Sie PyQt

Nachdem Sie pyrcc5 benötigen, installieren Sie PyQt mit Homebrew.

$ brew install pyqt

Die Abhängigkeit erfordert "python @ 3.8", aber wenn die Ressourcen des zuvor erstellten Plug-Ins kompiliert werden können, ist dies vorerst in Ordnung.

$ cd /Users/xxx/Library/Application\ Support/QGIS/QGIS3/profiles/default/python/plugins/plugin_test
$ pyrcc5 -o resources.py resources.qrc

Aktivieren Sie das erstellte Plug-In über das Menü "Plug-In" -> "Plug-In-Verwaltung und Installation ..." und prüfen Sie, bis es ausgeführt werden kann.

Installieren Sie den Python Tools für Visual Studio-Debugserver

Ich möchte ptvsd installieren, ein Python-Debugger-Paket für VS / VSCode, aber ich habe nicht die Pip für Python, die mit QGIS geliefert wird ...

Gehen Sie also zuerst zu PyPIs ptvsd-Paketseite und laden Sie * ptvsd-4.3.2.zip * von den Download-Dateien herunter.

Extrahieren Sie das Archiv und kopieren Sie den Ordner * ptvsd * in * ptvsd-4.3.2 / src * unter * / Applications / QGIS3.12.app / Contents / Resources / python *.

$ cd ~/Downloads
$ unzip ptvsd-4.3.2.zip
$ cd ptvsd-4.3.2/src
$ cp -r ptvsd /Applications/QGIS3.12.app/Contents/Resources/python

Starten Sie QGIS neu und installieren Sie das Debugvs-Plug-In. Wählen Sie nach der Installation im Plug-In-Menü oder auf der Schaltfläche in der Symbolleiste die Option [Debug Visual Studio aktivieren] aus.

OK, wenn die Meldung "Remote-Debug für Visual Studio wird ausgeführt" angezeigt wird.

Remote-Debugging von VSCode

Starten Sie VSCode mit dem zuvor erstellten Plugin-Verzeichnis als Arbeitsbereich.

$ cd /Users/xxx/Library/Application\ Support/QGIS/QGIS3/profiles/default/python/plugins/plugin_test
$ code .

Angeben des Python-Interpreters

Python ausführen: Wählen Sie Interpreter aus der Befehlspalette

Wählen Sie "Interpreterpfad eingeben ..." und geben Sie * / Applications / QGIS3.12.app / Contents / MacOS / bin / python3 * direkt an

Die Einstellungen werden in * .vscode / settings.json * geschrieben.

settings.json

{
  "python.pythonPath": "/Applications/QGIS3.12.app/Contents/MacOS/bin/python3"
}

Debug-Konfiguration hinzufügen

Wählen Sie das Menü Ausführen> Konfiguration hinzufügen ..., um die Konfiguration für das Remote-Debugging hinzuzufügen.

Umgebungsauswahl: Python Debug Configuration: Remote Attach Enter the host name: localhost Geben Sie die Portnummer ein, die ... (weggelassen): 5678

Die Konfiguration wird zu * .vscode / launch.json * hinzugefügt. Wenn es so bleibt, wie es ist, funktioniert es nicht gut. Ändern Sie daher den Wert von "remoteRoot" von "pathMappings" in "$ {workspaceFolder}".

launch.json

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python:anfügen",
      "type": "python",
      "request": "attach",
      "port": 5678,
      "host": "localhost",
      "pathMappings": [
        {
          "localRoot": "${workspaceFolder}",
          "remoteRoot": "${workspaceFolder}"
        }
      ]
    }
  ]
}

Wenn Sie nun den Debug-Lauf starten, indem Sie "Ausführen" -> "Debug starten" auswählen, wird er an den QGIS Python-Debug-Server angehängt. Sie können überprüfen, ob das Debuggen möglich ist, indem Sie einen Haltepunkt im Code festlegen und das Plug-In ausführen.

Ich habe das Gefühl, dass es möglich sein wird, sich in einer vertrauten Umgebung zu entwickeln.