Python Language
Sobrecarga

Métodos de magia / Dunder

Los métodos de Magic (también llamados dunder como abreviatura de subrayado doble) en Python tienen un propósito similar al de la sobrecarga de operadores en otros idiomas. Permiten a una clase definir su comportamiento cuando se usa como un operando en expresiones de operador unarias o binarias. También sirven como implementaciones llamadas por algunas funciones integradas.

Considere esta implementación de vectores bidimensionales.

import math

class Vector(object):
    # instantiation
    def __init__(self, x, y):
        self.x = x
        self.y = y

    # unary negation (-v)
    def __neg__(self):
        return Vector(-self.x, -self.y)

    # addition (v + u)
    def __add__(self, other):
        return Vector(self.x + other.x, self.y + other.y)

    # subtraction (v - u)
    def __sub__(self, other):
        return self + (-other)

    # equality (v == u)
    def __eq__(self, other):
        return self.x == other.x and self.y == other.y

    # abs(v)
    def __abs__(self):
        return math.hypot(self.x, self.y)

    # str(v)
    def __str__(self):
        return '<{0.x}, {0.y}>'.format(self)

    # repr(v)
    def __repr__(self):
        return 'Vector({0.x}, {0.y})'.format(self)

Ahora es posible usar naturalmente instancias de la clase Vector en varias expresiones.

v = Vector(1, 4)
u = Vector(2, 0)

u + v           # Vector(3, 4)
print(u + v)    # "<3, 4>" (implicit string conversion)
u - v           # Vector(1, -4)
u == v          # False
u + v == v + u  # True
abs(u + v)      # 5.0

Contenedor y tipos de secuencia.

Es posible emular tipos de contenedores, que admiten el acceso a valores por clave o índice.

Considere esta implementación ingenua de una lista dispersa, que almacena solo los elementos que no son cero para conservar la memoria.

class sparselist(object):
    def __init__(self, size):
        self.size = size
        self.data = {}
    
    # l[index]
    def __getitem__(self, index):
        if index < 0:
            index += self.size
        if index >= self.size:
            raise IndexError(index)
        try:
            return self.data[index]
        except KeyError:
            return 0.0

    # l[index] = value
    def __setitem__(self, index, value):
        self.data[index] = value

    # del l[index]
    def __delitem__(self, index):
        if index in self.data:
            del self.data[index]

    # value in l
    def __contains__(self, value):
        return value == 0.0 or value in self.data.values()

    # len(l)
    def __len__(self):
        return self.size

    # for value in l: ...
    def __iter__(self):
        return (self[i] for i in range(self.size)) # use xrange for python2

Entonces, podemos usar una lista sparselist como una list normal.

l = sparselist(10 ** 6)  # list with 1 million elements
0 in l                   # True
10 in l                  # False

l[12345] = 10            
10 in l                  # True
l[12345]                 # 10

for v in l:
    pass  # 0, 0, 0, ... 10, 0, 0 ... 0

Tipos callables

class adder(object):
    def __init__(self, first):
        self.first = first

    # a(...)
    def __call__(self, second):
        return self.first + second

add2 = adder(2)
add2(1)  # 3
add2(2)  # 4

Manejando conductas no implementadas.

Si su clase no implementa un operador sobrecargado específico para los tipos de argumentos provistos, debería return NotImplemented ( tenga en cuenta que esta es una constante especial , no la misma que NotImplementedError ). Esto permitirá a Python volver a probar otros métodos para hacer que la operación funcione:

Cuando se devuelve NotImplemented , el intérprete intentará la operación reflejada en el otro tipo, o algún otro repliegue, dependiendo del operador. Si todas las operaciones intentadas devuelven No NotImplemented , el intérprete generará una excepción apropiada.

Por ejemplo, dado x + y , si x.__add__(y) devuelve no implementado, y.__radd__(x) se intenta en su lugar.

class NotAddable(object):

    def __init__(self, value):
        self.value = value

    def __add__(self, other):
        return NotImplemented


class Addable(NotAddable):

    def __add__(self, other):
        return Addable(self.value + other.value)

    __radd__ = __add__

Como este es el método reflejado , debemos implementar __add__ y __radd__ para obtener el comportamiento esperado en todos los casos; afortunadamente, como ambos están haciendo lo mismo en este simple ejemplo, podemos tomar un atajo.

En uso:

>>> x = NotAddable(1)
>>> y = Addable(2)
>>> x + x
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: unsupported operand type(s) for +: 'NotAddable' and 'NotAddable'
>>> y + y
<so.Addable object at 0x1095974d0>
>>> z = x + y
>>> z
<so.Addable object at 0x109597510>
>>> z.value
3

Sobrecarga del operador

A continuación se muestran los operadores que pueden sobrecargarse en clases, junto con las definiciones de métodos que se requieren y un ejemplo del operador en uso dentro de una expresión.

Nota: el uso de other como nombre de variable no es obligatorio, pero se considera la norma.

El modulo parámetro opcional para __pow__ solo lo utiliza la función incorporada pow .

Cada uno de los métodos correspondientes a un operador binario tiene un método "correcto" correspondiente que comienza con __r , por ejemplo __radd__ :

class A:
    def __init__(self, a):
        self.a = a
    def __add__(self, other):
        return self.a + other
    def __radd__(self, other):
        print("radd")
        return other + self.a

A(1) + 2  # Out:  3
2 + A(1)  # prints radd. Out: 3

así como una versión in situ correspondiente, comenzando con __i :

class B:
    def __init__(self, b):
        self.b = b
    def __iadd__(self, other):
        self.b += other
        print("iadd")
        return self

b = B(2)
b.b       # Out: 2
b += 1    # prints iadd
b.b       # Out: 3

Como no hay nada especial en estos métodos, muchas otras partes del lenguaje, partes de la biblioteca estándar e incluso módulos de terceros agregan métodos mágicos por sí mismos, como métodos para convertir un objeto en un tipo o verificar las propiedades del objeto. Por ejemplo, la función str() incorporada llama al método __str__ del objeto, si existe. Algunos de estos usos se enumeran a continuación.

También existen los métodos especiales __enter__ y __exit__ para administradores de contexto, y muchos más.