operator — Стандартные операторы как функции

Исходный код: Lib/operator.py

Модуль operator экспортирует набор эффективных функций, соответствующих встроенным операторам Python. Например, operator.add(x, y) эквивалентно выражению x+y. Многие имена функций — это имена специальных методов, без двойных подчёркиваний. Для обеспечения обратной совместимости многие из них имеют вариант с сохранением двойных подчёркиваний. Варианты без двойных подчёркиваний предпочтительнее для ясности.

Функции делятся на категории, выполняющие сравнение объектов, логические операции, математические операции и операции с последовательностями.

Функции сравнения объектов применимы для всех объектов и названы в соответствии с операторами богатого сравнения, которые они поддерживают:

operator.lt(a, b)

operator.le(a, b)

operator.eq(a, b)

operator.ne(a, b)

operator.ge(a, b)

operator.gt(a, b)

operator.__lt__(a, b)

operator.__le__(a, b)

operator.__eq__(a, b)

operator.__ne__(a, b)

operator.__ge__(a, b)

operator.__gt__(a, b)

Выполняют «богатые сравнения» между a и b. В частности, lt(a, b) эквивалентно a < b, le(a, b) эквивалентно a <= b, eq(a, b) эквивалентно a == b, ne(a, b) эквивалентно a != b, gt(a, b) эквивалентно a > b и ge(a, b) эквивалентно a >= b. Обратите внимание, что эти функции могут возвращать любые значения, которые могут или не могут быть интерпретированы как булевы значения. Дополнительную информацию о богатых сравнениях см. в разделе Сравнения.

Логические операции также в целом применимы ко всем объектам и поддерживают проверки истинности, проверки тождественности и булевы операции:

operator.not_(obj)

operator.__not__(obj)

Возвращает результат not obj. (Обратите внимание, что для экземпляров объектов нет метода __not__(); эту операцию определяет только ядро интерпретатора. Результат зависит от методов __bool__() и __len__().)

operator.truth(obj)

Возвращает True, если obj истинно, и False в противном случае. Это эквивалентно использованию конструктора bool.

operator.is_(a, b)

Возвращает a is b. Проверяет тождественность объектов.

operator.is_not(a, b)

Возвращает a is not b. Проверяет тождественность объектов.

Математические и побитовые операции наиболее многочисленны:

operator.abs(obj)

operator.__abs__(obj)

Возвращает абсолютное значение obj.

operator.add(a, b)

operator.__add__(a, b)

Возвращает a + b, для чисел a и b.

operator.and_(a, b)

operator.__and__(a, b)

Возвращает побитовое и a и b.

operator.floordiv(a, b)

operator.__floordiv__(a, b)

Возвращает a // b.

operator.index(a)

operator.__index__(a)

Возвращает a, преобразованное в целое число. Эквивалентно a.__index__().

Изменено в версии 3.10: Результат всегда имеет точный тип int. Ранее результат мог быть экземпляром подкласса int.

operator.inv(obj)

operator.invert(obj)

operator.__inv__(obj)

operator.__invert__(obj)

Возвращает побитовое отрицание числа obj. Это эквивалентно ~obj.

operator.lshift(a, b)

operator.__lshift__(a, b)

Возвращает a, сдвинутое влево на b.

operator.mod(a, b)

operator.__mod__(a, b)

Возвращает a % b.

operator.mul(a, b)

operator.__mul__(a, b)

Возвращает a * b, для чисел a и b.

operator.matmul(a, b)

operator.__matmul__(a, b)

Возвращает a @ b.

Добавлена в версии 3.5.

operator.neg(obj)

operator.__neg__(obj)

Возвращает obj с отрицательным знаком (-obj).

operator.or_(a, b)

operator.__or__(a, b)

Возвращает побитовое или a и b.

operator.pos(obj)

operator.__pos__(obj)

Возвращает obj со знаком плюс (+obj).

operator.pow(a, b)

operator.__pow__(a, b)

Возвращает a ** b, для чисел a и b.

operator.rshift(a, b)

operator.__rshift__(a, b)

Возвращает a, сдвинутое вправо на b.

operator.sub(a, b)

operator.__sub__(a, b)

Возвращает a - b.

operator.truediv(a, b)

operator.__truediv__(a, b)

Возвращает a / b, где 2/3 равно 0,66, а не 0. Это также известно как «истинное» деление.

operator.xor(a, b)

operator.__xor__(a, b)

Возвращает побитовое исключающее или a и b.

Операции, которые работают с последовательностями (некоторые из них также с отображениями), включают:

operator.concat(a, b)

operator.__concat__(a, b)

Возвращает a + b для последовательностей a и b.

operator.contains(a, b)

operator.__contains__(a, b)

Возвращает результат проверки b in a. Обратите внимание на обратный порядок операндов.

operator.countOf(a, b)

Возвращает количество вхождений b в a.

operator.delitem(a, b)

operator.__delitem__(a, b)

Удаляет значение a по индексу b.

operator.getitem(a, b)

operator.__getitem__(a, b)

Возвращает значение a по индексу b.

operator.indexOf(a, b)

Возвращает индекс первого вхождения b в a.

operator.setitem(a, b, c)

operator.__setitem__(a, b, c)

Устанавливает значение a по индексу b в c.

operator.length_hint(obj, default=0)

Возвращает приблизительную длину объекта obj. Сначала пытается вернуть фактическую длину, затем — приблизительную длину с помощью object.__length_hint__(), и, наконец, возвращает значение по умолчанию.

Добавлена в версии 3.4.

Следующая операция работает с вызываемыми объектами:

operator.call(obj, /, *args, **kwargs)

operator.__call__(obj, /, *args, **kwargs)

Возвращает obj(*args, **kwargs).

Добавлена в версии 3.11.

Модуль operator также определяет инструменты для обобщённого поиска атрибутов и элементов. Они полезны для создания быстрых экстрактров полей в качестве аргументов для map(), sorted(), itertools.groupby() или других функций, ожидающих функцию в качестве аргумента.

operator.attrgetter(attr)

operator.attrgetter(*attrs)

Возвращает вызываемый объект, который извлекает 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).

Эквивалентно:

def attrgetter(*items):
    if any(not isinstance(item, str) for item in items):
        raise TypeError('attribute name must be a string')
    if len(items) == 1:
        attr = items[0]
        def g(obj):
            return resolve_attr(obj, attr)
    else:
        def g(obj):
            return tuple(resolve_attr(obj, attr) for attr in items)
    return g

def resolve_attr(obj, attr):
    for name in attr.split("."):
        obj = getattr(obj, name)
    return obj

operator.itemgetter(item)

operator.itemgetter(*items)

Возвращает вызываемый объект, который извлекает item из своего операнда с помощью метода операнда __getitem__(). Если указано несколько элементов, возвращает кортеж значений поиска. Например:

• После f = itemgetter(2), вызов f(r) возвращает r[2].
• После g = itemgetter(2, 5, 3), вызов g(r) возвращает (r[2], r[5], r[3]).

Эквивалентно:

def itemgetter(*items):
    if len(items) == 1:
        item = items[0]
        def g(obj):
            return obj[item]
    else:
        def g(obj):
            return tuple(obj[item] for item in items)
    return g

Элементы могут быть любого типа, принимаемого методом операнда __getitem__(). Словари принимают любое хешируемое значение. Список, кортеж и строка принимают индекс или срез:

>>> itemgetter(1)('ABCDEFG')
'B'
>>> itemgetter(1, 3, 5)('ABCDEFG')
('B', 'D', 'F')
>>> itemgetter(slice(2, None))('ABCDEFG')
'CDEFG'
>>> soldier = dict(rank='captain', name='dotterbart')
>>> itemgetter('rank')(soldier)
'captain'

Пример использования itemgetter() для извлечения определённых полей из кортежа записи:

>>> inventory = [('apple', 3), ('banana', 2), ('pear', 5), ('orange', 1)]
>>> getcount = itemgetter(1)
>>> list(map(getcount, inventory))
[3, 2, 5, 1]
>>> sorted(inventory, key=getcount)
[('orange', 1), ('banana', 2), ('apple', 3), ('pear', 5)]

operator.methodcaller(name, /, *args, **kwargs)

Возвращает вызываемый объект, который вызывает метод name на своём операнде. Если даны дополнительные аргументы и/или ключевые аргументы, они будут переданы методу также. Например:

• После f = methodcaller('name'), вызов f(b) возвращает b.name().
• После f = methodcaller('name', 'foo', bar=1), вызов f(b) возвращает b.name('foo', bar=1).

Эквивалентно:

def methodcaller(name, /, *args, **kwargs):
    def caller(obj):
        return getattr(obj, name)(*args, **kwargs)
    return caller

>>> a = 'hello'
>>> iadd(a, ' world')
'hello world'
>>> a
'hello'

>>> s = ['h', 'e', 'l', 'l', 'o']
>>> iadd(s, [' ', 'w', 'o', 'r', 'l', 'd'])
['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']
>>> s
['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']