👆 「Python貓」 ,一個值得加星標的公衆號python

序言
本文是 Python語法糖 系列文章之一。最新的源代碼能夠在 desugar 項目中找到(https://github.com/brettcannon/desugar)。git
介紹
Python 有一種叫作加強算術賦值
(augmented arithmetic assignment)的東西。可能你不熟悉這個叫法,其實就是在作數學運算的同時進行賦值,例如 a -= b 就是減法的加強算術賦值。github
加強賦值是在 Python 2.0 版本中 加入進來的。(譯註:在 PEP-203 中引入)web
剖析 -=
由於 Python 不容許覆蓋式賦值,因此相比其它有特殊/魔術方法的操做,它實現加強賦值的方式可能跟你想象的不徹底同樣。c#
首先,要知道a -= b
在語義上與 a = a-b
相同。但也要意識到,若是你預先知道要將一個對象賦給一個變量名,相比a - b
的盲操做,就可能會更高效。安全
例如,最起碼的好處是能夠避免建立一個新對象:若是能夠就地修改一個對象,那麼返回 self,就比從新構造一個新對象要高效。微信
所以,Python 提供了一個__isub__() 方法。若是它被定義在賦值操做的左側(一般稱爲 lvalue),則會調用右側的值(一般稱爲 rvalue )。因此對於a -= b
,就會嘗試去調用 a.__isub__(b)。app
若是調用的結果是 NotImplemented,或者根本不存在結果,那麼 Python 會退回到常規的二元算術運算:a - b
。(譯註:做者關於二元運算的文章,譯文在此)編輯器
最終不管用了哪一種方法,返回值都會被賦值給 a。函數
下面是簡單的僞代碼,a -= b
被分解成:
# 實現 a -= b 的僞代碼
if hasattr(a, "__isub__"):
_value = a.__isub__(b)
if _value is not NotImplemented:
a = _value
else:
a = a - b
del _value
else:
a = a - b
概括這些方法
因爲咱們已經實現了二元算術運算,所以概括加強算術運算並不太複雜。
經過傳入二元算術運算函數,並作一些自省(以及處理可能發生的 TypeError),它能夠被漂亮地概括成:
def _create_binary_inplace_op(binary_op: _BinaryOp) -> Callable[[Any, Any], Any]:
binary_operation_name = binary_op.__name__[2:-2]
method_name = f"__i{binary_operation_name}__"
operator = f"{binary_op._operator}="
def binary_inplace_op(lvalue: Any, rvalue: Any, /) -> Any:
lvalue_type = type(lvalue)
try:
method = debuiltins._mro_getattr(lvalue_type, method_name)
except AttributeError:
pass
else:
value = method(lvalue, rvalue)
if value is not NotImplemented:
return value
try:
return binary_op(lvalue, rvalue)
except TypeError as exc:
# If the TypeError is due to the binary arithmetic operator, suppress
# it so we can raise the appropriate one for the agumented assignment.
if exc._binary_op != binary_op._operator:
raise
raise TypeError(
f"unsupported operand type(s) for {operator}: {lvalue_type!r} and {type(rvalue)!r}"
)
binary_inplace_op.__name__ = binary_inplace_op.__qualname__ = method_name
binary_inplace_op.__doc__ = (
f"""Implement the augmented arithmetic assignment `a {operator} b`."""
)
return binary_inplace_op
這使得定義的 -= 支持 _create_binary_inplace_op(__ sub__),且能夠推斷出其它內容:函數名、調用什麼 __i*__ 函數,以及當二元算術運算出問題時,該調用哪一個可調用對象。
我發現幾乎沒有人使用**=
在寫本文的代碼時,我碰上了 **= 的一個奇怪的測試錯誤。在全部確保 __pow__ 會被適當地調用的測試中,有個測試用例對於 Python 標準庫中的operator
模塊倒是失敗。
個人代碼一般沒問題,若是代碼與 CPython 的代碼之間存在差別,一般會意味着是我哪裏出錯了。
可是,不管我多麼仔細地排查代碼,我都沒法定位出爲何個人測試會經過,而標準庫則失敗。
我決定深刻地瞭解 CPython 內部發生了什麼。從反彙編字節碼開始:
>>> def test(): a **= b
...
>>> import dis
>>> dis.dis(test)
1 0 LOAD_FAST 0 (a)
2 LOAD_GLOBAL 0 (b)
4 INPLACE_POWER
6 STORE_FAST 0 (a)
8 LOAD_CONST 0 (None)
10 RETURN_VALUE
經過它,我找到了在 eval 循環中的INPLACE_POWER
:
case TARGET(INPLACE_POWER): {
PyObject *exp = POP();
PyObject *base = TOP();
PyObject *res = PyNumber_InPlacePower(base, exp, Py_None);
Py_DECREF(base);
Py_DECREF(exp);
SET_TOP(res);
if (res == NULL)
goto error;
DISPATCH();
}
而後找到PyNumber_InPlacePower()
:
PyObject *
PyNumber_InPlacePower(PyObject *v, PyObject *w, PyObject *z)
{
if (v->ob_type->tp_as_number &&
v->ob_type->tp_as_number->nb_inplace_power != NULL) {
return ternary_op(v, w, z, NB_SLOT(nb_inplace_power), "**=");
}
else {
return ternary_op(v, w, z, NB_SLOT(nb_power), "**=");
}
}
鬆了口氣~代碼顯示若是定義了__ipow__,則會調用它,可是隻在沒有__ipow__ 時,纔會調用__pow__。
然而,正確的作法應該是:若是調用__ipow__ 時出問題,返回了 NotImplemented 或者根本不存在返回,那麼就應該調用 __pow__ 和__rpow__。
換句話說,當存在__ipow__時,以上代碼會意外地跳過 a**b 的後備語義!
實際上,大約11個月前,這個問題被部分地發現,並提交了 bug。我修復了該問題,並在 python-dev 上做了說明。
截至目前,這彷佛會在 Python 3.10 中修復,咱們還須要在 3.8 和 3.9 的文檔中添加關於 **= 有 bug 的通知(該問題可能很早就有了,但較舊的 Python 版本已處於僅安全維護模式,所以文檔不會變動)。
修復的代碼極可能不會被移植,由於它是語義上的變化,而且很難判斷是否有人意外地依賴了有問題的語義。可是這個問題花了很長時間才被注意到,這就代表 **= 的使用並不普遍,不然問題早就被發現了。

優質文章,推薦閱讀:

本文分享自微信公衆號 - Python貓(python_cat)。
若有侵權,請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」,歡迎正在閱讀的你也加入,一塊兒分享。