Как в Evrone пишут Python-код?
Подходы и практики написания кода разнятся от компании к компании и от команды к команде. В Evrone мы создали собственную подборку гайдлайнов, чтобы привести к общему стандарту корпоративные правила написания кода на Python.
Здесь мы подробно описали, как они работают.
В нашем гайдлайне четыре основных раздела. В разделе «О коде» описываются определенные принципы, следуя которым можно написать читаемый и поддерживаемый код. Условиями являются атомарность операций, логические блоки, размеры методов, функций и модулей, докстринги, файлы __init__.py и импорты.
Есть раздел, связанный с pull request. Как ни странно, не все разработчики знают, как создавать такие запросы или как их рецензировать. Мы решили формализовать решения, чтобы не объяснять это каждому новому разработчику.
Раздел «О тулинге» (о тестах, менеджерах пакетов, форматировании кода и т. д.) помогает привести код каждого отдельного разработчика к общему корпоративному стилю. Чтобы не спорить об индивидуальных предпочтениях, применяются специальные инструменты, которые переписывают весь код согласно определённым правилам.
Отдельный раздел посвящён документации ОреnAPI. Этот формат поддерживается большим количеством клиентов (Swagger, Postman, Insomnia Designer и др.). Кроме того, рукописная документация имеет тенденцию быстро устаревать, а документация, которая генерируется непосредственно из кода, позволяет не думать постоянно об её обновлении.
Подробнее о том, как устроены наши гайдлайны и чем они могут быть полезны вам, читайте у нас на сайте.
Еще новости от компании Evrone
UseStdLibVars: используйте переменные стандартных библиотек. Go-разработчики часто пишут свои собственные переменные или константы, а затем используют их в коде, который обращается к стандартной библиотеке. Поэтому наш Go-разработчик Саша...
Ruby Russia’22: как мы сделали 12 докладов с нуля. Конференция — это прежде всего место, где полторы тысячи рубистов могут собраться и поговорить о своей работе. Но как создать живое общение в онлайне? В конце сентября состоится 14-я ежегодная...
Как прошел второй Evrone Fest. Для нас корпоратив не просто неформальное общение. Evrone — удалённая команда, которая собирается вместе всего раз в год. И для многих это единственный шанс увидеть реального человека, который прячется за буквами в мессенджере...
Лучшее из интервью создателя JSON Дугласа Крокфорда. Мы поговорили с соавтором JavaScript и создателем JSON Дугласом Крокфордом. В интервью Джейсон поделился своим видением настоящего и будущего JavaScript, своим подходом к код-ревью и советами...
Тогда мы идём к вам. Модель пользователя в Django по умолчанию включает в себя электронную почту, имя пользователя и пароль. Но нередко бывают ситуации, когда эту модель необходимо расширить или заменить. Например, вам не нужно имя пользователя...
Большая ложь о Python. В этом году PyConDE и PyData Berlin объединили усилия, чтобы провести самую крутую конференцию для разработчиков Python. PyConDE, немецкая конференция по языку Python, проводится с 2011 года. PyData Berlin — это одно...
Как читать штрихкоды с помощью браузера. На каждой упаковке, в чеках, и даже в рекламе — QR и штрихкоды сегодня повсюду. Распознать их с помощью мобильного телефона не составляет труда, а вот делать это с помощью веб-приложений значительно сложнее...
Советы против выгорания от топ-разработчиков. В старой шутке говорится, что если вам третий день не хочется работать, значит сегодня среда. Но если это повторяется каждую неделю, нужно что-то менять. Выгорание — популярная проблема увлечённых...
Интересные мысли создателя С++ из интервью Evrone. Бьёрн Страуструп (Bjarne Stroustrup) спроектировал и разработал C++. Он также написал ряд книг об этом языке и больше ста научных статей. В интервью Evrone он рассказал, что думает о разнице...
Главное из интервью Дэвида Уолша для Evrone. Дэвид Уолш (David Walsh) — известный фронтенд-разработчик с большим опытом работы с JavaScript, HTML5, CSS, а также PHP и Python. А ещё он ведёт популярный блог. В своём интервью для Evrone Дэвид...