Хабрахабр

Мелкая питонячая радость #4: Radon — качество кода, измеренное в числах

Поэтому нет ничего удивительного в том, что они пытаются измерять в численном виде такую нетривиальную штуку, как качество кода. Инженеры очень любят измерения и числа.

Подробно про все существующие способы обмазывания кода всякими метриками можно почитать в этой статье. Метрик для оценки текстов программ придумали немало — от банального количества строк кода в проекте до не столь очевидного "индекса поддерживаемости" (Maintainability Index).

Она называется radon. В мире Python, конечно же, есть своя штука для оценки качества кода. Она написана на этом же самом Python и работает исключительно с питонячими файлами.

Ставим ее себе

pip install radon

Переходим в папку с вашим кодом и начинаем мерять.

Сырые статистические данные

А еще числа строк, непосредственно содержащих код и числа строк-комментов. Банальный подсчет числа строк в исходниках. Не очень информативная метрика, но она требуется для дальнейших вычислений.

radon raw ./

В ответ вам вывалится список файлов в проекте и статистика по каждому файлу.

Цикломатическая сложность

Метрика, которая измеряет сложность кода, опираясь на количество этих операций, называется цикломатической сложностью программы. Чем больше в коде переходов (if-else), циклов, генераторов, обработчиков исключений и логических операторов — тем больше у программы вариантов исполнения и тем сложнее удержать в голове различные состояния системы.

Считается она командой

radon cc ./

Индекс укажет на перегруженные логикой места, которые можно разбить на куски помельче, упростить или переписать (если есть такая возможность — алгоритм может быть очень сложным сам по себе и попытки его разбить на куски могут только ухудшить понимабельность кода). В ответ вы получите список файлов, классов, методов и функций в вашем проекте и их индекс сложности, от очень простого до очень сложного.

Метрики Холстеда

Полученные значения подставляются в формулы и получается набор чисел, который описывает сложность программы и количество усилий, предположительно затраченное на написание и понимание кода. Тут считаеся количество уникальных операторов и операндов в коде и их общее количество.

radon hal ./

Индекс поддерживаемости кода

Этот параметр рассчитывается на основе чисел, полученных из метрик, посчитанных выше. Этот индекс говорит нам о том, насколько сложно будет поддерживать или редактировать кусок программы.

radon mi ./

В ответ мы получим список файлов в проекте и их индекс поддерживаемости, от легкого до очень тяжелого.

Подробные алгоритмы рассчета метрик и документацию по ним можно смотреть здесь.

Куда это все?

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

  • Вам приходится ревьювить большое количество кода и нет времени уделять много внимания каждому файлу в отдельности. Прогон тестов позволит увидеть функцию, в которой новоприбывший джуниор запилил 40 вложенных условий.
  • Вам приходится рулить разработкой большого числа микросервисов, разбитых на маленькие проекты. Беглая оценка (возможно, даже в автоматическом режиме) позволит найти потенциально проблемные места и отревьювить их в ручном режиме.
  • Конечно же, гонять тесты на опенсорсных либах (особенно какие-нибудь не очень популярные решения с маленьким комьюнити).

Да. Познавательно? Возможно, иногда, может быть, в определенных случаях. Полезно и нужно?

Пожалуй, хороший проект на вечер. Поставить, поиграться, прогнать через метрики пару своих проектов, написать небольшой скрипт и навесить его хуком на коммиты?

Теги
Показать больше

Похожие статьи

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

Кнопка «Наверх»
Закрыть