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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
from contextlib import contextmanager
import os
import sys
import unittest
from traits.etsconfig.api import ETSConfig
from pyface.ui import ShadowedModuleFinder
class TestQt4ImportHooks(unittest.TestCase):
def test_qt4_import_no_hook(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
"pyface.ui.qt4.tests.good_package.good_import",
]):
with self._clean_meta_path():
with self.assertWarns(FutureWarning):
with self.assertRaises(ModuleNotFoundError) as cm:
import pyface.ui.qt4.tests.good_package.good_import # noqa F401
self.assertEqual(cm.exception.name, "pyface.ui.qt4.tests")
def test_qt4_import_other_package_hook(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
"pyface.ui.qt4.tests.good_package.good_import",
]):
with self._clean_meta_path():
# test with shadow module finder for different package
# (eg. another ETS package using the same code)
sys.meta_path.append(ShadowedModuleFinder(
package='foo.bar.',
true_package='foo.baz.',
))
with self.assertWarns(FutureWarning):
with self.assertRaises(ModuleNotFoundError) as cm:
import pyface.ui.qt4.tests.good_package.good_import # noqa F401
self.assertEqual(cm.exception.name, "pyface.ui.qt4.tests")
def test_qt4_import_with_hook(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
"pyface.ui.qt4.tests.good_package.good_import",
]):
with self._clean_meta_path():
sys.meta_path.append(ShadowedModuleFinder())
with self.assertWarns(DeprecationWarning):
import pyface.ui.qt4.tests.good_package.good_import # noqa F401
import pyface.ui.qt.tests.good_package.good_import
self.assertIs(
pyface.ui.qt4.tests.good_package.good_import,
pyface.ui.qt.tests.good_package.good_import,
)
self.assertIs(
pyface.ui.qt4.tests.good_package,
pyface.ui.qt.tests.good_package,
)
self.assertIs(
pyface.ui.qt4.tests,
pyface.ui.qt.tests,
)
def test_qt4_import_with_hook_no_module(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
]):
with self._clean_meta_path():
sys.meta_path.append(ShadowedModuleFinder())
with self.assertWarns(DeprecationWarning):
with self.assertRaises(ModuleNotFoundError) as cm:
import pyface.ui.qt4.tests.good_package.no_module # noqa F401
self.assertEqual(
cm.exception.name,
"pyface.ui.qt4.tests.good_package.no_module",
)
def test_qt4_import_with_hook_module_has_bad_import(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
]):
with self._clean_meta_path():
sys.meta_path.append(ShadowedModuleFinder())
with self.assertWarns(DeprecationWarning):
with self.assertRaises(ModuleNotFoundError) as cm:
import pyface.ui.qt4.tests.good_package.has_bad_import # noqa F401
self.assertEqual(cm.exception.name, "nonexistent_module")
def test_qt4_import_with_ets_qt4_imports(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
"pyface.ui.qt4.tests.good_package.good_import",
]):
with self._clean_meta_path():
with self._set_environment("ETS_QT4_IMPORTS", "1"):
with self.assertWarns(DeprecationWarning):
import pyface.ui.qt4.tests.good_package.good_import
import pyface.ui.qt.tests.good_package.good_import
self.assertIs(
pyface.ui.qt4.tests.good_package.good_import,
pyface.ui.qt.tests.good_package.good_import,
)
def test_qt4_import_with_ets_toolkit_qt4(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
"pyface.ui.qt4.tests.good_package.good_import",
]):
with self._clean_meta_path():
with self._set_environment("ETS_TOOLKIT", "qt4"):
with self.assertWarns(DeprecationWarning):
import pyface.ui.qt4.tests.good_package.good_import
import pyface.ui.qt.tests.good_package.good_import
self.assertIs(
pyface.ui.qt4.tests.good_package.good_import,
pyface.ui.qt.tests.good_package.good_import,
)
def test_qt4_import_with_ets_toolkit_qt(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
"pyface.ui.qt4.tests.good_package.good_import",
]):
with self._clean_meta_path():
with self._set_environment("ETS_TOOLKIT", "qt"):
with self.assertWarns(FutureWarning):
with self.assertRaises(ModuleNotFoundError):
import pyface.ui.qt4.tests.good_package.good_import # noqa F401
def test_qt4_import_with_etsconfig_toolkit_qt4(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
"pyface.ui.qt4.tests.good_package.good_import",
]):
with self._clean_meta_path():
with self._set_etsconfig_toolkit("qt4"):
with self.assertWarns(DeprecationWarning):
import pyface.ui.qt4.tests.good_package.good_import
import pyface.ui.qt.tests.good_package.good_import
self.assertIs(
pyface.ui.qt4.tests.good_package.good_import,
pyface.ui.qt.tests.good_package.good_import,
)
def test_qt4_import_with_etsconfig_toolkit_qt(self):
with self._unload_modules([
"pyface.ui.qt4",
"pyface.ui.qt4.tests",
"pyface.ui.qt4.tests.good_package",
"pyface.ui.qt4.tests.good_package.good_import",
]):
with self._clean_meta_path():
with self._set_etsconfig_toolkit("qt"):
with self.assertWarns(FutureWarning):
with self.assertRaises(ModuleNotFoundError):
import pyface.ui.qt4.tests.good_package.good_import # noqa F401
@contextmanager
def _clean_meta_path(self):
"""Temporarily remove ShadowedModuleFinder instances from sys.meta_path"""
old_meta_path = sys.meta_path[:]
sys.meta_path[:] = [
finder for finder in sys.meta_path
if not isinstance(finder, ShadowedModuleFinder)
]
try:
yield
finally:
sys.meta_path[:] = old_meta_path
@contextmanager
def _unload_modules(self, names):
"""Temporarily remove listed modules from sys.modules"""
old_modules = {
name: sys.modules.pop(name, None)
for name in names
}
try:
yield
finally:
for name, old_module in old_modules.items():
if old_module:
sys.modules[name] = old_module
else:
sys.modules.pop(name, None)
@contextmanager
def _set_environment(self, name, value):
"""Temporarily set an environment variable to a value"""
old_value = os.environ.get(name, None)
os.environ[name] = value
try:
yield
finally:
if old_value is None:
del os.environ[name]
else:
os.environ[name] = old_value
@contextmanager
def _set_etsconfig_toolkit(self, value):
"""Temporarily set ETSConfig.toolkit to a value"""
old_value = ETSConfig._toolkit
ETSConfig._toolkit = value
try:
yield
finally:
ETSConfig._toolkit = old_value
|
