Linting von Python-Code in Visual Studio

  • Artikel

Der Lintingprozess hebt Sprachsyntax und Stilprobleme in Ihrem Python-Quellcode hervor. Sie können einen Linter für Ihren Code ausführen, um subtile Programmierfehler oder unkonventionelle Codierungsmethoden, die zu Fehlern führen können, zu identifizieren und zu korrigieren. Linting kann die Verwendung einer nicht initialisierten oder undefinierten Variablen, Aufrufe undefinierter Funktionen, fehlende Klammern und subtile Probleme wie Versuche, integrierte Typen oder Funktionen neu zu definieren, erkennen. Linting unterscheidet sich von der Formatierung, da es die Ausführung Ihres Codes analysiert und Fehler erkennt, während die Formatierung lediglich die Darstellung Ihres Codes umstrukturiert.

Zwei häufige Optionen für Linting sind pylint und mypy. Diese Tools werden häufig verwendet, um nach Fehlern im Python-Code zu suchen und gute Python-Codierungsmuster zu fördern. Beide Tools sind in Visual Studio für Python-Projekte integriert.

Voraussetzungen

  • Visual Studio. Führen Sie zum Installieren des Produkts die Schritte unter Installieren von Visual Studio aus.
  • Zugriff auf ein Python-Projekt, um Lintingtools für vorhandenen Code auszuführen.

Ausführen eines Linters

Die Lintingtools in Visual Studio sind im Projektmappen-Explorer verfügbar.

Die folgenden Schritte zeigen, wie Sie einen Linter verwenden, um Ihren Code zu überprüfen.

  1. Klicken Sie in Visual Studio im Projektmappen-Explorer auf ein Python-Projekt, und wählen Sie Python und dann PyLint ausführen oder Mypy ausführen aus:

    Screenshot, der die verfügbaren Linting-Befehle für Python-Projekte im Solution Explorer zeigt.

    Der Befehl fordert Sie auf, den von Ihnen ausgewählten Linter in Ihrer aktiven Umgebung zu installieren, sofern dieser noch nicht vorhanden ist.

  2. Nachdem der Linter im Code ausgeführt wurde, können Sie alle Lintwarnungen und Fehler im Fenster Fehlerliste überprüfen:

    Screenshot der Liste der Pylint-Fehler und Warnungen für die Codedatei in Visual Studio.

  3. Doppelklicken Sie auf einen Fehler oder eine Warnung, um zu der Stelle im Quellcode zu gelangen, an der das Problem auftritt.

Festlegen von Befehlszeilenoptionen

Sowohl pylint als auch mypy bieten Befehlszeilenoptionen zum Konfigurieren von Linteinstellungen für Ihr Projekt.

Dieser Abschnitt zeigt ein Beispiel, bei dem Befehlszeilenoptionen von pylint verwendet werden, um das Verhalten von pylint über eine .pylintrc-Konfigurationsdatei zu steuern. Diese Datei kann im Stammverzeichnis eines Python-Projekts in Visual Studio oder in einem anderen Ordner abgelegt werden, je nachdem, wie umfassend Sie die Einstellungen anwenden möchten.

Die folgenden Schritte unterdrücken die Warnungen „fehlende Dokumentzeichenfolge“ (wie im vorherigen Bild gezeigt), indem eine .pylintrc-Datei im Python-Projekt verwendet wird.

  1. Navigieren Sie in der Befehlszeile zum Stammorder Ihres Projekts mit der .pyproj-Datei, und führen Sie den folgenden Befehl aus, um eine kommentierte Konfigurationsdatei zu generieren:

    pylint --generate-rcfile > .pylintrc

  2. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt, und wählen Sie Hinzufügen>Vorhandenes Element aus.

  3. Navigieren Sie im Dialogfeld zu dem Ordner mit der neuen .pylintrc-Datei. Wählen Sie die Datei .pylintrc aus, und klicken Sie dann auf Hinzufügen.

  4. Öffnen Sie im Projektmappen-Explorer die .pylintrc-Datei zur Bearbeitung.

  5. Es gibt mehrere Einstellungen, die Sie in der Datei konfigurieren können. In diesem Beispiel wird gezeigt, wie eine Warnung deaktiviert wird.

    1. Suchen Sie den Abschnitt [MESSAGES CONTROL] und ermitteln Sie dann die Einstellung disable in diesem Abschnitt.

      Screenshot der Deaktivierungseinstellung im Abschnitt NACHRICHTENSTEUERUNG der Pylintrc-Datei in Visual Studio.

      Die Einstellung disable besteht aus einer langen Zeichenfolge spezifischer Meldungen, an die Sie beliebige Warnungen anhängen können.

    2. Fügen Sie die Zeichenfolge ,missing-docstring (einschließlich des Kommapräfixes) an den Einstellungswert disable an:

      Screenshot, der zeigt, wie Sie eine bestimmte Warnmeldung an die Deaktivierungseinstellung in der Pylintrc-Datei in Visual Studio anhängen können.

  6. Speichern Sie die Datei .pylintrc.

  7. Führen Sie pylint erneut aus. Beachten Sie, dass die Warnungen „missing docstring“ jetzt unterdrückt werden.

Verwenden der pylintrc-Datei über die Netzwerkfreigabe

Sie können eine .pylintrc-Datei aus einer Netzwerkfreigabe verwenden.

  1. Erstellen Sie eine Umgebungsvariable namens PYLINTRC.

  2. Weisen Sie der Variablen den Wert des Dateinamens in der Netzwerkfreigabe zu, indem Sie einen UNC-Pfad (Universal Naming Convention) oder einen zugeordneten Laufwerkbuchstaben verwenden. Beispiel: PYLINTRC=\\myshare\python\.pylintrc.

Zugehöriger Inhalt