Python描述符使用方法

最新推荐文章于 2025-04-25 09:32:21 发布

原创最新推荐文章于 2025-04-25 09:32:21 发布 · 298 阅读

1 ·

CC 4.0 BY-SA版权

Python编程进阶专栏收录该内容

3 篇文章

订阅专栏

本文详细介绍了Python中的描述符概念及其实现方式，包括通过定义特定方法如__get__、__set__等来控制属性访问的过程，并对比了使用property装饰器和传统方法的区别。

描述符

个人的理解是，描述符其实就是增强版的属性。比如创建一个类，人。人有一个属性name。我现在想在初始化的时候，对这个name属性的长度进行限制。我还想在调用该属性的时候，打印某些东西。设置该属性的时候，可以进行判断。那么我们可以创建一个Name类，把name属性托管给Name类。这个Name类就是描述符。

具体实现

首先作为一个描述符类，必须实现下面几个方法之一：

__set__(self, instance, value)
__get__(self, instance, owner)
__delete__(self, instance)

这其中self是描述符类的实例对象，instance是属性被托管类的实例，owner是属性被托管的类。

代码

示例：

class Name(object):
	# 描述符类
    def __init__(self, name = "Jiaqi"):
        self._name = name
    
    def __get__(self, instance, owner):
        return self._name

    def __set__(self, instance, value):
    	#限制一下名字长度
        if len(value) < 10 and len(value) > 1:
            print("descriptor's name")
            self._name = value
        else:
            raise ValueError("The length of name is error.")
    def __delete__(self, instance):
        del self._name

class Person(object):
	# 托管
    name = Name()
    def __init__(self, name):
        self.name = name

Jiaqi = Person("Jiaqi")
Jiaqi.name

结果：

descriptor's name
'Jiaqi'

property函数

这样比较复杂。Python提供了一个内置的描述符。我们可以通过Property()函数来创建描述符，非常方便，示例如下:

class Person(object):
    def __init__(self, name, height):
        self._name = name
        self._height = height
    
    def _name_get(self):
        return self._name
    
    def _name_set(self, value):
        self._name = value
    
    def _heigth_get(self):
        return self._height

    def _height_set(self, value):
        self._height = value
    
    name = property(_name_get, _name_set)
    height = property(_heigth_get, _height_set)

    def __repr__(self):
        return "{} name is {}, height is {}.".format(
            self.__class__.__name__,        
            self._name, self._height
        )
jiaqi = Person("Jiaqi", 183)
print(jiaqi.name)
print(jiaqi.height)
jiaqi

结果：

Jiaqi
183
Person name is Jiaqi, height is 183.

当然，这种方法有时候比较不好。因为子类继承父类后，如果父类中使用了property()函数实现了一个描述符，此时我们如果覆写了子类的_name_get函数的话（以上面的例子为例），Property函数中使用的_name_get函数还是父类的。因此如果使用property函数，需要在子类中覆写。

使用property装饰器

一种比较妥善的方法是，使用property作为装饰器。
基本方法如下：

class Person(object):
    def __init__(self, name, height):
        self._name = name
        self._height = height
    
    @property
    def name(self):
        return self._name
    
    @name.setter
    def name(self, value):
        self._name = value

    @property
    def height(self):
        return self._height
    
    @height.setter
    def height(self, value):
        self._height = value


    def __repr__(self):
        return "{} name is {}, height is {}.".format(
            self.__class__.__name__,        
            self._name, self._height
        )
jiaqi = Person("Jiaqi", 183)
print(jiaqi.name)
print(jiaqi.height)
jiaqi

结果：

Jiaqi
183
Person name is Jiaqi, height is 183.