Идиомы и анти-идиомы в Python¶Idioms and Anti-Idioms in Python

Конструкции языка, которые не следует использовать¶Language Constructs You Should Not Use

Хотя в Python относительно мало «подводных камней» по сравнению с другими языками, в нём всё ещё есть конструкции, которые полезны только в крайних случаях или откровенно опасны.

f = open("www")
f.read()

# foo.py
a = 1

# bar.py
from foo import a
if something():
    a = 2 # опасность: foo.a != a

# foo.py
a = 1

# bar.py
import foo
if something():
    foo.a = 2

try:
    foo = opne("file") # опечатка в "open"
except:
    sys.exit("could not open file!")

try:
    foo = opne("file") # будет изменён на "open", как только будет запущен
except IOError:
    sys.exit("could not open file")

Исключения¶Exceptions

Исключения – полезная возможность Python. Стоит научиться возбуждать их всякий раз, когда происходит что-то неожиданное, и перехватывать только там, где можно на них повлиять.

Ниже приведён очень популярный антипаттерн.

def get_status(file):
    if not os.path.exists(file):
        print("file not found")
        sys.exit(1)
    return open(file).readline()

Рассмотрим случай, когда файл удаляется между вызовом os.path.exists() и вызовом open(). Это означает, что последняя строка вызовет исключение IOError. То же самое произойдёт, если file существует, но нет прав на чтение. Поскольку при тестировании на обычной машине с существующими и несуществующими файлами ошибка не проявляется, результаты тестирования будут выглядеть нормально, и код будет выпущен. Тогда необработанное исключение IOError доходит до пользователя, который вынужден смотреть на некрасивую трассировку.

Вот более правильный способ:

def get_status(file):
    try:
        return open(file).readline()
    except (IOError, OSError):
        print("file not found")
        sys.exit(1)

В этой версии либо файл открывается и строка читается (так что это работает даже на ненадёжных соединениях NFS или SMB), либо выводится сообщение и приложение завершается.

Тем не менее, get_status() делает слишком много предположений – что она будет использоваться только в коротком скрипте, а не, скажем, в долго работающем сервере. Конечно, вызывающий код мог бы сделать что-то вроде

try:
    status = get_status(log)
except SystemExit:
    status = None

Поэтому старайтесь использовать как можно меньше конструкций except в коде – обычно они нужны как универсальный обработчик в main() или внутри вызовов, которые всегда должны завершаться успешно.

Итак, вероятно, лучший вариант:

def get_status(file):
    return open(file).readline()

Вызывающий код может обработать исключение, если захочет (например, если он перебирает несколько файлов в цикле), или просто позволить исключению всплыть к своему вызывающему.

Последний вариант тоже не очень хорош – из-за особенностей реализации файл не будет закрыт при возникновении исключения, пока не завершится обработчик, а возможно, и вовсе не будет закрыт в реализациях, отличных от C (например, Jython).

def get_status(file):
    fp = open(file)
    try:
        return fp.readline()
    finally:
        fp.close()

Использование встроенных средств¶Using the Batteries

Время от времени кто-то снова пытается написать что-то для стандартной библиотеки Python, обычно плохо. Хотя у некоторых модулей интерфейс оставляет желать лучшего, обычно гораздо лучше использовать богатую стандартную библиотеку и типы данных, входящие в Python, чем изобретать свои собственные.

Полезный модуль, о котором очень мало кто знает, – это os.path. Он всегда содержит правильные операции с путями для вашей операционной системы и обычно будет гораздо лучше того, что вы придумаете сами.

Сравните:

# фу!
return dir+"/"+file
# лучше
return os.path.join(dir, file)

Ещё полезные функции из os.path: basename(), dirname() и splitext().

Есть также много полезных встроенных функций, о которых люди по какой-то причине не знают: min() и max() могут находить минимум/максимум любой последовательности со сравниваемой семантикой, например, но многие пишут свои собственные max()/min(). Ещё одна очень полезная функция – functools.reduce(). Классическое использование reduce() выглядит примерно так:

import sys, operator, functools
nums = list(map(float, sys.argv[1:]))
print(functools.reduce(operator.add, nums) / len(nums))

Этот маленький скрипт выводит среднее значение всех чисел, переданных в командной строке. reduce() суммирует все числа, а остальное – просто подготовка и обработка результатов.

Кстати, обратите внимание, что float() и int() принимают аргументы строкового типа и поэтому подходят для разбора – при условии, что вы готовы обрабатывать ValueError, которое они вызывают.

Использование обратного слеша для продолжения инструкций¶Using Backslash to Continue Statements

Поскольку Python рассматривает перевод строки как завершитель инструкции, и поскольку инструкции часто бывают слишком длинными, чтобы поместить их в одну строку, многие делают так:

if foo.bar()['first'][0] == baz.quux(1, 2)[5:9] and \
   calculate_number(10, 20) != forbulate(500, 360):
      pass

Следует понимать, что это опасно: случайный пробел после \ сделает эту строку неверной, а случайные пробелы, как известно, трудно заметить в редакторах. В этом случае будет хотя бы синтаксическая ошибка, но если бы код был:

value = foo.bar()['first'][0]*baz.quux(1, 2)[5:9] \
        + calculate_number(10, 20)*forbulate(500, 360)

то ошибка была бы неявной.

Обычно гораздо лучше использовать неявное продолжение внутри скобок:

Эта версия защищена от ошибок:

value = (foo.bar()['first'][0]*baz.quux(1, 2)[5:9]
        + calculate_number(10, 20)*forbulate(500, 360))