python自省

Python自省 (introspection)

这个也是python彪悍的特性.

什么是自省 (introspection) : 自省是指这种能力：检查某些事物以确定它是什么、它知道什么以及它能做什么。

自省向程序员提供了极大的灵活性和控制力。

自省就是面向对象的语言所写的程序在运行时,所能知道对象的类型.

简单一句就是运行时能够获得对象的类型.比如

    type()
    dir()
    getattr()
    hasattr()
    isinstance()
    ...

理解元类 metaclasses

在理解 metaclasses 前,我们需要掌握 Python 的 classes Python 的 classes 定义十分有趣,有点借鉴了 Smalltalk 语言, 当然了 ,我并不懂 Smalltalk 语言!

>>> class ObjectCreator(object):
...     		pass
... 

什么是类, 能够被实例化成 对象 (object) 的代码组织

因此:

它的属性可以被赋值
它可被复制
可以给它添加属性
我们可以向他的方法传参数
…

例如:

>>> print(ObjectCreator) # 因为是对象 ,所以可以被打印
<class '__main__.ObjectCreator'>
>>> def echo(o):
...       print(o)
... 
>>> echo(ObjectCreator) # 打印对象
<class '__main__.ObjectCreator'>
>>> print(hasattr(ObjectCreator, 'new_attribute'))
False
>>> ObjectCreator.new_attribute = 'foo' # 添加属性
>>> print(hasattr(ObjectCreator, 'new_attribute'))
True
>>> print(ObjectCreator.new_attribute)
foo
>>> ObjectCreatorMirror = ObjectCreator # 赋值
>>> print(ObjectCreatorMirror.new_attribute)
foo
>>> print(ObjectCreatorMirror())
<__main__.ObjectCreator object at 0x8997b4c>

也可以动态的 操 作 它!

e.g:

>>> def choose_class(name):
...     if name == 'foo':
...         	class Foo(object):
...             		pass
...         	return Foo # return the class, not an instance
...     else:
...         	class Bar(object):
...             		pass
...         	return Bar
...     
>>> MyClass = choose_class('foo') 
>>> print(MyClass) # the function returns a class, not an instance
<class '__main__.Foo'>
>>> print(MyClass()) # you can create an object from this class
<__main__.Foo object at 0x89c6d4c>

class 创建类是标准方法, 还是需要手动组织代码去 定义或者实例化这个 class

当我们遇到未知的情况怎么办, 例如常见 ORM, 我们需要调用我们没有定义的属性怎么办?

好了 python 有个古老的方案 type().

>>> print(type(1))
<type 'int'>
>>> print(type("1"))
<type 'str'>
>>> print(type(ObjectCreator))
<type 'type'>
>>> print(type(ObjectCreator()))
<class '__main__.ObjectCreator'>

type() 重点!

type 的定义

type(class name, 
    需要继承的元组(可为空)
     一些属性和值(可为空)) 
# eg: 继承类
>>>   class FooChild(Foo):
...         pass
>>> FooChild = type('FooChild', (Foo,), {})
>>> print(FooChild)
<class '__main__.FooChild'>
>>> print(FooChild.bar) # bar is inherited from Foo
True
# eg: 定义属性
>>> def echo_bar(self):
...       print(self.bar)
... 
>>> FooChild = type('FooChild', (Foo,), {'echo_bar': echo_bar})
>>> hasattr(Foo, 'echo_bar')
False
>>> hasattr(FooChild, 'echo_bar')
True
>>> my_foo = FooChild()
>>> my_foo.echo_bar()
True
# eg: 
>>> def echo_bar_more(self):
...       print('yet another method')
... 
>>> FooChild.echo_bar_more = echo_bar_more
>>> hasattr(FooChild, 'echo_bar_more')
True

常规情况我们实例化对象

MyClass = MetaClass()
MyObject = MyClass()
# 使用 type 元类可以这样
MyClass = type('MyClass', (), {})

python 里面万物皆元类

>>> age = 35
>>> age.__class__
<type 'int'>
>>> name = 'bob'
>>> name.__class__
<type 'str'>
>>> def foo(): pass
>>> foo.__class__
<type 'function'>
>>> class Bar(object): pass
>>> b = Bar()
>>> b.__class__
<class '__main__.Bar'>

那么什么是class 的 class ?

>>> age.__class__.__class__
<type 'type'>
>>> name.__class__.__class__
<type 'type'>
>>> foo.__class__.__class__
<type 'type'>
>>> b.__class__.__class__
<type 'type'>

什么是 metaclass

我们先来看看 new 和 init

new是一个静态方法,而init是一个实例方法.
new方法会返回一个创建的实例,而init什么都不返回.
只有在new返回一个cls的实例时后面的init才能被调用.
当创建一个新实例时调用new,初始化一个实例时用init.
所以,元类就是创建类对象的东西.

如果你愿意你也可以把它叫做’类工厂’.type是Python的内建元类,当然,你也可以创建你自己的元类.

metaclass属性

当你创建一个函数的时候,你可以添加metaclass属性:

class Foo(object):
  __metaclass__ = something...
  [...]

如果你这么做了，Python就会用元类来创建类Foo.

小心点，这里面有些技巧.

你首先写下class Foo(object，但是类对象Foo还没有在内存中创建.

Python将会在类定义中寻找metaclass.如果找打了就用它来创建类对象Foo.如果没找到,就会默认用type创建类.

把下面这段话反复读几次。

当你写如下代码时 :

class Foo(Bar):
		pass

Python将会这样运行:

在Foo中有没有_metaclass属性?

如果有,Python会在内存中通过metaclass创建一个名字为Foo的类对象(我说的是类对象,跟紧我的思路).

如果Python没有找到metaclass，它会继续在Bar（父类）中寻找metaclass属性，并尝试做和前面同样的操作.

如果Python在任何父类中都找不到metaclass，它就会在模块层次中去寻找metaclass，并尝试做同样的操作。

如果还是找不到metaclass,Python就会用内置的type来创建这个类对象。

现在的问题就是，你可以在metaclass中放置些什么代码呢？

答案就是：可以创建一个类的东西。

那么什么可以用来创建一个类呢？type，或者任何使用到type或者子类化type的东东都可以。

自定义元类

元类的主要目的就是为了当创建类时能够自动地改变类.

通常，你会为API做这样的事情，你希望可以创建符合当前上下文的类.

假想一个很傻的例子，你决定在你的模块里所有的类的属性都应该是大写形式。有好几种方法可以办到，但其中一种就是通过在模块级别设定metaclass.

采用这种方法，这个模块中的所有类都会通过这个元类来创建，我们只需要告诉元类把所有的属性都改成大写形式就万事大吉了。

幸运的是，metaclass实际上可以被任意调用，它并不需要是一个正式的类（我知道，某些名字里带有’class’的东西并不需要是一个class，画画图理解下，这很有帮助）。

所以，我们这里就先以一个简单的函数作为例子开始。

元类会自动将你通常传给’type’的参数作为自己的参数传入

def upper_attr(future_class_name, future_class_parents, future_class_attr):
  """
    返回一个将属性列表变为大写字母的类对象
  """

  		# 选取所有不以'__'开头的属性,并把它们编程大写
 		 uppercase_attr = {}
 		 for name, val in future_class_attr.items():
     			 if not name.startswith('__'):
          				uppercase_attr[name.upper()] = val
      			else:
          				uppercase_attr[name] = val

  		# 用'type'创建类
  		return type(future_class_name, future_class_parents, uppercase_attr)

		__metaclass__ = upper_attr # 将会影响整个模块

class Foo(): # global __metaclass__ won't work with "object" though
 	 # 我们也可以只在这里定义__metaclass__，这样就只会作用于这个类中
  	bar = 'bip'

print(hasattr(Foo, 'bar'))
# 输出: False
print(hasattr(Foo, 'BAR'))
# 输出: True

f = Foo()
		print(f.BAR)
		# 输出: 'bip'

现在让我们再做一次，这一次用一个真正的class来当做元类。

# 请记住，'type'实际上是一个类，就像'str'和'int'一样
# 所以，你可以从type继承
class UpperAttrMetaclass(type):
    # __new__ 是在__init__之前被调用的特殊方法
    # __new__是用来创建对象并返回它的方法
    # 而__init__只是用来将传入的参数初始化给对象
    # 你很少用到__new__，除非你希望能够控制对象的创建
    # 这里，创建的对象是类，我们希望能够自定义它，所以我们这里改写__new__
    # 如果你希望的话，你也可以在__init__中做些事情
    # 还有一些高级的用法会涉及到改写__call__特殊方法，但是我们这里不用
    	def __new__(upperattr_metaclass, future_class_name,
                future_class_parents, future_class_attr):

        		uppercase_attr = {}
       		 	for name, val in future_class_attr.items():
            			if not name.startswith('__'):
                				uppercase_attr[name.upper()] = val
            			else:
                				uppercase_attr[name] = val

        		return type(future_class_name, future_class_parents, uppercase_attr)

但是这不是真正的面向对象(OOP).我们直接调用了type，而且我们没有改写父类的new方法。现在让我们这样去处理:

class UpperAttrMetaclass(type):
		def __new__(upperattr_metaclass, future_class_name,
            future_class_parents, future_class_attr):

    			uppercase_attr = {}
    			for name, val in future_class_attr.items():
        				if not name.startswith('__'):
            					uppercase_attr[name.upper()] = val
        				else:
            					uppercase_attr[name] = val

    			# 重用 type.__new__ 方法
    			# 这就是基本的OOP编程，没什么魔法
    			return type.__new__(upperattr_metaclass, future_class_name,
                        future_class_parents, uppercase_attr)

你可能已经注意到了有个额外的参数upperattr_metaclass，这并没有什么特别的。 类方法的第一个参数总是表示当前的实例，就像在普通的类方法中的self参数一样。

当然了，为了清晰起见，这里的名字我起的比较长。 但是就像self一样，所有的参数都有它们的传统名称。 因此，在真实的产品代码中一个元类应该是像这样的：

class UpperAttrMetaclass(type):
		def __new__(cls, clsname, bases, dct):

    			uppercase_attr = {}
    			for name, val in dct.items():
       					 if not name.startswith('__'):
            					uppercase_attr[name.upper()] = val
        				else:
            					uppercase_attr[name] = val

    			return type.__new__(cls, clsname, bases, uppercase_attr)

如果使用super方法的话，我们还可以使它变得更清晰一些，这会缓解继承 （是的，你可以拥有元类，从元类继承，从type继承）

class UpperAttrMetaclass(type):
		def __new__(cls, clsname, bases, dct):

    			uppercase_attr = {}
    			for name, val in dct.items():
       					 if not name.startswith('__'):
            					uppercase_attr[name.upper()] = val
       					 else:
            					uppercase_attr[name] = val

    			return super(UpperAttrMetaclass, cls).__new__(cls, clsname, bases, uppercase_attr)

就是这样，除此之外，关于元类真的没有别的可说的了。

使用到元类的代码比较复杂，这背后的原因倒并不是因为元类本身， 而是因为你通常会使用元类去做一些晦涩的事情，依赖于自省，控制继承等等。

确实，用元类来搞些“黑暗魔法”是特别有用的，因而会搞出些复杂的东西来。 但就元类本身而言，它们其实是很简单的：

拦截类的创建 修改一个类 返回修改之后的类 为什么要用metaclass类而不是函数?

由于metaclass可以接受任何可调用的对象，那为何还要使用类呢，因为很显然使用类会更加复杂啊？

这里有好几个原因：

意图会更加清晰。当你读到UpperAttrMetaclass(type)时，你知道接下来要发生什么。 你可以使用OOP编程。元类可以从元类中继承而来，改写父类的方法。元类甚至还可以使用元类。 你可以把代码组织的更好。当你使用元类的时候肯定不会是像我上面举的这种简单场景，通常都是针对比较复杂的问题。将多个方法归总到一个类中会很有帮助，也会使得代码更容易阅读。 你可以使用new,init以及call这样的特殊方法。它们能帮你处理不同的任务。就算通常你可以把所有的东西都在new里处理掉，有些人还是觉得用init更舒服些。 哇哦，这东西的名字是metaclass，肯定非善类，我要小心！ 说了这么多TMD究竟为什么要使用元类？

现在回到我们的大主题上来，究竟是为什么你会去使用这样一种容易出错且晦涩的特性？

好吧，一般来说，你根本就用不上它：

“元类就是深度的魔法，99%的用户应该根本不必为此操心。如果你想搞清楚究竟是否需要用到元类，那么你就不需要它。那些实际用到元类的人都非常清楚地知道他们需要做什么，而且根本不需要解释为什么要用元类。” —— Python界的领袖 Tim Peters 元类的主要用途是创建API。一个典型的例子是Django ORM。

它允许你像这样定义：

class Person(models.Model):
  		name = models.CharField(max_length=30)
  		age = models.IntegerField()

但是如果你像这样做的话：

guy = Person(name='bob', age='35')
print(guy.age)

这并不会返回一个IntegerField对象，而是会返回一个int，甚至可以直接从数据库中取出数据。

这是有可能的，因为models.Model定义了metaclass， 并且使用了一些魔法能够将你刚刚定义的简单的Person类转变成对数据库的一个复杂hook。

Django框架将这些看起来很复杂的东西通过暴露出一个简单的使用元类的API将其化简，通过这个API重新创建代码，在背后完成真正的工作。

结语

首先，你知道了类其实是能够创建出类实例的对象。

好吧，事实上，类本身也是实例，当然，它们是元类的实例。

>>> class Foo(object): pass
>>> id(Foo)
142630324

Python中的一切都是对象，它们要么是类的实例，要么是元类的实例.

除了type.type实际上是它自己的元类，在纯Python环境中这可不是你能够做到的，这是通过在实现层面耍一些小手段做到的。

其次，元类是很复杂的。对于非常简单的类，你可能不希望通过使用元类来对类做修改。你可以通过其他两种技术来修改类.