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

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

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

class numbers.Number

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

1. Числовая иерархия

class numbers.Complex

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

real

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

imag

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

abstractmethod 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. Тогда __radd__() B получает шанс. Если он принимает 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, 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)

# ...