OpenERP与Python 元编程
-
Python元编程被称为“黑魔法”。Python界的传奇人物Tim Peters有云:
[quote]Python的元编程这种黑魔法99%的人都无需了解,如果你拿不准是否应该用到它时,你不需要它.[/quote]
OpenERP基本遵循了Tim Peters的教诲,但是却在6.1版本之后忍不住触及了一点点,从此游走于黑白两道之间:)
其实OpenERP中用到的元类(MetaClass)作用非常简单:就是在V6.1后我们在模块中所定义的实体类,不需要进行实例化,比如
OpenERPV6.1之前的实体类定义:<br />Class MyProduct(osv.osv):<br /> _inherit="product.product"<br /> pass<br />MyProduct()<br />
在OpenERPV6.1之后则不需要上面的类的实例化过程了。即,不需要下面这句了:<br />MyProduct()
为了了解元类如何实现取消实例化过程,首先我们来看一下OpenERP中实体类的实例化过程到底做了些什么。
我们一般知道,Python类的调用或称为实例化,会生成该类的一个实例对象(instance object),比如:<br />class A(object):<br /> ...: def __init__(self, x):<br /> ...: self.x = x<br /> ...: <br /><br />In [2]: a = A(2)<br /><br />In [3]: a<br />Out[3]: <__main__.A at 0x2ff2fd0><br />
a就是类A的一个实例对象。这是Python的基础知识,很好理解。但是,我要告诉你的是:在OpenERP中,MyProduct()并不产生MyProduct类的实例,甚至再深究的话,我们经常在代码中用到的pool.get('product.product')从对象池中获取的实例对象,也非这个MyProduct类所生成的实例。
这到底是怎么一回事?我们首先要了解什么是类的实例化,或者类的调用到底是怎样的一个过程,比如上例中A(2),其实其执行过程基本上可以分为两个部分,用Python 来表示就是:<br />n = A.__new__(A, 2) #创建类的实例对象<br />if isinstance(n, A): A.__init__(n, 2) #实例对象初始化<br />
类A本身并没有定义__new__类方法,所以直接调用其父类即:object的__new__方法获得实例对象,如果获得的对象是A的实例则执行__init__方法
同样的,Myproduct所继承的osv.osv类(或OE6.1以后称为BaseModel)就有一个__new__方法,而这个方法返回的是None,所以按照上面的说明它都不会运行到实例初始化的部分,当然也就无法获得Myproduct的实例。
如果我们仔细分析代码,发现这个__new__的主要作用基本上就是下面这点代码:<br /> module_model_list = MetaModel.module_to_models.setdefault(cls._module, [])<br /> if cls not in module_model_list:<br /> if not cls._custom:<br /> module_model_list.append(cls)<br />
其实MetaModel是一个元类(metaclass)等会儿要讲到,module_to_models则是这个类上的一个变量,其对应一个字典,字典的key对应每一个“模块”就是OpenERP的addons,其值对应这个模块中所定义的实体类(比如我们上例中的MyProduct)
所以调用实体类并没有实例化,只是就这样登记备案了一下,事实上只有在模块载入(loading)过程中才会对所注册的实体类实例化,其实也不是一般意义的实例化,而是要另外创造一个新类,再做实例化。(这部分以后有空再介绍)
那么问题回到原点,OpenERPV6.1以后如何做到,不调用实体类,即不运行BaseModel上的__new__方法就可以做到上述的类的注册过程。把OpenERP变色的那一点黑,这就出现了。对,就是那个叫MetaModel的家伙。在介绍MetaModel之前我们先快速的讲解一下Python的metaclass。
在Python中一切皆为“对象”, 类的实例是对象,类本身也是对象。类的实例对象是通过对类的调用获得的,那么类本身这个对象又是如何获得的呢?
其实上面的例子中类A的定义可以改写为:<br />A = type('A', (object,), {'__init__': lambda self,x: self.x=x})<br />
从上面的代码可以看出类A是通过调用type,或者是通过对type的实例化来获得的,事实上默认情况下所有的类都是由type实例化获得,这个type类就是所生成类的元类。
类的实例对象可以对应五花八门我们定义的各种类,同理,我们是否可以定义除type以外用来生成类对象的五花八门的元类呢?答案当然是肯定的。看看我们的MetaModel:<br />class MetaModel(type):<br /> ....<br />
它与我们的普通的类定义没有什么差别,唯一需要注意的是其继承的父类是‘type',
而在OpenERP所有的实体类的基类BaseModel的类定义中有这么一句:<br />__metaclass__ = MetaModel<br />
这句有特殊的含义,表示该类对象将由元类MetaModel实例化生成。在Python3.x中则用如下的语法:<br />Class MyProduct(metaclass=MetaModel, osv.osv)<br />
还记得上面提到的类的实例化,new, __init__两步,元类的实例化也是一样。
我们看到MetaModel的__init__方法与上面提到的BaseModel类的__new__方法中有完全类似的代码:<br /> if not self._custom:<br /> self.module_to_models.setdefault(self._module, []).append(self)<br />
就是做了一个注册备案的动作。所以类对象本身产生的过程就已经注册了类,可以不用和6.0及以前版本的OpenERP每次定义实体类都要调用一下了。 -
[quote author=mrshelly link=topic=5771.msg14289#msg14289 date=1361832208]
校长. 我想如果使用 metaclass 是不是就是我一直想要的一个东西 的方向?
我想根据一段代码(string) 生成一个 import 后的 module 对象?
[/quote]
哈哈,看看Tim Peters 的回答! “如果你拿不准是否应该用到它时,你不需要它“
不过,好象真的用不到metaclass,下面的代码是不是你想要的? 但是,Python牛人们告诫我们,尽量不要用eval, exec等,那是既不安全又丑陋的,mrshelly就好这口没办法。code = """<br />x = 100<br />class A(object):<br /> def __init__(self, y):<br /> print('x=%s' % x)<br /> print('y=%s' % y)<br /> """<br />import imp<br />mymodule = imp.new_module('mymodule')<br />exec code in mymodule.__dict__<br /><br />In [41]: mymodule.A(2)<br />x=100<br />y=2<br />Out[41]: <mymodule.A at 0x2e6c110><br />
-
刚刚又 Google 到一种方法
<br /><br />code = '''<br />x = 100<br />class A(object):<br /> def __init__(self, y):<br /> print('x=%s' % x)<br /> print('y=%s' % y)<br />'''<br />import types<br />m = types.ModuleType('test_m')<br />exec code in m.__dict__<br /><br />import sys<br />sys.modules['test_m'] = m<br />
然后 import test_m 就OK了.
总结一下, 就是 使用 imp.new_module 或者 types.ModuleType 可以生成一个 module object 然后 再给 这个 object 添加 代码里的方法,属性
添加的方法, 主要使用 exec 来玩
再记录一下, 由 pyc 文件加载的代码<br /><br />import marshal<br />import types<br /><br />b = open('test_m.pyc', 'rb').read()<br />code = marshal.loads(b[8:])<br />m = types.ModuleType('test_m')<br />exec code in m.__dict__<br /><br />sys.modules['test_m'] = m<br /><br />#test<br />import test_m<br /><br />
除了 exec 不爽点之外. 其他比较完美...
code object 似乎也只能使用 exec 来导入到模块 object 中... -
看了您的大作之后,欲罢不能,看了好几个小时代码,加上自己的理解。
也得一文 OpenERP 模块动态加载原理及启动代码分析 http://buke.github.com/blog/2013/02/26/openerp-dynamic-loading-and-booting-way/
请斧正 ~ ;D -
[quote author=wangbuke link=topic=5771.msg14298#msg14298 date=1361879273]
看了您的大作之后,欲罢不能,看了好几个小时代码,加上自己的理解。
也得一文 OpenERP 模块动态加载原理及启动代码分析 http://buke.github.com/blog/2013/02/26/openerp-dynamic-loading-and-booting-way/
请斧正 ~ ;D
[/quote]
把真正的强人引出来了,@wangbuke是OpenERP中文社区贡献高质量代码最多的人,文档协作组织者之一,他的强文一定要看。我在文章里卖的那个“以后再讨论”的关子,buke已清晰表达,还有更多学习热点。 -
mark