Поделиться через

Код Lint Python в Visual Studio

  • Статья

Процесс подкладки выделяет проблемы с синтаксисом языка и стилем в исходном коде Python. Вы можете запустить в коде литер, чтобы определить и исправить тонкие ошибки программирования или нестандартные методики программирования, которые могут привести к ошибкам. Linting может обнаруживать использование неинициализированной или неопределенной переменной, вызовов неопределенных функций, отсутствующих скобок и тонких проблем, таких как попытки переопределения встроенных типов или функций. Linting отличается от форматирования, так как он анализирует выполнение кода и обнаруживает ошибки, а форматирование — только реструктурирует отображение кода.

Два распространенных варианта подкладки включают pylint и mypy. Эти средства широко используются для проверка ошибок в коде Python и поощряют хорошие шаблоны кодирования Python. Оба средства интегрированы в проекты Visual Studio для Python.

Необходимые компоненты

  • Visual Studio. Чтобы установить продукт, выполните действия, описанные в разделе "Установка Visual Studio".
  • Доступ к проекту Python для запуска инструментов подкладки в существующем коде.

Запуск linter

Средства подкладки в Visual Studio доступны в Обозреватель решений.

В следующих шагах показано, как использовать linter для проверка кода.

  1. В Visual Studio щелкните правой кнопкой мыши проект Python в Обозреватель решений и выберите Python, а затем запустите PyLint или Run Mypy:

    Снимок экрана: доступные команды подкладки для проектов Python в Обозреватель решений.

    Командная строка устанавливает литер, который вы выбираете в активной среде, если она еще не присутствует.

  2. После запуска linter в коде можно просмотреть все предупреждения и ошибки lint в окне списка ошибок:

    Снимок экрана: список ошибок и предупреждений pylint для файла кода в Visual Studio.

  3. Дважды щелкните ошибку или предупреждение, чтобы перейти в расположение в исходном коде, где создается проблема.

Настройка параметров командной строки

Параметры командной строки предложения pylint и mypy позволяют настроить параметры подстроки для проекта.

В этом разделе показан пример использования параметров командной строки pylint для управления поведением pyLint с помощью .pylintrc файла конфигурации. Этот файл можно поместить в корневой каталог проекта Python в Visual Studio или другую папку в зависимости от того, насколько широко вы хотите применить параметры.

Следующие шаги подавляют предупреждения "отсутствующие документы" (как показано на предыдущем изображении) с помощью .pylintrc файла в проекте Python.

  1. В командной строке перейдите в корневую папку проекта, в которой есть .pyproj файл, и выполните следующую команду, чтобы создать закомментированный файл конфигурации:

    pylint --generate-rcfile > .pylintrc

  2. В Обозреватель решений щелкните проект правой кнопкой мыши и выберите "Добавить>существующий элемент".

  3. В диалоговом окне перейдите к папке с новым .pylintrc файлом. .pylintrc Выберите файл и нажмите кнопку "Добавить".

  4. В Обозреватель решений откройте .pylintrc файл для редактирования.

  5. В файле можно настроить несколько параметров. В этом примере показано, как отключить предупреждение.

    1. [MESSAGES CONTROL] Найдите раздел и найдите disable параметр в этом разделе.

      Снимок экрана: параметр отключения в разделе MESSAGES CONTROL файла pylintrc в Visual Studio.

      Параметр disable состоит из длинной строки определенных сообщений, к которым можно добавить все нужные предупреждения.

    2. Добавьте строку (включая префикс ,missing-docstring запятой) к значению disable параметра:

      Снимок экрана, на котором показано, как добавить определенное предупреждение к параметру отключения в файле pylintrc в Visual Studio.

  6. Сохраните файл .pylintrc.

  7. Запустите pylint еще раз. Обратите внимание, что предупреждения "отсутствующие документы" теперь подавляются.

Использование файла pylintrc из сетевой папки

Файл можно использовать .pylintrc из сетевого ресурса.

  1. Создайте переменную среды с именем PYLINTRC.

  2. Назначьте переменную значение имени файла в сетевой папке с помощью пути UNC или сопоставленного буквы диска. Например, PYLINTRC=\\myshare\python\.pylintrc.

Связанный контент