Python-Tests in Visual Studio Code

Die Python-Erweiterung baut auf den integrierten Testfunktionen von VS Code auf und bietet Test-Discovery, Testabdeckung sowie das Ausführen und Debuggen von Tests für Pythons integriertes unittest-Framework und pytest.

Tests konfigurieren

Wenn die Python-Erweiterung installiert ist und eine Python-Datei im Editor geöffnet wird, erscheint ein Becher-Symbol in der VS Code-Aktivitätsleiste, das für die Ansicht Test Explorer steht. Wenn noch kein Test-Framework aktiviert ist, zeigt der Test Explorer die Schaltfläche Python-Tests konfigurieren an. Durch Auswahl von Python-Tests konfigurieren werden Sie aufgefordert, ein Test-Framework und einen Ordner mit den Tests auszuwählen. Wenn Sie unittest verwenden, wählen Sie außerdem das Dateiglob-Muster aus, das zur Identifizierung Ihrer Testdateien verwendet wird.

Tests können jederzeit über den Befehl Python: Tests konfigurieren in der Befehlspalette konfiguriert werden, oder indem Sie python.testing.unittestEnabled oder python.testing.pytestEnabled im Einstellungs-Editor oder in der Datei settings.json festlegen, wie in der VS Code-Dokumentation zu Einstellungen beschrieben. Jedes Framework verfügt außerdem über spezifische Konfigurationseinstellungen, wie unter Testkonfigurationseinstellungen für die jeweiligen Ordner und Muster beschrieben.

Wenn Sie pytest aktivieren und es in der aktivierten Umgebung noch nicht installiert ist, versucht die Python-Erweiterung, es im Hintergrund zu installieren. Wenn zudem beide Frameworks aktiviert sind, führt die Python-Erweiterung nur pytest aus.

Test-Discovery

Standardmäßig versucht die Python-Erweiterung, Tests zu entdecken, sobald Sie ein Framework aktivieren. Sie können die Test-Discovery jederzeit über den Befehl Test: Tests aktualisieren in der Befehlspalette auslösen.

Die Test-Discovery wendet die Discovery-Muster für das aktuelle Framework an (die über die Testkonfigurationseinstellungen angepasst werden können). Das Standardverhalten ist wie folgt:

• python.testing.unittestArgs: Sucht im Projektstammordner nach jeder Python-Datei (.py), die "test" im Namen enthält. Alle Testdateien müssen importierbare Module oder Pakete sein. Sie können das Muster für den Dateiableich mit der Konfigurationseinstellung -p und den Ordner mit der Einstellung -t anpassen.

• python.testing.pytestArgs: Sucht nach jeder Python-Datei (.py), deren Name mit "test_" beginnt oder auf "_test" endet, und die sich irgendwo innerhalb des aktuellen Ordners oder in Unterordnern befindet.

Wenn die Test-Discovery erfolgreich war, werden die Tests im Test Explorer aufgelistet.

Wenn Sie die Test-Discovery direkt über den Test Explorer auslösen, können Sie auch einen laufenden Discovery-Vorgang abbrechen. Verwenden Sie die Schaltfläche Abbrechen, die während der Discovery die Schaltfläche Aktualisieren ersetzt.

Wenn die Discovery fehlschlägt (z. B. wenn das Test-Framework nicht installiert ist oder ein Syntaxfehler in der Testdatei vorliegt), wird im Test Explorer eine Fehlermeldung mit einem Link zu den Protokollen angezeigt. Sie können im Python-Ausgabebereich die vollständige Fehlermeldung einsehen (verwenden Sie den Menübefehl Ansicht > Ausgabe, um das Ausgabefenster anzuzeigen, und wählen Sie dann Python aus dem Dropdown-Menü auf der rechten Seite).

Tests ausführen

Sie können Tests mit einer der folgenden Aktionen ausführen:

• Wählen Sie bei geöffneter Testdatei das grüne Ausführungssymbol, das im Seitenrand neben der Testdefinitionszeile angezeigt wird, wie im vorherigen Abschnitt gezeigt. Dieser Befehl führt nur diese eine Methode aus.

  

• Über die Befehlspalette, indem Sie einen der folgenden Befehle ausführen:

  • Test: Alle Tests ausführen - Führt alle erkannten Tests aus.
  • Test: Tests in der aktuellen Datei ausführen - Führt alle Tests in der Datei aus, die im Editor geöffnet ist.
  • Test: Test am Cursor ausführen - Führt nur die Testmethode aus, an der sich Ihr Cursor im Editor befindet.

• Über den Test Explorer:

  • Um alle erkannten Tests auszuführen, wählen Sie die Wiedergabetaste oben im Test Explorer.

    

  • Um eine bestimmte Gruppe von Tests oder einen einzelnen Test auszuführen, wählen Sie die Datei, die Klasse oder den Test aus und klicken Sie dann auf die Wiedergabetaste rechts neben diesem Element.

    

  • Sie können auch eine Auswahl von Tests über den Test Explorer ausführen. Halten Sie dazu Strg+Klick (oder Cmd+Klick unter macOS) auf die Tests, die Sie ausführen möchten, führen Sie einen Rechtsklick auf einen davon aus und wählen Sie Test ausführen.

Nach einem Testlauf zeigt VS Code die Ergebnisse direkt im Editor als Dekorationen im Seitenrand an. Fehlgeschlagene Tests werden ebenfalls im Editor hervorgehoben, mit einer Peek-Ansicht, die die Fehlermeldung des Testlaufs und eine Historie aller Testläufe anzeigt. Sie können Escape drücken, um die Ansicht zu schließen. Sie können sie deaktivieren, indem Sie die Benutzereinstellungen öffnen (Befehl Einstellungen: Einstellungen (UI) öffnen in der Befehlspalette) und den Wert der Einstellung Testing: Automatically Open Peek View auf never ändern.

Im Test Explorer werden Ergebnisse für einzelne Tests sowie für alle Klassen und Dateien angezeigt, die diese Tests enthalten. Ordner zeigen ein Fehlersymbol an, wenn einer der Tests in diesem Ordner nicht bestanden wurde.

VS Code zeigt Testergebnisse auch im Bereich Testergebnisse an.

Tests mit Codeabdeckung ausführen

Um Tests mit aktivierter Abdeckung (Coverage) auszuführen, wählen Sie das Abdeckungs-Ausführungssymbol im Test Explorer oder die Option Mit Abdeckung ausführen aus jedem Menü, aus dem Sie normalerweise Testläufe starten. Die Python-Erweiterung führt die Abdeckung mithilfe des pytest-cov-Plugins aus, wenn Sie pytest verwenden, oder mit coverage.py für unittest.

Sobald der Abdeckungslauf abgeschlossen ist, werden Zeilen im Editor für die zeilenbasierte Abdeckung hervorgehoben. Die Testergebnisse der Abdeckung erscheinen als Unter-Tab "Testabdeckung" im Test Explorer, den Sie auch über Testing: Focus on Test Coverage View in der Befehlspalette aufrufen können (⇧⌘P (Windows, Linux Ctrl+Shift+P)). In diesem Bereich können Sie die Zeilenabdeckungsmetriken für jede Datei und jeden Ordner in Ihrem Workspace sowie die Zweigabdeckung einsehen, sofern relevant.

Für eine feinere Kontrolle Ihres Abdeckungslaufs bei der Verwendung von pytest können Sie die Einstellung python.testing.pytestArgs bearbeiten, um Ihre Spezifikationen einzufügen. Wenn das pytest-Argument --cov in python.testing.pytestArgs vorhanden ist, nimmt die Python-Erweiterung keine zusätzlichen Änderungen an den Coverage-Argumenten vor, damit Ihre Anpassungen wirksam werden können. Wenn kein --cov-Argument gefunden wird, fügt die Erweiterung vor dem Lauf --cov=. zu den pytest-Argumenten hinzu, um die Abdeckung im Workspace-Stammverzeichnis zu aktivieren.

Weitere Informationen zur Testabdeckung finden Sie in der Dokumentation zur Testabdeckung von VS Code.

Tests debuggen

Um Tests zu debuggen, führen Sie einen Rechtsklick auf die Dekoration im Seitenrand neben der Funktionsdefinition aus und wählen Sie Test debuggen, oder wählen Sie das Symbol Test debuggen neben diesem Test im Test Explorer.

Sie können die folgenden Befehle in der Befehlspalette verwenden, um Tests zu debuggen:

• Test: Alle Tests debuggen - Startet den Debugger für alle Tests in Ihrem Workspace.
• Test: Tests in der aktuellen Datei debuggen - Startet den Debugger für die Tests, die Sie in der Datei definiert haben, die im Editor geöffnet ist.
• Test: Test am Cursor debuggen - Startet den Debugger nur für die Methode, auf der Ihr Cursor im Editor fokussiert ist. Sie können auch die Test debuggen-Symbole im Test Explorer verwenden, um den Debugger für alle Tests in einem ausgewählten Bereich und alle erkannten Tests zu starten.

Sie können auch das Standardverhalten beim Klicken auf die Dekoration im Seitenrand ändern, um Tests zu debuggen anstatt sie auszuführen, indem Sie den Wert der Einstellung testing.defaultGutterClickAction in Ihrer settings.json-Datei auf debug setzen.

Der Debugger funktioniert für Tests genauso wie für anderen Python-Code, einschließlich Haltepunkten, Variableninspektion usw. Um die Einstellungen für das Debuggen von Tests anzupassen, können Sie Test-Debug-Konfigurationen entweder in den launch.json- oder settings.json-Dateien im .vscode-Ordner Ihres Workspace angeben, indem Sie "purpose": ["debug-test"] zu Ihrer Konfiguration hinzufügen. Diese Konfiguration wird verwendet, wenn Sie die Befehle Test: Alle Tests debuggen, Test: Tests in der aktuellen Datei debuggen und Test: Test am Cursor debuggen ausführen.

Zum Beispiel deaktiviert die folgende Konfiguration in der Datei launch.json die Einstellung justMyCode für das Debuggen von Tests:

{
  "name": "Python: Debug Tests",
  "type": "debugpy",
  "request": "launch",
  "program": "${file}",
  "purpose": ["debug-test"],
  "console": "integratedTerminal",
  "justMyCode": false
}

Wenn Sie mehr als einen Konfigurationseintrag mit "purpose": ["debug-test"] haben, wird die erste Definition verwendet, da wir derzeit keine mehreren Definitionen für diesen Anforderungstyp unterstützen.

Weitere Informationen zum Debuggen oder um zu verstehen, wie es in VS Code funktioniert, finden Sie in den Artikeln zu Python-Debugkonfigurationen und allgemein zum Debuggen in VS Code.

Tests parallel ausführen

Die Unterstützung für die parallele Ausführung von Tests mit pytest ist über das Paket pytest-xdist verfügbar. Besuchen Sie deren Dokumentation für weitere Informationen zur Verwendung von pytest-xdist.

Wenn xdist aktiviert ist und keine Anzahl von Workern in den Argumenten angegeben ist, wird die Anzahl der Worker von der Python-Erweiterung automatisch basierend darauf optimiert, wie viele Tests im Test Explorer ausgewählt sind.

Django-Unit-Tests

Die Python-Erweiterung bietet auch Unterstützung für die Erkennung und Ausführung von Django-Unit-Tests! Sie können Ihre Django-Tests mit nur wenigen zusätzlichen Einrichtungsschritten entdecken lassen:

1. Setzen Sie "python.testing.unittestEnabled": true, in Ihrer settings.json-Datei.
2. Fügen Sie MANAGE_PY_PATH als Umgebungsvariable hinzu.
   1. Erstellen Sie eine .env-Datei im Stammverzeichnis Ihres Projekts.
   2. Fügen Sie MANAGE_PY_PATH='<Pfad-zu-manage.py>' zur .env-Datei hinzu und ersetzen Sie <Pfad-zu-manage.py> durch den Pfad zur manage.py-Datei Ihrer Anwendung.

      Tipp: Sie können den Pfad kopieren, indem Sie mit der rechten Maustaste auf die Datei im Explorer klicken und Pfad kopieren wählen.

3. Fügen Sie bei Bedarf Django-Testargumente zu "python.testing.unittestArgs": [] in der settings.json-Datei hinzu und entfernen Sie alle Argumente, die nicht mit Django kompatibel sind.

Navigieren Sie zur Test-Ansicht und wählen Sie die Schaltfläche Tests aktualisieren, damit Ihre Django-Tests angezeigt werden!

Fehlerbehebung

Wenn Ihre Django-Unit-Tests nicht in der Test-Ansicht angezeigt werden, versuchen Sie die folgenden Schritte zur Fehlerbehebung:

• Suchen Sie nach Fehlermeldungen im Python-Ausgabefenster. Sie könnten einen Hinweis darauf geben, warum Ihre Tests nicht erkannt werden.
• Versuchen Sie, die Django-Tests im Terminal auszuführen. "Übersetzen" Sie dann denselben Befehl in VS Code-Einstellungen. Wenn Sie beispielsweise python manage.py test --arg im Terminal ausführen, würden Sie MANAGE_PY_PATH='./manage.py' zu einer .env-Datei hinzufügen und "python.testing.unittestArgs": [--arg] in den VS Code-Einstellungen festlegen. Alternativ können Sie die Befehle, die von der Python-Erweiterung ausgeführt werden, auch im Python-Ausgabefenster finden.
• Verwenden Sie den absoluten Pfad zur manage.py-Datei beim Festlegen der Umgebungsvariablen MANAGE_PY_PATH, falls Sie ursprünglich den relativen Pfad verwendet haben.

Testbefehle

Nachfolgend finden Sie alle unterstützten Befehle für Tests mit der Python-Erweiterung in VS Code. Diese sind alle über die Befehlspalette zu finden:

Testkonfigurationseinstellungen

Das Verhalten beim Testen mit Python wird durch allgemeine UI-Einstellungen von VS Code gesteuert sowie durch Einstellungen, die spezifisch für Python und das jeweils aktivierte Framework sind.

Allgemeine UI-Einstellungen

Die Einstellungen, die die Benutzeroberfläche der Testfunktionen beeinflussen, werden von VS Code selbst bereitgestellt und können im VS Code-Einstellungs-Editor gefunden werden, wenn Sie nach "Testing" suchen.

Allgemeine Python-Einstellungen

unittest-Konfigurationseinstellungen

Die Standardargumente für unittest sind wie folgt:

• -v setzt die Standard-Ausführlichkeit. Entfernen Sie dieses Argument für eine einfachere Ausgabe.
• -s . gibt das Startverzeichnis für die Erkennung von Tests an. Wenn Sie Tests in einem "test"-Ordner haben, ändern Sie das Argument in -s test (was "-s", "test" im Argument-Array bedeutet).
• -p *test*.py ist das Discovery-Muster, das verwendet wird, um nach Tests zu suchen. In diesem Fall ist es jede .py-Datei, die das Wort "test" enthält. Wenn Sie Testdateien anders benennen, z. B. durch Anhängen von "_test" an jeden Dateinamen, verwenden Sie ein Muster wie *_test.py im entsprechenden Argument des Arrays.

Um einen Testlauf beim ersten Fehler zu stoppen, fügen Sie die Option "-f" (fail fast) zum Argument-Array hinzu.

Siehe unittest-Befehlszeilenschnittstelle für den vollständigen Satz verfügbarer Optionen.

pytest-Konfigurationseinstellungen

Die Standardargumente für pytest sind wie folgt:

• rootdir wird dynamisch basierend auf dem Vorhandensein einer python.testing.cwd-Einstellung in Ihrem Workspace angepasst.

Sie können pytest auch mithilfe einer pytest.ini-Datei konfigurieren, wie unter pytest-Konfiguration beschrieben.

IntelliSense-Einstellungen

Siehe auch

• Python-Umgebungen - Steuert, welcher Python-Interpreter zum Bearbeiten und Debuggen verwendet wird.
• Einstellungenreferenz – Erkunden Sie die gesamte Bandbreite der Python-bezogenen Einstellungen in VS Code.