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


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

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

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

class numbers.Integral

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

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

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

def __hash__(self):
    if self.denominator == 1:
        # Получить целые числа правильно.
        return hash(self.numerator)
    # Дорогая проверка, но точно правильная.
    if self == float(self):
        return hash(float(self))
    else:
        # Используется хэш кортежа, чтобы избежать высокой частоты коллизий на
        # простые дроби.
        return hash((self.numerator, self.denominator))

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

Конечно, существует больше возможных ABC для чисел, и это была бы плохая иерархия, если бы она исключала возможность их добавления. Вы можете добавить 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. Тогда __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):
            # Включает целые числа.
            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)

# ...