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

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

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

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

>>> for name in sys.argv[1:]:
>>>     exec "%s=1" % name
>>> def func(s, **kw):
>>>     for var, val in kw.items():
>>>         exec "s.%s=val" % var  # недопустимо!
>>> execfile("handler.py")
>>> handle()

>>> d = {}
>>> for name in sys.argv[1:]:
>>>     d[name] = 1
>>> def func(s, **kw):
>>>     for var, val in kw.items():
>>>         setattr(s, var, val)
>>> d={}
>>> execfile("handle.py", d, d)
>>> handle = d['handle']
>>> handle()

# 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")
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. То же самое произойдёт, если файл существует, но нет прав на чтение. Поскольку тестирование на обычной машине на существующих и несуществующих файлах кажется безошибочным, результаты тестов будут выглядеть хорошо, и код будет выпущен. Позже необработанное IOError (или, возможно, другое EnvironmentError) дойдёт до пользователя, который увидит неприглядную трассировку.

Вот несколько более удачный способ.

def get_status(file):
    try:
        return open(file).readline()
    except EnvironmentError as err:
        print "Unable to open file: {}".format(err)
        sys.exit(1)

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

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

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

Но есть способ лучше. Следует стараться использовать как можно меньше конструкций except в своём коде – те, что используются, обычно находятся внутри вызовов, которые всегда должны завершаться успешно, или как всеобъемлющий перехват в главной функции.

Итак, ещё лучшая версия get_status(), вероятно,

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

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

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

Лучшая версия этой функции использует вызов open() в качестве менеджера контекста, что гарантирует закрытие файла сразу после возврата функции:

def get_status(file):
    with open(file) as fp:
        return fp.readline()

Использование встроенных средств¶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(). Ещё одна чрезвычайно полезная функция – reduce(), которую можно использовать для многократного применения бинарной операции к последовательности, сводя её к одному значению. Например, вычислить факториал с помощью серии операций умножения:

>>> n = 4
>>> import operator
>>> reduce(operator.mul, range(1, n+1))
24

Что касается разбора чисел, обратите внимание, что float(), int() и long() все принимают строковые аргументы и будут отклонять некорректные строки, порождая 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))