loststylus Aug 10 2012 at 11:39

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

2 min

7.1K

Python*

Recovery Mode

+12

Comments 9

Zerstoren Aug 10 2012 at 11:42

Нямка, воспользуюсь. Как-раз есть 2 проекта, которые нужно обязательно сильно покрывать документацией.
Вот и проверю)

Жаль что качество доков оценить невозможно(

loststylus Aug 10 2012 at 11:49

Это да. Я планирую добавить в будущем прстенький анализ длины докстрингов, чтобы предупреждать если они уж слишком короткие — конечно, не замена ручной проверке качества, но хоть что-то :)

G0ran Aug 10 2012 at 12:13

Я, например, проверяю покрытие кода docstring'ами с помощью PyLint — он как раз тоже в процентном соотношении всё выводит.

loststylus Aug 10 2012 at 12:20

Упс, был не в курсе что он это умеет. В гугле по docstring coverage ничего полезного не находилось, когда я искал :(

G0ran Aug 10 2012 at 12:27

Он же как раз проверяет соответствие кода на PEP 8 и Python style guide, соответственно docstring туда тоже входит (PEP 257), вполне удобно, попробуйте :)

loststylus Aug 10 2012 at 12:37

Посмотрел, здорово, действительно есть, правда придется править кофиг, если потребуется проверить только наличие докстрингов без другого анализа :(

aavezel Aug 10 2012 at 12:39

Занятно :)

$> cover.py cover.py
....
Overall statistics:
Docstrings needed: 11; Docstrings exist: 4; Docstrings missing: 7
Total docstring coverage: 36.4%;  Grade: not so good

ЗЫ Спасибо, воспользуюсь. Хотя в PyCharm есть встроенная система оценки покрытия…

loststylus Aug 10 2012 at 12:43

Все никак не оценю PyCharm, надо будет опробовать — буду теперь знать, что хоть где-то еще есть встроенное :)

Кстати, docstring-coverage можно с помощью setup.py install поставить ;)

av0000 Aug 10 2012 at 23:29

Отложил для быстрой проверки наряду с pep8…

Сейчас активно используют sphinx-doc для документирования, а у него есть опция ругаться на неполное покрытие… Пока обхожусь им, если надо именно полостью всё описать. Правда, на недокументированных полях и срытых классах его корёжит, а как отключить ему «respect __all__» при генерации док — пока не разобрался ((

Show the best of all time