Construction de l'environnement de développement de plug-in QGIS3 Python avec VSCode (macOS)

Ceci est un mémo lors de la création d'un environnement pour le développement et le débogage à distance des plug-ins QGIS sur VSCode. L'environnement est le suivant.

macOS Catalina 10.15.5
Visual Studio Code 1.45.1
Extension Python est déjà installé --Utilisez Homebrew le cas échéant

Ce n'est pas très brillant pour QGIS ou Python, c'est donc une bonne chose.

Installez QGIS

Installez avec le programme d'installation téléchargé depuis Site officiel ou Homebrew Cask.

$ brew cask install qgis

J'ai installé la dernière version (version 3.12.3).

Essayez soudainement de créer un plug-in QGIS

Développement de plugins de Matériel pédagogique ouvert de formation SIG Utilisez Plugin Builder 3 pour créer un plug-in de test en vous référant à la page matériaux / python / 10 / 10.html).

L'emplacement d'exportation du plug-in est le répertoire du plug-in du profil par défaut (* / Users / nom d'utilisateur / Library / Application Support / QGIS / QGIS3 / profiles / default / python / plugins *).

Au stade de la génération du plug-in, une erreur indiquant qu'il n'y a pas de compilateur de ressources s'affiche, mais elle est écrite pour le moment. pyrcc5 error

Installez PyQt

Maintenant que vous avez besoin de pyrcc5, installez PyQt avec Homebrew.

$ brew install pyqt

La dépendance nécessite python @ 3.8, mais si les ressources du plug-in que vous avez créé précédemment peuvent être compilées, c'est OK pour le moment.

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

Activez le plug-in créé depuis le menu "Plug-in" -> "Plug-in management and installation ..." et vérifiez qu'il peut être exécuté. テストプラグインの起動

Installer le serveur de débogage Python Tools pour Visual Studio

Je veux installer ptvsd, un package de débogage Python pour VS / VSCode, mais je n'ai pas le pip pour Python fourni avec QGIS ...

Allez d'abord sur la page du paquet ptvsd de PyPI et téléchargez * ptvsd-4.3.2.zip * à partir des fichiers de téléchargement.

Extrayez l'archive et copiez le dossier * ptvsd * dans * ptvsd-4.3.2 / src * sous * / 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

Redémarrez QGIS et installez le plug-in debugvs. Après l'installation, sélectionnez [Activer le débogage de Visual Studio] dans le menu du plug-in ou le bouton de la barre d'outils. debugvs

OK si le message «Remote Debug for Visual Studio is running» s'affiche.

Débogage à distance depuis VSCode

Démarrez VSCode en utilisant le répertoire du plugin que vous avez créé précédemment en tant qu'espace de travail.

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

Spécification de l'interpréteur Python

Exécutez Python: sélectionnez Interpréteur dans la palette de commandes Select Interpreter

Sélectionnez "Entrer le chemin de l'interpréteur ..." et spécifiez * / Applications / QGIS3.12.app / Contents / MacOS / bin / python3 * directement Enter path

Les paramètres sont écrits dans * .vscode / settings.json *.

`settings.json`


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

Ajouter une configuration de débogage

Sélectionnez le menu Exécuter> Ajouter une configuration ... pour ajouter la configuration pour le débogage à distance.

Sélection d'environnement: Python Debug Configuration: Remote Attach Enter the host name: localhost Entrez le numéro de port qui ... (Omis): 5678

La configuration est ajoutée à * .vscode / launch.json *. S'il est laissé tel quel, il ne fonctionnera pas bien, alors modifiez la valeur de remoteRoot de pathMappings en" $ {workspaceFolder} ".

`launch.json`


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

Maintenant, lorsque vous lancez le débogage en sélectionnant "Exécuter" -> "Démarrer le débogage", il sera attaché au serveur de débogage QGIS Python. Vous pouvez vérifier que le débogage est possible en définissant un point d'arrêt dans le code et en exécutant le plug-in. Break Point

J'ai le sentiment qu'il sera possible de se développer dans un environnement familier.