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 -
Абстрактный атрибут.
-
Примечания для разработчиков типов
Разработчикам следует позаботиться о том, чтобы равные числа имели одинаковые хеш-значения. Это может быть непросто, если существуют два разных расширения вещественных чисел. Например, 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))
Добавление других числовых 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
Для операции смешанных типов с подклассами Complex существует 5 различных случаев. Код выше, не относящийся к MyIntegral и OtherTypeIKnowAbout, я буду называть «шаблонным». a будет экземпляром A, который является подклассом Complex (a : A <: Complex), и b : B <:
Complex. Рассмотрим a + b:
- Если
Aопределяет__add__(), принимающийb, всё в порядке. - Если
Aпереходит к шаблонному коду и возвращает значение из__add__(), мы упустим возможность того, чтоBопределяет более интеллектуальный__radd__(), поэтому шаблонный код должен возвращатьNotImplementedиз__add__(). (ИлиAвообще может не реализовывать__add__().) - Затем вызывается
__radd__()объектаB. Если он принимаетa, всё в порядке. - Если он переходит к шаблонному коду, других методов для вызова не остаётся, поэтому здесь и должна находиться реализация по умолчанию.
- Если
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–2024 Python Software Foundation
Licensed under the PSF License.
https://docs.python.org/3.12/library/numbers.html