Lint Python code in Visual Studio

  • Artykuł

Proces linting wyróżnia składnię języka i problemy ze stylem w kodzie źródłowym języka Python. Możesz uruchomić linter w kodzie, aby zidentyfikować i poprawić subtelne błędy programowania lub niekonwencjonalne praktyki kodowania, które mogą prowadzić do błędów. Linting może wykrywać użycie niezainicjowanej lub niezdefiniowanej zmiennej, wywołań funkcji niezdefiniowanych, brak nawiasów i subtelnych problemów, takich jak próby ponownego zdefiniowania wbudowanych typów lub funkcji. Linting różni się od formatowania, ponieważ analizuje sposób uruchamiania kodu i wykrywa błędy, podczas gdy formatowanie zmienia tylko sposób wyświetlania kodu.

Dwie typowe opcje podszewki obejmują pylint i mypy. Te narzędzia są powszechnie używane do sprawdzania błędów w kodzie języka Python i zachęcają do dobrych wzorców kodowania języka Python. Oba narzędzia są zintegrowane z programem Visual Studio dla projektów języka Python.

Wymagania wstępne

  • Visual Studio. Aby zainstalować produkt, wykonaj kroki opisane w temacie Instalowanie programu Visual Studio.
  • Dostęp do projektu języka Python w celu uruchamiania narzędzi linting w istniejącym kodzie.

Uruchamianie lintera

Narzędzia do obsługi linting w programie Visual Studio są dostępne w Eksplorator rozwiązań.

W poniższych krokach pokazano, jak za pomocą lintera sprawdzić kod.

  1. W programie Visual Studio kliknij prawym przyciskiem myszy projekt języka Python w Eksplorator rozwiązań i wybierz pozycję Python, a następnie wybierz polecenie Uruchom plik PyLint lub Uruchom narzędzie Mypy:

    Zrzut ekranu przedstawiający dostępne polecenia linting dla projektów języka Python w Eksplorator rozwiązań.

    Polecenie wyświetla monit o zainstalowanie lintera wybranego w aktywnym środowisku, jeśli jeszcze go nie ma.

  2. Po uruchomieniu linter w kodzie możesz przejrzeć wszelkie ostrzeżenia i błędy lint w oknie Lista błędów:

    Zrzut ekranu przedstawiający listę błędów i ostrzeżeń dotyczących pliku kodu w programie Visual Studio.

  3. Kliknij dwukrotnie błąd lub ostrzeżenie, aby przejść do lokalizacji w kodzie źródłowym, w którym jest generowany problem.

Ustawianie opcji wiersza polecenia

Zarówno pylint , jak i mypy oferują opcje wiersza polecenia, aby skonfigurować ustawienia linting dla projektu.

W tej sekcji przedstawiono przykład użycia opcji wiersza polecenia pylint do kontrolowania zachowania pyLint za pomocą .pylintrc pliku konfiguracji. Ten plik można umieścić w katalogu głównym projektu języka Python w programie Visual Studio lub innym folderze, w zależności od tego, jak szeroko chcesz zastosować ustawienia.

Poniższe kroki pomijają ostrzeżenia "brak ściągnięcia dokumentu" (jak pokazano na poprzedniej ilustracji) przy użyciu .pylintrc pliku w projekcie języka Python.

  1. W wierszu polecenia przejdź do folderu głównego projektu zawierającego .pyproj plik i uruchom następujące polecenie, aby wygenerować skomentowany plik konfiguracji:

    pylint --generate-rcfile > .pylintrc

  2. W Eksplorator rozwiązań kliknij prawym przyciskiem myszy projekt i wybierz polecenie Dodaj>istniejący element.

  3. W oknie dialogowym przejdź do folderu zawierającego nowy .pylintrc plik. .pylintrc Wybierz plik, a następnie wybierz pozycję Dodaj.

  4. W Eksplorator rozwiązań otwórz .pylintrc plik do edycji.

  5. Istnieje kilka ustawień, które można skonfigurować w pliku. W tym przykładzie pokazano, jak wyłączyć ostrzeżenie.

    1. Znajdź sekcję [MESSAGES CONTROL] , a następnie znajdź disable ustawienie w tej sekcji.

      Zrzut ekranu przedstawiający ustawienie wyłączenia w sekcji MESSAGES CONTROL pliku pylintrc w programie Visual Studio.

      Ustawienie disable składa się z długiego ciągu określonych komunikatów, do których można dołączyć odpowiednie ostrzeżenia.

    2. Dołącz ciąg ,missing-docstring (w tym prefiks przecinka) do disable wartości ustawienia:

      Zrzut ekranu przedstawiający sposób dołączania określonego komunikatu ostrzegawczego do ustawienia wyłączenia w pliku pylintrc w programie Visual Studio.

  6. Zapisz plik .pylintrc.

  7. Uruchom ponownie narzędzie pylint. Zwróć uwagę, że ostrzeżenia "brakujące docstring" są teraz pomijane.

Używanie pliku pylintrc z udziału sieciowego

Możesz użyć .pylintrc pliku z udziału sieciowego.

  1. Utwórz zmienną środowiskową o nazwie PYLINTRC.

  2. Przypisz zmienną wartość nazwy pliku w udziale sieciowym przy użyciu ścieżki Universal Naming Convention (UNC) lub zamapowanej litery dysku. Na przykład PYLINTRC=\\myshare\python\.pylintrc.

Powiązana zawartość