numbers — Числовые абстрактные базовые классы

Модуль numbers (PEP 3141) определяет иерархию числовых абстрактных базовых классов, которые постепенно определяют больше операций. Ни один из типов, определённых в этом модуле, не может быть создан.

class numbers.Number

Корень числовой иерархии. Если вам нужно только проверить, является ли аргумент x числом, не заботясь о его типе, используйте isinstance(x, Number).

1. Числовая башня

class numbers.Complex

Подклассы этого типа описывают комплексные числа и включают операции, которые работают со встроенным типом complex. К ним относятся: преобразования к complex и bool, real, imag, +, -, *, /, abs(), conjugate(), ==, и !=. Все, кроме - и != являются абстрактными.

real

Абстрактный. Возвращает вещественную часть этого числа.

imag

Абстрактный. Возвращает мнимую часть этого числа.

conjugate()

Абстрактный. Возвращает комплексно сопряжённое число. Например, (1+3j).conjugate() == (1-3j).

class numbers.Real

К Complex, Real добавляет операции, которые работают с вещественными числами.

Коротко: преобразование к float, math.trunc(), round(), math.floor(), math.ceil(), divmod(), //, %, <, <=, >, и >=.

Real также предоставляет значения по умолчанию для complex(), real, imag и conjugate().

class numbers.Rational

Подтип Real и добавляет свойства numerator и denominator, которые должны быть приведены к наименьшим членам. С ними он предоставляет значение по умолчанию для float().

numerator

Абстрактный.

denominator

Абстрактный.

class numbers.Integral

Подтип Rational и добавляет преобразование к int. Предоставляет значения по умолчанию для float(), numerator и denominator. Добавляет абстрактные методы для ** и операций с битами: <<, >>, &, ^, |, ~.

2. Примечания для разработчиков типов

Разработчики должны тщательно следить за тем, чтобы равные числа были равны и были присвоены одинаковые значения хешей. Это может быть тонким моментом, если существуют два разных расширения вещественных чисел. Например, fractions.Fraction реализует hash() следующим образом:

def __hash__(self):
    if self.denominator == 1:
        # Get integers right.
        return hash(self.numerator)
    # Expensive check, but definitely correct.
    if self == float(self):
        return hash(float(self))
    else:
        # Use tuple's hash to avoid a high collision rate on
        # simple fractions.
        return hash((self.numerator, self.denominator))

2.1. Добавление дополнительных числовых ABC

Конечно, есть и другие возможные ABC для чисел, и эта иерархия была бы плохой, если бы она исключила возможность их добавления. Вы можете добавить MyFoo между Complex и Real с помощью:

class MyFoo(Complex): ...
MyFoo.register(Real)

2.2. Реализация арифметических операций

Мы хотим реализовать арифметические операции таким образом, чтобы операции с разными типами либо вызывали реализацию, чьи авторы знали о типах обоих аргументов, либо преобразовывали оба в ближайший встроенный тип и выполняли операцию там. Для подтипов Integral это означает, что __add__() и __radd__() должны быть определены как:

class MyIntegral(Integral):

    def __add__(self, other):
        if isinstance(other, MyIntegral):
            return do_my_adding_stuff(self, other)
        elif isinstance(other, OtherTypeIKnowAbout):
            return do_my_other_adding_stuff(self, other)
        else:
            return NotImplemented

    def __radd__(self, other):
        if isinstance(other, MyIntegral):
            return do_my_adding_stuff(other, self)
        elif isinstance(other, OtherTypeIKnowAbout):
            return do_my_other_adding_stuff(other, self)
        elif isinstance(other, Integral):
            return int(other) + int(self)
        elif isinstance(other, Real):
            return float(other) + float(self)
        elif isinstance(other, Complex):
            return complex(other) + complex(self)
        else:
            return NotImplemented

Существует 5 различных случаев для операции с разными типами на подклассах Complex. Я буду называть весь вышеприведённый код, не связанный с MyIntegral и OtherTypeIKnowAbout «шаблоном». a будет экземпляром A, который является подтипом Complex (a : A <: Complex), и b : B <: Complex. Я буду рассматривать a + b:

1. Если A определяет __add__(), принимающий b, всё хорошо.
2. Если A возвращается к шаблону кода, и он возвращает значение из __add__(), мы пропустим возможность того, что B определяет более интеллектуальную __radd__(), поэтому шаблон должен возвращать NotImplemented из __add__(). (Или A может вообще не реализовывать __add__().)
3. Затем B получает возможность __radd__(). Если она принимает a, всё хорошо.
4. Если она возвращается к шаблону, больше нет методов для проверки, поэтому здесь должна быть реализация по умолчанию.
5. Если B <: A, Python попробует B.__radd__ перед A.__add__. Это нормально, потому что это было реализовано с знанием A, так что оно может обрабатывать эти экземпляры, прежде чем делегировать Complex.

Если A <: Complex и B <: Real без обмена какой-либо другой информацией, то соответствующая общая операция — это операция, использующая встроенное complex, и оба __radd__() попадают туда, поэтому a+b == b+a.

Поскольку большинство операций с любым заданным типом будут очень похожи, может быть полезно определить вспомогательную функцию, которая генерирует прямые и обратные экземпляры любой данной операции. Например, fractions.Fraction использует:

def _operator_fallbacks(monomorphic_operator, fallback_operator):
    def forward(a, b):
        if isinstance(b, (int, long, Fraction)):
            return monomorphic_operator(a, b)
        elif isinstance(b, float):
            return fallback_operator(float(a), b)
        elif isinstance(b, complex):
            return fallback_operator(complex(a), b)
        else:
            return NotImplemented
    forward.__name__ = '__' + fallback_operator.__name__ + '__'
    forward.__doc__ = monomorphic_operator.__doc__

    def reverse(b, a):
        if isinstance(a, Rational):
            # Includes ints.
            return monomorphic_operator(a, b)
        elif isinstance(a, numbers.Real):
            return fallback_operator(float(a), float(b))
        elif isinstance(a, numbers.Complex):
            return fallback_operator(complex(a), complex(b))
        else:
            return NotImplemented
    reverse.__name__ = '__r' + fallback_operator.__name__ + '__'
    reverse.__doc__ = monomorphic_operator.__doc__

    return forward, reverse

def _add(a, b):
    """a + b"""
    return Fraction(a.numerator * b.denominator +
                    b.numerator * a.denominator,
                    a.denominator * b.denominator)

__add__, __radd__ = _operator_fallbacks(_add, operator.add)

# ...