MLOps Data science knowledge

Почему это важно?

Начинающий программист

Опытный программист

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

В процессе сбора материала для презентации я набрел на исследования, в которых датчики следили за движениями глаз начинающего и опытного программистов. Code style как стандарт разработки

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

Видео довольно старое, от 2012 года, и запись была направлена на исследование процессов мозга программиста. Чуть подробнее можно почитать тут.

Основная мотивация появления CodeStyle

Ускорить понимания и ревью кода.
Уменьшить стилистическое разнообразие кода.
Уменьшить сложность кода.
Сократим использование плохих практик.

Читаемость кода

Есть 2 способа ускорить чтение и понимания кода:

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

Конечно стоит идти по второму пути, поскольку это снизит нагрузку на разработчика, мы выделили следующие поинты, которые дадут повышение читабельности кода:

Если вы обеспечили историческое написание понятного кода, то, сколько бы не приходило и не уходило разработчиков, вы всегда имеете равное качество кода, что позволяет проекту динамично расти вне зависимости от его объема.
Если ваш код написан понятно, новый специалист быстро разберется и начнет приносить пользу. Есть такое понятие, как точка самоокупаемости сотрудника. Это точка, с которой сотрудник начинает приносить больше пользы. А если код написан понятно, новым сотрудникам проще читать ваш код, без необходимости детально разбираться. И чем быстрее он это сделает, тем быстрее перестанет задавать тонны вопросов остальным специалистам, отнимая у них время. А время специалистов, которые прошли точку самоокупаемости, значительно дороже для команды и компании с точки зрения потенциальной ценности приносимой продукту.
Не нужно будет постоянно спотыкаться о чью-то оригинальность и специфическое оформление. Ваш мозг меньше сопротивляется, т.к. не нужно вникать в чужую стилистику. Ментальных ресурсов на чтение понятного кода нужно намного меньше.
Конечно же, важен результат, чтобы ПО работало, но также важно, насколько удобно его изучать и дорабатывать.

Pep8

Структура файла (line length, indentation, blanc lines, break lines, imports, encoding, tabs or spaces)
Разделение пробелами выражений
Комментарии (docstrings, block and inline comments)
Naming convention (переменные, константы, типы, функции, классы, методы)
Аннотации к функциям и переменным
Другие рекомендации