Получи случайную криптовалюту за регистрацию!

​​#library #code Interrogate проверка кода на docstring покры | Пристанище Дата Сайентиста

​​#library #code

Interrogate проверка кода на docstring покрытие

Мы на работе продолжаем улучшать нашу кодовую базу. И теперь я расскажу про библиотеку Interrogate. Она проверяет нашу кодовую базу на наличие отсутствующих строк документации.

Документация должна быть так же важна, как и сам код. И он должен жить внутри кода. В Python есть стандартизированный формат документации - docstring.


Установка:
pip install interrogate

Будем использовать это внутри pre-commit хука:
  - id: interrogate
    name: interrogate
    entry: interrogate
    language: python
    args: [-vv, -i, --fail-under=80]
    files: \.py$

Таким образом мы будем считать не покрытым код с меньше чем 80% строками документации.

Пример отработки на скрине.

Документация