numbers — Numeric abstract base classes

Вихідний код: Lib/numbers.py

---

The numbers module (PEP 3141) defines a hierarchy of numeric abstract base classes which progressively define more operations. None of the types defined in this module are intended to be instantiated.

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

To Complex, Real adds the operations that work on real numbers.

Якщо коротко, це: перетворення на float, math.trunc(), round(), math.floor(), math.ceil(), divmod(), //, %, <, <=, > і >=.

Real також надає значення за замовчуванням для complex(), real, imag і conjugate().

class numbers.Rational

Subtypes Real and adds numerator and denominator properties, which should be in lowest terms. With these, it provides a default for float().

numerator

Анотація.

denominator

Анотація.

class numbers.Integral

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

Notes for type implementors

Implementors should be careful to make equal numbers equal and hash them to the same values. This may be subtle if there are two different extensions of the real numbers. For example, fractions.Fraction implements hash() as follows:

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)

Реалізація арифметичних дій

We want to implement the arithmetic operations so that mixed-mode operations either call an implementation whose author knew about the types of both arguments, or convert both to the nearest built in type and do the operation there. For subtypes of Integral, this means that __add__() and __radd__() should be defined as:

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. If A defines an __add__() which accepts b, all is well.

2. If A falls back to the boilerplate code, and it were to return a value from __add__(), we’d miss the possibility that B defines a more intelligent __radd__(), so the boilerplate should return NotImplemented from __add__(). (Or A may not implement __add__() at all.)

3. Then B’s __radd__() gets a chance. If it accepts a, all is well.

4. Якщо він повернеться до шаблону, більше не буде можливих методів, які можна спробувати, тому тут має бути реалізація за замовчуванням.

5. Якщо B <: A, Python намагається B.__radd__ перед A.__add__. Це нормально, тому що його було реалізовано зі знанням A, тому він може обробити ці випадки перед делегуванням Complex.

If A <: Complex and B <: Real without sharing any other knowledge, then the appropriate shared operation is the one involving the built in complex, and both __radd__() s land there, so 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)

# ...