Функция property( ) в Python

Функция property в Python используется для создания и управления свойствами классов. Это встроенный способ для инкапсуляции данных и обеспечения управления доступом к атрибутам объектов.

Синтаксис

property(fget=None, fset=None, fdel=None, doc=None)

Параметры

• fget (необязательный): Функция для получения значения свойства.
• fset (необязательный): Функция для установки значения свойства.
• fdel (необязательный): Функция для удаления свойства.
• doc (необязательный): Строка документации (docstring) для свойства.

Возвращаемое значение

Функция property возвращает объект свойства (property object), который можно использовать в классе для управления доступом к атрибутам.

Примеры использования

Пример 1: Создание свойства только для чтения

class Circle:
    def __init__(self, radius):
        self._radius = radius

    @property
    def radius(self):
        return self._radius

circle = Circle(5)
print(circle.radius)  # Вывод: 5
# circle.radius = 10  # Ошибка: нельзя присвоить значение свойству только для чтения

Пример 2: Создание свойства с методом установки

class Circle:
    def __init__(self, radius):
        self._radius = radius

    @property
    def radius(self):
        return self._radius

    @radius.setter
    def radius(self, value):
        if value < 0:
            raise ValueError("Радиус не может быть отрицательным")
        self._radius = value

circle = Circle(5)
print(circle.radius)  # Вывод: 5
circle.radius = 10
print(circle.radius)  # Вывод: 10
# circle.radius = -5  # Ошибка: Радиус не может быть отрицательным

Пример 3: Создание свойства с методом удаления

class Circle:
    def __init__(self, radius):
        self._radius = radius

    @property
    def radius(self):
        return self._radius

    @radius.setter
    def radius(self, value):
        if value < 0:
            raise ValueError("Радиус не может быть отрицательным")
        self._radius = value

    @radius.deleter
    def radius(self):
        del self._radius

circle = Circle(5)
print(circle.radius)  # Вывод: 5
del circle.radius
# print(circle.radius)  # Ошибка: атрибут удален

Пример 4: Использование строки документации

class Circle:
    def __init__(self, radius):
        self._radius = radius

    @property
    def radius(self):
        """Радиус круга"""
        return self._radius

print(Circle.radius.__doc__)  # Вывод: Радиус круга

Важные замечания

1. Инкапсуляция: Свойства позволяют инкапсулировать данные и управлять доступом к ним, обеспечивая защиту и валидацию.
2. Декораторы: Использование декораторов @property, @property.setter и @property.deleter упрощает создание и управление свойствами.
3. Документирование: Свойства могут иметь строки документации, что улучшает читаемость и поддерживаемость кода.