Festlegen von Python-Quellordnern in Visual Studio Code

Visual Studio Code ist mein bevorzugter Editor. Leider, es funktioniert nicht mit zusätzlichen Python-Quellordnern, ohne dass Sie es merken. Dieser Blog zeigt wie Sie einen Python-Quellordner hinzufügen und die gewohnte Entwicklererfahrung zurückgewinnen.

Obwohl es üblich ist, Top-Level-Module zu verwenden, können Sie mit Python Ihr Projekt organisieren wie Sie wollen. Das src-basierte Modul-Layout verwendet einen src-Ordner, um die Module der obersten Ebene zu speichern.

Um Python so zu konfigurieren, dass es nach Modulen im src-Ordner sucht, ändern wir die Standard-Suchpfad. In PyCharm geschieht dies durch die Auswahl eines Quellordners. In Visual Studio Code geschieht dies durch die Einstellung der Option PYTHONPATH variabel.

Quellordner zum PYTHONPATH hinzufügen

Ändern Sie settings.json , um den Quellordner "src" in das integrierte Terminal aufzunehmen:

{
  "terminal.integrated.env.osx": {
    "PYTHONPATH": "${workspaceFolder}/src",
  },
  "terminal.integrated.env.linux": {
    "PYTHONPATH": "${workspaceFolder}/src",
  },
  "terminal.integrated.env.windows": {
    "PYTHONPATH": "${workspaceFolder}/src",
  },
  "python.envFile": "${workspaceFolder}/.env"
}

Und fügen Sie .env hinzu oder ändern Sie es, um den Quellordner "src" in die Python-Umgebung des Editors aufzunehmen:

PYTHONPATH=./src

Beachten Sie, dass der PYTHONPATH sowohl für die Python-Umgebung des Editors als auch für den integriertes Terminal. Die Python-Umgebung des Editors wird von Erweiterungen und bietet Linting- und Testfunktionen. Das integrierte Terminal wird verwendet beim Debuggen, um eine neue Python-Umgebung zu aktivieren.

Bemerkung Diese Konfiguration überschreibt den bestehenden PYTHONPATH. Zum Erweitern, verwenden Sie die folgenden Einstellungen:

{
  "terminal.integrated.env.osx": {
    "PYTHONPATH": "${env:PYTHONPATH}:${workspaceFolder}/src",
  },
  "terminal.integrated.env.linux": {
    "PYTHONPATH": "${env:PYTHONPATH}:${workspaceFolder}/src",
  },
  "terminal.integrated.env.windows": {
    "PYTHONPATH": "${env:PYTHONPATH};${workspaceFolder}/src",
  }
}

PYTHONPATH=${PYTHONPATH}:./src # Use path separator ';' on Windows.

Entwicklung des Lebenslaufs

Es ist nicht nötig, den Arbeitsbereich neu zu laden. Öffnen Sie einfach eine beliebige Python-Datei und genießen Sie die Fähigkeiten der Redakteure. Bitte beachten Sie, dass es sicher ist, die settings.json Datei in der Versionskontrolle.

Wenn Ihnen diese zusätzliche Konfiguration nicht gefällt, können Sie Ihr Projekt umstrukturieren. Verwenden Sie die Top-Level-Modulstruktur oder , indem Sie Pakete erstellen.