开始免费使用
当前位置：首页 > Python > Python property装饰器与类属性用法详解

Python property装饰器与类属性用法详解

山海之间
山海之间
发布时间：2026-10-14| 4人浏览过
原创

本文深入解析Python中property属性的两种实现方式：@property装饰器与property类属性。详细对比了旧式类与新式类在访问方式上的差异，并通过圆形面积、分页计算及商品管理等实例，演示了如何安全地封装数据，实现属性的获取、修改与删除功能，帮助开发者选择最适合的代码风格。

property属性

这是一种特殊的属性类型，其使用体验类似于实例属性，但实际上它对应着某个方法。

为了兼顾类的封装特性，同时允许开发者通过“对象.属性”的形式来调用方法，@property 装饰器提供了一种优雅的解决方案。使用它时，可以直接通过方法名访问，无需在方法名后添加一对()小括号。

以下是一个计算圆面积的示例。


class Circle(object):

    PI = 3.14

    def __init__(self, r):
        # r圆的半径
        self.r = r
        self.__area = self.PI * self.r * self.r
    
    @property
    def area(self):
        return self.__area

    def get_area(self):
        return self.__area


In [2]: c = Circle(10)

In [3]: c.area
Out[3]: 314.0

In [4]: c.get_area()
Out[4]: 314.0

在使用property属性时，需注意以下关键点：

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

  实例方法：c.get_area()
  property装饰的方法：c.area

具体实例

以商城电脑主机列表页面为例，每次请求不应展示数据库中的所有数据，而是通过分页功能局部显示。因此，向数据库请求数据时需明确指定获取从第m条到第n条的数据。该分页功能包含以下步骤：

  • 根据用户请求的当前页码和总数据条数，计算出起始位置m和结束位置n。
  • 根据计算出的m和n向数据库请求相应数据。

class Pager(object):
    
    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

# ipython测验
In [2]: p = Pager(1)


In [3]: p.start		# 就是起始值，即：m
Out[3]: 0

In [4]: p.end		# 就是结束值，即：n
Out[4]: 10

In [5]: p = Pager(2)

In [6]: p.start
Out[6]: 10

In [7]: p.end
Out[7]: 20

property属性主要有两种实现方式：

  • 装饰器方式，即在方法上应用@property装饰器。
  • 类属性方式，即在类中定义值为property对象的类属性，具体通过property()函数实现。

装饰器方式

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

Python中的类分为旧式类和新式类两类，其中新式类的属性比旧式类的属性更为丰富。

旧式类

旧式类仅具有一种@property装饰器。


   
class Goods:
    
    def __init__(self, name):
        self.name = name
        
    @property
    def price(self):
        return 100
    
# ipython测验
In [10]: g = Goods('手表')

In [11]: g.price
Out[11]: 100

新式类

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


class Goods:
    """
    python3中默认继承object类
    以python2、3执行此程序的结果不同，因为只有在python3中才有@xxx.setter  @xxx.deleter
    """
    @property
    def price(self):
        print('@property')

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

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

        
# ipython测验
In [13]: g = Goods()

In [14]: g.price
@property

In [15]: g.price = 100
@price.setter

In [16]: del g.price
@price.deleter
  • 当单独调用g.price时，会自动执行被@property修饰的price方法，并获取该方法的返回值。
  • 当对g.price = 100进行赋值操作时，会自动执行被@price.setter修饰的price方法，并将100赋值给该方法的参数。
  • 当执行del g.price删除操作时，会自动执行被@price.deleter修饰的price方法。

注意事项

  • 在旧式类中，属性只有一种访问方式，其对应被@property修饰的方法。
  • 在新式类中，属性有三种访问方式，分别对应被@property、@方法名.setter和@方法名.deleter修饰的方法。

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


# Goods类@property应用

class Goods(object):

    def __init__(self, name, price):
        # 原价
        self.original_price = price

        # 折扣
        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):
        print('删除商品原价')
        del self.original_price

        
# ipython测验
In [22]: g = Goods('小米手机', 2000)

In [23]: g.price
Out[23]: 1600.0

In [24]: g.price = 3000

In [25]: g.price
Out[25]: 2400.0

In [26]: del g.price
删除商品原价

In [27]: g.price
---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
<ipython-input-27-38ee45b469f2> in <module>
----> 1 g.price

<ipython-input-18-d5ea66eb7ece> in price(self)
     12     def price(self):
     13         # 实际价格 = 原价 * 折扣
---> 14         new_price = self.original_price * self.discount
     15         return new_price
     16

AttributeError: 'Goods' object has no attribute 'original_price'

类属性方式

创建值为property对象的类属性。当使用类属性方式创建property属性时，旧式类和新式类的表现无区别。


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

    BAR = property(get_bar)
    
    
# ipython 测验
In [32]: f = Foo()

In [33]: f.BAR
Out[33]: 'get_bar'

当调用f.BAR时，会自动调用get_bar()方法，并获取方法的返回值。

property()函数包含四个参数：

  • 第一个参数是方法名，当调用“对象.属性”时自动触发执行该方法。
  • 第二个参数是方法名，当调用“对象.属性 = XXX”时自动触发执行该方法。
  • 第三个参数是方法名，当调用“del 对象.属性”时自动触发执行该方法。
  • 第四个参数是字符串，用于描述该属性，可通过“对象.属性._doc_”调用。

class Foo(object):

    def __init__(self, bar):
        self.bar = bar
    
    def get_bar(self):
        print('get_bar')
        return self.bar

    def set_bar(self, value): 
        """必须要有两个参数"""
        print('set bar ' + value)
        self.bar = value

    def del_bar(self):
        print('del bar')
        del self.bar

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

    
# ipython测验
In [50]: f = Foo('python')

In [51]: f.BAR
get_bar
Out[51]: 'python'

In [52]: f.BAR = 'Java'
set bar Java

In [53]: f.BAR
get_bar
Out[53]: 'Java'

In [54]: del f.BAR
del bar

property对象与@property装饰器对比

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

property对象类属性


# Goods类 property对象类属性 应用

class Goods(object):

    def __init__(self, name, price):
        # 原价
        self.original_price = price

        # 折扣
        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):
        print('删除商品原价')
        del self.original_price

    PRICE = property(get_price, set_price, del_price, "price description")

    
# ipython测验
In [59]: g = Goods('Mac电脑', 9000)

In [60]: g.PRICE
Out[60]: 7200.0

In [61]: g.PRICE = 10000

In [62]: g.PRICE
Out[62]: 8000.0

In [63]: del g.PRICE
删除商品原价

@property装饰器


# Goods类 @property装饰器 应用

class Goods(object):

    def __init__(self, name, price):
        # 原价
        self.original_price = price

        # 折扣
        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):
        print('删除商品原价')
        del self.original_price
        
        
# ipython测验
In [59]: g = Goods('Mac电脑', 9000)

In [60]: g.PRICE
Out[60]: 7200.0

In [61]: g.PRICE = 10000

In [62]: g.PRICE
Out[62]: 8000.0

In [63]: del g.PRICE
删除商品原价

可以看出，两种方式均可实现功能。但@property装饰器在旧式类中只有@property，没有@method.setter和@method.deleter；而在新式类中，两种方式均可使用。因此，可根据个人习惯选择其中一种。

大自然用数百亿年创造出我们现实世界，而程序员用几百年创造出一个完全不同的虚拟世界。我们用键盘敲出一砖一瓦，用大脑构建一切。人们把1000视为权威，我们反其道行之，捍卫1024的地位。我们不是键盘侠，我们只是平凡世界中不凡的缔造者。

到此这篇关于Python中property使用技巧的文章就介绍到这了，更多相关Python property内容请搜索本站以前的文章或继续浏览下面的相关文章，希望大家以后多多支持本站！

相关文章

相关标签: Python 面向对象编程

免责声明：本文内容仅供参考，不代表本站观点。转载或引用请注明出处。

作者最新文章

全部文章

Python 相关产品和应用

全部下载
PythonSelenium
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

Python机器学习
scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Python代码质量
Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Python代码质量
Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

Pythonpytest
pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

PythonFastAPI
FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架，支持类型提示和自动接口文档。

PythonFlask
Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

PythonDjango
Django

Django

6.1.2 · Windows

成熟的 Python Web 框架，适合构建内容站点和业务系统。

PythonSpyder
Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

PythonSciPy
SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。