property python 3 что это
Метод property() в Python
Автор: Кольцов Д · Опубликовано 21.11.2020 · Обновлено 25.11.2020
Конструкция property() возвращает атрибут свойства.
Параметры
Свойство функции принимает четыре необязательных параметра:
Возвращаемое значение из свойства
Метод возвращает атрибут свойства из заданного средства получения, установки и удаления:
Пример 1: Создание атрибута с помощью метода получения, установки и удаления
Здесь _name используется в качестве частной переменной для хранения имени Person.
Теперь мы устанавливаем новое имя атрибута свойства, вызывая метод property().
Как показано в программе, обращение к p.name изнутри вызывает get_name() как getter, set_name() как setter и del_name() как deleteter через напечатанный вывод, присутствующий внутри методов.
Пример 2: Использование декоратора
Вместо использования property() в Python вы можете использовать декоратор @property() для назначения получателя, установщика и удалителя.
Здесь вместо использования property() мы использовали декоратор @property.
Во-первых, мы указываем, что метод name() также является атрибутом Person. Это делается с помощью @property перед методом получения, как показано в программе.
Затем мы используем имя атрибута, чтобы указать установщик и удалитель.
Это делается с помощью @ name.setter для метода установки и @ name.deleter для метода удаления.
Обратите внимание, мы использовали одно и то же имя метода() с разными определениями для определения получателя, установщика и удалителя.
Изучаем Декораторы в Python
Декораторы Python весьма хороши, однако их достаточно сложно понять при первом знакомстве. Декоратор в Python – это функция, которая принимает другую функцию в качестве аргумента. Декоратор модифицирует или улучшает принятую функцию и выдает измененную. Это значит, что когда вы вызываете декорированную функцию, вы получите функцию, которая может иметь небольшие отличия, в виде дополнительных функций, совмещенных с базовым определением. Нам нужно рассмотреть основу декоратора, а именно функцию.
Простая функция
Python Функция это блок кода, который начинается с ключевого слова def, с дальнейшим названием функции. Функция может принимать от нуля и более аргументов, ключевые аргументы или сочетание этих аргументов. Функция всегда выдает результат. Если вы не определили, что именно она должна выдавать, она выдаст None. Вот очень простой пример функции, которая выдает строку:
Все что мы сделали в этом коде, это вызвали функцию и указали значение выдачи. Давайте создадим другую функцию:
Эта функция принимает один аргумент и этот аргумент должен быть функцией или вызываемой. По факту, ее стоит вызывать, используя определенную в прошлом функцию. Вы заметите, что это функция содержит вложенную внутрь функцию, которую мы называем other_func. Она принимает результат переданной функции, её выражение и создает строку, которая говорит нам о том, что мы сделали, после чего она возвращается.
Давайте взглянем на полную версию данного кода:
Так и работает декоратор. Мы создали одну функцию и передали её другой второй функции. Вторая функция является функцией декоратора. Декоратор модифицирует или усиливает функцию, которая была передана и возвращает модификацию. Если вы запустите этот код, вы увидите следующий выход в stdout:
Давайте немного изменим код, чтобы превратить another_function в декоратор:
Обратите внимание на то, что декоратор начинается с символа @, за которым следует название функции, которую мы собираемся «декорировать». Для получения декоратора python, вам нужно только разместить его в строке перед определением функции. Теперь, когда мы вызываем **a_function, она будет декорирована, и мы получим следующий результат:
Давайте создадим декоратор, который будет делать что-нибудь полезное.
Есть вопросы по Python?
На нашем форуме вы можете задать любой вопрос и получить ответ от всего нашего сообщества!
Telegram Чат & Канал
Вступите в наш дружный чат по Python и начните общение с единомышленниками! Станьте частью большого сообщества!
Паблик VK
Одно из самых больших сообществ по Python в социальной сети ВК. Видео уроки и книги для вас!
Создание логируемого декоратора
Возможно, вам потребуется логировать того, что делает ваша функция. Большую часть времени логинг будет встроен внутри вашей функции. Однако, бывают случаи, когда вам нужно сделать это на уровне функции, что бы получить представление о потоке программы или, возможно, для следования тем или иным условиям бизнеса, таким как аудит. Посмотрим на небольшой декоратор, который мы можем использовать для записи названия любой функции и того, что она делает:
Этот небольшой скрипт содержит функцию log, которая принимает функцию как единственный аргумент. Мы создаем объект логгер, а название лог файла такое же, как и у функции. После этого, функция log будет записывать, как наша функция была вызвана и что она возвращает, если возвращает.
Встроенные декораторы
Python содержит несколько встроенных декораторов. Из всех этих декораторов, самой важной троицей являются:
Также существуют декораторы в различных разделах стандартной библиотеки Python. Одним из примеров является functools.wraps. Мы сосредоточимся на трех главных декораторах, указанных выше.
@classmethod и @staticmethod
Я не пользовался ими ранее, так что сделал небольшое исследование.
Если мы взглянем на пример кода, в котором показано, как работает декоратор, это может помочь понять основные принципы:
Полезные декораторы
Как и обещал, приведу список полезных декораторов. Среди них как стандартные поставляемые вместе с Python, так и декораторы из других библиотек и исходные коды прочих интересных декораторов.
Начнем с самых известных.
Свойства @property
Декоратор @property облегчает создание свойств в классах Python. Свойства выглядят как обычные атрибуты (поля) класса, но при их чтении вызывается геттер (getter), при записи – сеттер (setter), а при удалении – делитер (deleter). Геттер и делитер опциональны.
Краткая справка. Свойства нужны, чтобы элегантно в стиле ООП обрабатывать работу с полями класса. В ООП с полями класса не работают напрямую, они сокрыты. В интерфейс взаимодействия выводятся геттеры и сеттеры. Кроме того, геттер может производить вычисления, если свойство не хранится в классе, а является результатом какой-то математической формулы. А сеттер может проверять входные данные на корректность и вызывать побочные эффекты, например, сеттер при установке позиции картинки на экране может вызвать перерисовку экрана.
Декоратор @property возвращает объект-дескриптор. О них я еще не рассказывал, но обязательно расскажу. @property встроен и виден без import.
Примеры. Вес коробки не может быть отрицательным:
Статические и классовые методы
Методы могут быть не только у экземпляра класса, но и у самого класса, которые вызываются без какого-то экземпляра (без self). Декораторы @staticmethod и @classmethod как раз делают метод таким (статическим или классовым). Эти декораторы встроены и видны без import.
Статический метод – это способ поместить функцию в класс, если она логически относится к этому классу. Статический метод ничего не знает о классе, из которого его вызвали.
Классовый метод напротив знает, из какого класса его вызывают. Он принимает неявный первый аргумент (обычно его зовут cls ), который содержит вызывающий класс. Классовые методы прекрасно подходят, когда нужно учесть иерархию наследования. Пример: метод group создает список из нескольких людей. Причем для Person – список Person, а для Worker – список Worker. Со @staticmethod такое бы не вышло:
@contextmanager
Этот декоратор позволяет получить из генератора – контекст менеджер. Находится в стандартном модуле contextlib. Пример открытие файла.
Кэширование @lru_cache
Писал здесь подробно. Запоминает результаты функции для данного набора аргументов, при следующем вызове уже не выполняет функцию, а достает результат из кэша. Размер кэша регулируется. Часто используемые элементы остаются в кэше, редкие – вытесняются, если размер доходит до максимального.
Пример. Без кэша это рекурсивная функция чисел Фибоначчи была бы крайне неэффективна:
@functools.wraps
Декоратор @functools.wraps полезен при разработке других декораторов. Передает имя, документацию и прочую мета-информацию из декорируемой функции к ее обертке. Подробнее в статье про декораторы.
@atexit.register
Декоратор @atexit.register регистрирует функцию для вызова ее при завершении работы процесса Python.
Измерение времени @timeit
Переходим к самописным декораторам.
Этот декоратор измеряет время выполнения функции, которую декорирует.
Как видите, нам не нужно вмешиваться в код функции, не нужно каждый раз писать измеритель времени, декоратор отлично экономит нашу работу: надо измерить время – дописали @timeit и видим все, как на ладони.
Кэшируемое свойство класса
Свойство класса, которое реально вычисляется один раз, а потом запоминается на ttl секунд:
Из 10 повторений только первое вызовет код геттера, а остальные возьмут значение из кэша.
Устаревший метод с @deprecated
При вызове метода или функции, помеченной декоратором @deprecated будет выдано предупреждение, что этот метод или функция является устаревшими:
Повторитель
Повторяет вызов функции n раз, возвращает последний результат.
Замедлитель
Замедляет исполнение функции на нужное число секунд. Бывает полезно для отладки.
Помощник для отладки
Этот декоратор будет логгировать все вызовы функции и печатать ее аргументы и возвращаемое значение.
Декораторы в Django и Flask
Декораторы активно задействованы в Django. Например, они позволяют налагать условия на обработку запросов или дополнять запрос дополнительной логикой:
Пример с проверкой наличия зарегистрированного юзера для Flask:
Еще хочу!
Вот ссылка на широкий набор декораторов и библиотек, их применяющих (на английском). Или вот тут.
🐉 Специально для канала @pyway. Подписывайтесь на мой канал в Телеграм @pyway 👈
Использование property в Python
Руководство с примерами использования функции property в языке программирования Python.
Введение
Функция property — создает вычисляемое свойство, которое позволяет использовать методы класса в качестве свойств объектов. Свойство — это аттрибут класса, который может считывать или записывать информацию. Использование property создает дескриптор, который позволяет создавать свойства объекту.
Проблема
Давайте рассмотрим пример. Существует класс человек, возраст которого не может быть меньше 0 и больше 120. Типичная ООП программа будет выглядеть примерно так:
Как мы видим в этой реализации присутствуют некоторые проблемы и давайте их рассмотрим внимательно.
Создадим экземпляр 30 летнего человека, и проверим корректность введенных данных.
Число 30 входит в рамки человеческой жизни и проблем у нас не возникло.
Попробуем ввести возраст вне рамок человеческой жизни
В данном примере мы обратились к методу класса, который проверил входные данные, из-за чего нам не удалось выставить некорректный возраст.
Но мы можем напрямую обратиться к аттрибуту self.age и указать абсолютно любой возраст.
Таким способом мы нарушаем алгоритм работы нашего класса, что является серьезной проблемой.
Решение
Для решения этой проблемы существуют два способа. Первый способ подразумевает использование декоратора функции, а второй способ указывает в функции property getter, setter и deleter.
Использование декоратора
@property — это декоратор, который обрабатывает получение, установку и удаление переменных класса так, как это было задумано в Python. Код для вышеописанного сценария будет выглядеть теперь так:
Наш код стал более лаконичным, но давайте разберемся по пунктам что же все таки изменилось и на что это повлияло.
Обратите внимание, что обе функции имеют одинаковое имя. Это необходимо для работы программы.
Попробуем установить некорректное значение и посмотрим что получится:
Используя декоратор @property мы ограничиваем возможность указания значений переменным в классе.
Прямое указание функций
Во втором варианте использование property мы описываем функцию для установки значения и получения значения.
Как видите, нам просто нужно было изменить переменные и добавить специальную строку age = property(get_age, set_age), которая залатала дыры в нашем исходном коде и сэкономила нам кучу времени!
Все работает, как и ожидалось.
Вывод
В данном руководстве мы рассмотрели, как и для чего использовать property, воспользовались двумя вариантами реализации и проверили оба. Я не упомянул в статье о так называемых deleter, предлагаю вам сделать это самостоятельно.
Как использовать декоратор свойств Python?
В Python есть очень полезная функция, называемая декораторами, которая является всего лишь синтаксической для оберток функций. Здесь мы сосредоточимся на декораторе свойств, который представляет собой особый тип декоратора.
Эта тема может вас немного запутать, поэтому мы рассмотрим ее шаг за шагом с примерами.
На чем основан декоратор свойств Python?
Вы можете вызвать это в своем интерпретаторе Python и посмотреть:
Этот объект property имеет несколько дополнительных методов для получения и установки значений объекта. У него также есть метод его удаления.
Список методов приведен ниже:
Итак, следует отметить, что декоратор свойств будет использовать эту функцию, которая будет иметь некоторые специальные методы для чтения и записи в объект. Но как это нам помогает?
Использование декоратора свойств Python
Чтобы использовать декоратор свойств, нам нужно обернуть его вокруг любой функции или метода.
Вот простой пример:
Это то же самое, что:
Рассмотрим приведенный ниже класс без каких-либо декорированных методов:
Здесь, как вы можете видеть, когда мы изменяем только атрибут name нашего объекта, ссылка на атрибут full_id все еще не обновляется.
Однако это не лучший способ решить эту проблему, поскольку вместо этого вам может потребоваться преобразовать все такие атрибуты в метод и изменить атрибуты в вызовы методов. Это не удобно.
Давайте попробуем прямо сейчас.
Действительно, теперь это работает. Теперь нам не нужно вызывать full_id используя круглые скобки.
Хотя это все еще метод, декоратор свойств маскирует его и обрабатывает так, как если бы это было свойство класса.
Использование свойства с сеттером
В приведенном выше примере подход сработал, потому что мы явно не full_id свойство full_id напрямую. По умолчанию использование @property делает это свойство доступным только для чтения.
Это означает, что вы не можете явно изменить свойство.
Очевидно, у нас нет разрешений, поскольку свойство доступно только для чтения.
Чтобы сделать свойство доступным для записи, вспомните метод property().setter о котором мы говорили, который также является декоратором.
Однако мы не можем напрямую использовать свойство full_id в нашем свойстве установки. Обратите внимание, что это приведет к бесконечному спуску рекурсии в Python.
Обновленный код теперь будет выглядеть так:
Эти скрытые атрибуты класса (например, _full_id ) позволяют нам очень легко использовать внешние свойства. Именно поэтому свойства широко используются в современных проектах с открытым исходным кодом.
Они упрощают задачу для конечного пользователя, а также позволяют разработчикам легко отделить скрытые атрибуты от не скрытых свойств.