property staticmathod classmethod 反射

使用@property

在绑定属性时，如果我们直接把属性暴露出去，虽然写起来很简单，但是，没办法检查参数，导致可以把成绩随便改：

s = Student()
s.score = 9999

这显然不合逻辑。为了限制score的范围，可以通过一个set_score()方法来设置成绩，再通过一个get_score()来获取成绩，这样，在set_score()方法里，就可以检查参数：

class Student(object):

    def get_score(self):
         return self._score

    def set_score(self, value):
        if not isinstance(value, int):
            raise ValueError('score must be an integer!')
        if value < 0 or value > 100:
            raise ValueError('score must between 0 ~ 100!')
        self._score = value

现在，对任意的Student实例进行操作，就不能随心所欲地设置score了：

>>> s = Student()
>>> s.set_score(60) # ok!
>>> s.get_score()
60
>>> s.set_score(9999)
Traceback (most recent call last):
  ...
ValueError: score must between 0 ~ 100!

但是，上面的调用方法又略显复杂，没有直接用属性这么直接简单。

有没有既能检查参数，又可以用类似属性这样简单的方式来访问类的变量呢？对于追求完美的Python程序员来说，这是必须要做到的！

还记得装饰器（decorator）可以给函数动态加上功能吗？对于类的方法，装饰器一样起作用。Python内置的@property装饰器就是负责把一个方法变成属性调用的：

class Student(object):

    @property
    def score(self):
        return self._score

    @score.setter
    def score(self, value):
        if not isinstance(value, int):
            raise ValueError('score must be an integer!')
        if value < 0 or value > 100:
            raise ValueError('score must between 0 ~ 100!')
        self._score = value

@property的实现比较复杂，我们先考察如何使用。把一个getter方法变成属性，只需要加上@property就可以了，此时，@property本身又创建了另一个装饰器@score.setter，负责把一个setter方法变成属性赋值，于是，我们就拥有一个可控的属性操作：

>>> s = Student()
>>> s.score = 60 # OK，实际转化为s.set_score(60)
>>> s.score # OK，实际转化为s.get_score()
60
>>> s.score = 9999
Traceback (most recent call last):
  ...
ValueError: score must between 0 ~ 100!

注意到这个神奇的@property，我们在对实例属性操作的时候，就知道该属性很可能不是直接暴露的，而是通过getter和setter方法来实现的。

还可以定义只读属性，只定义getter方法，不定义setter方法就是一个只读属性：

class Student(object):

    @property
    def birth(self):
        return self._birth

    @birth.setter
    def birth(self, value):
        self._birth = value

    @property
    def age(self):
        return 2015 - self._birth

上面的birth是可读写属性，而age就是一个只读属性，因为age可以根据birth和当前时间计算出来。

小结

@property广泛应用在类的定义中，可以让调用者写出简短的代码，同时保证对参数进行必要的检查，这样，程序运行时就减少了出错的可能性。

(译文)Python中的staticmethod与classmethod

 

原文是stackoverflow的一则高票回答，原文链接
可能之前也有人翻译过，但是刚好自己也有疑惑，所以搬运一下，个人水平有限所以可能翻译存在误差，欢迎指正（如侵删）。

---

尽管classmethod和staticmethod非常的相似，但是两者在具体的使用上还是有着细微的差别：classmethod必须使用类对象作为第一个参数，而staticmethod则可以不传递任何参数。

让我们通过实际的例子来看看。

样板

让我们假设有处理日期信息的类：

class Date(object):
    day = 0
    month = 0
    year = 0
    
    def __init__(self, day=0, month=0, year=0):
        self.day = day
        self.month = month
        self.year = year

这个类很显然可以被用来存储某些日期信息（不考虑时区信息；让我们假设所有的日期都用UTC表示）

这里定义了__init__，典型的类实例初始化方法，它作为典型的instancemethod接受参数，其中第一个传递的必要参数是新建的实例本身。

类方法

有一些可以通过使用classmethod很好解决的任务。

假设我们有很多('dd-mm-yyyy')格式字符串的日期信息，想要把它们创建成Date类实例。我们不得不在项目的不同地方做这些事情。

所以我们必须要做到：

1. 分析得到的年月日字符串，把它们转化成三个整形变量或者拥有三个元素的元组的变量。
2. 通过传递这些值实例化Date。

得到：

day, month, year = map(int, string_date.split('-'))
date1 = Date(day, month, year)

C++拥有重载的特性可以达到这种目的，但是Python缺乏此类特性。所以，python使用classmethod的方式。让我们尝试一种另类的构造函数。

    @classmethod
    def from_string(cls, date_as_string):
        day, month, year = map(date_as_string.split('-'))
        date1 = cls(day, month, year)
        return date1

date2 = Date.from_string('11-09-2012')

进一步分析一下以上代码的执行，以及它的优势：

1.在一个地方解析日期字符串并且重复使用它。
2.做到很好的封装（相对于把执行字符串解析作为一个单独的函数在任何地方执行，这里使用的方法更符合OOP的范式）
3.cls表示类对象，而不是类实例。这样很酷，因为如果我们继承Date类，那么所有的子类也都将拥有from_string这个方法。

静态方法

那么staticmethod又是什么呢？它和classmethod非常的相似，但是不强制要求传递参数（但是做的事与类方法或实例方法一样）。

让我们来看一个使用的例子。

我们有一个日期字符串需要以某种方式验证。这个任务与之前一样要定义在Date类内部，但是不要求实例化它。

静态方法在这种情况下就非常有用。看一下下面这个代码片段：

    @staticmethod
    def is_date_valid(date_as_string):
        day, month, year = map(int, date_as_string_split('-'))
        return day <= 31 and month <= 12 and year <= 3999
    
    is_date = Date.is_date_valid('11-09-2012')

现在正如我们了解到的staticmethod的使用，我们不需要访问它所属的类，它本质上就是一个函数，调用方式和调用函数一样，不同的是它不关注对象和对象内部属性。

反射

对编程语言比较熟悉的朋友，应该知道“反射”这个机制。Python作为一门动态语言，当然不会缺少这一重要功能。然而，在网络上却很少见到有详细或者深刻的剖析论文。下面结合一个web路由的实例来阐述python的反射机制的使用场景和核心本质。

一、前言

?

1 2 3 4 5

def f1():   print("f1是这个函数的名字！")    s = "f1" print("%s是个字符串" % s)

　　在上面的代码中，我们必须区分两个概念，f1和“f1"。前者是函数f1的函数名，后者只是一个叫”f1“的字符串，两者是不同的事物。我们可以用f1()的方式调用函数f1，但我们不能用"f1"()的方式调用函数。说白了就是，不能通过字符串来调用名字看起来相同的函数！

二、web实例

　　考虑有这么一个场景，根据用户输入的url的不同，调用不同的函数，实现不同的操作，也就是一个url路由器的功能，这在web框架里是核心部件之一。下面有一个精简版的示例：

　　首先，有一个commons模块，它里面有几个函数，分别用于展示不同的页面，代码如下：

?

1 2 3 4 5 6 7 8

def login():   print("这是一个登陆页面！")   def logout():   print("这是一个退出页面！")   def home():   print("这是网站主页面！")

　　其次，有一个visit模块，作为程序入口，接受用户输入，展示相应的页面，代码如下：（这段代码是比较初级的写法）

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

import commons   def run():   inp = input("请输入您想访问页面的url： ").strip()   if inp == "login":     commons.login()   elif inp == "logout":     commons.logout()   elif inp == "home":     commons.home()   else:     print("404")   if __name__ == '__main__':   run()

　　我们运行visit.py，输入：home，页面结果如下：

?

1 2	请输入您想访问页面的url： home 这是网站主页面！

　　这就实现了一个简单的WEB路由功能，根据不同的url，执行不同的函数，获得不同的页面。

　　然而，让我们考虑一个问题，如果commons模块里有成百上千个函数呢(这非常正常)?。难道你在visit模块里写上成百上千个elif?显然这是不可能的！那么怎么破？

三、反射机制

　　仔细观察visit中的代码，我们会发现用户输入的url字符串和相应调用的函数名好像！如果能用这个字符串直接调用函数就好了！但是，前面我们已经说了字符串是不能用来调用函数的。为了解决这个问题，python为我们提供一个强大的内置函数：getattr!我们将前面的visit修改一下，代码如下：

?

1 2 3 4 5 6 7 8 9

import commons   def run():   inp = input("请输入您想访问页面的url： ").strip()   func = getattr(commons,inp)   func()    if __name__ == '__main__':   run()

　　首先说明一下getattr函数的使用方法：它接收2个参数，前面的是一个对象或者模块，后面的是一个字符串，注意了！是个字符串！

　　例子中，用户输入储存在inp中，这个inp就是个字符串，getattr函数让程序去commons这个模块里，寻找一个叫inp的成员（是叫，不是等于），这个过程就相当于我们把一个字符串变成一个函数名的过程。然后，把获得的结果赋值给func这个变量，实际上func就指向了commons里的某个函数。最后通过调用func函数，实现对commons里函数的调用。这完全就是一个动态访问的过程，一切都不写死，全部根据用户输入来变化。

　　执行上面的代码，结果和最开始的是一样的。

　　这就是python的反射，它的核心本质其实就是利用字符串的形式去对象（模块）中操作（查找/获取/删除/添加）成员，一种基于字符串的事件驱动！

　　这段话，不一定准确，但大概就是这么个意思。

四、进一步完善

　　上面的代码还有个小瑕疵，那就是如果用户输入一个非法的url，比如jpg，由于在commons里没有同名的函数，肯定会产生运行错误，具体如下：

?

1 2 3 4 5 6 7

请输入您想访问页面的url： jpg Traceback (most recent call last):  File "F:/Python/pycharm/s13/reflect/visit.py", line 16, in <module>   run()  File "F:/Python/pycharm/s13/reflect/visit.py", line 11, in run   func = getattr(commons,inp) AttributeError: module 'commons' has no attribute 'jpg'

　　那怎么办呢？其实，python考虑的很全面了，它同样提供了一个叫hasattr的内置函数，用于判断commons中是否具有某个成员。我们将代码修改一下：

?

1 2 3 4 5 6 7 8 9 10 11 12

import commons    def run():   inp = input("请输入您想访问页面的url： ").strip()   if hasattr(commons,inp):     func = getattr(commons,inp)     func()   else:     print("404")    if __name__ == '__main__':   run()

　　通过hasattr的判断，可以防止非法输入错误，并将其统一定位到错误页面。

　　其实，研究过python内置函数的朋友，应该注意到还有delattr和setattr两个内置函数。从字面上已经很好理解他们的作用了。

　　python的四个重要内置函数：getattr、hasattr、delattr和setattr较为全面的实现了基于字符串的反射机制。他们都是对内存内的模块进行操作，并不会对源文件进行修改。

五、动态导入模块

　　上面的例子是在某个特定的目录结构下才能正常实现的，也就是commons和visit模块在同一目录下，并且所有的页面处理函数都在commons模块内。如下图：

　　但在现实使用环境中，页面处理函数往往被分类放置在不同目录的不同模块中，也就是如下图：

　　难道我们要在visit模块里写上一大堆的import 语句逐个导入account、manage、commons模块吗？要是有1000个这种模块呢？

　　刚才我们分析完了基于字符串的反射，实现了动态的函数调用功能，我们不禁会想那么能不能动态导入模块呢？这完全是可以的！

　　python提供了一个特殊的方法：__import__(字符串参数)。通过它，我们就可以实现类似的反射功能。__import__()方法会根据参数，动态的导入同名的模块。

我们再修改一下上面的visit模块的代码。

?

1 2 3 4 5 6 7 8 9 10 11 12

def run():   inp = input("请输入您想访问页面的url： ").strip()   modules, func = inp.split("/")   obj = __import__(modules)   if hasattr(obj, func):     func = getattr(obj, func)     func()   else:     print("404")    if __name__ == '__main__':   run()

运行一下：

?

1 2 3 4

请输入您想访问页面的url： commons/home 这是网站主页面！ 请输入您想访问页面的url： account/find 这是一个查找功能页面！

　　我们来分析一下上面的代码：

　　首先，我们并没有定义任何一行import语句；

　　其次，用户的输入inp被要求为类似“commons/home”这种格式，其实也就是模拟web框架里的url地址，斜杠左边指向模块名，右边指向模块中的成员名。

　　然后，modules,func = inp.split("/")处理了用户输入，使我们获得的2个字符串，并分别保存在modules和func变量里。

　　接下来，最关键的是obj = __import__(modules)这一行，它让程序去导入了modules这个变量保存的字符串同名的模块，并将它赋值给obj变量。

　　最后的调用中，getattr去modules模块中调用func成员的含义和以前是一样的。

　　总结：通过__import__函数，我们实现了基于字符串的动态的模块导入。

　　同样的，这里也有个小瑕疵！

　　如果我们的目录结构是这样的：

 　　那么在visit的模块调用语句中，必须进行修改，我们想当然地会这么做：

?

1 2 3 4 5 6 7 8 9 10 11 12

def run():   inp = input("请输入您想访问页面的url： ").strip()   modules, func = inp.split("/")   obj = __import__("lib." + modules)   #注意字符串的拼接   if hasattr(obj, func):     func = getattr(obj, func)     func()   else:     print("404")    if __name__ == '__main__':   run()

　　改了这么一个地方:obj = __import__("lib." + modules)，看起来似乎没什么问题，和import lib.commons的传统方法类似，但实际上运行的时候会有错误。

?

1 2 3 4

请输入您想访问页面的url： commons/home 404 请输入您想访问页面的url： account/find 404

　　为什么呢？因为对于lib.xxx.xxx.xxx这一类的模块导入路径，__import__默认只会导入最开头的圆点左边的目录，也就是“lib”。我们可以做个测试，在visit同级目录内新建一个文件，代码如下：

?

1 2	obj = __import__("lib.commons") print(obj)

　　执行结果：

?

1	<module 'lib' (namespace)>

　　这个问题怎么解决呢？加上fromlist = True参数即可！

?

1 2 3 4 5 6 7 8 9 10 11 12

def run():   inp = input("请输入您想访问页面的url： ").strip()   modules, func = inp.split("/")   obj = __import__("lib." + modules, fromlist=True) # 注意fromlist参数   if hasattr(obj, func):     func = getattr(obj, func)     func()   else:     print("404")    if __name__ == '__main__':   run()

　　至此，动态导入模块的问题基本都解决了，只剩下最后一个，那就是万一用户输入错误的模块名呢？比如用户输入了somemodules/find，由于实际上不存在somemodules这个模块，必然会报错！那有没有类似上面hasattr内置函数这么个功能呢？答案是没有！碰到这种，你只能通过异常处理来解决。

六、最后的思考

　　可能有人会问python不是有两个内置函数exec和eval吗？他们同样能够执行字符串。比如：

?

1	exec("print('haha')")

结果：

?

1

haha

　　那么直接使用它们不行吗？非要那么费劲地使用getattr， __import__干嘛？

　　其实，在上面的例子中，围绕的核心主题是如何利用字符串驱动不同的事件，比如导入模块、调用函数等等，这些都是python的反射机制，是一种编程方法、设计模式的体现，凝聚了高内聚、松耦合的编程思想，不能简单的用执行字符串来代替。当然，exec和eval也有它的舞台，在web框架里也经常被使用。