7.9. Operator Right¶

x + y - if method "add" on object x fails, then call "radd" on object y (y.__radd__(x))
x - y - if method "sub" on object x fails, then call "rsub" on object y (y.__rsub__(x))
x * y - if method "mul" on object x fails, then call "rmul" on object y (y.__rmul__(x))
x ** y - if method "pow" on object x fails, then call "rpow" on object y (y.__rpow__(x))
x @ y - if method "matmul" on object x fails, then call "rmatmul" on object y (y.__rmatmul__(x))
x / y - if method "truediv" on object x fails, then call "rtruediv" on object y (y.__rtruediv__(x))
x // y - if method "floordiv" on object x fails, then call "rfloordiv" on object y (y.__rfloordiv__(x))
x % y - if method "mod" on object x fails, then call "rmod" on object y (y.__rmod__(x))

Table 7.4. Numerical Operator Overload¶
Operator	Method
`obj + other`	`other.__radd__(obj)`
`obj - other`	`other.__rsub__(obj)`
`obj * other`	`other.__rmul__(obj)`
`obj ** other`	`other.__rpow__(obj)`
`obj @ other`	`other.__rmatmul__(obj)`
`obj / other`	`other.__rtruediv__(obj)`
`obj // other`	`other.__rfloordiv__(obj)`
`obj % other`	`other.__rmod__(obj)`

7.9.1. SetUp¶

>>> from dataclasses import dataclass
>>> from functools import reduce

7.9.2. Syntax¶

>>> @dataclass
... class Vector:
...     x: int
...     y: int
...
...     def __radd__(self, other): ...              # x + y     if fails, then calls y.__radd__(x)
...     def __rsub__(self, other): ...              # x - y     if fails, then calls y.__rsub__(x)
...     def __rmul__(self, other): ...              # x * y     if fails, then calls y.__rmul__(x)
...     def __rpow__(self, power, modulo=None): ... # x ** y    if fails, then calls y.__rpow__(x)
...     def __rmatmul__(self, other): ...           # x @ y     if fails, then calls y.__rmatmul__(x)
...     def __rtruediv__(self, other): ...          # x / y     if fails, then calls y.__rtruediv__(x)
...     def __rfloordiv__(self, other): ...         # x // y    if fails, then calls y.__rfloordiv__(x)
...     def __rmod__(self, other): ...              # x % y     if fails, then calls y.__rmod__(x)

7.9.3. Left Operation¶

>>> class Left:
...     def __add__(self, other):
...         return 'left'
>>>
>>> class Right:
...     pass

Left operation:

>>> Left() + Right()   # left.__add__(right)
'left'

What if Right class does not define __add__ attribute?

>>> Right() + Left()    # right.__add__(left)
Traceback (most recent call last):
TypeError: unsupported operand type(s) for +: 'Right' and 'Left'

7.9.4. Example¶

>>> class Left:
...     def __add__(self, other):
...         return 'left'
...
...     def __radd__(self, other):
...         return 'left too'
>>>
>>>
>>> class Right:
...     pass

Left operation:

>>> Left() + Right()   # left.__add__(right)
'left'

What if Right class does not define __add__ attribute? Python will search for __radd__ attribute in Right class:

>>> Right() + Left()     # Right.__add__(left) -> error -> # left.__radd__(right)
'left too'

7.9.5. Both¶

>>> class Left:
...     def __add__(self, other):
...         return 'left'
...
...     def __radd__(self, other):
...         return 'left too'
>>>
>>>
>>> class Right:
...     def __add__(self, other):
...         return 'right'
>>>
>>>
>>> Left() + Right()    # left.__add__(right)
'left'
>>>
>>> Right() + Left()    # right.__add__(left)
'right'

7.9.6. Example¶

>>> a = 1
>>> b = 2
>>>
>>>
>>> a - b
-1
>>>
>>> a.__sub__(b)
-1
>>> b.__rsub__(a)
-1
>>>
>>>
>>> b - a
1
>>>
>>> b.__sub__(a)
1
>>> a.__rsub__(b)
1

7.9.7. Use Case¶

>>> import numpy as np
>>>
>>>
>>> mylist = [1, 2, 3]
>>> myarr = np.array([4,5,6])
>>>
>>>
>>> myarr + mylist
array([5, 7, 9])
>>>
>>>
>>> mylist + myarr
array([5, 7, 9])
>>>
>>>
>>> mylist.__add__(myarr)
Traceback (most recent call last):
TypeError: can only concatenate list (not "numpy.ndarray") to list
>>>
>>> myarr.__radd__(mylist)
array([5, 7, 9])

>>> class ndarray:
...     def __add__(self, other):
...         if isinstance(other, list):
...             other = np.array(other)
...         if isinstance(other, np.array):
...             ...
...
...     def __radd__(self, other):
...         if isinstance(other, list):
...             other = np.array(other)
...         if isinstance(other, np.array):
...             ...

7.9.8. Use Case - 0x01¶

Game

>>> hero @ Position(x=50, y=120)  
>>>
>>> hero['gold'] += dragon['gold']  

7.9.9. Use Case - 0x02¶

>>> from dataclasses import dataclass, field
>>>
>>>
>>> @dataclass
... class User:
...     firstname: str
...     lastname: str
>>>
>>>
>>> @dataclass
... class Group:
...     members: list[User] = field(default_factory=list)
...
...     def __iadd__(self, other):
...         self.members.append(other)
...         return self
>>>
>>>
>>> ares3 = Group()
>>> ares3 += User('Mark', 'Watney')
>>> ares3 += User('Melissa', 'Lewis')
>>>
>>> print(ares3)
Group(members=[User(firstname='Mark', lastname='Watney'), User(firstname='Melissa', lastname='Lewis')])
>>>
>>> for member in ares3.members:
...     print(member)
User(firstname='Mark', lastname='Watney')
User(firstname='Melissa', lastname='Lewis')

7.9.10. Use Case - 0x03¶

SetUp:

>>> import numpy as np

Example 1:

>>> a = [1, 2, 3]
>>> b = [4, 5, 6]
>>>
>>> a + b
[1, 2, 3, 4, 5, 6]
>>>
>>> a.__add__(b)
[1, 2, 3, 4, 5, 6]

Example 2:

>>> a = np.array([1, 2, 3])
>>> b = np.array([4, 5, 6])
>>>
>>> a + b
array([5, 7, 9])
>>>
>>> a.__add__(b)
array([5, 7, 9])

Example 3:

>>> a = np.array([1, 2, 3])
>>> b = [4, 5, 6]
>>>
>>> a + b
array([5, 7, 9])
>>>
>>> a.__add__(b)
array([5, 7, 9])

Why this works:

>>> class ndarray:
...     def __add__(self, other):
...         if type(other) is not ndarray:
...             other = np.array(other)

Example 4:

>>> a = [1, 2, 3]
>>> b = np.array([4, 5, 6])
>>>
>>> a + b
array([5, 7, 9])
>>>
>>> a.__add__(b)
Traceback (most recent call last):
TypeError: can only concatenate list (not "numpy.ndarray") to list
>>>
>>> b.__radd__(a)
array([5, 7, 9])