A @property dekoratőr a Pythonban: használati esetei, előnyei és szintaxisa

? Ismerje meg a tulajdonságokat

Üdvözöljük! Ebben a cikkben megtudhatja, hogyan kell együttműködni a @propertydíszítővel a Pythonban.

Tanulni fogsz:

  • A tulajdonságok használatának előnyei a Pythonban.
  • A dekoratőr funkcióinak alapjai: mik ezek és hogyan kapcsolódnak a @property-hez.
  • Hogyan használhatod a @property-t getterek, beállítók és törlők meghatározására?

1️⃣ A Python tulajdonságainak előnyei

Kezdjük egy kis összefüggéssel. Miért használja a Python tulajdonságait?

A tulajdonságok az attribútumokkal való munka "Pythonic" módjának tekinthetők, mert:

  • A tulajdonságok meghatározásához használt szintaxis nagyon tömör és olvasható.
  • Pontosan elérheti a példányattribútumokat, mintha nyilvános attribútumok lennének, miközben a közvetítők (varázslók és beállítók) "varázslatát" használja az új értékek érvényesítéséhez és az adatok közvetlen elérésének vagy módosításának elkerülésére.
  • A @property használatával "újrafelhasználhatja" egy tulajdonság nevét, hogy elkerülje az új nevek létrehozását a kezdőknek, beállítóknak és törlőknek.

Ezek az előnyök teszik a tulajdonságokat igazán fantasztikus eszközzé, amely segít tömörebb és olvashatóbb kód megírásában. ?

2️⃣ Bevezetés a lakberendezőkhöz

A díszítő funkció alapvetően egy olyan funkció, amely új funkciókat ad hozzá egy argumentumként átadott függvényhez. A díszítő funkció használata olyan, mintha csokoládé hinti adna egy jégkrémhez? Ez lehetővé teszi számunkra, hogy új funkciókat adjunk hozzá egy meglévő funkcióhoz anélkül, hogy módosítanánk.

Az alábbi példában láthatja, hogy néz ki egy tipikus díszítő funkció a Pythonban:

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

Elemezzük részletesen ezeket az elemeket:

  • Először megtaláljuk a dekorátor funkciót def decorator(f)(a sprinkleket ✨), amelyek fargumentumként egy függvényt vesznek fel .
def decorator(f): def new_function(): print("Extra Functionality") f() return new_function
  • Ez a dekoratőr funkció egy beágyazott függvény, new_function. Figyelje meg, hogyan fhívják belülről new_functionugyanazt a funkciót, miközben új funkciót ad hozzá a függvényhívás előtt (a funkcióhívás után új funkciót is felvehetünk).
  • A díszítő függvény maga adja vissza a beágyazott függvényt new_function.
  • Ezután (lent) megtaláljuk a díszíteni kívánt funkciót (a fagylaltot?) initial_function. Figyelje meg a nagyon különös szintaxist ( @decorator) a függvény fejléce felett.
@decorator def initial_function(): print("Initial Functionality") initial_function()

Ha futtatjuk a kódot, akkor ezt a kimenetet látjuk:

Extra Functionality Initial Functionality

Figyelje meg, hogyan működik a dekoratőr funkció akkor is, ha csak hívunk initial_function(). Ez a varázslat a @decorator? Hozzáadásához.

OteMegjegyzés: Általában azt írnánk@ , hogy a dekorátor funkció nevét a @ szimbólum után cseréljük ki.

Tudom, hogy azt kérdezheti: ez hogyan kapcsolódik a @ tulajdonsághoz? A @property a tulajdon () függvény beépített díszítője a Pythonban. Bizonyos módszerek "különleges" funkcionalitását adják annak érdekében, hogy azok getterként, beállítóként vagy törlőként működjenek, amikor tulajdonságokat definiálunk egy osztályban.

Most, hogy ismeri a dekoratőröket, nézzük meg a @property használatának valódi forgatókönyvét!

? Valódi forgatókönyv: @ tulajdonság

Tegyük fel, hogy ez az óra a program része. Ön modellezés egy házban egy Houseosztály (abban a pillanatban, az osztály csak van egy ára például attribútum által meghatározott):

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

Ez a példányattribútum nyilvános, mert a neve nem rendelkezik aláhúzással. Mivel az attribútum jelenleg nyilvános, nagyon valószínű, hogy Ön és a csapat többi fejlesztője a program más részeiben pontjelöléssel közvetlenül elérte és módosította az attribútumot :

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

? Tipp: Az obj egy olyan változót képvisel, amely a példányára hivatkozik House.

Eddig minden remekül működik, igaz? De tegyük fel, hogy a rendszer hozzárendelése előtt felkérést kap arra, hogy ezt az attribútumot védetté tegye (nem nyilvános), és érvényesítse az új értéket . Pontosabban ellenőriznie kell, hogy az érték pozitív lebegő-e. Hogyan tennéd ezt? Lássuk.

A kód módosítása

Ezen a ponton, ha úgy dönt, hogy gettert és beállítót ad hozzá, akkor Ön és csapata valószínűleg pánikba esik? Ennek az az oka, hogy az egyes kódsorokat, amelyek elérik vagy módosítják az attribútum értékét, módosítani kell a getter vagy a setter hívásához. Ellenkező esetben a kód megszakad ⚠️.

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

De ... A tulajdonságok megmentenek! A -val @propertyÖnnek és csapatának nem kell módosítania ezen sorok egyikét sem, mert képes lesz hozzáadni a „színfalak mögé” gettert és beállítót anélkül, hogy befolyásolná azt a szintaxist, amelyet az attribútum eléréséhez vagy módosításához használt, amikor az nyilvános volt.

Félelmetes, igaz?  

? @ tulajdonság: Szintaxis és logika

Ha úgy dönt, hogy használja @property, osztálya az alábbi példának tűnik:

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

Konkrétan három módszert határozhat meg egy tulajdonsághoz:

  • A getter -, hogy hozzáférjen az attribútum értéke.
  • A szetter - állítsa be az attribútum értéke.
  • A deleter - törölni a példány attribútumot.

Az ár most "védett"

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.