Python—property

property

概述

在python中主要为属性提供一个便利的操作方式

如果我们现在需要设计一个银行账户类，这个类中包含账户人的姓名，余额（假如现在不考虑具体的操作接口）

class Account(object):
    def __init__(self,name,money):
        self.name=name
        self.money=money

问题：不安全（设计很简单方便，所有的属性外部可以访问修改，非常不安全）

改进1

• 隐藏细节

对于账户信息而言，金额不允许让用户直接修改。如果修改，只能去窗口办理

程序的实现该如何操作？

在使用对象时。尽量不要让使用者直接操作对象中的属性，因为直接操作会带来安全隐患

这个时候考虑私有属性

class Account(object):
    def __init__(self,name,money):
        self.__name=name
        self.__money=money

代码改进以后，将所有的属性设计成私有属性后。确实从外部使用时，不知道内部的属性，不能直接修改对象，隐藏了细节

但一个新的问题，如果确实需要对属性进行修改，该怎么办？

改进二

添加方法实现对数据的更改

class Account(object):
    def __init__(self,name,money):
        self.__name=name
        self.__balance=money

    def get_name(self):
        return self.__name
    def set_balance(self,money):
        self.__balance=money
    def get_balance(self):
        return self.__balance

经过修改，外部使用这个类的对象时，想使用对象中的属性，只能通过类中提供的 set/get 接口来操作，提高了程序的安全性。

这样，程序基本达到了设计需求，但是能不能更加完善呢？

如果在使用这个类的对象过程中，由于误操作，传入了不正常的数据，导致数据异常。该如何以避免这种情况发生呢？

比如：设置金额时出现了负数，或字符串，或其它类型的对象。

改进三

set_balance方法中，对传入数据进行有效性判断，如果是无效数据，提示用户出错

class Account(object):
    def __init__(self,name,money):
        self.__name=name
        self.__balance=money

    def get_name(self):
        return self.__name
    def set_balance(self,money):
        if isinstance(money,int):
            if money>0:
                self.__balance = money
            else:
                raise ValueError('输入金额不正确')
        else:
            raise ValueError('输入金额不是数据')

    def get_balance(self):
        return self.__balance

通过 property 类实例对象以后，在使用对象中的属性时，就可以像使用普通公有属性一样来调用，但是实际调用的还是 set/get 方法。 在实例 property 对象时，不是所有的参数都需要写，比如示例中的 name 只提供了 get 方法，并且是一个私有的方法。这样就完全隐藏了内部的实现细节 。

经过几个版本的迭代，程序看上去越来越健壮，安全性也越来越高

但是使用过程中，可不可以更精炼一些？

属性操作

property类

在python中提供了一个property类，通过对创建这个类的对象的设置，在使用对象的私有属性时，可以不再使用属性的函数调用方式，而是像普通的公有属性一样去使用属性，为开发者提供便利

property(fget=None,fset=None,fdel=None,doc=None) # property attribute

property是一个类，__init__方法由四个参数组成，实例后返回一个用来操作属性的对象

• 参数一：属性的获取方法
• 参数二：属性的设置方法
• 参数三：属性的删除方法
• 参数四：属性描述

class Account(object):
    def __init__(self,name,money):
        self.__name=name
        self.__balance=money

    def __get_name(self):
        return self.__name
    def set_balance(self,money):
        if isinstance(money,int):
            if money>0:
                self.__balance = money
            else:
                raise ValueError('输入金额不正确')
        else:
            raise ValueError('输入金额不是数据')

    def get_balance(self):
        return self.__balance
    # 使用property类来为属性设置便利的访问方式
    name=property(__get_name)
    balance=property(get_balance,set_balance)

ac=Account('Tom',10000)
print(ac.name)
print(ac.balance)
ac.balance=1000
print(ac.balance)

Tom
10000
1000

简洁之后的写法

class Account(object):
    def __init__(self,name,money):
        self.__name=name
        self.__balance=money


    @property
    def name(self):
        return self.__name
    @property
    def balance(self):
        return self.__balance
    @balance.setter
    def balance(self,money):
        if isinstance(money,int):
            if money>0:
                self.__balance = money
            else:
                raise ValueError('输入金额不正确')
        else:
            raise ValueError('输入金额不是数据')

ac=Account('Tom',10000)
print(ac.name)
print(ac.balance)
ac.balance=1000
print(ac.balance)

Tom
10000
1000

self

如果对象的方法中需要使用该对象的属性，该怎么办？

• 关键字self主要用于对象方法中，表示调用该方法的对象
• 在方法中使用self，可以获取到调用当前方法的对象，进而获取该对象的属性和方法

调用对象的方法时，为什么不需要设置self对应的参数

• 某个对象调用其方法时，python解释器会把这个对象作为第一个参数传递给方法，所以，开发者只需要在定义的时候“预留第一个参数”self即可

class Cat:
    # 方法
    def introduce(self):
        print('name is %s,age is: %d'%(self.name,self.age))
# 实例化，创建一个对象
cat=Cat()
cat.name='蓝猫'
cat.age=6
cat.introduce()

name is 蓝猫,age is: 6

方法内定义属性

• 使用self操作属性和对象的变量名在效果上类似。如果属性在赋值时还没有被定义，就会自动定义一个属性并赋值

class Cat:
    def introduce(self):
        self.type='aaa'

cat=Cat()
cat.introduce()
print(cat.type)

aaa

__new__方法

• 创建对象时，系统会自动调用__new__方法
• 开发者可以使用__new__方法来自定义对象的创建过程
• __new__至少要有一个参数cls，代表要实例化的类，此参数在实例化时由Python解释器自动提供
• __new__必须要有返回值，返回实例化出来的实例，这点在自己实现__new__时要特别注意，可以return父类__new__出来的实例，或者直接是object的__new__出来的实例
• __init__有一个参数self，就是这个__new__返回的实例，__init__在__new__的基础上可以完成一些其它初始化的动作，__init__不需要返回值
• 如果创建对象时传递了自定义参数，且重写了new方法，则new也必须 “预留” 该形参,否则__init__方法将无法获取到该参数

class A(object):
    def __new__(cls, x):
        print('this is in A.__new__, and x is ', x)
        return super(A, cls).__new__(cls)

    def __init__(self, y):
        print('this is in A.__init__, and y is ', y)

class C(object):
    def __new__(cls, n):
        print('this is in C.__new__, and n is ', n)
        return super(C, cls).__new__(cls)

    def __init__(self, a):
        print('this is in C.__init__, and a is ', a)


class B(A):
    def __new__(cls, z):
        print('this is in B.__new__, and z is ', z)
        return A.__new__(cls, z)

    def __init__(self, m):
        print('this is in B.__init__, and m is ', m)

# class B(A):
#     def __new__(cls, z):
#         print('this is in B.__new__, and z is ', z)
#         return object.__new__(cls)
#     def __init__(self, m):
#         print('this is ni B.__init__, and m is ', m)

if __name__ == '__main__':
    a = A(100)
    print('=' * 20)
    b = B(200)
    print(type(b))
    
this is in A.__new__, and x is  100
this is in A.__init__, and y is  100
====================
this is in B.__new__, and z is  200
this is ni B.__init__, and m is  200
<class '__main__.B'>

__call__方法

对象后面加括号，触发执行

构造方法的执行是有创建对象触发的，即：对象=类名()

而对于，__call__方法的执行是由对象后加括号触发的，即对象()或者类()

class A(object):
    def __call__(self, x):
        print('__call__ called, print x: ', x)

a = A()
a('123')

__call__ called, print x:  123

__doc__方法

class Foo:
    """这是一段说明"""
    pass
class Bar(Foo):
    pass
print(Foo.__doc__)
print(Bar.__doc__) # 该属性无法继承给子类

这是一段说明
None