Декораторът @property в Python: Случаи на използване, предимства и синтаксис

Запознайте се с имоти

Добре дошли! В тази статия ще научите как да работите с @propertyдекоратора в Python.

Ще се научиш:

  • Предимствата на работата със свойства в Python.
  • Основите на функциите на декоратора: какви са те и как са свързани с @property.
  • Как можете да използвате @property за дефиниране на getters, setters и Deleters.

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клас (в момента класът има дефиниран само атрибут на ценова инстанция):

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.