2015-06-03 2 views
1

Я хочу написать модульный тест для Python, который будет проверять, есть ли в каждом пакете, модуле, классе и методе строка __doc__.Тест на существование docstring

Каков правильный путь к этому? Я думал о том, чтобы сделать эту проверку с рекурсивным импортом.

+0

Обратите внимание, что такие инструменты, как 'pylint', уже проверяют на docstrings, поэтому вы можете посмотреть, как они это делают (или просто использовать их). – jonrsharpe

+0

Я только что нашел это, поэтому я не уверен, что это то, что вам нужно или нет, но, возможно, стоит посмотреть: https://docs.python.org/2/library/doctest.html – stevieb

+0

Я знаю obout doctest, но я не хочу писать код без намека, проверки синтаксиса, раскраски и т. д. Спасибо в любом случае :) – urosjarc

ответ

2

Крик на @jonrsharpe для подсказки obout pylint. :)

Make .pylintrc по умолчанию с помощью следующей команды:

pylint --generate-rcfile > .pylintrc 

Редактировать изменение переменной-строка документации мин длиной до:

docstring-min-length=10 

Затем выполнить этот сценарий ... эхо напечатает выход код из теста pylint:

pylint --disable=all --enable=missing-docstring <package-name> 
echo $? 

Если эхо 0, то pylint прошло иначе. Надеюсь, что это hellps;)

Смежные вопросы