Spec-Zone.ru › Python 3.14

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

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

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

numerator

Абстрактный атрибут. Числитель этого рационального числа.

denominator

Абстрактный атрибут. Знаменатель этого рационального числа.

class numbers.Integral

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

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

Разработчикам следует позаботиться о том, чтобы равные числа считались равными и имели одинаковые хеш-значения. Это может быть непросто, если существуют два разных расширения вещественных чисел. См. также Хеширование числовых типов.

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

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

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

Для смешанной операции над подклассами Complex есть 5 разных случаев. Код выше, не связанный с 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, 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)

# ...

© 2001 Python Software Foundation
Licensed under the PSF License.
https://docs.python.org/3.14/library/numbers.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API