Python——property函数、类方法和静态方法以及描述符

hardStudy_h

已于 2024-08-30 10:19:53 修改

阅读量1k

点赞数 21

分类专栏： Python笔记文章标签： python 开发语言

于 2024-08-30 10:18:31 首次发布

本文链接：https://blog.csdn.net/weixin_45720999/article/details/141677654

版权

Python笔记专栏收录该内容

28 篇文章 0 订阅

订阅专栏

`property()` 函数

Python 中的 property() 函数是一个内置函数，用于将类的方法属性化。这意味着你可以像访问数据属性一样访问这些方法，但实际上这些方法会执行一些操作（如计算值、验证输入等），然后返回结果。这种方式使得类的使用更加直观，同时保持了类的封装性。

基本原理

property()函数本质上创建了一个只读、只写或可读写的属性。这个属性背后可以绑定到类的某个方法上，但对外表现仍然像是一个数据属性。这通过Python的描述符协议（descriptor protocol）实现，但property()函数为用户隐藏了这些底层的复杂性。

参数

property()函数可以接收四个参数，但通常只需要前三个：

fget：一个函数，用于获取属性值。如果不提供，则属性是只写的。
fset：一个函数，用于设置属性值。如果不提供，则属性是只读的。
fdel：一个函数，用于删除属性。如果不提供，则属性不能被删除。
doc：属性的文档字符串。这是一个可选参数，用于提供属性的文档。

使用方式

作为装饰器

property()函数最常见的用法是作为装饰器来修饰类中的方法。这要求Python 3.x版本，因为Python 2.x需要稍微不同的语法。

class Circle:  
    def __init__(self, radius=1.0):  
        self._radius = radius  
  
    @property  
    def radius(self):  
        """获取圆的半径"""  
        return self._radius  
  
    @radius.setter  
    def radius(self, value):  
        """设置圆的半径，确保半径为正数"""  
        if value >= 0:  
            self._radius = value  
        else:  
            raise ValueError("半径不能为负数")  
  
    @radius.deleter  
    def radius(self):  
        """删除圆的半径（这里只是演示，实际中可能不需要）"""  
        del self._radius  
  
# 使用  
c = Circle()  
print(c.radius)  # 访问属性值  
c.radius = 5  
print(c.radius)  # 修改属性值  
# c.radius = -1  # 这会抛出 ValueError  
# del c.radius    # 这会删除 _radius 属性

手动调用

在Python 2.x中，或者出于某种特定的目的，你也可以手动调用property()函数，并将其结果赋值给一个类属性。

class Circle:  
    def __init__(self, radius=1.0):  
        self._radius = radius  
  
    def get_radius(self):  
        return self._radius  
  
    def set_radius(self, value):  
        if value >= 0:  
            self._radius = value  
        else:  
            raise ValueError("半径不能为负数")  
  
    # 创建属性  
    radius = property(get_radius, set_radius)  
  
# 使用  
c = Circle()  
print(c.radius)  # 访问属性值  
c.radius = 5  
print(c.radius)  # 修改属性值

优点

封装：隐藏了属性的实现细节，只暴露了必要的接口。
灵活性：可以在获取、设置或删除属性时执行额外的逻辑，如验证、计算等。
易读性：代码更加清晰，易于理解，特别是当属性访问背后有复杂逻辑时。

注意事项

当使用property()时，要确保内部状态（即self._x等）的命名与公开的属性名（即x）有所区别，以避免命名冲突和潜在的混淆。
尽管property()提供了很大的灵活性，但过度使用可能会使类的接口变得复杂和难以理解。因此，应谨慎使用，并确保其真正提高了代码的清晰度和可维护性。

类方法（Class Methods）

Python中的类方法（Class Methods）是一种特殊的方法，它属于类本身，而不是类的实例。类方法接收类作为第一个参数（按照惯例，这个参数通常命名为cls），而不是类的实例。这允许类方法执行那些不依赖于实例状态的操作，比如修改类属性或访问类级别的数据。

类方法通过@classmethod装饰器来定义。这使得该方法能够访问类变量和类方法，但不能直接访问实例变量或实例方法（因为没有具体的实例）。

定义类方法

下面是一个简单的例子，展示了如何定义一个类方法：

class MyClass:  
    counter = 0  # 类变量  
  
    @classmethod  
    def increment(cls):  
        cls.counter += 1  # 修改类变量  
        print(f"Counter is now: {cls.counter}")  
  
# 调用类方法  
MyClass.increment()  # 输出: Counter is now: 1  
MyClass.increment()  # 输出: Counter is now: 2

在这个例子中，increment是一个类方法，它通过@classmethod装饰器来定义。这个方法简单地递增了类变量counter的值，并打印出当前的计数值。注意，由于这是一个类方法，它接收cls作为第一个参数（尽管在方法内部我们没有直接使用它，但它是必需的），并且可以直接访问和修改类变量counter。

类方法与实例方法的区别

实例方法：属于类的实例（对象），可以访问和修改实例变量和实例方法，也能访问类变量和类方法。实例方法的第一个参数通常是self，它代表类的实例本身。
类方法：属于类本身，不依赖于任何实例。它可以访问和修改类变量和类方法，但不能直接访问或修改实例变量和实例方法（除非通过类的实例来间接访问）。类方法的第一个参数通常是cls，它代表类本身。

使用场景

类方法通常用于以下场景：

当你需要一个方法，这个方法需要访问类变量或类方法，但不涉及任何实例变量或实例方法时。
当你需要实现一些工厂方法时，这些方法用于创建类的实例，但创建过程需要类级别的信息或决策。
当你需要实现单例模式时，类方法可以用来控制类的实例数量。

总之，类方法是Python中一种强大的工具，允许你在类级别上执行操作，而不需要创建类的实例。

静态方法（Static Methods）

Python中的静态方法（Static Methods）是定义在类中，但与类本身和类的实例都没有直接关联的方法。静态方法既不接收类（cls）作为第一个参数，也不接收实例（self）作为第一个参数。这意味着静态方法既不能访问类的属性或方法，也不能访问实例的属性或方法，除非它们被明确地作为参数传递给该方法。

静态方法通过@staticmethod装饰器来定义。虽然它们定义在类中，但实际上更像是与类名相关联的命名空间中的普通函数。

定义静态方法

下面是一个简单的例子，展示了如何定义一个静态方法：

class MyClass:  
    @staticmethod  
    def static_method():  
        print("这是一个静态方法")  
  
# 调用静态方法  
MyClass.static_method()  # 输出: 这是一个静态方法  
  
# 也可以通过类的实例调用，但这样做并没有实际意义  
instance = MyClass()  
instance.static_method()  # 同样输出: 这是一个静态方法

静态方法与实例方法和类方法的区别

实例方法：属于类的实例（对象），可以访问和修改实例变量和实例方法，也能访问类变量和类方法（但不能直接修改类变量，除非在类方法中通过类名来修改）。实例方法的第一个参数是self，代表类的实例本身。
类方法：属于类本身，可以访问和修改类变量和类方法，但不能直接访问或修改实例变量和实例方法（除非通过类的实例来间接访问）。类方法的第一个参数是cls，代表类本身。
静态方法：与类本身和类的实例都没有直接关联，既不能访问类变量也不能访问实例变量，除非这些变量被明确地作为参数传递给该方法。静态方法没有隐含的第一个参数。

使用场景

静态方法的使用场景相对较少，但在某些情况下它们可以非常有用：

当你想要将一组逻辑上相关的函数组织在一起时，可以使用静态方法将它们放在同一个类中。这样做的好处是提高了代码的可读性和可维护性，因为这些函数现在有了共同的命名空间。
当你想要定义一个辅助函数，该函数不需要访问类的任何属性或方法，但仍然希望它与类保持关联时，静态方法是一个很好的选择。

总之，静态方法是Python中一种有用的工具，允许你在类中定义与类本身和类的实例都不直接关联的方法。然而，它们的使用应该谨慎，以避免滥用或误用。

描述符

Python中的描述符（Descriptors）是一种特殊类型的对象，它们实现了__get__(), __set__(), 和 __delete__() 方法中的至少一个。这些方法允许描述符对象控制对另一个对象的属性的访问。描述符是Python数据模型中的一个高级特性，它们通常用于实现像属性（property）、方法（method）、函数（function）、以及类的其他特性这样的内置类型。即描述符只能应用于类属性。

描述符的分类

在Python中，描述符是用来代理一个类的属性的特殊类。根据描述符实现的方法不同，可以将描述符分为两类：

数据描述符（Data Descriptor）：
- 至少实现了__get__()和__set__()两个方法的描述符。
- 数据描述符的优先级高于实例属性。
非数据描述符（Non-Data Descriptor）：
- 没有实现__set__()方法的描述符，但可能实现__get__()和__delete__()方法。
- 非数据描述符的优先级低于实例属性。

描述符的优先级

在Python中，当一个实例的属性被访问或修改时，Python会按照以下顺序搜索相应的属性（即描述符的优先级）：

类属性：直接在类上定义的属性（例如class MyClass: attr = value），如果直接访问类属性，则不会触发描述符的方法。
数据描述符：如果属性是一个数据描述符，则直接调用该描述符的__get__()方法来获取值，如果需要设置值，则调用__set__()方法。数据描述符的优先级高于实例属性。
实例属性：如果属性不是描述符或者不是数据描述符，Python会尝试在实例的__dict__中查找该属性。如果找到了，则直接返回或修改该属性的值。
非数据描述符：如果属性是一个非数据描述符，且不在实例的__dict__中，则调用该描述符的__get__()方法来获取值（如果定义了__delete__()方法，则在删除属性时调用）。非数据描述符的优先级低于实例属性。
__getattr__()方法：如果以上所有方式都没有找到属性，则调用类的__getattr__()方法（如果定义了该方法）。这通常用于实现默认属性值或处理未知的属性访问。

描述符的用途

描述符主要用于以下场景：

属性封装：通过描述符，你可以控制对对象属性的访问，包括读取、设置和删除。这可以用来实现属性的验证、计算属性（即，其值基于其他属性计算得出）、以及属性的只读或只写行为。
方法绑定：Python中的方法（尤其是实例方法）就是描述符的一个例子。当方法被定义在类中时，它们作为未绑定的方法存在。但是，当这些方法被实例调用时，它们会自动绑定到该实例上，这就是描述符在起作用。
类元编程：描述符可以用于创建具有动态行为的类，这些行为在类定义时可能还不完全清楚。例如，你可以使用描述符来在访问属性时自动加载数据，或者将属性的修改记录到日志中。

描述符的协议

描述符必须实现以下一个或多个特殊方法：

__get__(self, instance, owner)：当尝试访问属性时调用。instance 是拥有该属性的对象实例，owner 是该属性被定义到的类（如果通过类访问属性，则 instance 为 None）。
__set__(self, instance, value)：当尝试修改属性时调用。value 是新的属性值。
__delete__(self, instance)：当尝试删除属性时调用。

示例：实现一个只读描述符

下面是一个简单的只读描述符实现，它不允许对属性进行修改：

class ReadOnlyDescriptor:  
    def __init__(self, initial_value):  
        self.value = initial_value  
  
    def __get__(self, instance, owner):  
        return self.value  
  
    def __set__(self, instance, value):  
        raise AttributeError("这个属性是只读的")  
  
class MyClass:  
    x = ReadOnlyDescriptor(10)  
  
obj = MyClass()  
print(obj.x)  # 输出: 10  
  
# 尝试修改属性将引发 AttributeError  
# obj.x = 20

具体的访问顺序：

1.属性装饰：在类 MyClass 中，x 属性被赋值为 ReadOnlyDescriptor 类的一个实例。这通常在类定义的顶层完成，看起来像这样：

class MyClass:  
    x = ReadOnlyDescriptor(10)

这样，x 属性就变成了一个描述符。

2.访问属性：当你创建 MyClass 类的实例 obj并访问 obj.x 时，Python 会按照以下步骤处理：

首先，Python 检查 obj的实例字典 __dict__ 是否有 x 属性。
如果没有找到，Python 会查找 MyClass 类的字典，发现 x 是一个描述符。
由于 x 是一个描述符，Python 调用 ReadOnlyDescriptor 实例的 __get__ 方法来获取属性值。

3.调用 __get__ 方法：__get__ 方法被调用时，会传入三个参数：实例 instance（这里是 obj），类 owner（这里是 MyClass 类），以及属性名 name（这里是 'x'）。__get__ 方法内部会调用在 ReadOnlyDescriptor 实例化时传入的参数10，并返回其结果。

注意事项

当描述符对象被用作另一个对象的属性时，如果描述符的__get__、__set__或__delete__方法被定义，则这些方法将覆盖对属性的直接访问。
描述符通常定义在类的外部，并以某种方式（如作为类属性）与类相关联。但是，描述符本身也可以是类的实例或子类。
默认情况下，如果一个类定义了__get__方法但没有定义__set__方法，则这个属性被认为是只读的。相反，如果定义了__set__但没有定义__get__，则这个属性是写保护的（即，不能读取其值，但可以设置）。
描述符在Python的许多内置类型中都有应用，例如，property、classmethod和staticmethod都是描述符的实现。