Debuggen von Plug-Ins mit Visual Studio Code

Als Workflowstandard für viele Entwickler ist die Visual Studio Code-IDE zum Debuggen von Python-Plug-Ins verfügbar.

WARNING
Mit der debugpy.listen()-Methode kann jeder, der sich mit dem angegebenen Port verbinden kann, beliebigen Code innerhalb des gedebuggten Prozesses ausführen.
Das Debuggen sollte daher nur eingerichtet und auf sicheren Netzwerken ausgeführt werden.

Führen Sie die folgenden Schritte aus, um die Synergie zwischen Visual Studio Code und Substance 3D Designer einzurichten:

  1. Installieren Sie Visual Studio Code und die Python-Erweiterung.

  2. Installieren Sie das Python-Debugmodul.

    note
    NOTE
    Stellen Sie sicher, dass der Python-Interpreter in Designer das Modul "debugpy" finden kann. Am einfachsten ist es, der Umgebungsvariablen PYTHONPATH das Verzeichnis hinzuzufügen, in dem sich das Modul "debug" befindet. Eine Alternative könnte darin bestehen, sys.path im Skript zu ändern, um den Pfad zum debugpy-Modul hinzuzufügen.
  3. Starten Sie die Anwendung, öffnen Sie den Python-Editor, und führen Sie den folgenden Code aus:

    code language-none
    import sys
    
    
    
    debugpy_path = '/path/to/debugpy/module'
    
    debugpy_port = 5678
    
    designer_py_interpreter = '/path/to/python/executable/bundled/in/designer'
    
    
    
    if not debugpy_path in sys.path:
    
        sys.path.append(debugpy_path)
    
    
    
    import debugpy
    
    
    
    debugpy.configure(python=designer_py_interpreter)
    
    debugpy.listen(debugpy_port)
    
  4. Öffnen Sie das Projekt in Visual Studio Code, und erstellen Sie eine launch.json-Datei. Fügen Sie Folgendes zur Datei hinzu:

    code language-none
    {
    
        "name": "Attach to Designer",
    
        "type": "python",
    
        "request": "attach",
    
        "port": <port number used in the script above>,
    
        "host": "127.0.0.1"
    
    }
    
  5. Klicken Sie auf das Symbol Debuggen, erstellen oder bearbeiten Sie die Debuggerkonfiguration, falls erforderlich.

  6. Wählen Sie die Python: Hängen Sie das Paket an die Designer-Konfiguration an, und klicken Sie auf Debuggen starten.

    Sie sollten jetzt in der Lage sein, Haltepunkte festzulegen, den Code schrittweise zu durchlaufen und alle anderen Features des Debuggers von Visual Studio Code zu verwenden.

recommendation-more-help
substance-3d-designer-help-guide