Как обычно, слушая Python Bytes 181 Я слышал о инструменте, который я должен был попробовать сразу!
Эта вещь 🔥 горячо от прессы, мы говорим первый релиз только 3 недели назад. Это то, что сообщество Python нужно несколько лет назад, и он принадлежит к твоему CI сегодня . Я пробовал несколько инструментов, которые пытались сделать покрытие DOCSTRING в прошлом, но они были немного громоздкими и были быстро забыты. Не допросить, его мертвые!
Ничего, я пытался, пришел близко к этому хорошо
Он запускает охват документации для вашего проекта Python. Это позволяет устанавливать минимальное количество покрытия DOCSTRING для вашего проекта и имеет несколько отличных инструкций по настройке прямо в README.
Установите его
Запрос на Pypi, так что это супер просто, чтобы установить с пипс
pip install interrogate
запустить его
Это лучшая часть, его супер легко запустить прямо из командной строки! Просто назовите это и дайте ему путь к бегу.
interrogate -v
😲 У меня есть какая-то работа, чтобы сделать
Один из моих новых пакетов с открытым исходным кодом Find-Kedro только ударил 71%.
interrogate find-kedro -v
Лично мне очень нравится Двойной многолетний Вывод, который дает вам имена всего, что отсутствует DOCSTRING и линия, на которой они возникают.
interrogate find-kedro -vv
Дать ему ⭐
Каждый проект этот удивительный заслуживает большой OL ⭐ на Github! Перейти к EconChick/допрос И дать ему один … это заслуживает этого! Пока вы там проверьте злые Хорошо Readme. Он имеет отличные примеры того, как запустить его из вашей командной строки, как предварительный коммит, в вашем CI, с вашим кодом или PYPROJECT.TOML.
Пока вы там проверьте злые Хорошо readme!
Что вы думаете? 👇
Оставьте его в комментариях о том, что вы считаете минимальным покрытием DocString для проекта.
Оригинал: “https://dev.to/waylonwalker/interrogate-is-a-pretty-awesome-brand-new-cli-for-python-packages-52ai”