Python property 语法详解:装饰器与类属性两种实现方式

白榆
白榆
发布时间:2026-10-14 | 2人浏览过
原创

本文详细解析 Python 中 property 语法的两种实现方式:@property 装饰器与 property() 类属性。重点讲解新式类中获取、修改、删除属性的三种访问方式,以及经典类与新式类的区别。通过分页计算等实际案例,展示如何利用 property 简化数据访问逻辑并实现私有属性的安全封装。

Python property 基础概念

property() 函数用于在新式类中返回属性对象。

Python 提供了 property 语法,其功能类似于 C# 中的 get/set 访问器,主要具备以下两个核心作用:

  • 将类方法转换为只读属性;
  • 实现属性的 getter(获取)和 setter(设置)方法。

接下来重点介绍 Python 中 property 语法的具体用法,内容如下:

在大多数编程语言中,类的每个属性通常都标配对应的 setter 和 getter 方法。

示例代码展示如下:


class Money(object):
  def __init__(self):
    self.__money = 0

  def getMoney(self):
    return self.__money

  def setMoney(self, value):
    if isinstance(value, int):
      self.__money = value
    else:
      print("error:不是整型数字")

设置私有属性的目的是防止数据被意外读取或修改。通过增加方法来获取或设置私有属性,可以在未来需要时进行过滤或验证。

其他语言通常采用这种方式,但 Python 不推荐这种繁琐的做法,而是推荐使用 property。

property 属性的定义与特性

一、什么是 property 属性

property 是一种特殊属性,使用时看起来像实例属性,但实际上对应某个方法。


class Foo:
  def func(self):
    pass

  # 定义property属性
  @property
  def prop(self):
    pass

foo_obj = Foo()
foo_obj.func() # 调用实例方法
foo_obj.prop # 调用property属性

示例代码如下:


class Goods:
  @property
  def size(self):
    return 100

obj = Goods()
ret = obj.size # 调用属性
print(ret) # 100

当访问 obj.size 时,会自动调用 size 方法并返回其结果。

定义和调用 property 属性时需注意以下几点:

  • 定义时,需在实例方法上添加 @property 装饰器;
  • 该方法仅接受 self 一个参数;
  • 调用时,无需添加括号。

那么 property 属性具体有什么用途?下面通过一个实例进行说明。

property 在实际场景中的应用

以京东商城电脑主机列表页面为例,每次请求不可能将数据库所有内容显示在页面上,而是通过分页功能局部显示。因此,向数据库请求数据时需指定获取从第 m 条到第 n 条的数据,该分页功能包括:

  • 根据用户请求的当前页和总数据条数计算 m 和 n;
  • 根据计算出的 m 和 n 从数据库中请求数据。

class Pager:
  def __init__(self, current_page):
    # 用户当前请求的页码(第一页、第二页...)
    self.current_page = current_page
    # 每页默认显示10条数据
    self.per_items = 10

  @property
  def start(self):
    val = (self.current_page - 1) * self.per_items
    return val

  @property
  def end(self):
    val = self.current_page * self.per_items
    return val

p = Pager(1)
p.start # 就是起始值,即:m
p.end # 就是结束值,即:n

由此可见,Python property 属性的功能是:在内部进行一系列逻辑计算,最终将计算结果返回。

property 的两种实现方式

二、property 属性的两种实现方式

  • 装饰器方式:即在方法上应用 @property 装饰器。
  • 类属性方式:即在类中定义值为 property 对象的类属性。

装饰器方式实现 property

1、装饰器方式

在类的实例方法上应用 @property 装饰器。

Python 中的类分为经典类和新式类,新式类的属性比经典类更丰富(如果类继承自 object,则为新式类)。

经典类仅具有一种 @property 装饰器。


class Goods:
  @property
  def price(self):
    return "laowang"

obj = Goods()
# 自动执行 @property 修饰的 price 方法,并获取方法的返回值
result = obj.price 
print(result) # laowang

新式类具有三种 @property 相关装饰器。

Python 3 中默认继承 object 类,因此只有在 Python 3 中才支持 @xxx.setter 和 @xxx.deleter。


class Goods:
  
  @property
  def price(self):
    print('@property')

  @price.setter
  def price(self, value):
    print('@price.setter')

  @price.deleter
  def price(self):
    print('@price.deleter')

obj = Goods()
# 自动执行 @property 修饰的 price 方法,并获取方法的返回值
obj.price # @property
# 自动执行 @price.setter 修饰的 price 方法,并将 123 赋值给方法的参数
obj.price = 123 # @price.setter
# 自动执行 @price.deleter 修饰的 price 方法
del obj.price # @price.deleter

注意:

  • 经典类中的属性只有一种访问方式,即被 @property 修饰的方法。
  • 新式类中的属性有三种访问方式,分别对应被 @property、@方法名.setter、@方法名.deleter 修饰的方法。

由于新式类具有三种访问方式,我们可以根据这些特点,分别将三个方法定义为对同一属性的获取、修改和删除操作。

示例代码如下:


class Goods(object):

  def __init__(self):
    # 原价
    self.original_price = 100
    # 折扣
    self.discount = 0.8

  @property
  def price(self):
    # 实际价格 = 原价 * 折扣
    new_price = self.original_price * self.discount
    return new_price

  @price.setter
  def price(self, value):
    self.original_price = value

  @price.deleter
  def price(self):
    del self.original_price

obj = Goods()
obj.price     # 获取商品价格
obj.price = 200  # 修改商品原价
del obj.price   # 删除商品原价

类属性方式实现 property

2、类属性方式

创建值为 property 对象的类属性。

当使用类属性方式创建 property 属性时,经典类和新式类没有区别。

示例代码如下:


class Foo:
  def get_bar(self):
    return 'laowang'

  BAR = property(get_bar)

obj = Foo()
reuslt = obj.BAR # 自动调用get_bar方法,并获取方法的返回值
print(reuslt) # laowang

property 方法包含四个参数:

  • 第一个参数是方法名,当调用 对象.属性 时自动触发执行该方法;
  • 第二个参数是方法名,当调用 对象.属性 = XXX 时自动触发执行该方法;
  • 第三个参数是方法名,当调用 del 对象.属性 时自动触发执行该方法;第四个参数是字符串,当调用 对象.属性.__doc__ 时返回该描述信息。

示例代码如下:


class Foo(object):
  def get_bar(self):
    print("getter...")
    return 'laowang'

  def set_bar(self, value):
    """必须两个参数"""
    print("setter...")
    return 'set value' + value

  def del_bar(self):
    print("deleter...")
    return 'laowang'

  BAR = property(get_bar, set_bar, del_bar, "description...")

obj = Foo()
# 自动调用第一个参数中定义的方法:get_bar
obj.BAR # getter...
# 自动调用第二个参数中定义的方法:set_bar方法,并将“alex”当作参数传入
obj.BAR = "alex" # setter...
# 自动获取第四个参数中设置的值:description...
desc = Foo.BAR.__doc__
print(desc) # description...
# 自动调用第三个参数中定义的方法:del_bar方法
del obj.BAR # deleter...

由于类属性方式创建的 property 属性具有三种访问方式,我们可以根据这些特点,分别将三个方法定义为对同一属性的获取、修改和删除操作。


class Goods(object):

  def __init__(self):
    # 原价
    self.original_price = 100
    # 折扣
    self.discount = 0.8

  def get_price(self):
    # 实际价格 = 原价 * 折扣
    new_price = self.original_price * self.discount
    return new_price

  def set_price(self, value):
    self.original_price = value

  def del_price(self):
    del self.original_price

  PRICE = property(get_price, set_price, del_price, '价格属性描述...')

obj = Goods()
obj.PRICE     # 获取商品价格
obj.PRICE = 200  # 修改商品原价
del obj.PRICE   # 删除商品原价

综上所述:

  • 定义 property 属性共有两种方式,分别是【装饰器】和【类属性】,其中【装饰器】方式针对经典类和新式类有所不同。
  • 通过使用 property 属性,能够简化调用者获取数据的流程。

总结

总结

到此这篇关于 Python 中 property 语法的文章介绍完毕,更多相关 Python property 语法内容请搜索本站以前的文章或继续浏览下面的相关文章,希望大家以后多多支持本站!

本站声明

本文内容仅供参考,不代表本站观点。转载或引用请注明出处。如发现内容问题,请通过联系我们页面反馈。

Python 相关产品和应用

全部下载

专题列表