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

Источник: Lib/numbers.py

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

class numbers.Number

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

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

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 должны быть экземплярами Integral и иметь наименьшее значение при положительном значении denominator.

numerator

Аннотация.

denominator

Аннотация.

class numbers.Integral

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

Заметки для разработчиков типов

Разработчикам следует внимательно следить за тем, чтобы равные числа были равны и хэшировались на одинаковые значения. Это может быть сложно, если существуют два различных расширения вещественных чисел. Например, 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))

Добавление новых числовых азбук

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

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

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

Мы хотим реализовать арифметические операции так, чтобы операции смешанного режима либо вызывали реализацию, автор которой знает о типах обоих аргументов, либо преобразовывали их к ближайшему встроенному типу и выполняли операцию там. Для подтипов 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, 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, Real):
            return fallback_operator(float(a), float(b))
        elif isinstance(a, 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)

# ...