Декораторы в Python: примеры использования
Сегодня мы поговорим о такой особенности языка Python как декораторы. Декораторы – это специально созданные функции, которые помогают добавить дополнительную функциональность в уже существующий код. Интересен тот факт, что в других языках (например, в С) подобных штук нет.
Декоратор меняет поведение других функций. При этом он не прерывает работу основной функции. Декораторы в Python могут быть как функциями, так и классами. Обычно декораторы вызываются перед определением функции, которую нужно декорировать.
Ниже давайте рассмотрим различные примеры использования декораторов.
Декораторы в Python: примеры использования
Пример 1
Пример 2
Во wrapper у нас сначала идет вывод первого сообщения (first message), затем функция, которая собственно и оборачивается в обертку при помощи декоратора, а затем — вывод второго сообщения (second message).
После этого «декорируем» decorator2, как показано в предпоследней строке кода. И, наконец, последней строчкой кода мы вызываем декорированную функцию.
В выводе сначала отображается первое сообщение. После этого выводится третье сообщение (вследствие вызова функции decorator2 ). А второе сообщение отображается лишь в конце.
Возврат значений из декорированных функций
Следующий пример касается передачи или получения аргументов в декораторе. Это чем-то похоже на передачу значений в обычные функции.
Ниже мы видим результат — python печатается первым, а Сoding is easy печатается позже. Это из-за порядка вызова функций с аргументами.
Создание цепочки декораторов
Мы составили цепочку декораторов с помощью символов звездочки и плюса. В данном примере для декорирования функции используется более одного декоратора.
Сначала определяем оба декоратора, со звездочками и плюсами. Затем оба декоратора прикрепляются к функции function() : они указываются над функцией, а перед ними ставится знак @. Таким образом функция модифицируется, а вывод будет декорированным.
В обертках звездочки и плюсы добавлены до и после вызова функции. В результате с каждой стороны строки прикрепляется по 5 звездочек и 3 знака «плюс».
Добавление нескольких декораторов к одной функции
Пропишем два декоратора. Первый — для разделения строки. Второй — для приведения к верхнему регистру. После этого, под вызовами, мы определим еще один декоратор, который разделит предложение и сделает его списком.
В приведенном выше коде сначала все буквы предложения переводятся в верхний регистр, а затем предложение разбивается на части. Получившиеся слова возвращаются в виде списка. Обратите внимание, что изначально предложение было написано строчными буквами.
Использование декораторов Python при обработке исключений
Эта строка является основой всей программы, так как проверяет ее работоспособность. Она проверяет, не превышает ли позиция массива размер массива, и в случае превышения выводит сообщение об ошибке. В противном случае функция будет выполнять действие декораторов.
В примере на скриншоте значение индекса больше размера массива. Следовательно, в выводе мы увидим сообщение об ошибке.
Заключение
Сегодня мы рассмотрели декораторы в Python и несколько примеров их использования. Надеемся, это помогло вам понять базовую концепцию работы декораторов в Python.
Декораторы
Рассмотрим где их можно использовать и как написать свой декоратор.
Источники
Лутц, Изучаем Python. глава 38. Декораторы
Пакеты с декорататорами, используемые в заданиях:
Для чего нужны декораторы
Недостатки (любой обертывающей логики):
Вспоминаем работу с функциями
Чтобы понять как работают декораторы, напишем свой декоратор.
Для этого вспомним некоторые идеи питона.
Функции являются объектами
Функции внутри функции
В питоне можно определить функцию внутри функции. Ее можно будет вызвать внутри объемлющей функции. Но нельзя напрямую вызвать вне объемлющей функции.
Видим, что нельзя снаружи объемлющей функции напрямую вызывать вложенную функцию. Но вложенную функцию можно вернуть и потом вызывать из любого места:
Возвращаем функцию из функции
Заметьте, внутри функции hi вложенные функции greet и welcome НЕ вызываются. Они только возвращаются. Вызываются они в других местах (куда функции вернули).
Из функции возвращаются объекты функций greet и welcome.
При вызове hi(name=ali) вызовется функции hi и возвратит ссылку на функцию welcome.
Функцию можно передать аргументом другой функции:
Декораторы позволяют исполнять код до и после вызова функции
Пишем декоратор
Мы уже по сути написали декоратор. Добавим в него еще действия после вызова функции.
Мы обернули вызов нашей функции.
По сути, есть только переменные (глобальные и разных сортов локальные) и вызов функций (в т.ч. compile). Есть замыкания (если функция объявляется внутри другой, то из внутренней функции доступны не только свои локальные переменные, но и локальные переменные внешней)
Декоратор можно написать через синтаксис с @.
Выражение @a_new_decorator это сокращенная версия следующего кода:
Но у нас перестало работать __name__ так, как мы хотим (печатать имя вот этой самой функции):
Наша функция a_function_requiring_decoration была заменена на wrapTheFunction. Она перезаписала имя и строку документации оригинальной функции. Это можно исправить, используя functools.wrap:
Как сделать декоратор
Примечание: @wraps принимает на вход функцию для декорирования и добавляет функциональность копирования имени, строки документации, списка аргументов и т.д. Это открывает доступ к свойствам декорируемой функции из декоратора.
Использования декораторов
Авторизация
Декораторы могут использоваться в веб-приложениях для проверки авторизации пользователя, перед тем как открывать ему доступ к функционалу. Они активно используются в веб-фреймворках Flask и Django. Вот пример проверки авторизации на декораторах:
Логирование
Декораторы с аргументами
Является ли @wraps декоратором или она обычная функция, которая может принимать аргументы?
Когда используется синтаксис @my_decorator, мы применяем декорирующую функцию с аргументом в виде декорируемой функции. В Python все является объектом, в том числе и функци. Можно написать функции, возвращающие декорирующие функции.
Вложенные декораторы внутри функций
Добавим к примеру с логером аргумент в виде файла, куда мы будем логировать:
Декораторы классов
Пусть наш лог-декоратор находится на продакшене и теперь мы хотим, кроме регулярной записи в лог-файл, иметь возможность экстренного уведомления по емейл в случае ошибок.
Звучит как повод написать класс-наследник, но мы до этого работали с декораторами функций. Они связывали имена функций с другим вызываемым объектом на этапе определения фукнции.
Посмортрим на декораторы классов, которые будут связывать имя класса с другим вызываемым объектом на этапе его пределения.
Такое решение имеет дополнительно преимущество в краткости, в сравнении с вложенными функциями, при этом синтаксис декорирования функции остается прежним:
Расширим класс logit, чтобы notify мог посылать емейл:
@email_logit будет работать также как и @logit, при этом отправляя сообщения на почту администратору помимо журналирования.
Еще о декораторах
Управление функцией сразу после ее создания:
Так как функции func присваивается та же оригинальная функция funс, то такой декоратор просто что-то делает после определения функций.
Можно использовать для регистрации функции в прикладном интерфейсе, присоединения атрибутов функции и тп.
Мы изучали больше перехват вызова функции:
Декоратор вызывается на этапе декорирования. Возвращаемый объект будет вызываться при вызове функции. Возвращаемый объект может принимать любые аргументы, которые передаются в декорируемую функцию.
Аналогично, при декорировании класса объект экземпляра является всего лишь первым аргументом возвращаемого вызываемого объекта.
Т.е. при декорировании фукнции:
Для каждой декорированной функции создается новая область видимости, в которой сохраняется информация о состоянии.
При декорировании с помощью класса:
Для каждой декорированной функции создается новый экземпляр, хранящий информацию о состоянии в своих атрибутах.
В методах класса первым аргуметом идет self, поэтому такой класс-декоратор не работает для декорирования методов.
Декорирование методов
Для одновременной поддержки возможности декорирования функций и методов лучше всего применять вложенные функции:
Декораторы классов
Можно декорировать класс. Конструкция
Результат работы декоратора вызывается, когда позднее в программе нужно создать экземпляр класса. Например, чтобы выполнить некоторые операции сразу после создания класса, нужно вернуть сам оригинальный класс:
Если нужно добавить обертывающую логику, которая будет перехватывать создание экземпляра класса С, то нужно возвращать вызываемый объект:
Цитата (Лутц, с 1096) В этом примере декоратор присвоит оригинальному имени класса другой класс, который сохраняет оригинальный класс в области видимости объемлющей функции, создает и встраивает экземпляр оригинального класса при вызове. Когда позднее будет выполнена попытка прочитать значение атрибута экземпляра, она будет перехвачена методом __getattr__ обертки и делегирована встроенному экземпляру оригинального класса. Кроме того, для каждого декорированного класса создается новая область видимости объемлющей функции, в которой сохраняется оригинальный класс.
Поддержка множества экземпляров
Тут будет ОДИН экземпляр класса С
пример подробнее с печатью:
Можно исправить, вернув из Decorator.__call__ не self, а self.wrapped.
Альтернативный подход будет описан ниже.
Вложение декораторов
Напишем декоратор, который измеряет сколько времени занимает вызов функции и будет суммировать это время для разных вызовов.
До Python 3.3 для этого можно использовать функцию time.clock(). Начиная с Python 3.3 лучше использовать time.perf_counter() или time.process_time().
Измерение времени генерации списков против времени создания с использованием функции map имеет смысл до Python 2.6, потому что далее map возвращает генератор (т.е. отрабатывает мгновенно) и нужно сравнивать уже итерацию по генератору и по списку.
Добавим аргументы в декоратор timer
Хочется, чтобы каждый таймер имел метку для вывода (например, печатать ==> ), а так же отключать и включать сообщения.
Для передачи аргумента в декоратор можно написать функцию-декоратор:
Задачи
Задача 0. @logit
Дописать в декоратор logit логирование аргументов, с которым была вызвана функция
Задача 1. @timer в виде вложенных функций
Реализовать декоратор @timer через вложенные функции. Должно работать:
Задача 2. @logit + @timer
Проверить, что оба декоратора могут быть одновременно применены к одной и той же функции.
Задача 3. класс-декоратор
Написать декоратор @timer с использованием класса так, чтобы им можно было декорировать методы класса.
Задача 4. Два класс-декоратора
Реализовать два декоратора через классы (@timer, @logit).
Можно ли ими декорировать одновременно?
Задача 5. Декоратор класса
Использовать декоратор
Напишите пример использования декоратора Easy Dump of Function Arguments
Посмотрите, как он работает для переданных в виде аргументов списков и словарей.
Декораторы
Декораторы в Python и примеры их практического использования.
Итак, что же это такое? Для того, чтобы понять, как работают декораторы, в первую очередь следует вспомнить, что функции в python являются объектами, соответственно, их можно возвращать из другой функции или передавать в качестве аргумента. Также следует помнить, что функция в python может быть определена и внутри другой функции.
Вспомнив это, можно смело переходить к декораторам. Декораторы — это, по сути, «обёртки», которые дают нам возможность изменить поведение функции, не изменяя её код.
Создадим свой декоратор «вручную»:
Наверное, теперь мы бы хотели, чтобы каждый раз, во время вызова stand_alone_function, вместо неё вызывалась stand_alone_function_decorated. Для этого просто перезапишем stand_alone_function:
Собственно, это и есть декораторы. Вот так можно было записать предыдущий пример, используя синтаксис декораторов:
То есть, декораторы в python — это просто синтаксический сахар для конструкций вида:
При этом, естественно, можно использовать несколько декораторов для одной функции, например так:
И используя синтаксис декораторов:
Также нужно помнить о том, что важен порядок декорирования. Сравните с предыдущим примером:
Передача декоратором аргументов в функцию
Однако, все декораторы, которые мы рассматривали, не имели одного очень важного функционала — передачи аргументов декорируемой функции. Собственно, это тоже несложно сделать.
Декорирование методов
Один из важных фактов, которые следует понимать, заключается в том, что функции и методы в Python — это практически одно и то же, за исключением того, что методы всегда ожидают первым параметром ссылку на сам объект (self). Это значит, что мы можем создавать декораторы для методов точно так же, как и для функций, просто не забывая про self.
Конечно, если мы создаём максимально общий декоратор и хотим, чтобы его можно было применить к любой функции или методу, то можно воспользоваться распаковкой аргументов:
Декораторы с аргументами
А теперь попробуем написать декоратор, принимающий аргументы:
Теперь перепишем данный код с помощью декораторов:
Вернёмся к аргументам декораторов, ведь, если мы используем функцию, чтобы создавать декораторы «на лету», мы можем передавать ей любые аргументы, верно?
Таким образом, мы можем передавать декоратору любые аргументы, как обычной функции. Мы можем использовать и распаковку через *args и **kwargs в случае необходимости.
Некоторые особенности работы с декораторами
Последняя проблема частично решена добавлением в модуле functools функции functools.wraps, копирующей всю информацию об оборачиваемой функции (её имя, из какого она модуля, её документацию и т.п.) в функцию-обёртку.
Забавным фактом является то, что functools.wraps тоже является декоратором.
Примеры использования декораторов
Декораторы могут быть использованы для расширения возможностей функций из сторонних библиотек (код которых мы не можем изменять), или для упрощения отладки (мы не хотим изменять код, который ещё не устоялся).
Также полезно использовать декораторы для расширения различных функций одним и тем же кодом, без повторного его переписывания каждый раз, например:
Понимаем декораторы в Python’e, шаг за шагом. Шаг 1
На Хабре множество раз обсуждалась тема декораторов, однако, на мой взгляд, данная статья (выросшая из одного вопроса на stackoverflow) описывает данную тему наиболее понятно и, что немаловажно, является «пошаговым руководством» по использованию декораторов, позволяющим новичку овладеть этой техникой сразу на достойном уровне.
Итак, что же такое «декоратор»?
Впереди достаточно длинная статья, так что, если кто-то спешит — вот пример того, как работают декораторы:
Те же из вас, кто готов потратить немного времени, приглашаются прочесть длиииинный пост.
Функции в Python’e являются объектами
Для того, чтобы понять, как работают декораторы, в первую очередь следует осознать, что в Python’е функции — это тоже объекты.
Давайте посмотрим, что из этого следует:
Запомним этот факт, скоро мы к нему вернёмся, но кроме того, стоит понимать, что функция в Python’e может быть определена… внутри другой функции!
Ссылки на функции
Ну что, вы всё ещё здесь?:)
Подождите, раз мы можем возвращать функцию, значит, мы можем и передавать её другой функции, как параметр:
Ну что, теперь у нас есть все необходимые знания для того, чтобы понять, как работают декораторы.
Как вы могли догадаться, декораторы — это, по сути, просто своеобразные «обёртки», которые дают нам возможность делать что-либо до и после того, что сделает декорируемая функция, не изменяя её.
Создадим свой декоратор «вручную»
Наверное, теперь мы бы хотели, чтобы каждый раз, во время вызова a_stand_alone_function, вместо неё вызывалась a_stand_alone_function_decorated. Нет ничего проще, просто перезапишем a_stand_alone_function функцией, которую нам вернул my_shiny_new_decorator:
Вы ведь уже догадались, что это ровно тоже самое, что делают @декораторы.:)
Разрушаем ореол таинственности вокруг декораторов
Вот так можно было записать предыдущий пример, используя синтаксис декораторов:
Да, всё действительно так просто! decorator — просто синтаксический сахар для конструкций вида:
Декораторы — это просто pythonic-реализация паттерна проектирования «Декоратор». В Python включены некоторые классические паттерны проектирования, такие как рассматриваемые в этой статье декораторы, или привычные любому пайтонисту итераторы.
Конечно, можно вкладывать декораторы друг в друга, например так:
И используя синтаксис декораторов:
Следует помнить о том, что порядок декорирования ВАЖЕН:
На этом моменте Вы можете счастливо уйти, с осознанием того, что вы поняли, что такое декораторы и с чем их едят.
Для тех же, кто хочет помучать ещё немного свой мозг, завтра будет допереведена вторая часть статьи, посвящённая продвинутому использованию декораторов.
Декораторы в Python: понять и полюбить
Декораторы — один из самых полезных инструментов в Python, однако новичкам они могут показаться непонятными. Возможно, вы уже встречались с ними, например, при работе с Flask, но не хотели особо вникать в суть их работы. Эта статья поможет вам понять, чем являются декораторы и как они работают.
Что такое декоратор?
Новичкам декораторы могут показаться неудобными и непонятными, потому что они выходят за рамки «обычного» процедурного программирования как в Си, где вы объявляете функции, содержащие блоки кода, и вызываете их. То же касается и объектно-ориентированного программирования, где вы определяете классы и создаёте на их основе объекты. Декораторы не принадлежат ни одной из этих парадигм и исходят из области функционального программирования. Однако не будем забегать вперёд, разберёмся со всем по порядку.
Декоратор — это функция, которая позволяет обернуть другую функцию для расширения её функциональности без непосредственного изменения её кода. Вот почему декораторы можно рассматривать как практику метапрограммирования, когда программы могут работать с другими программами как со своими данными. Чтобы понять, как это работает, сначала разберёмся в работе функций в Python.
Как работают функции
Все мы знаем, что такое функции, не так ли? Не будьте столь уверены в этом. У функций Python есть определённые аспекты, с которыми мы нечасто имеем дело, и, как следствие, они забываются. Давайте проясним, что такое функции и как они представлены в Python.
Функции как процедуры
С этим аспектом функций мы знакомы лучше всего. Процедура — это именованная последовательность вычислительных шагов. Любую процедуру можно вызвать в любом месте программы, в том числе внутри другой процедуры или даже самой себя. По этой части больше нечего сказать, поэтому переходим к следующему аспекту функций в Python.
Функции как объекты первого класса
В Python всё является объектом, а не только объекты, которые вы создаёте из классов. В этом смысле он (Python) полностью соответствует идеям объектно-ориентированного программирования. Это значит, что в Python всё это — объекты:
Тот факт, что всё является объектами, открывает перед нами множество возможностей. Мы можем сохранять функции в переменные, передавать их в качестве аргументов и возвращать из других функций. Можно даже определить одну функцию внутри другой. Иными словами, функции — это объекты первого класса. Из определения в Википедии:
Объектами первого класса в контексте конкретного языка программирования называются элементы, с которыми можно делать всё то же, что и с любым другим объектом: передавать как параметр, возвращать из функции и присваивать переменной.
И тут в дело вступает функциональное программирование, а вместе с ним — декораторы.
Функциональное программирование — функции высших порядков
В Python используются некоторые концепции из функциональных языков вроде Haskell и OCaml. Пропустим формальное определение функционального языка и перейдём к двум его характеристикам, свойственным Python:
Функциональному программированию присущи и другие свойства вроде отсутствия побочных эффектов, но мы здесь не за этим. Лучше сконцентрируемся на другом — функциях высших порядков. Что есть функция высшего порядка? Снова обратимся к Википедии:
Функции высших порядков — это такие функции, которые могут принимать в качестве аргументов и возвращать другие функции.
Если вы знакомы с основами высшей математики, то вы уже знаете некоторые математические функции высших порядков порядка вроде дифференциального оператора d/dx. Он принимает на входе функцию и возвращает другую функцию, производную от исходной. Функции высших порядков в программировании работают точно так же — они либо принимают функцию(и) на входе и/или возвращают функцию(и).
Пара примеров
Раз уж мы ознакомились со всеми аспектами функций в Python, давайте продемонстрируем их в коде:
Здесь мы определили простую функцию. Из фрагмента кода далее вы увидите, что эта функция, как и классы с числами, является объектом в Python:
Теперь давайте посмотрим на функции в качестве объектов первого класса.
Мы можем хранить функции в переменных:
Определять функции внутри других функций:
Передавать функции в качестве аргументов и возвращать их из других функций:
Из этих примеров должно стать понятно, насколько функции в Python гибкие. С учётом этого можно переходить к обсуждению декораторов.
Как работают декораторы
Повторим определение декоратора:
Декоратор — это функция, которая позволяет обернуть другую функцию для расширения её функциональности без непосредственного изменения её кода.
Раз мы знаем, как работают функции высших порядков, теперь мы можем понять как работают декораторы. Сначала посмотрим на пример декоратора:
Здесь decorator_function() является функцией-декоратором. Как вы могли заметить, она является функцией высшего порядка, так как принимает функцию в качестве аргумента, а также возвращает функцию. Внутри decorator_function() мы определили другую функцию, обёртку, так сказать, которая обёртывает функцию-аргумент и затем изменяет её поведение. Декоратор возвращает эту обёртку. Теперь посмотрим на декоратор в действии:
Иными словами, выражение @decorator_function вызывает decorator_function() с hello_world в качестве аргумента и присваивает имени hello_world возвращаемую функцию.
И хотя этот декоратор мог вызвать вау-эффект, он не очень полезный. Давайте взглянем на другие, более полезные (наверное):
Здесь мы создаём декоратор, замеряющий время выполнения функции. Далее мы используем его на функции, которая делает GET-запрос к главной странице Google. Чтобы измерить скорость, мы сначала сохраняем время перед выполнением обёрнутой функции, выполняем её, снова сохраняем текущее время и вычитаем из него начальное.
После выполнения кода получаем примерно такой результат:
К этому моменту вы, наверное, начали осознавать, насколько полезными могут быть декораторы. Они расширяют возможности функции без редактирования её кода и являются гибким инструментом для изменения чего угодно.
Используем аргументы и возвращаем значения
В приведённых выше примерах декораторы ничего не принимали и не возвращали. Модифицируем наш декоратор для измерения времени выполнения:
Вывод после выполнения:
Как вы видите, аргументы декорируемой функции передаются функции-обёртке, после чего с ними можно делать что угодно. Можно изменять аргументы и затем передавать их декорируемой функции, а можно оставить их как есть или вовсе забыть про них и передать что-нибудь совсем другое. То же касается возвращаемого из декорируемой функции значения, с ним тоже можно делать что угодно.
Декораторы с аргументами
Мы также можем создавать декораторы, которые принимают аргументы. Посмотрим на пример:
Здесь мы модифицировали наш старый декоратор таким образом, чтобы он выполнял декорируемую функцию iters раз, а затем выводил среднее время выполнения. Однако чтобы добиться этого, пришлось воспользоваться природой функций в Python.
Да, это может быть действительно сложно уместить в голове, поэтому держите правило:
Декоратор принимает функцию в качестве аргумента и возвращает функцию.
Объекты-декораторы
Напоследок стоит упомянуть, что не только функции, а любые вызываемые объекты могут быть декоратором. Экземпляры классов/объекты с методом __call__() тоже можно вызывать, поэтому их можно использовать в качестве декораторов. Эту функциональность можно использовать для создания декораторов, хранящих какое-то состояние. Например, вот декоратор для мемоизации:
Тут будут перечислены некоторые важные вещи, которые не были затронуты в статье или были затронуты вскользь. Вам может показаться, что они расходятся с тем, что было написано в статье до этого, но на самом деле это не так.
Заключение
Надеемся, эта статья помогла вам понять, какая «магия» лежит в основе работы декораторов.