Я люблю Python и код Python ️
TL;DR,
Отчет по руководству по стилю Python
Это один из первых языков программирования, который я выучил и начал зарабатывать на жизнь его написанием.
Я написал много кода на Python для разных целей на работе и в свободное время. Написание кода, который работает, часто прекрасно, и вы можете жить с ним в течение некоторого времени. Однако для меня этот код также должен быть хорошо написан. Всегда стоит потратить несколько дополнительных минут на приведение в порядок и очистку кода перед его публикацией.
Мы читаем больше кода, чем пишем, и мне лично нравится читать чужой код. Это познакомило меня с различными стилями написания хорошего кода на Python. Чем чище и лучше структурирован код, тем легче понять, что он делает. Это очень важно, когда вы хотите отлаживать, рефакторинговать и оптимизировать вещи. Вы просто не можете сделать это с кодом, который вы не можете прочитать и понять.
В Python есть отличное руководство по стилю под названием PEP8 . Он охватывает большинство ситуаций, в которые вы попадете при написании Python. Мне нравится PEP8, и я убеждаюсь, что мой код соответствует рекомендациям PEP8. Я считаю, что в это было вложено много усилий и размышлений. С другой стороны, PEP8 можно считать общим руководством по Python, поскольку он позволяет использовать различные подходы для достижения схожих целей.
Каждый раз, когда я сталкивался с ситуацией, когда я не был уверен в синтаксисе, я искал его на PEP8, чтобы найти, что два или более способов считаются хорошими. Будучи вовлеченным в большие проекты, где все больше разработчиков ежедневно продвигают код, вещи, как правило, сходят с ума в отношении согласованности.
Я подумал, что было бы неплохо создать самоуверенное руководство в качестве дополнения к PEP8. Это должно уменьшить размышления о правильном синтаксисе и делегировать работу руководству.
Вы можете найти мое руководство по стилю |/Python на GitHub . Я восхищаюсь своими усилиями по разработке собственного руководства по стилю кода по умолчанию.
Не стесняйтесь использовать его, копировать и изменять, чтобы он подходил вам и вашей команде. Это все еще незавершенная работа, поэтому, пожалуйста, извините за любые ошибки. Ваши запросы на вытягивание более чем приветствуются.
Вы не должны сходить с ума, следуя какому-либо руководству и насильно пытаясь применить его там, где оно не подходит. Руководства по стилю созданы для того, чтобы помочь вам сосредоточиться на решении проблем, а не беспокоиться о синтаксисе.
В следующих нескольких постах здесь, на Codementor, я выберу части руководства, чтобы обсудить их. Я надеюсь, что таким образом получу обратную связь от других наставников и познакомлюсь с их стилем написания кода на Python.