1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
#!/usr/bin/env python
# Copyright (C) 2022 The Qt Company Ltd.
# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
'''Test cases for Python representation of C++ enums.'''
import os
import sys
import unittest
from pathlib import Path
sys.path.append(os.fspath(Path(__file__).resolve().parents[1]))
from shiboken_paths import init_paths
init_paths()
import shiboken6
# This is needed after the introduction of BUILD_DIR.
import sample
from sample import SampleNamespace, ObjectType, Event
from shibokensupport.signature import get_signature
def createTempFile():
import tempfile
return tempfile.SpooledTemporaryFile(mode='rw')
class EnumTest(unittest.TestCase):
'''Test case for Python representation of C++ enums.'''
@unittest.skipIf(sys.pyside63_option_python_enum, "test not suitable for Python enum")
def testEnumRepr(self):
enum = SampleNamespace.Option(1)
self.assertEqual(eval(repr(enum)), enum)
enum = SampleNamespace.Option(999)
self.assertEqual(eval(repr(enum)), enum)
def testHashability(self):
self.assertEqual(hash(SampleNamespace.TwoIn), hash(SampleNamespace.TwoOut))
self.assertNotEqual(hash(SampleNamespace.TwoIn), hash(SampleNamespace.OneIn))
def testEnumValuesInsideEnum(self):
'''Enum values should be accessible inside the enum as well as outside.'''
for value_name in (SampleNamespace.Option.__members__ if sys.pyside63_option_python_enum
else SampleNamespace.Option.values):
enum_item1 = getattr(SampleNamespace.Option, value_name)
enum_item2 = getattr(SampleNamespace, value_name)
self.assertEqual(enum_item1, enum_item2)
def testPassingIntegerOnEnumArgument(self):
'''Tries to use an integer in place of an enum argument.'''
self.assertRaises(TypeError, SampleNamespace.getNumber, 1)
def testBuildingEnumFromIntegerValue(self):
'''Tries to build the proper enum using an integer.'''
SampleNamespace.getNumber(SampleNamespace.Option(1))
def testBuildingEnumWithDefaultValue(self):
'''Enum constructor with default value'''
enum = SampleNamespace.Option()
self.assertEqual(enum, SampleNamespace.None_)
def testEnumConversionToAndFromPython(self):
'''Conversion of enum objects from Python to C++ back again.'''
enumout = SampleNamespace.enumInEnumOut(SampleNamespace.TwoIn)
self.assertTrue(enumout, SampleNamespace.TwoOut)
self.assertEqual(repr(enumout), repr(SampleNamespace.TwoOut))
def testEnumConstructorWithTooManyParameters(self):
'''Calling the constructor of non-extensible enum with the wrong number of parameters.'''
self.assertRaises(TypeError, SampleNamespace.InValue, 13, 14)
def testEnumConstructorWithNonNumberParameter(self):
'''Calling the constructor of non-extensible enum with a string.'''
self.assertRaises((TypeError, ValueError), SampleNamespace.InValue, '1')
def testEnumItemAsDefaultValueToIntArgument(self):
'''Calls function with an enum item as default value to an int argument.'''
self.assertEqual(SampleNamespace.enumItemAsDefaultValueToIntArgument(), SampleNamespace.ZeroIn)
self.assertEqual(SampleNamespace.enumItemAsDefaultValueToIntArgument(SampleNamespace.ZeroOut), SampleNamespace.ZeroOut)
self.assertEqual(SampleNamespace.enumItemAsDefaultValueToIntArgument(123), 123)
def testAnonymousGlobalEnums(self):
'''Checks availability of anonymous global enum items.'''
self.assertEqual(sample.AnonymousGlobalEnum_Value0, 0)
self.assertEqual(sample.AnonymousGlobalEnum_Value1, 1)
def testAnonymousClassEnums(self):
'''Checks availability of anonymous class enum items.'''
self.assertEqual(SampleNamespace.AnonymousClassEnum_Value0, 0)
self.assertEqual(SampleNamespace.AnonymousClassEnum_Value1, 1)
def testEnumClasses(self):
# C++ 11: values of enum classes need to be fully qualified to match C++
sum = Event.EventTypeClass.Value1 + Event.EventTypeClass.Value2
self.assertEqual(sum, 1)
def testSetEnum(self):
event = Event(Event.ANY_EVENT)
self.assertEqual(event.eventType(), Event.ANY_EVENT)
event.setEventType(Event.BASIC_EVENT)
self.assertEqual(event.eventType(), Event.BASIC_EVENT)
event.setEventTypeByConstRef(Event.SOME_EVENT)
self.assertEqual(event.eventType(), Event.SOME_EVENT)
@unittest.skipIf(sys.pyside63_option_python_enum, "test not suitable for Python enum")
def testEnumTpPrintImplementation(self):
'''Without SbkEnum.tp_print 'print' returns the enum represented as an int.'''
tmpfile = createTempFile()
print(Event.ANY_EVENT, file=tmpfile)
tmpfile.seek(0)
text = tmpfile.read().strip()
tmpfile.close()
self.assertEqual(text, str(Event.ANY_EVENT))
self.assertEqual(text, repr(Event.ANY_EVENT))
def testEnumArgumentWithDefaultValue(self):
'''Option enumArgumentWithDefaultValue(Option opt = UnixTime);'''
self.assertEqual(SampleNamespace.enumArgumentWithDefaultValue(), SampleNamespace.UnixTime)
self.assertEqual(SampleNamespace.enumArgumentWithDefaultValue(SampleNamespace.RandomNumber), SampleNamespace.RandomNumber)
@unittest.skipIf(sys.pyside63_option_python_enum, "test not suitable for Python enum")
def testSignature(self):
enum = SampleNamespace.Option(1)
types = type(enum).mro()
klass = types[0]
base = types[1]
# The class has an empty signature.
self.assertEqual(get_signature(klass), None)
# The base class must be Enum
self.assertNotEqual(get_signature(base), None)
# It contains an int annotation.
param = get_signature(base).parameters["itemValue"]
self.assertEqual(param.annotation, int)
class MyEvent(Event):
def __init__(self):
Event.__init__(self, Event.EventType(3 if sys.pyside63_option_python_enum else 999))
class OutOfBoundsTest(unittest.TestCase):
def testValue(self):
e = MyEvent()
self.assertEqual(repr(e.eventType()), "<EventType.ANY_EVENT: 3>"
if sys.pyside63_option_python_enum else 'sample.Event.EventType(999)')
@unittest.skipIf(sys.pyside63_option_python_enum, "test not suitable for Python enum")
def testNoneName(self):
e = MyEvent()
t = e.eventType()
self.assertEqual(t.name, None)
class EnumOverloadTest(unittest.TestCase):
'''Test case for overloads involving enums'''
def testWithInt(self):
'''Overload with Enums and ints with default value'''
o = ObjectType()
self.assertEqual(o.callWithEnum('', Event.ANY_EVENT, 9), 81)
self.assertEqual(o.callWithEnum('', 9), 9)
class EnumOperators(unittest.TestCase):
'''Test case for operations on enums'''
def testInequalitySameObject(self):
self.assertFalse(Event.ANY_EVENT != Event.ANY_EVENT)
if __name__ == '__main__':
unittest.main()
|
