Python二元算术运算常用方法解析
在本文中,我想谈谈二元算术运算。具体来说,我想解读减法的工作原理:a - b。我故意选择了减法,因为它是不可交换的。这可以强调出操作顺序的重要性,与加法操作相比,你可能会在实现时误将 a 和 b 翻转,但还是得到相同的结果。
查看 c 代码
按照惯例,我们从查看 cpython 解释器编译的字节码开始。
>>> def sub(): a - b ... >>> import dis >>> dis.dis(sub) 1 0 load_global 0 (a) 2 load_global 1 (b) 4 binary_subtract 6 pop_top 8 load_const 0 (none) 10 return_value
看起来我们需要深入研究 binary_subtract 操作码。翻查 python/ceval.c 文件,可以看到实现该操作码的 c 代码如下:
case target(binary_subtract): { pyobject *right = pop(); pyobject *left = top(); pyobject *diff = pynumber_subtract(left, right); py_decref(right); py_decref(left); set_top(diff); if (diff == null) goto error; dispatch(); }
这里的关键代码是pynumber_subtract(),实现了减法的实际语义。继续查看该函数的一些宏,可以找到binary_op1() 函数。它提供了一种管理二元操作的通用方法。
不过,我们不把它作为实现的参考,而是要用python的数据模型,官方文档很好,清楚介绍了减法所使用的语义。
从数据模型中学习
通读数据模型的文档,你会发现在实现减法时,有两个方法起到了关键作用:__sub__ 和 __rsub__。
1、__sub__()方法
当执行a - b 时,会在 a 的类型中查找__sub__(),然后把 b 作为它的参数。这很像我写属性访问的文章 里的__getattribute__(),特殊/魔术方法是根据对象的类型来解析的,并不是出于性能目的而解析对象本身;在下面的示例代码中,我使用_mro_getattr() 表示此过程。
因此,如果已定义 __sub__(),则 type(a).__sub__(a,b) 会被用来作减法操作。(译注:魔术方法属于对象的类型,不属于对象)
这意味着在本质上,减法只是一个方法调用!你也可以将它理解成标准库中的 operator.sub() 函数。
我们将仿造该函数实现自己的模型,用 lhs 和 rhs 两个名称,分别表示 a-b 的左侧和右侧,以使示例代码更易于理解。
# 通过调用__sub__()实现减法 def sub(lhs: any, rhs: any, /) -> any: """implement the binary operation `a - b`.""" lhs_type = type(lhs) try: subtract = _mro_getattr(lhs_type, "__sub__") except attributeerror: msg = f"unsupported operand type(s) for -: {lhs_type!r} and {type(rhs)!r}" raise typeerror(msg) else: return subtract(lhs, rhs)
2、让右侧使用__rsub__()
但是,如果 a 没有实现__sub__() 怎么办?如果 a 和 b 是不同的类型,那么我们会尝试调用 b 的 __rsub__()(__rsub__ 里面的“r”表示“右”,代表在操作符的右侧)。
当操作的双方是不同类型时,这样可以确保它们都有机会尝试使表达式生效。当它们相同时,我们假设__sub__() 就能够处理好。但是,即使两边的实现相同,你仍然要调用__rsub__(),以防其中一个对象是其它的(子)类。
3、不关心类型
现在,表达式双方都可以参与运算!但是,如果由于某种原因,某个对象的类型不支持减法怎么办(例如不支持 4 - “stuff”)?在这种情况下,__sub__ 或__rsub__ 能做的就是返回 notimplemented。
这是给 python 返回的信号,它应该继续执行下一个操作,尝试使代码正常运行。对于我们的代码,这意味着需要先检查方法的返回值,然后才能假定它起作用。
# 减法的实现,其中表达式的左侧和右侧均可参与运算 _missing = object() def sub(lhs: any, rhs: any, /) -> any: # lhs.__sub__ lhs_type = type(lhs) try: lhs_method = debuiltins._mro_getattr(lhs_type, "__sub__") except attributeerror: lhs_method = _missing # lhs.__rsub__ (for knowing if rhs.__rub__ should be called first) try: lhs_rmethod = debuiltins._mro_getattr(lhs_type, "__rsub__") except attributeerror: lhs_rmethod = _missing # rhs.__rsub__ rhs_type = type(rhs) try: rhs_method = debuiltins._mro_getattr(rhs_type, "__rsub__") except attributeerror: rhs_method = _missing call_lhs = lhs, lhs_method, rhs call_rhs = rhs, rhs_method, lhs if lhs_type is not rhs_type: calls = call_lhs, call_rhs else: calls = (call_lhs,) for first_obj, meth, second_obj in calls: if meth is _missing: continue value = meth(first_obj, second_obj) if value is not notimplemented: return value else: raise typeerror( f"unsupported operand type(s) for -: {lhs_type!r} and {rhs_type!r}" )
4、子类优先于父类
如果你看一下__rsub__() 的文档,就会注意到一条注释。它说如果一个减法表达式的右侧是左侧的子类(真正的子类,同一类的不算),并且两个对象的__rsub__() 方法不同,则在调用__sub__() 之前会先调用__rsub__()。换句话说,如果 b 是 a 的子类,调用的顺序就会被颠倒。
这似乎是一个很奇怪的特例,但它背后是有原因的。当你创建一个子类时,这意味着你要在父类提供的操作上注入新的逻辑。这种逻辑不一定要加给父类,否则父类在对子类操作时,就很容易覆盖子类想要实现的操作。
具体来说,假设有一个名为 spam 的类,当你执行 spam() - spam() 时,得到一个 lessspam 的实例。接着你又创建了一个 spam 的子类名为 bacon,这样,当你用 spam 去减 bacon 时,你得到的是 veggiespam。
如果没有上述规则,spam() - bacon() 将得到 lessspam,因为 spam 不知道减掉 bacon 应该得出 veggiespam。
但是,有了上述规则,就会得到预期的结果 veggiespam,因为 bacon.__rsub__() 首先会在表达式中被调用(如果计算的是 bacon() - spam(),那么也会得到正确的结果,因为首先会调用 bacon.__sub__(),因此,规则里才会说两个类的不同的方法需有区别,而不仅仅是一个由 issubclass() 判断出的子类。)
# python中减法的完整实现 _missing = object() def sub(lhs: any, rhs: any, /) -> any: # lhs.__sub__ lhs_type = type(lhs) try: lhs_method = debuiltins._mro_getattr(lhs_type, "__sub__") except attributeerror: lhs_method = _missing # lhs.__rsub__ (for knowing if rhs.__rub__ should be called first) try: lhs_rmethod = debuiltins._mro_getattr(lhs_type, "__rsub__") except attributeerror: lhs_rmethod = _missing # rhs.__rsub__ rhs_type = type(rhs) try: rhs_method = debuiltins._mro_getattr(rhs_type, "__rsub__") except attributeerror: rhs_method = _missing call_lhs = lhs, lhs_method, rhs call_rhs = rhs, rhs_method, lhs if ( rhs_type is not _missing # do we care? and rhs_type is not lhs_type # could rhs be a subclass? and issubclass(rhs_type, lhs_type) # rhs is a subclass! and lhs_rmethod is not rhs_method # is __r*__ actually different? ): calls = call_rhs, call_lhs elif lhs_type is not rhs_type: calls = call_lhs, call_rhs else: calls = (call_lhs,) for first_obj, meth, second_obj in calls: if meth is _missing: continue value = meth(first_obj, second_obj) if value is not notimplemented: return value else: raise typeerror( f"unsupported operand type(s) for -: {lhs_type!r} and {rhs_type!r}" )
推广到其它二元运算
解决掉了减法运算,那么其它二元运算又如何呢?好吧,事实证明它们的操作相同,只是碰巧使用了不同的特殊/魔术方法名称。
所以,如果我们可以推广这种方法,那么我们就可以实现 13 种操作的语义:+ 、-、*、@、/、//、%、**、<<、>>、&、^、和 |。
由于闭包和 python 在对象自省上的灵活性,我们可以提炼出 operator 函数的创建。
# 一个创建闭包的函数,实现了二元运算的逻辑 _missing = object() def _create_binary_op(name: str, operator: str) -> any: """create a binary operation function. the `name` parameter specifies the name of the special method used for the binary operation (e.g. `sub` for `__sub__`). the `operator` name is the token representing the binary operation (e.g. `-` for subtraction). """ lhs_method_name = f"__{name}__" def binary_op(lhs: any, rhs: any, /) -> any: """a closure implementing a binary operation in python.""" rhs_method_name = f"__r{name}__" # lhs.__*__ lhs_type = type(lhs) try: lhs_method = debuiltins._mro_getattr(lhs_type, lhs_method_name) except attributeerror: lhs_method = _missing # lhs.__r*__ (for knowing if rhs.__r*__ should be called first) try: lhs_rmethod = debuiltins._mro_getattr(lhs_type, rhs_method_name) except attributeerror: lhs_rmethod = _missing # rhs.__r*__ rhs_type = type(rhs) try: rhs_method = debuiltins._mro_getattr(rhs_type, rhs_method_name) except attributeerror: rhs_method = _missing call_lhs = lhs, lhs_method, rhs call_rhs = rhs, rhs_method, lhs if ( rhs_type is not _missing # do we care? and rhs_type is not lhs_type # could rhs be a subclass? and issubclass(rhs_type, lhs_type) # rhs is a subclass! and lhs_rmethod is not rhs_method # is __r*__ actually different? ): calls = call_rhs, call_lhs elif lhs_type is not rhs_type: calls = call_lhs, call_rhs else: calls = (call_lhs,) for first_obj, meth, second_obj in calls: if meth is _missing: continue value = meth(first_obj, second_obj) if value is not notimplemented: return value else: exc = typeerror( f"unsupported operand type(s) for {operator}: {lhs_type!r} and {rhs_type!r}" ) exc._binary_op = operator raise exc
有了这段代码,你可以将减法运算定义为 _create_binary_op(“sub”, “-”),然后根据需要重复定义出其它运算。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。