Проекты Python с поэзией и VSCode. Часть 2

Python Projects с поэзией и VSCode (3 частью серии)

В Первая часть Мы узнали, что pyproject.toml Файл есть и как работать с ним, используется Поэзия Чтобы начать новый проект, создать виртуальную среду и добавлять и удалять зависимости. Все это со следующими командами:

В этой второй части мы будем:

• Добавьте нашу виртуальную среду в VSCode Отказ
• Обновите наши зависимости.
• Интеграция наших зависимостей Dev с редактором:
  • Flake8.
  • Чернить
  • Питиш

И в третьей части мы будем:

• Написать образец библиотеки.
• Построить наш проект с Поэзия Отказ
• Опубликовать его на Pypi Отказ

Прежде чем начать, убедитесь, что вы установили VSCode добавил Python расширение и что вы следовали и/или поняли Первая часть этой серии.

Настройка поэзии на VSCode

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

Хорошо, по сей день нет новых версий.

Когда вы создаете виртуальную среду с Венв Команда, VSCode автоматически устанавливает его в качестве среды Python по умолчанию для этого проекта. При работе с Поэзия , в первый раз нам нужно будет набрать следующее в терминале и внутри папки проекта:

$ poetry shell
$ code .

Первая команда Поэзия раковина , выведет нас внутри нашей виртуальной среды, и кода Открою текущую папку внутри VSCode Отказ

Открыть как-долго папка (или тот, с именем вашего проекта) с помощью левой панели и рядом с __init__.py Создать Как-long.py файл. В левом нижнем углу вы увидите текущую среду Python:

Нажмите на него и отобразится список доступных сред. Выберите тот, который имеет имя вашего проекта в нем:

Теперь давайте интегрируем наши зависимости разработки, Flake8. , Черный и Pteest в Visual Studio Code.

Flake8.

Flake8 предоставит наши проекты Рятинг Возможности. Другими словами, предупреждение об ошибках синтаксиса и стиля, а также благодаря VSCode, мы будем знать их, как мы введены.

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

Нажмите на Выберите Линтер и выберите Flake8. из списка. Теперь VSCode скажу нам наше синтаксис и Стиль Проблемы, зеленые или красные в зависимости от его серьезности, всегда с хорошим описанием того, что не так:

Похоже, у нас есть две проблемы: мы пропустим пустую строку в конце нашего файла (стиль) и забыли добавить цитаты нашим Привет мир! Строка (синтаксис). Исправьте их и посмотрим, все предупреждения исчезают.

Чернить

Черный Является ли яблочный код, инструмент, который будет смотреть на наш код и автоматически отформатировать его в соответствии с Pep 8 Руководство по стилю, то же самое Pep что использует Flake8 к линтам нашего стиля ошибок.

Держать Shift + CMD/Ctrl + P Чтобы открыть командную палитру, введите Форматировать документ и нажмите Enter. Появится новое всплывающее сообщение:

Выберите Использовать черный Отказ Теперь скопируйте этот плохо отформатированный код в ваш файл Python:

for i in range(5):         # this comment has too many spaces
      print(i)  # this line has 6 space indentation.

Какой уродливый кусок S ** … код. Попробуйте форматировать его снова и посмотреть, как * Black Исправляет все их для вас!

Еще одна вещь, которую мы можем сделать, это настроить VSCode, чтобы каждый раз, когда мы сохраняем, Черный автоматически отформатирует наш код. Держать CMD/CTRL +, Чтобы открыть настройки. Убедитесь, что вы находитесь в Настройки рабочего пространства Поиск Формат на сохранении и активируйте флажок:

Наконец, Черный По умолчанию до 88 символов в строке в отличие от 80, разрешенных Flake8. , чтобы избежать конфликтов, откройте .vscode Папка и добавьте следующее в конце settings.json файл:

{
    ...
    "python.linting.flake8Args": [
        "--max-line-length=88"
    ],
}

Питиш

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

Pteest является очень популярным и удобным для пользовательских оснований для написания тестов. Мы уже установил это Таким образом, мы также будем интегрировать это с VSCode Отказ

Открыть Тесты папка и выберите test_how_long.py файл. Поэзия Уже дает нам наш первый тест:

# test_how_long.py
from how_long import __version__


def test_version():
    assert __version__ == '0.1.0'

Этот тест импортирует __Version__ Переменная от __init__.py Файл, который находится внутри Как_long Папка и утверждает, что текущая версия 0.1.0 Отказ Откройте интегрированный терминал, собираясь на Терминал> Новый терминал и тип:

$ pytest

Выход будет выглядеть так:

Хорошо, все в порядке. Откройте свою командую палитру Shift + CMD/Ctrl + P :

• Напишите единица и выберите Python: Настройка тестов подразделения Отказ
• Выберите pteest Отказ
• Выберите каталог, в котором хранятся тесты, Тесты в нашем случае.

Произошло три вещи:

• В строке состояния появилась новая кнопка: Пробежать тесты Отказ Это то же самое, что набрав pteest в терминале. Нажмите его и выберите Запустите все тесты подразделения Отказ Когда закончите, это сообщит вам количество проверенных испытаний и тесты, которые не:

• Новый значок в левом баре. Если вы нажмете на него панель, отображающую все тесты. Здесь вы можете запустить каждый по отдельности:

• Внутри тестового файла, новые параметры будут отображаться до каждой тестовой функции: значок проверки появится, если в порядке, и х в противном случае. Это также позволяет вам запустить определенные тесты:

Вывод

До сих пор у нас есть:

• Начал новый проект Отказ
• Создана виртуальная среда с Поэзия Отказ
• Добавлено, удалено и обновлено зависимости.
• Добавлена наша виртуальная среда на VSCode.
• Настроен Flake8. к Lint Наш код, как мы введем.
• Выберите Черный Как форма нашего проекта.
• И Pteest проводить наши тесты наглядным образом.

В Третий И последняя часть мы будем:

• Написать образец библиотеки.
• Построить наш проект с Поэзия Отказ
• Опубликовать его на Pypi Отказ

Вот и все, хорошего дня!

Python Projects с поэзией и VSCode (3 частью серии)

Оригинал: “https://dev.to/wilfredinni/python-projects-with-poetry-and-vscode-part-2-596b”