python 常用装饰器

@property的介绍与使用

• python的@property是python的一种装饰器，是用来修饰方法的。

作用

• 我们可以使用@property装饰器来创建只读属性，@property装饰器会将方法转换为相同名称的只读属性,可以与所定义的属性配合使用，这样可以防止属性被修改。

使用场景

装饰方法

• 修饰方法，是方法可以像属性一样访问。
• 如果使用property进行修饰后，又在调用的时候，方法后面添加了()， 那么就会显示错误信息：TypeError: ‘int’ object is not callable，也就是说添加@property 后，这个方法就变成了一个属性，如果后面加入了()，那么就是当作函数来调用，而它却不是callable（可调用）的。
• 没有使用property修饰，它是一种方法，如果把括号去掉，不会报错输出的就会是方法存放的地址。
• 代码示例

class DataSet(object):
  @property
  def method_with_property(self): ##含有@property
      return 15
  def method_without_property(self): ##不含@property
      return 15

l = DataSet()
print(l.method_with_property) # 加了@property后，可以用调用属性的形式来调用方法,后面不需要加（）。
print(l.method_without_property())  #没有加@property , 必须使用正常的调用方法的形式，即在后面加()

防止属性被修改

• ​ 由于python进行属性的定义时，没办法设置私有属性，因此要通过@property的方法来进行设置。这样可以隐藏属性名，让用户进行使用的时候无法随意修改。

class DataSet(object):
    def __init__(self):
        self._images = 1
        self._labels = 2 #定义属性的名称
    @property
    def images(self): #方法加入@property后，这个方法相当于一个属性，这个属性可以让用户进行使用，而且用户有没办法随意修改。
        return self._images 
    @property
    def labels(self):
        return self._labels
l = DataSet()
#用户进行属性调用的时候，直接调用images即可，而不用知道属性名_images，因此用户无法更改属性，从而保护了类的属性。
print(l.images) # 加了@property后，可以用调用属性的形式来调用方法,后面不需要加（）。

实现setter和getter的行为

• @property是python的一个内置装饰器，使用装饰器的目的是改变类的方法或者属性，这样调用者就无需在代码中做任何改动。

class Adult(object):    
    def __init__(self):
        self.__age = 0
    
    @property
    def age(self):
        print('getter() method called')
        return self.__age
        
    @age.setter
    def age(self, value):
        if value < 18:
            raise ValueError('Sorry, you are a child, games not allowed')
        print('setter() method called')
        self.__age = value
        
xiaoli = Adult()
xiaoli.age = 19
print(xiaoli.age)

@staticmethod 与 @classmethod

作用

• 一般来说，要使用某个类的方法，需要先实例化一个对象再调用方法。而使用@staticmethod或@classmethod，就可以不需要实例化，直接类名.方法名()来调用。
• 这有利于组织代码，把某些应该属于某个类的函数给放到那个类里去，同时有利于命名空间的整洁。

代码示例

• 分别定义静态函数，类普通函数，类函数

class A(object):
    a = 'a'
    # foo1为静态函数，用@staticmethod装饰器装饰
    @staticmethod
    def foo1(name):
        print 'hello', name
    # foo2为正常的函数，是类的实例的函数
    def foo2(self, name):
        print 'hello', name
	# foo3为类函数
    @classmethod
    def foo3(cls, name):
        print 'hello', name

• 调用

a = A()
a.foo1('mamq') # 输出: hello mamq
A.foo1('mamq')# 输出: hello mamq
a.foo2('mamq') # 输出: hello mamq
A.foo2('mamq') # 报错: unbound method foo2() must be called with A instance as first argument (got str instance instead)
a.foo3('mamq') # 输出: hello mamq
A.foo3('mamq') # 输出: hello mamq

两者区别

使用区别

• @staticmethod不需要表示自身对象的self和自身类的cls参数，就跟使用函数一样。
• @classmethod也不需要self参数，但第一个参数需要是表示自身类的cls参数。
• 如果在@staticmethod中要调用到这个类的一些属性方法，只能直接类名.属性名或类名.方法名。
• 而@classmethod因为持有cls参数，可以来调用类的属性，类的方法，实例化对象等，避免硬编码。

代码演示

• 在classmethod中可以调用类中定义的其他方法、类的属性，但staticmethod只能通过A.a调用类的属性，但无法通过在该函数内部调用A.foo2()。

class A(object):
    a = 'a'
    @staticmethod
    def foo1(name):
        print 'hello', name
        print A.a # 正常
        print A.foo2('mamq') # 报错: unbound method foo2() must be called with A instance as first argument (got str instance instead)
    def foo2(self, name):
        print 'hello', name
    @classmethod
    def foo3(cls, name):
        print 'hello', name
        print A.a
        print cls().foo2(name)

@abstractmethod

• 如果在父类中某个函数使用了@abstractmethod，那么子类中必须重新定义一遍这个函数，其子类才能实例化，否则就会报错。
• 使用@abstractmethod的作用是，提醒编程者，避免子类在编程过程中漏掉某个必要的函数。
• 代码示例

from abc import ABC, abstractmethod
 
 
class Foo(ABC):
    @abstractmethod
    def fun(self):
        '''please Implemente in subclass'''
 
 
class SubFoo(Foo):
    def fun(self):
        print('fun in SubFoo')
 
a = SubFoo()
a.fun()

参考资料

python中的cls到底指的是什么，与self有什么区别?
python @property的介绍与使用
setter在python中 python的setter的作用 转载
@abstractmethod 的作用与使用方法