PEP 8, Consistency

Изучаем PEP 8 по частям. Часть 2, A Foolish Consistency is the Hobgoblin of Little Minds.

Тут говорится о том, что:

Бессмысленная последовательность (постоянство) это проклятие недалеких умов.

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

Руководство это — про соответствие. Соответствие вашего кода руководству — это важно. Согласованность кода внутри вашего проекта — еще важнее. Согласованность внутри модуля или функции — наиболее важно.

И самое важное: знайте, когда нужно противоречить. Иногда руководство просто не применимо. Когда сомневаетесь, используйте свой здравый смысл. Посмотрите на примеры и решите, что выглядит лучше (для читаемости кода). Спрашивайте!

В частности: не ломайте обратную совместимость только для соответствия PEP 8!

Еще хорошие причины игнорировать отдельные правила:

1. Когда применение правила делает код менее читабельным, даже для того, кто привык читать код, оформленный по PEP 8.

2. Для поддержки согласованности с окружающим кодом, хотя это возможность почистить код.

3. Когда «неправильный» код был написал до появления этих правил и нет других причин переделывать его.

4. Когда код должен оставаться совместимым с старыми версиями Python, которые не поддерживают фичи, применяемые в руководстве.

http://legacy.python.org/dev/peps/pep-0008/

http://docs.python-guide.org/en/latest/writing/style/

В целом, руководство дает правила, призванные повысить читаемость кода. Если применение правил читаемость кода не повышает, или портит работу проекта — нахер такие правила.

Намекаю: даже соблюдая все правила этикета можно разосраться с окружающими. А можно прекрасно ладить с людьми, ничего не зная о наличии этикета.

original post http://vasnake.blogspot.com/2014/09/pep-8-consistency.html