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

Синтаксис, правила написания кода в Python

Одним из ключевых моментов PEP 8 является то, что код читается гораздо чаще, чем пишется. Приведенные здесь рекомендации предназначены для улучшения читабельности кода и обеспечения его согласованности с широким спектром кода Python. Как говориться в Дзене Python "Читаемость имеет значение".

Руководство по стилю о последовательности:

• Согласованность с PEP 8 по стилю кодирования очень важна.
• Согласованность внутри проекта важнее.
• Согласованность внутри одного модуля или функции является наиболее важной.

Однако, иногда рекомендации по стилю просто не применимы. В случае сомнений используйте свое решение. Посмотрите на другие примеры и решите, что выглядит лучше. И не стесняйтесь спрашивать! В общем, не нарушайте обратную совместимость только из за соблюдения PEP 8!

Некоторые другие веские причины игнорировать это руководство:

• Применение PEP 8 в проекте сделает код менее читабельным, даже для тех, кто привык читать код, который следует этому PEP.
• Рассматриваемый код похож по стилю с ранее написанным кодом, который также нарушает PEP 8 (возможно, по историческим причинам) - хотя это возможность привести чужой код в порядок.
• Рассматриваемый код предшествует введению руководства, и нет никаких других причин для изменения этого кода.
• Когда код может остаться совместимым со старыми версиями Python, который не поддерживает функции, рекомендованную в PEP.