Функция Python property()
property()Это встроенная функция в Python, используемая для создания свойств.
property — это мощный механизм, который позволяет выполнять код при доступе к атрибутам. Он часто используется для реализации продвинутых возможностей, таких как вычисляемые свойства и валидация данных.
Определения слов: property 意为"属性",用于定义类的属性。
Базовый синтаксис и параметры
Формат синтаксиса
property(fget=None, fset=None, fdel=None, doc=None)
Описание параметра
- Параметр fget(необязательный):
- Тип: функция
- Описание: Функция, вызываемая при получении значения свойства.
- Параметр fset(необязательный):
- Тип: функция
- Описание: Функция, вызываемая при установке значения свойства.
- Параметр fdel(необязательный):
- Тип: функция
- Описание: Функция, вызываемая при удалении свойства.
- Параметр doc(необязательный):
- Тип: String
- Описание: Строка документации свойства.
Описание функций
- Возвращаемое значение: Возвращает объект свойства.
- Особенности: Делает доступ к свойству похожим на обычную переменную, но на самом деле выполняет функцию.
Примеры
Пример 1: Базовое использование
Пример
class Circle:
def __init__(self, radius):
self.radius = radius
# Использование property для создания вычисляемых свойств
def get_area(self):
"""Вычислить площадь круга."""
return 3.14159 * self.radius ** 2
def set_radius(self, value):
"""Установить радиус (можно добавить проверку)."""
if value < 0:
raise ValueError(Радиус не может быть отрицательным)
self.radius = value
# Создать свойство
area = property(get_area, set_radius)
# Использование
c = Circle(5)
print(fРадиус: {c.radius}) # Вывод: Радиус: 5
print(fПлощадь: {c.area}) # Вывод: Площадь: 78.53975
# Установить свойство
c.radius = 10
print(fНовая площадь: {c.area}) # Вывод: Новая площадь: 314.159
# Проверка
c.radius = -5 # Вызовет исключение
def __init__(self, radius):
self.radius = radius
# Использование property для создания вычисляемых свойств
def get_area(self):
"""Вычислить площадь круга."""
return 3.14159 * self.radius ** 2
def set_radius(self, value):
"""Установить радиус (можно добавить проверку)."""
if value < 0:
raise ValueError(Радиус не может быть отрицательным)
self.radius = value
# Создать свойство
area = property(get_area, set_radius)
# Использование
c = Circle(5)
print(fРадиус: {c.radius}) # Вывод: Радиус: 5
print(fПлощадь: {c.area}) # Вывод: Площадь: 78.53975
# Установить свойство
c.radius = 10
print(fНовая площадь: {c.area}) # Вывод: Новая площадь: 314.159
# Проверка
c.radius = -5 # Вызовет исключение
Ожидаемый вывод:
半径: 5 面积: 78.53975 新面积: 314.159
Пояснение к коду:
- С помощью property можно определять вычисляемые свойства.
- Сеттер может добавлять логику проверки данных.
Пример 2: Использование декоратора @property (рекомендуется)
Пример
class Student:
def __init__(self, name, score):
self.name = name
self._score = score
@property
def score(self):
"""Получить score"""
return self._score
@score.setter
def score(self, value):
"""Установить балл (с проверкой)"""
if not 0 <= value <= 100:
raise ValueError(Балл должен быть между 0 и 100)
self._score = value
@property
def grade(self):
"""Вычислить оценку на основе балла"""
if self._score >= 90:
return 'A'
elif self._score >= 80:
return 'B'
elif self._score >= 70:
return 'C'
elif self._score >= 60:
return 'D'
else:
return 'F'
# Использование
s = Student("Tom", 85)
print(s.name) # Вывод: Tom
print(s.score) # Вывод: 85
print(s.grade) # Вывод: B
s.score = 92 # Установить score
print(s.grade) # Вывод: A
s.score = 105 # Вызовет исключение
def __init__(self, name, score):
self.name = name
self._score = score
@property
def score(self):
"""Получить score"""
return self._score
@score.setter
def score(self, value):
"""Установить балл (с проверкой)"""
if not 0 <= value <= 100:
raise ValueError(Балл должен быть между 0 и 100)
self._score = value
@property
def grade(self):
"""Вычислить оценку на основе балла"""
if self._score >= 90:
return 'A'
elif self._score >= 80:
return 'B'
elif self._score >= 70:
return 'C'
elif self._score >= 60:
return 'D'
else:
return 'F'
# Использование
s = Student("Tom", 85)
print(s.name) # Вывод: Tom
print(s.score) # Вывод: 85
print(s.grade) # Вывод: B
s.score = 92 # Установить score
print(s.grade) # Вывод: A
s.score = 105 # Вызовет исключение
Ожидаемый вывод:
Tom 85 B A
Пояснение к коду:
- Декоратор @property — более питоничный способ записи.
- Можно определить геттер, сеттер и делетер.
Пример 3: свойство только для чтения
Пример
class Person:
def __init__(self, name):
self._name = name
@property
def name(self):
"""Свойство только для чтения"""
return self._name
# Без сеттера свойство не может быть изменено
p = Person("Tom")
print(p.name) # Вывод: Tom
# Попытка изменить его вызовет ошибку (нет сеттера)
# p.name = "Jack" # вызовет AttributeError
# Удаление его также вызовет ошибку
# del p.name # вызовет AttributeError
def __init__(self, name):
self._name = name
@property
def name(self):
"""Свойство только для чтения"""
return self._name
# Без сеттера свойство не может быть изменено
p = Person("Tom")
print(p.name) # Вывод: Tom
# Попытка изменить его вызовет ошибку (нет сеттера)
# p.name = "Jack" # вызовет AttributeError
# Удаление его также вызовет ошибку
# del p.name # вызовет AttributeError
Ожидаемый вывод:
Tom
Определив только геттер и не определяя сеттер, можно создать свойство, доступное только для чтения.
Другие расширения
Встроенные функции Python3