На данный момент я пишу, у меня нет опыта работы, поэтому мой единственный способ практически узнать о разработке программного обеспечения – через проекты с открытым исходным кодом. Некоторое время назад я выпустил первую версию ответственности, мой первый открытый исходный проект Python.
Miguelmj/ответственность
Система рекомендации для переполнения стека без ответа Вопросы
Хотя Я давно знал питона, я всегда использовал его для личных проектов и назначений колледжа . По этой причине, когда я сделал свой код открытым, мне пришлось задать вопросы, принять критику и посмотреть, что сделали другие. Здесь я хочу показать вам некоторые вещи, о которых я узнал.
Стиль, Pep 8 и черный
Когда вы делаете проект с открытым исходным кодом, вы хотите сделать код доступен и очистить. Кто-нибудь признает код спагетти, когда они его видят, независимо от того, каковы их личный стиль кодирования. Вы должны покрыть некоторые минимумы здесь.
Кроме того, основная часть философии Python является читаемостью кода. Первый принцип в Дзен Питона Читает:
Красивая лучше, чем уродливая.
Итак, как я видел некоторые ссылки здесь и там о документе под названием PEP 8 – Руководство по стилю для Python Code Я начал читать это, чтобы узнать его и применить его к моим коде.
Вскоре мне сказали, что это была пустая трата времени, когда я мог бы использовать код код, как Черный Отказ Это легко учиться и использовать, и улучшение сразу заметно. Вы можете исправить свои файлы на месте или просто распечатать различие с изменениями, не применяя их.
Пример 1. Форматирование файлов напрямую :
Пример 2. Печать разных без изменений :
Однако я не думаю, что читать PEP 8 – пустая трата времени. Черный Может игнорировать некоторые вещи, которые вы все еще должны обратить внимание, чтобы иметь чистый стиль. Тем не менее, это действительно хорошо для ревизий общего стиля.
PSF/Black
Бескомпромиссная форма Python код
Проверка кода с Pyflakes и стервюрами
Некоторые ошибки в коде не будут замечены до выполнения, но они могут быть предотвращены дотошным обзором заранее. То же самое происходит с Dead Code, который остался после некоторых изменений. Pyflakes и стервятник могут помочь вам с этим.
Pyflakes Проверка пассивного кода; Он анализирует код, не выполняя его, поэтому оно ничего не нарушит. Он указывает на переменные конфликты и, в отличие от других шашек, он не жалуется на стиль кода (у нас есть черный и более).
Стервятность Находит мертвый код: неиспользуемые переменные, функции и импорт. Но нет Pyflakes не включает этого? Не совсем, потому что Pyflakes следует принципу стараться изо всех сил, чтобы избежать ложных срабатываний. Сердцевик, с другой стороны, добавляет к каждому предупреждению в процентах доверия. В Python трудно сказать, когда некоторая функция не используется, потому что это динамический язык, и в большинстве случаев Pyflakes не предупреждает о них.
Сравнение продукции :
Pycqa/pyflakes.
Простая программа, которая проверяет исходные файлы Python для ошибок
jendrikseip/стервятник
Найти мертвый код Python
Зависимости отслеживания с PIPREQS
Наконец, если вы хотите, чтобы ваш проект был использован или изменен другими программистами, лучше, если они могут установить зависимости напрямую, вместо того, чтобы установить их один за другим, каждый после A Модуль не нашел ошибку Отказ Для этого вам нужно Добавить требования .txt Файл к вашему проекту Отказ
Вы могли бы сделать это вручную (но это не весело) или использовать Пип заморозить Но это пишет все ваши установленные пакеты, многое больше, чем необходимо. Вместо этого, используя PipReqs Ваш файл требований.
Пример PipReqs:
Теперь, если кто-то клонирует ваш проект, они могут просто использовать PIP Установка -R. требования .txt И будут установлены зависимости.
Bndr/pipreqs.
PIPREQS – генерировать файл требований PIP.txt на основе импорта любого проекта. Ищете сопровождающие, чтобы переместить этот проект вперед.
Вывод
Я надеюсь, что вы найдете некоторые из них так полезны, как я. Я почти уверен, что есть другие отличные инструменты для использования в Python Projects. Ты знаешь? Пожалуйста, поделитесь ими в комментариях!
Рекомендуемое чтение
Советы для начинающих, чтобы сделать алгебру в Python
Miguelmj · 21 ноября ’20 · 5 мин читать
Многосциплинарность – Что там, кроме кода?
Miguelmj · 24 марта · 5 мин читать
Вы можете следовать за мной в Twitter! 🐦
Оригинал: “https://dev.to/miguelmj/open-sourcing-a-python-project-tools-you-should-know-about-8bc”