test_operator_overloading.py 4.23 KB
Newer Older
1
import pytest
2

3
from pybind11_tests import ConstructorStats
4
from pybind11_tests import operators as m
5
6


Dean Moldovan's avatar
Dean Moldovan committed
7
def test_operator_overloading():
8
9
    v1 = m.Vector2(1, 2)
    v2 = m.Vector(3, -1)
10
11
12
    v3 = m.Vector2(1, 2)  # Same value as v1, but different instance.
    assert v1 is not v3

Dean Moldovan's avatar
Dean Moldovan committed
13
14
15
    assert str(v1) == "[1.000000, 2.000000]"
    assert str(v2) == "[3.000000, -1.000000]"

16
17
    assert str(-v2) == "[-3.000000, 1.000000]"

Dean Moldovan's avatar
Dean Moldovan committed
18
19
20
21
22
23
24
25
26
27
    assert str(v1 + v2) == "[4.000000, 1.000000]"
    assert str(v1 - v2) == "[-2.000000, 3.000000]"
    assert str(v1 - 8) == "[-7.000000, -6.000000]"
    assert str(v1 + 8) == "[9.000000, 10.000000]"
    assert str(v1 * 8) == "[8.000000, 16.000000]"
    assert str(v1 / 8) == "[0.125000, 0.250000]"
    assert str(8 - v1) == "[7.000000, 6.000000]"
    assert str(8 + v1) == "[9.000000, 10.000000]"
    assert str(8 * v1) == "[8.000000, 16.000000]"
    assert str(8 / v1) == "[8.000000, 4.000000]"
28
29
    assert str(v1 * v2) == "[3.000000, -2.000000]"
    assert str(v2 / v1) == "[3.000000, -0.500000]"
Dean Moldovan's avatar
Dean Moldovan committed
30

31
32
    assert v1 == v3
    assert v1 != v2
33
    assert hash(v1) == 4
34
35
    # TODO(eric.cousineau): Make this work.
    # assert abs(v1) == "abs(Vector2)"
36

37
38
39
40
    v1 += 2 * v2
    assert str(v1) == "[7.000000, 0.000000]"
    v1 -= v2
    assert str(v1) == "[4.000000, 1.000000]"
Dean Moldovan's avatar
Dean Moldovan committed
41
42
    v1 *= 2
    assert str(v1) == "[8.000000, 2.000000]"
43
44
45
46
47
48
    v1 /= 16
    assert str(v1) == "[0.500000, 0.125000]"
    v1 *= v2
    assert str(v1) == "[1.500000, -0.125000]"
    v2 /= v1
    assert str(v2) == "[2.000000, 8.000000]"
Dean Moldovan's avatar
Dean Moldovan committed
49

50
    cstats = ConstructorStats.get(m.Vector2)
51
    assert cstats.alive() == 3
Dean Moldovan's avatar
Dean Moldovan committed
52
    del v1
53
    assert cstats.alive() == 2
Dean Moldovan's avatar
Dean Moldovan committed
54
    del v2
55
56
    assert cstats.alive() == 1
    del v3
Dean Moldovan's avatar
Dean Moldovan committed
57
    assert cstats.alive() == 0
58
    assert cstats.values() == [
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
        "[1.000000, 2.000000]",
        "[3.000000, -1.000000]",
        "[1.000000, 2.000000]",
        "[-3.000000, 1.000000]",
        "[4.000000, 1.000000]",
        "[-2.000000, 3.000000]",
        "[-7.000000, -6.000000]",
        "[9.000000, 10.000000]",
        "[8.000000, 16.000000]",
        "[0.125000, 0.250000]",
        "[7.000000, 6.000000]",
        "[9.000000, 10.000000]",
        "[8.000000, 16.000000]",
        "[8.000000, 4.000000]",
        "[3.000000, -2.000000]",
        "[3.000000, -0.500000]",
        "[6.000000, -2.000000]",
76
    ]
Dean Moldovan's avatar
Dean Moldovan committed
77
78
79
80
81
    assert cstats.default_constructions == 0
    assert cstats.copy_constructions == 0
    assert cstats.move_constructions >= 10
    assert cstats.copy_assignments == 0
    assert cstats.move_assignments == 0
82
83
84
85
86


def test_operators_notimplemented():
    """#393: need to return NotSupported to ensure correct arithmetic operator behavior"""

87
    c1, c2 = m.C1(), m.C2()
88
89
90
91
92
93
94
95
96
    assert c1 + c1 == 11
    assert c2 + c2 == 22
    assert c2 + c1 == 21
    assert c1 + c2 == 12


def test_nested():
    """#328: first member in a class can't be used in operators"""

97
98
99
    a = m.NestA()
    b = m.NestB()
    c = m.NestC()
100
101

    a += 10
102
    assert m.get_NestA(a) == 13
103
    b.a += 100
104
    assert m.get_NestA(b.a) == 103
105
    c.b.a += 1000
106
    assert m.get_NestA(c.b.a) == 1003
107
    b -= 1
108
    assert m.get_NestB(b) == 3
109
    c.b -= 3
110
    assert m.get_NestB(c.b) == 1
111
    c *= 7
112
    assert m.get_NestC(c) == 35
113
114
115
116
117
118
119
120
121
122
123

    abase = a.as_base()
    assert abase.value == -2
    a.as_base().value += 44
    assert abase.value == 42
    assert c.b.a.as_base().value == -2
    c.b.a.as_base().value += 44
    assert c.b.a.as_base().value == 42

    del c
    pytest.gc_collect()
luz.paz's avatar
luz.paz committed
124
    del a  # Shouldn't delete while abase is still alive
125
126
127
128
129
    pytest.gc_collect()

    assert abase.value == 42
    del abase, b
    pytest.gc_collect()
130
131
132
133
134
135


def test_overriding_eq_reset_hash():
    assert m.Comparable(15) is not m.Comparable(15)
    assert m.Comparable(15) == m.Comparable(15)

136
137
138
    with pytest.raises(TypeError) as excinfo:
        hash(m.Comparable(15))
    assert str(excinfo.value).startswith("unhashable type:")
139
140
141
142
143
144
145

    for hashable in (m.Hashable, m.Hashable2):
        assert hashable(15) is not hashable(15)
        assert hashable(15) == hashable(15)

        assert hash(hashable(15)) == 15
        assert hash(hashable(15)) == hash(hashable(15))
146
147
148
149
150


def test_return_set_of_unhashable():
    with pytest.raises(TypeError) as excinfo:
        m.get_unhashable_HashMe_set()
151
    assert str(excinfo.value.__cause__).startswith("unhashable type:")