В настоящее время нетрудно иметь единообразный стиль кода для всех проектов (и, что еще лучше, для разных проектов); тем не менее, тратить время на споры о стилях во время проверки кода унизительно и непродуктивно . Переходит в Black, что означает бескомпромиссное средство форматирования кода Python.
Это действительно освобождает от необходимости беспокоиться о форматировании кода, не иметь непродуктивных, бесплодных дискуссий по PR о мелочах кода, и в то же время быть уверенным в том, что весь ваш код хорошо отформатирован; самое главное, качество стиля не зависит от разработчика (да ладно, кто никогда не работал с ленивым неряхом, который не может влезть в его - это всегда толстый череп «он», который длинные строки и беспорядочный код порождают такие ошибки, как гнездо тараканов?)
В Google есть концепция читабельности (у меня были и Java, и C ++; и эта концепция мне очень понравилась) и полный набор инструментов для обеспечения согласованности стиля кода. Если вы напишете Python; не Google; и, тем не менее, вам нравится чистый код, подумайте об использовании Black.
Со страницы своего проекта:
Используя его, вы соглашаетесь передать контроль над мелочами ручного форматирования. В свою очередь, Black дает вам скорость, детерминизм и свободу от ворчаний пикодестила по поводу форматирования. Вы сэкономите время и силы для более важных дел.
Почерневший код выглядит одинаково независимо от проекта, который вы читаете. Через некоторое время форматирование станет прозрачным, и вы сможете сосредоточиться на содержании.
Использовать его очень просто: в вашем Pipfile
используйте:
[dev-packages] black = "==18.9b0"
Прикрепить к выпуску необходимо, пока Проблема 517 не будет решена, или используйте флаг --pre
, затем запустите:
pipenv install --dev
И чтобы запустить автоформатер:
pipenv run black -l 100 src tests
предполагая, что ваш код Python находится в папках src
и tests
; это также изменяет длину строки до 100 столбцов.
Мы также рекомендуем добавить это в ловушку перед фиксацией (сценарий в .git/hooks/pre-commit
), чтобы код автоматически форматировался перед переходом к PR (и тогда люди будут смеяться над вами, потому что вы забыли запустить черный).
Удачного (чистого) кодирования!