Материал подготовил: Виталий Евтушенко, НИУ ВШЭ
Редактирование: Алла Тамбовцева, НИУ ВШЭ
Читать про coding style в целом.
Чтобы упростить процессы и жизнь, человечество начало придумывать некие стандарты: стандарты красоты, золотые стандарты, стандарты уровня жизни, стандарты ведения войны, стандарты обработки чисел с плавающей точкой. Можно предположить, что стандартизация не обошла стороной и прикладное программирование. И это предположение будет верным.
Один из стандартов — стандарт оформления кода. Также есть стандарты документации, стандарты используемых библиотек. Почти на всё есть свой стандарт, а иногда ещё и внутренняя/локальная/корпоративная договоренность (конвенция).
В целом, это очень утилитарная идея, которая позволяет унифицировать оформление кода, сделав его более читаемым. Какие основные принципы включают стандарты оформления кода (кода вообще, не только в Python).
Ограничение на количество символов в строке: максимальная возможная длина одного монитора, чтобы не использовать полосу прокрутки (scroll bar).
Осмысленные имена переменных: чтобы другой человек (а также разработчик, который уже через несколько дней ‒ другой человек) понимал, что содержится в переменной. Например, переменная today_temp
вместо A
; number_of_revolution_per_year_in_developing_countries
вместо переменной с названием B
.
Пробелы: ставить пробелы для лучшей читаемости кода.
Отступы vs Пробелы: для отсутствия проблем с компиляцией программы и более быстрого поиска ошибок нужно отличать отступы (табуляция) от пробелов.
С помощью coding style человек, впервые увидевший ваш код, может потратить меньше времени на понимание кода, если он выполнен согласно стандарту («согласно стандарту» - примерно равно согласно «здравому смыслу»).
Возможно, coding style documents не всегда написаны кровью (по аналогии с техникой безопасности и правилами дорожного движения), но написаны ценой человеко-часов, которые стоит экономить.
Совет: прочитайте PEP8, а потом проверьте свое чувство стиля в тесте по второй ссылке. Третья ссылка просто клад — она не только позволяет проверить скопированный в специальное поле код на соответствие стандартам, но и выводит комментарии по каждому недочету!