Руководство по стилю Python

Я люблю Python и код Pythonic ️

ТЛ;ДР,

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

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

Мы читаем больше кода, чем пишем, и мне лично нравится читать чужой код. Это познакомило меня с разными стилями написания хорошего кода на Python. Чем чище и лучше структурирован код, тем легче понять, что он делает. Это очень важно, когда вы хотите что-то отлаживать, рефакторить и оптимизировать. Вы просто не можете сделать это с кодом, который вы не можете прочитать и понять.

В Python есть отличное руководство по стилю под названием PEP8. Он охватывает большинство ситуаций, с которыми вы столкнетесь при написании Python. Мне нравится PEP8, и я слежу за тем, чтобы мой код соответствовал рекомендациям PEP8. Я считаю, что в него было вложено много усилий и размышлений. С другой стороны, PEP8 можно рассматривать как общее руководство по Python, поскольку оно допускает различные подходы для достижения схожих целей.

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

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

Вы можете найти мой Руководство по стилю Python на GitHub. Я восхищаюсь своими усилиями по созданию своего собственного руководства по стилю кода по умолчанию.

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

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

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