Как в Evrone пишут Python-код?

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

В нашем гайдлайне четыре основных раздела. В разделе «О коде» описываются определенные принципы, следуя которым можно написать читаемый и поддерживаемый код. Условиями являются атомарность операций, логические блоки, размеры методов, функций и модулей, докстринги, файлы __init__.py и импорты.

Есть раздел, связанный с pull request. Как ни странно, не все разработчики знают, как создавать такие запросы или как их рецензировать. Мы решили формализовать решения, чтобы не объяснять это каждому новому разработчику.

Раздел «О тулинге» (о тестах, менеджерах пакетов, форматировании кода и т. д.) помогает привести код каждого отдельного разработчика к общему корпоративному стилю. Чтобы не спорить об индивидуальных предпочтениях, применяются специальные инструменты, которые переписывают весь код согласно определённым правилам.

Отдельный раздел посвящён документации ОреnAPI. Этот формат поддерживается большим количеством клиентов (Swagger, Postman, Insomnia Designer и др.). Кроме того, рукописная документация имеет тенденцию быстро устаревать, а документация, которая генерируется непосредственно из кода, позволяет не думать постоянно об её обновлении.

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