源代码: Lib/operator.py

operator 模块提供了一套与Python的内置运算符对应的高效率函数。例如，operator.add(x, y) 与表达式 x+y 相同。 许多函数名与特殊方法名相同，只是没有双下划线。为了向后兼容性，也保留了许多包含双下划线的函数。为了表述清楚，建议使用没有双下划线的函数。

函数包含的种类有：对象的比较运算、逻辑运算、数学运算以及序列运算。

对象比较函数适用于所有的对象，函数名根据它们对应的比较运算符命名。

在 a 和 b 之间进行全比较。具体的，lt(a, b) 与 a = b 相同。注意这些函数可以返回任何值，无论它是否可当作布尔值。关于全比较的更多信息请参考 比较运算 。

逻辑运算通常也适用于所有对象，并且支持真值检测、标识检测和布尔运算：

返回 not obj 的结果。 （请注意对象实例并没有 __not__() 方法；只有解释器核心可定义此操作。 结果会受 __bool__() 和 __len__() 方法影响。）

如果 obj 为真值则返回 True，否则返回 False。 这等价于使用 bool 构造器。

返回 a is b。 检测对象标识。

返回 a is not b。 检测对象标识。

数学和按位运算的种类是最多的：

返回 obj 的绝对值。

对于数字 a 和 b，返回 a + b。

返回 x 和 y 按位与的结果。

返回 a // b。

返回 a 转换为整数的结果。 等价于 a.__index__()。

在 3.10 版本发生变更: 结果总是为 int 类型。 在之前版本中，结果可能为 int 的子类的实例。

返回数字 obj 按位取反的结果。 这等价于 ~obj。

返回 a 左移 b 位的结果。

返回 a % b。

对于数字 a 和 b，返回 a * b。

返回 a @ b。

在 3.5 版本加入.

返回 obj 取负的结果 (-obj)。

返回 a 和 b 按位或的结果。

返回 obj 取正的结果 (+obj)。

对于数字 a 和 b，返回 a ** b。

返回 a 右移 b 位的结果。

返回 a - b。

返回 a / b 例如 2/3 将等于 .66 而不是 0。 这也被称为“真”除法。

返回 a 和 b 按位异或的结果。

适用于序列的操作（其中一些也适用于映射）包括：

对于序列 a 和 b，返回 a + b。

返回 b in a 检测的结果。 请注意操作数是反序的。

返回 b 在 a 中的出现次数。

移除 a 中索引号为 b 的值。

返回 a 中索引为 b 的值。

返回 b 在 a 中首次出现所在的索引号。

将 a 中索引号为 b 的值设为 c。

Return an estimated length for the object obj. First try to return its actual length, then an estimate using object.__length_hint__(), and finally return the default value.

在 3.4 版本加入.

The following operation works with callables:

Return obj(*args, **kwargs).

在 3.11 版本加入.

operator 模块还定义了一些用于常规属性和条目查找的工具。 这些工具适合用来编写快速字段提取器作为 map(), sorted(), itertools.groupby() 或其他需要相应函数参数的函数的参数。

返回一个可从操作数中获取 attr 的可调用对象。 如果请求了一个以上的属性，则返回一个属性元组。 属性名称还可包含点号。 例如：

在 f = attrgetter('name') 之后，调用 f(b) 将返回 b.name。

在 f = attrgetter('name', 'date') 之后，调用 f(b) 将返回 (b.name, b.date)。

在 f = attrgetter('name.first', 'name.last') 之后，调用 f(b) 将返回 (b.name.first, b.name.last)。

等价于:

返回一个使用操作数的 __getitem__() 方法从操作数中获取 item 的可调用对象。 如果指定了多个条目，则返回一个查找值的元组。 例如：

在 f = itemgetter(2) 之后，调用 f(r) 将返回 r[2]。

在 g = itemgetter(2, 5, 3) 之后，调用 g(r) 将返回 (r[2], r[5], r[3])。

等价于:

The items can be any type accepted by the operand's __getitem__() method. Dictionaries accept any hashable value. Lists, tuples, and strings accept an index or a slice:

使用 itemgetter() 从元组的记录中提取特定字段的例子：

返回一个在操作数上调用 name 方法的可调用对象。 如果给出额外的参数和/或关键字参数，它们也将被传给该方法。 例如：

在 f = methodcaller('name') 之后，调用 f(b) 将返回 b.name()。

在 f = methodcaller('name', 'foo', bar=1) 之后，调用 f(b) 将返回 b.name('foo', bar=1)。

等价于:

以下表格显示了抽象运算是如何对应于 Python 语法中的运算符和 operator 模块中的函数的。

运算

语法

函数

加法

a + b

add(a, b)

字符串拼接

seq1 + seq2

concat(seq1, seq2)

包含测试

obj in seq

contains(seq, obj)

除法

a / b

truediv(a, b)

除法

a // b

floordiv(a, b)

按位与

a & b

and_(a, b)

按位异或

a ^ b

xor(a, b)

按位取反

~ a

invert(a)

按位或

a | b

or_(a, b)

取幂

a ** b

pow(a, b)

标识

a is b

is_(a, b)

标识

a is not b

is_not(a, b)

索引赋值

obj[k] = v

setitem(obj, k, v)

索引删除

del obj[k]

delitem(obj, k)

索引取值

obj[k]

getitem(obj, k)

左移

a b

rshift(a, b)

切片赋值

seq[i:j] = values

setitem(seq, slice(i, j), values)

切片删除

del seq[i:j]

delitem(seq, slice(i, j))

切片取值

seq[i:j]

getitem(seq, slice(i, j))

字符串格式化

s % obj

mod(s, obj)

减法

a - b

sub(a, b)

真值测试

obj

truth(obj)

比较

a b

gt(a, b)

许多运算都有“原地”版本。 以下列出的是提供对原地运算符相比通常语法更底层访问的函数，例如 statement x += y 相当于 x = operator.iadd(x, y)。 换一种方式来讲就是 z = operator.iadd(x, y) 等价于语句块 z = x; z += y。

在这些例子中，请注意当调用一个原地方法时，运算和赋值是分成两个步骤来执行的。 下面列出的原地函数只执行第一步即调用原地方法。 第二步赋值则不加处理。

对于不可变的目标例如字符串、数字和元组，更新的值会被计算，但不会被再被赋值给输入变量：

对于可变的目标例如列表和字典，原地方法将执行更新，因此不需要后续赋值操作：

a = iadd(a, b) 等价于 a += b。

a = iand(a, b) 等价于 a &= b。

a = iconcat(a, b) 等价于 a += b 其中 a 和 b 为序列。

a = ifloordiv(a, b) 等价于 a //= b。

a = ilshift(a, b) 等价于 a = b。

a = isub(a, b) 等价于 a -= b。

a = itruediv(a, b) 等价于 a /= b。

a = ixor(a, b) 等价于 a ^= b。