Der @property Decorator in Python: Anwendungsfälle, Vorteile und Syntax

🔹 Eigenschaften erfüllen

Herzlich willkommen! In diesem Artikel erfahren Sie, wie Sie mit dem @propertyDekorator in Python arbeiten.

Du wirst es lernen:

  • Die Vorteile der Arbeit mit Eigenschaften in Python.
  • Die Grundlagen der Dekorationsfunktionen: Was sie sind und wie sie mit @property zusammenhängen.
  • Wie Sie @property verwenden können, um Getter, Setter und Deleter zu definieren.

1️⃣ Vorteile von Eigenschaften in Python

Beginnen wir mit ein wenig Kontext. Warum sollten Sie Eigenschaften in Python verwenden?

Eigenschaften können als "pythonische" Arbeitsweise mit Attributen angesehen werden, weil:

  • Die zum Definieren von Eigenschaften verwendete Syntax ist sehr präzise und lesbar.
  • Sie können auf Instanzattribute genau so zugreifen, als wären sie öffentliche Attribute, während Sie die "Magie" von Intermediären (Getter und Setter) verwenden, um neue Werte zu validieren und zu vermeiden, direkt auf die Daten zuzugreifen oder diese zu ändern.
  • Mit @property können Sie den Namen einer Eigenschaft "wiederverwenden", um zu vermeiden, dass neue Namen für die Getter, Setter und Deleter erstellt werden.

Diese Vorteile machen Eigenschaften zu einem wirklich großartigen Werkzeug, mit dem Sie präziseren und lesbareren Code schreiben können. ?

2️⃣ Einführung in Dekorateure

Eine Dekorationsfunktion ist im Grunde eine Funktion, die einer Funktion, die als Argument übergeben wird, neue Funktionen hinzufügt. Die Verwendung einer Dekorationsfunktion ist wie das Hinzufügen von Schokostreuseln zu einem Eis? Damit können wir einer vorhandenen Funktion neue Funktionen hinzufügen, ohne sie zu ändern.

Im folgenden Beispiel sehen Sie, wie eine typische Dekorationsfunktion in Python aussieht:

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

Lassen Sie uns diese Elemente im Detail analysieren:

  • Wir finden zuerst die Dekorationsfunktion def decorator(f)(die Streusel ✨), die eine Funktion fals Argument verwendet.
def decorator(f): def new_function(): print("Extra Functionality") f() return new_function
  • Diese Dekorationsfunktion hat eine verschachtelte Funktion new_function. Beachten Sie, wie fim Inneren aufgerufen wird new_function, um dieselbe Funktionalität zu erreichen, während vor dem Funktionsaufruf neue Funktionen hinzugefügt werden (wir können auch nach dem Funktionsaufruf neue Funktionen hinzufügen).
  • Die Decorator-Funktion selbst gibt die verschachtelte Funktion zurück new_function.
  • Dann (unten) finden wir die Funktion, die dekoriert werden soll (das Eis?) initial_function. Beachten Sie die sehr eigenartige Syntax ( @decorator) über dem Funktionsheader.
@decorator def initial_function(): print("Initial Functionality") initial_function()

Wenn wir den Code ausführen, sehen wir diese Ausgabe:

Extra Functionality Initial Functionality

Beachten Sie, wie die Dekorationsfunktion ausgeführt wird, auch wenn wir nur aufrufen initial_function(). Dies ist die Magie des Hinzufügens von @decorator?

💡Hinweis: Im Allgemeinen schreiben wir @und ersetzen den Namen der Dekorationsfunktion nach dem @ -Symbol.

Ich weiß, dass Sie sich vielleicht fragen: Wie hängt das mit der @ Eigenschaft zusammen? Die Eigenschaft @property ist ein integrierter Dekorator für die Funktion property () in Python. Es wird verwendet, um bestimmten Methoden "spezielle" Funktionen zu geben, damit sie als Getter, Setter oder Deleter fungieren, wenn wir Eigenschaften in einer Klasse definieren.

Nachdem Sie mit Dekorateuren vertraut sind, sehen wir uns ein reales Szenario für die Verwendung von @property an!

🔸 Reales Szenario: @property

Angenommen, diese Klasse ist Teil Ihres Programms. Sie modellieren ein Haus mit einer HouseKlasse (im Moment ist für die Klasse nur ein Preisinstanzattribut definiert):

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

Dieses Instanzattribut ist öffentlich, da sein Name keinen führenden Unterstrich enthält. Da das Attribut derzeit öffentlich ist, ist es sehr wahrscheinlich, dass Sie und andere Entwickler in Ihrem Team das Attribut direkt in anderen Teilen des Programms mithilfe der Punktnotation wie folgt aufgerufen und geändert haben :

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

💡 Tipp: obj repräsentiert eine Variable, die auf eine Instanz von verweist House.

So far everything is working great, right? Butlet's say that you are asked to make this attribute protected (non-public) and validate the new value before assigning it. Specifically, you need to check if the value is a positive float. How would you do that? Let's see.

Changing your Code

At this point, if you decide to add getters and setters, you and your team will probably panic ?. This is because each line of code that accesses or modifies the value of the attribute will have to be modified to call the getter or setter, respectively. Otherwise, the code will break ⚠️.

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

But... Properties come to the rescue! With @property, you and your team will not need to modify any of those lines because you will able to add getters and setters "behind the scenes" without affecting the syntax that you used to access or modify the attribute when it was public.

Awesome, right?  

🔹 @property: Syntax and Logic

If you decide to use @property, your class will look like the example below:

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

Specifically, you can define three methods for a property:

  • A getter - to access the value of the attribute.
  • A setter - to set the value of the attribute.
  • A deleter - to delete the instance attribute.

Price is now "Protected"

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.