Python Language Propriétés


Exemple

Les classes Python prennent en charge les propriétés , qui ressemblent à des variables d'objet classiques, mais avec la possibilité d'attacher un comportement et une documentation personnalisés.

class MyClass(object):

    def __init__(self):
       self._my_string = ""
    
    @property
    def string(self):
        """A profoundly important string."""
        return self._my_string

    @string.setter
    def string(self, new_value):
        assert isinstance(new_value, str), \
               "Give me a string, not a %r!" % type(new_value)
        self._my_string = new_value

    @string.deleter
    def x(self):
        self._my_string = None

L'objet de la classe MyClass semblera avoir une propriété .string , mais son comportement est maintenant étroitement contrôlé:

mc = MyClass()
mc.string = "String!"
print(mc.string)
del mc.string

Outre la syntaxe utile ci-dessus, la syntaxe de la propriété permet la validation ou d’autres augmentations à ajouter à ces attributs. Cela pourrait être particulièrement utile avec les API publiques - où un niveau d'aide devrait être donné à l'utilisateur.

Une autre utilisation courante des propriétés est de permettre à la classe de présenter des «attributs virtuels» - des attributs qui ne sont pas réellement stockés mais qui ne sont calculés que sur demande.

class Character(object):
    def __init__(name, max_hp):
        self._name = name
        self._hp = max_hp
        self._max_hp = max_hp

    # Make hp read only by not providing a set method
    @property
    def hp(self):
        return self._hp

    # Make name read only by not providing a set method
    @property
    def name(self):
        return self.name

    def take_damage(self, damage):
        self.hp -= damage
        self.hp = 0 if self.hp <0 else self.hp

    @property
    def is_alive(self):
        return self.hp != 0

    @property
    def is_wounded(self):
        return self.hp < self.max_hp if self.hp > 0 else False

    @property
    def is_dead(self):
        return not self.is_alive

bilbo = Character('Bilbo Baggins', 100)
bilbo.hp
# out : 100
bilbo.hp = 200        
# out : AttributeError: can't set attribute
# hp attribute is read only.

bilbo.is_alive
# out : True
bilbo.is_wounded
# out : False
bilbo.is_dead
# out : False

bilbo.take_damage( 50 )

bilbo.hp
# out : 50

bilbo.is_alive
# out : True
bilbo.is_wounded
# out : True
bilbo.is_dead
# out : False

bilbo.take_damage( 50 )
bilbo.hp
# out : 0

bilbo.is_alive
# out : False
bilbo.is_wounded
# out : False
bilbo.is_dead
# out : True