Python @property 与 @staticmethod 与 @classmethod 装饰器的介绍与使用

一、@property

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

作用:

  1. 可以使用@property装饰器来创建只读属性,@property装饰器会将方法转换为相同名称的只读属性
  2. 可以与所定义的属性配合使用,这样可以防止属性被修改。
  3. 对类的私有属性进行操作

1.1. 修饰方法,使方法可以像属性一样访问

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 , 必须使用正常的调用方法的形式,即在后面加()

两个都输出为15。

class DataSet(object):
  @property
  def method_with_property(self): ##含有@property
      return 15
l = DataSet()
print(l.method_with_property()) # 加了@property后,可以用调用属性的形式来调用方法,后面不需要加()。

如果使用property进行修饰后,又在调用的时候,方法后面添加了 (), 那么就会显示错误信息:TypeError: 'int' object is not callable,也就是说添加 @property 后,这个方法就变成了一个属性,如果后面加入了 (),那么就是当作函数来调用,而它却不是 callable(可调用)的。

class DataSet(object):
  def method_without_property(self): ##不含@property
      return 15
l = DataSet()
print(l.method_without_property) #没有加@property , 必须使用正常的调用方法的形式,即在后面加()

没有使用property修饰,它是一种方法,如果把括号去掉,不会报错,输出的就会是方法存放的地址。

1.2.与所定义的属性配合使用,这样可以防止属性被修改

​ 由于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后,可以用调用属性的形式来调用方法,后面不需要加()。

即,如果这样调用

l = DataSet()
l.images = 5

会报错:AttributeError: can't set attribute

当然,如果用户强行调用

l = DataSet()
l._images = 5

那属性就被改了

私有属性

1)单下划线 _ 开头:只是告诉别人这是私有属性,外部依然可以访问更改    
2)双下划线__开头:外部不可通过 instancename. propertyname来访问或者更改,而实际将其转化为了 _classname__propertyname

1.3 对类的私有属性进行操作

一般为了程序安全而封装的原因,python中会有一些私有属性,无法直接访问,那么这个时候如果操作他呢,就需要类给提供相应的 getter / setter方法。

1. 通过自定义get,set方法,调用方法的形式去对私有属性进行操作

class People(object):
    def get_name(self):
        # 返回前还可以对数据做处理,比如格式化等
        return self._name
    def set_name(self, value):
        if not isinstance(value, str):   # 在赋值之前添加判断
            raise TypeError('People object.name,name must be a str!')  # 抛出异常
        self._name = value

# 调用的时候仍然是方便快捷的直接赋值:
p1 = People()
p1.set_name('李四')
print(p1.get_name())  # 李四

2. 使用property标注同名函数的形式。这是最终开发中常用的方法。

class People(object):
    def __init__(self, name, age):
        self.name = name
        self.age = age

    @property
    def name(self):
        # 返回前还可以对数据做处理,比如格式化等
        return self._name

    @name.setter
    def name(self, value):
        if not isinstance(value, str):   # 在赋值之前添加判断
            raise TypeError('People object.name,name must be a str!')  # 抛出异常
        self._name = value

# 调用的时候仍然是方便快捷的直接赋值:
p1 = People('张三', 22)
p1.name = '李四'
print(p1.name)  # 李四
p1.name = 33    # TypeError: People object.name,name must be a str!

@name.setter(类似于 setter 操作),就可以对属性 name 赋值,而且可以加上对所赋值的属性进行判断。

总结

  1. @property 成为属性函数,可以对属性赋值时做必要的检查,比如在 setter 方法里加过滤判断条件。此外相比自定义的 getset 方法,property 保证了代码的短小精悍,对私有属性的操作代码格式化模块化。
  2. @property只有一个参数 self,且要有返回值,所以一般定义属性的 get 方法。
  3. 注意 @property 调用方式,没有括号,而是直接调用属性名即可。

=============================================================

二、@staticmethod

普通的类内函数是需要实例化之后才可以调用的,但是 @staticmethod 静态方法无需实例化也可直接调用

class cal:
    def __init__(self,x,y):
        self.x = x
        self.y = y

    @staticmethod       #静态方法 类或实例均可调用
    def cal_test(a,b,c): #改静态方法函数里不传入self 或 cls
        print(a,b,c)

# 实例化
c1 = cal(10,11)
c1.cal_test(1,2,3)      #>>> 1 2 3
# 静态方法无需实例化也可直接调用
cal.cal_test(1,2,3)     #>>> 1 2 3

@classmethod

参考:正确理解Python中的 @staticmethod@classmethod方法

参考:

  1. python @property的介绍与使用

你可能感兴趣的:(python,python)