Свойства

В прошлом уроке баланс карты читался методом: card.balance(). Работает, но выглядит странно — баланс скорее атрибут карты, чем действие. Python позволяет оставить внутренний _balance спрятанным и при этом читать баланс как атрибут, без скобок. Для этого есть свойства (property).

@property

Строка @property перед методом — это декоратор (decorator): он меняет то, как работает метод под ним. Метод с @property вызывается сам, когда атрибут читают, — скобки не нужны. Например, у заказа статус хранится во внутреннем _status, а читается свойством status:

class Order:
    def __init__(self, number):
        self._number = number
        self._status = "новый"

    @property
    def number(self):
        return self._number

    @property
    def status(self):
        return self._status

    def pay(self):
        if self._status == "оплачен":
            return False  # дважды не оплачивают
        self._status = "оплачен"
        return True


order = Order(17)
print(order.number, order.status)  # без скобок
print(order.pay(), order.status)
print(order.pay(), order.status)

17 новый
True оплачен
False оплачен

Снаружи order.status выглядит как обычный атрибут, но записать в него нельзя: у свойства есть только «чтение» — геттер (getter). Так получается атрибут только для чтения:

order.status = "отменён"

AttributeError: property 'status' of 'Order' object has no setter

Менять статус можно только методами заказа — например, pay(), который не даст оплатить заказ дважды. Так же стоит поступить с балансом подарочной карты.

class GiftCard:
    def __init__(self, amount):
        self._balance = amount

    def balance(self):
        ...

    def pay(self, amount):
        if amount > self._balance:
            return False
        self._balance -= amount
        return True

    def top_up(self, amount):
        if amount <= 0:
            return False
        self._balance += amount
        return True

class GiftCard:
    def __init__(self, amount):
        self._balance = amount

    @property
    def balance(self):
        return self._balance

    def pay(self, amount):
        if amount > self._balance:
            return False
        self._balance -= amount
        return True

    def top_up(self, amount):
        if amount <= 0:
            return False
        self._balance += amount
        return True

order.number()

TypeError: 'int' object is not callable

Вычисляемый атрибут

Свойство не обязано возвращать сохранённый атрибут — оно может вычислять значение каждый раз, когда его читают. Например, сумма корзины: её не нужно хранить и обновлять при каждом add, достаточно посчитать по товарам:

class Product:
    def __init__(self, name, price):
        self.name = name
        self.price = price


class Cart:
    def __init__(self):
        self.items = []

    def add(self, product):
        self.items.append(product)

    # свойства total и count

class Product:
    def __init__(self, name, price):
        self.name = name
        self.price = price


class Cart:
    def __init__(self):
        self.items = []

    def add(self, product):
        self.items.append(product)

    @property
    def total(self):
        return sum(p.price for p in self.items)

    @property
    def count(self):
        return len(self.items)

Вычисляемое свойство всегда актуально: оно считается заново при каждом чтении. Значение, вычисленное один раз в __init__, устареет, как только поменяются данные.

class Drink:
    def __init__(self, name, volume):
        self.name = name
        self.volume = volume

    @property
    def size(self):
        ...

class Drink:
    def __init__(self, name, volume):
        self.name = name
        self.volume = volume

    @property
    def size(self):
        if self.volume <= 250:
            return "S"
        if self.volume <= 350:
            return "M"
        return "L"

Свойство или метод

Правило выбора:

В следующем уроке у свойства появится и запись — с проверкой значения.