пятница, 27 июля 2012 г.

Docstring coverage - покрытие python-кода документацией

Как проверить, что python-разработчики хорошо задокументировали код, кроме как просматривать все руками или генерировать pydoc'ом документацию и сравнивать с исходниками? Вот и я не нашел никакого решения, пока случайно не натолкнулся на старый-престарый скрипт, который вдохновил меня на форк и последующую доработку.

В результате у меня получился полезный инструмент Docstring coverage, позволяющий оценить процентное покрытие кода документацией по всему проекту.

Пускается так:
docstring-coverage [опции] <путь к папке или модулю>


Среди опций есть -m, которая заставляет утилиту пропускать __магические__ методы python и -v, позволяющая настроить уровень "болтливости" вывода от 0 до 3.

Можно импортировать в рабочий проект использовать для получения статистики по покрытию:

import docstringcoverage
cover_results = docstringcoverage.get_docstring_coverage('somefolder/somefile.py')

Вся документация с примерами есть на странице проекта.


Комментариев нет:

Отправить комментарий