В этом разделе приводятся концепции, связанные со стилем (надеемся, вы с ними согласитесь). Зачастую они применимы и к другим языкам. Некоторые следуют непосредственно из «Дзена Питона», другие основаны на здравом смысле. Они подтверждают наш принцип работы: при написании кода Python выбирать наиболее очевидный способ его представления из имеющихся вариантов.
В Python предпочтителен наиболее явный способ выражения:
| Плохой код | Хороший код |
|---|---|
def make_dict(*args): | def make_dict(x, y): |
····x, y = args | ····return {'x': x, 'y': y} |
····return dict(**locals()) |
В примере хорошего кода
В каждой строке размещайте только одно выражение. Использование сложных выражений (вроде абстракция списков (иначе называют списковыми включениями — list comprehensions)) позволяется и даже поощряется за их краткость и выразительность, но признаком хорошего тона будет размещение отдельных выражений на разных строках. Это поможет создавать более простые для понимания разности[37], когда подобное выражение изменяется:
| Плохой код | Хороший код |
|---|---|
print('one'); print('two') | print('one') |
print('two') | |
if x == 1: print('one') | if x == 1: |
····print('one') | |
if ( | cond1 = |
···· | cond2 = |
····# сделать что-нибудь | if cond1 and cond2: |
····# сделать что-нибудь |
Повышение читаемости кода среди питонистов ценится гораздо выше, чем увеличение объема на несколько байт (в случае двух-выражений-print-в-одной-строке) или увеличение времени вычисления на несколько миллисекунд (в случае нескольких-условий-в-отдельных-строках). Кроме того, когда группа разработчиков вносит изменения в открытый код, историю изменений хорошего кода проще расшифровать, поскольку изменение в одной строке может воздействовать только на одно выражение.
Обработка ошибок в Python выполняется с помощью выражения try. Пример из пакета HowDoI (более подробно описывается в разделе «HowDoI» в главе 5) Бена Глейтсмана (Ben Gleitzman) показывает, когда замалчивать ошибки приемлемо:
def format_output(code, args):
····if not args['color']:
········return code
····lexer = None
····# попробуем отыскать лексеры с помощью тегов Stack Overflow
····# или аргументов query
····for keyword in args['query'].split() + args['tags']:
········try:
············lexer = get_lexer_by_name(keyword)
············break
········except ClassNotFound:
············pass
····# лексер не найден, пробуем угадать
····if not lexer:
········lexer = guess_lexer(code)
····return highlight(code,
····················lexer,
····················TerminalFormatter(bg='dark'))
Перед вами часть пакета, который предоставляет сценарий командной строки, позволяющий найти в Интернете (по умолчанию на сайте Stack Overflow) способ выполнить задачу по программированию. Функция format_output() подсвечивает синтаксис, просматривая теги вопроса на предмет строки, которую смог разобрать лексер (также он называется
• поток выполнения входит в блок try (весь код, расположенный между try и except), лексер успешно определяется, цикл прерывается, и функция возвращает код, подсвеченный с помощью выбранного лексера;
• лексер не найден, генерируется и обрабатывается исключение ClassNotFound — и ничего не происходит. Цикл продолжит выполнение до тех пор, пока не завершится самостоятельно или не будет найден лексер;
• генерируется какое-то другое исключение (например, KeyboardInterrupt), которое не обрабатывается и поднимается на верхний уровень, останавливая выполнение.
