Декоратор @property у Python: випадки його використання, переваги та синтаксис

Зустріньте властивості

Ласкаво просимо! У цій статті ви дізнаєтеся, як працювати з @propertyдекоратором на Python.

Ти навчишся:

  • Переваги роботи зі властивостями в Python.
  • Основи функцій декоратора: що це таке і як вони пов’язані з @property.
  • Як ви можете використовувати @property для визначення геттерів, сетерів та видалювачів.

1️⃣ Переваги властивостей Python

Почнемо з трохи контексту. Чому ви використовуєте властивості в Python?

Властивості можна вважати "пітонічним" способом роботи з атрибутами, оскільки:

  • Синтаксис, що використовується для визначення властивостей, є дуже стислим і читабельним.
  • Ви можете отримати доступ до атрибутів екземпляра точно так, як якщо б це були загальнодоступні атрибути, використовуючи "магію" посередників (геттерів та сеттерів) для перевірки нових значень та уникнення безпосереднього доступу до даних або їх модифікації.
  • Використовуючи @property, ви можете «повторно використовувати» ім’я властивості, щоб уникнути створення нових імен для геттерів, установників та видалювачів.

Ці переваги роблять властивості дійсно чудовим інструментом, який допоможе вам написати більш стислий і читабельний код. ?

2️⃣ Вступ до декораторів

Функція декоратора - це в основному функція, яка додає нову функціональність до функції, яка передається як аргумент. Використання функції декоратора - це все одно, що додати шоколадні бризки в морозиво?. Це дозволяє нам додавати нову функціональність до існуючої функції, не змінюючи її.

У наведеному нижче прикладі ви можете побачити, як виглядає типова функція декоратора в Python:

def decorator(f): def new_function(): print("Extra Functionality") f() return new_function @decorator def initial_function(): print("Initial Functionality") initial_function()

Давайте детально розберемо ці елементи:

  • Спочатку ми знаходимо функцію декоратора def decorator(f)(бризки ✨), яка приймає функцію fяк аргумент.
def decorator(f): def new_function(): print("Extra Functionality") f() return new_function
  • Ця функція декоратор має вкладену функцію, new_function. Зверніть увагу, як fвикликається всередині new_functionдля досягнення тієї ж функціональності при додаванні нової функціональності перед викликом функції (ми також можемо додати нову функціональність після виклику функції).
  • Сама функція декоратора повертає вкладену функцію new_function.
  • Потім (нижче) ми знаходимо функцію, яка буде прикрашена (морозиво?) initial_function. Зверніть увагу на дуже своєрідний синтаксис ( @decorator) над заголовком функції.
@decorator def initial_function(): print("Initial Functionality") initial_function()

Якщо ми запустимо код, ми побачимо такий результат:

Extra Functionality Initial Functionality

Зверніть увагу, як працює функція декоратора, навіть якщо ми лише дзвонимо initial_function(). Це магія додавання @decorator?.

Примітка: Загалом, ми писали б @, замінюючи назву функції декоратора після символу @.

Я знаю, що ви можете запитати: як це пов’язано з @property? @Property - це вбудований декоратор функції property () у Python. Він використовується, щоб надати "особливу" функціональність певним методам, щоб змусити їх діяти як геттери, сетери або видалячі, коли ми визначаємо властивості в класі.

Тепер, коли ви знайомі з декораторами, давайте побачимо реальний сценарій використання @property!

🔸 Сценарій реального світу: @property

Скажімо, цей клас є частиною вашої програми. Ви моделюєте будинок із Houseкласом (на даний момент у класі визначено лише атрибут price instance):

class House: def __init__(self, price): self.price = price

Цей атрибут екземпляра є загальнодоступним, оскільки його назва не має провідного підкреслення. Оскільки атрибут в даний час є загальнодоступним, дуже ймовірно, що ви та інші розробники у вашій команді отримували доступ та змінювали атрибут безпосередньо в інших частинах програми, використовуючи крапкові позначення, наприклад:

# Access value obj.price # Modify value obj.price = 40000

💡 Порада: obj представляє змінну, яка посилається на екземпляр House.

Поки що все працює чудово, так? Але припустимо, що вас просять зробити цей атрибут захищеним (непублічним) і перевірити нове значення перед тим, як присвоювати його . Зокрема, вам потрібно перевірити, чи є значення позитивним плаваючим знаком. Як би ти це зробив? Подивимось.

Зміна коду

На цьому етапі, якщо ви вирішите додати геттерів і сеттерів, ви і ваша команда, ймовірно, будете панікувати?. Це пояснюється тим, що кожен рядок коду, який отримує доступ або змінює значення атрибута, повинен бути модифікований, щоб викликати геттера або сеттера відповідно. В іншому випадку код зламається ⚠️.

# Changed from obj.price obj.get_price() # Changed from obj.price = 40000 obj.set_price(40000)

Але ... Властивості приходять на допомогу! З цим @propertyвам і вашій команді не потрібно буде змінювати жоден з цих рядків, оскільки ви зможете додавати геттери та сетери "за кадром", не впливаючи на синтаксис, який ви використовували для доступу або модифікації атрибута, коли він був загальнодоступним.

Чудово, правда?  

🔹 @property: Синтаксис та логіка

Якщо ви вирішите використовувати @property, ваш клас буде виглядати так, як показано нижче:

class House: def __init__(self, price): self._price = price @property def price(self): return self._price @price.setter def price(self, new_price): if new_price > 0 and isinstance(new_price, float): self._price = new_price else: print("Please enter a valid price") @price.deleter def price(self): del self._price

Зокрема, для властивості можна визначити три методи :

  • Газопоглинач - для доступу до значення атрибута.
  • Сетер - встановити значення атрибута.
  • Deleter - видалити атрибут реалізації.

Ціна зараз "Захищена"

Please note that the price attribute is now considered "protected" because we added a leading underscore to its name in self._price:

self._price = price

In Python, by convention, when you add a leading underscore to a name, you are telling other developers that it should not be accessed or modified directly outside of the class. It should only be accessed through intermediaries (getters and setters) if they are available.

🔸 Getter

Here we have the getter method:

@property def price(self): return self._price

Notice the syntax:

  • @property - Used to indicate that we are going to define a property. Notice how this immediately improves readability because we can clearly see the purpose of this method.
  • def price(self) - The header. Notice how the getter is named exactly like the property that we are defining: price. This is the name that we will use to access and modify the attribute outside of the class. The method only takes one formal parameter, self, which is a reference to the instance.
  • return self._price - This line is exactly what you would expect in a regular getter. The value of the protected attribute is returned.

Here is an example of the use of the getter method:

>>> house = House(50000.0) # Create instance >>> house.price # Access value 50000.0

Notice how we access the price attribute as if it were a public attribute. We are not changing the syntax at all, but we are actually using the getter as an intermediary to avoid accessing the data directly.

🔹 Setter

Now we have the setter method:

@price.setter def price(self, new_price): if new_price > 0 and isinstance(new_price, float): self._price = new_price else: print("Please enter a valid price")

Notice the syntax:

  • @price.setter - Used to indicate that this is the setter method for the price property. Notice that we are not using @property.setter, we are using @price.setter. The name of the property is included before .setter.
  • def price(self, new_price): - The header and the list of parameters. Notice how the name of the property is used as the name of the setter. We also have a second formal parameter (new_price), which is the new value that will be assigned to the price attribute (if it is valid).
  • Finally, we have the body of the setter where we validate the argument to check if it is a positive float and then, if the argument is valid, we update the value of the attribute. If the value is not valid, a descriptive message is printed. You can choose how to handle invalid values according the needs of your program.

This is an example of the use of the setter method with @property:

>>> house = House(50000.0) # Create instance >>> house.price = 45000.0 # Update value >>> house.price # Access value 45000.0

Notice how we are not changing the syntax, but now we are using an intermediary (the setter) to validate the argument before assigning it. The new value (45000.0) is passed as an argument to the setter :

house.price = 45000.0

If we try to assign an invalid value, we see the descriptive message. We can also check that the value was not updated:

>>> house = House(50000.0) >>> house.price = -50 Please enter a valid price >>> house.price 50000.0

💡 Tip: This proves that the setter method is working as an intermediary. It is being called "behind the scenes" when we try to update the value, so the descriptive message is displayed when the value is not valid.

🔸 Deleter

Finally, we have the deleter method:

@price.deleter def price(self): del self._price

Notice the syntax:

  • @price.deleter - Used to indicate that this is the deleter method for the price property. Notice that this line is very similar to @price.setter, but now we are defining the deleter method, so we write @price.deleter.
  • def price(self): - The header. This method only has one formal parameter defined, self.
  • del self._price - The body, where we delete the instance attribute.

💡 Tip: Notice that the name of the property is "reused" for all three methods.

This is an example of the use of the deleter method with @property:

# Create instance >>> house = House(50000.0) # The instance attribute exists >>> house.price 50000.0 # Delete the instance attribute >>> del house.price # The instance attribute doesn't exist >>> house.price Traceback (most recent call last): File "", line 1, in  house.price File "", line 8, in price return self._price AttributeError: 'House' object has no attribute '_price'

The instance attribute was deleted successfully ?. When we try to access it again, an error is thrown because the attribute doesn't exist anymore.

🔹 Some final Tips

You don't necessarily have to define all three methods for every property. You can define read-only properties by only including a getter method. You could also choose to define a getter and setter without a deleter.

If you think that an attribute should only be set when the instance is created or that it should only be modified internally within the class, you can omit the setter.

You can choose which methods to include depending on the context that you are working with.

🔸 In Summary

  • You can define properties with the @property syntax, which is more compact and readable.
  • @property can be considered the "pythonic" way of defining getters, setters, and deleters.
  • By defining properties, you can change the internal implementation of a class without affecting the program, so you can add getters, setters, and deleters that act as intermediaries "behind the scenes" to avoid accessing or modifying the data directly.

I really hope you liked my article and found it helpful. To learn more about Properties and Object Oriented Programming in Python, check out my online course, which includes 6+ hours of video lectures, coding exercises, and mini projects.