Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 1 | # Test packages (dotted-name import) |
| 2 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 3 | import sys |
| 4 | import os |
| 5 | import tempfile |
| 6 | import textwrap |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 7 | import unittest |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 8 | from test import support |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 9 | |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 10 | |
| 11 | # Helpers to create and destroy hierarchies. |
| 12 | |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 13 | def cleanout(root): |
| 14 | names = os.listdir(root) |
| 15 | for name in names: |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 16 | fullname = os.path.join(root, name) |
| 17 | if os.path.isdir(fullname) and not os.path.islink(fullname): |
| 18 | cleanout(fullname) |
| 19 | else: |
| 20 | os.remove(fullname) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 21 | os.rmdir(root) |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 22 | |
Barry Warsaw | 3a9d061 | 2000-09-01 06:53:52 +0000 | [diff] [blame] | 23 | def fixdir(lst): |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 24 | if "__builtins__" in lst: |
| 25 | lst.remove("__builtins__") |
Antoine Pitrou | ea3eb88 | 2012-05-17 18:55:59 +0200 | [diff] [blame] | 26 | if "__initializing__" in lst: |
| 27 | lst.remove("__initializing__") |
Barry Warsaw | 3a9d061 | 2000-09-01 06:53:52 +0000 | [diff] [blame] | 28 | return lst |
| 29 | |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 30 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 31 | # XXX Things to test |
| 32 | # |
| 33 | # import package without __init__ |
| 34 | # import package with __init__ |
| 35 | # __init__ importing submodule |
| 36 | # __init__ importing global module |
| 37 | # __init__ defining variables |
| 38 | # submodule importing other submodule |
| 39 | # submodule importing global module |
| 40 | # submodule import submodule via global name |
| 41 | # from package import submodule |
| 42 | # from package import subpackage |
| 43 | # from package import variable (defined in __init__) |
| 44 | # from package import * (defined in __init__) |
| 45 | |
| 46 | |
Christian Heimes | db4a2ef | 2007-11-12 19:53:03 +0000 | [diff] [blame] | 47 | class TestPkg(unittest.TestCase): |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 48 | |
| 49 | def setUp(self): |
| 50 | self.root = None |
Christian Heimes | dae2a89 | 2008-04-19 00:55:37 +0000 | [diff] [blame] | 51 | self.pkgname = None |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 52 | self.syspath = list(sys.path) |
Antoine Pitrou | 060cee2 | 2009-11-13 16:29:04 +0000 | [diff] [blame] | 53 | self.modules_before = support.modules_setup() |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 54 | |
| 55 | def tearDown(self): |
| 56 | sys.path[:] = self.syspath |
Antoine Pitrou | 060cee2 | 2009-11-13 16:29:04 +0000 | [diff] [blame] | 57 | support.modules_cleanup(*self.modules_before) |
R. David Murray | 378c0cf | 2010-02-24 01:46:21 +0000 | [diff] [blame] | 58 | if self.root: # Only clean if the test was actually run |
| 59 | cleanout(self.root) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 60 | |
Ezio Melotti | 1392500 | 2011-03-16 11:05:33 +0200 | [diff] [blame] | 61 | # delete all modules concerning the tested hierarchy |
Christian Heimes | dae2a89 | 2008-04-19 00:55:37 +0000 | [diff] [blame] | 62 | if self.pkgname: |
| 63 | modules = [name for name in sys.modules |
| 64 | if self.pkgname in name.split('.')] |
| 65 | for name in modules: |
| 66 | del sys.modules[name] |
| 67 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 68 | def run_code(self, code): |
| 69 | exec(textwrap.dedent(code), globals(), {"self": self}) |
| 70 | |
| 71 | def mkhier(self, descr): |
| 72 | root = tempfile.mkdtemp() |
Guido van Rossum | 41360a4 | 1998-03-26 19:42:58 +0000 | [diff] [blame] | 73 | sys.path.insert(0, root) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 74 | if not os.path.isdir(root): |
| 75 | os.mkdir(root) |
| 76 | for name, contents in descr: |
| 77 | comps = name.split() |
| 78 | fullname = root |
| 79 | for c in comps: |
| 80 | fullname = os.path.join(fullname, c) |
| 81 | if contents is None: |
| 82 | os.mkdir(fullname) |
| 83 | else: |
| 84 | f = open(fullname, "w") |
| 85 | f.write(contents) |
| 86 | if contents and contents[-1] != '\n': |
| 87 | f.write('\n') |
| 88 | f.close() |
| 89 | self.root = root |
Christian Heimes | dae2a89 | 2008-04-19 00:55:37 +0000 | [diff] [blame] | 90 | # package name is the name of the first item |
| 91 | self.pkgname = descr[0][0] |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 92 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 93 | def test_1(self): |
| 94 | hier = [("t1", None), ("t1 __init__.py", "")] |
| 95 | self.mkhier(hier) |
| 96 | import t1 |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 97 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 98 | def test_2(self): |
| 99 | hier = [ |
| 100 | ("t2", None), |
| 101 | ("t2 __init__.py", "'doc for t2'"), |
| 102 | ("t2 sub", None), |
| 103 | ("t2 sub __init__.py", ""), |
| 104 | ("t2 sub subsub", None), |
| 105 | ("t2 sub subsub __init__.py", "spam = 1"), |
| 106 | ] |
| 107 | self.mkhier(hier) |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 108 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 109 | import t2.sub |
| 110 | import t2.sub.subsub |
| 111 | self.assertEqual(t2.__name__, "t2") |
| 112 | self.assertEqual(t2.sub.__name__, "t2.sub") |
| 113 | self.assertEqual(t2.sub.subsub.__name__, "t2.sub.subsub") |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 114 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 115 | # This exec crap is needed because Py3k forbids 'import *' outside |
| 116 | # of module-scope and __import__() is insufficient for what we need. |
| 117 | s = """ |
| 118 | import t2 |
| 119 | from t2 import * |
| 120 | self.assertEqual(dir(), ['self', 'sub', 't2']) |
| 121 | """ |
| 122 | self.run_code(s) |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 123 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 124 | from t2 import sub |
| 125 | from t2.sub import subsub |
| 126 | from t2.sub.subsub import spam |
| 127 | self.assertEqual(sub.__name__, "t2.sub") |
| 128 | self.assertEqual(subsub.__name__, "t2.sub.subsub") |
| 129 | self.assertEqual(sub.subsub.__name__, "t2.sub.subsub") |
| 130 | for name in ['spam', 'sub', 'subsub', 't2']: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 131 | self.assertTrue(locals()["name"], "Failed to import %s" % name) |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 132 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 133 | import t2.sub |
| 134 | import t2.sub.subsub |
| 135 | self.assertEqual(t2.__name__, "t2") |
| 136 | self.assertEqual(t2.sub.__name__, "t2.sub") |
| 137 | self.assertEqual(t2.sub.subsub.__name__, "t2.sub.subsub") |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 138 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 139 | s = """ |
| 140 | from t2 import * |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 141 | self.assertTrue(dir(), ['self', 'sub']) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 142 | """ |
| 143 | self.run_code(s) |
Guido van Rossum | c8bf884 | 1997-09-08 16:06:20 +0000 | [diff] [blame] | 144 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 145 | def test_3(self): |
| 146 | hier = [ |
| 147 | ("t3", None), |
| 148 | ("t3 __init__.py", ""), |
| 149 | ("t3 sub", None), |
| 150 | ("t3 sub __init__.py", ""), |
| 151 | ("t3 sub subsub", None), |
| 152 | ("t3 sub subsub __init__.py", "spam = 1"), |
| 153 | ] |
| 154 | self.mkhier(hier) |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 155 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 156 | import t3.sub.subsub |
| 157 | self.assertEqual(t3.__name__, "t3") |
| 158 | self.assertEqual(t3.sub.__name__, "t3.sub") |
| 159 | self.assertEqual(t3.sub.subsub.__name__, "t3.sub.subsub") |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 160 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 161 | def test_4(self): |
| 162 | hier = [ |
| 163 | ("t4.py", "raise RuntimeError('Shouldnt load t4.py')"), |
| 164 | ("t4", None), |
| 165 | ("t4 __init__.py", ""), |
| 166 | ("t4 sub.py", "raise RuntimeError('Shouldnt load sub.py')"), |
| 167 | ("t4 sub", None), |
| 168 | ("t4 sub __init__.py", ""), |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 169 | ("t4 sub subsub.py", |
| 170 | "raise RuntimeError('Shouldnt load subsub.py')"), |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 171 | ("t4 sub subsub", None), |
| 172 | ("t4 sub subsub __init__.py", "spam = 1"), |
| 173 | ] |
| 174 | self.mkhier(hier) |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 175 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 176 | s = """ |
| 177 | from t4.sub.subsub import * |
| 178 | self.assertEqual(spam, 1) |
| 179 | """ |
| 180 | self.run_code(s) |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 181 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 182 | def test_5(self): |
| 183 | hier = [ |
| 184 | ("t5", None), |
| 185 | ("t5 __init__.py", "import t5.foo"), |
| 186 | ("t5 string.py", "spam = 1"), |
| 187 | ("t5 foo.py", |
| 188 | "from . import string; assert string.spam == 1"), |
| 189 | ] |
| 190 | self.mkhier(hier) |
Guido van Rossum | 6c61242 | 1997-09-06 18:42:57 +0000 | [diff] [blame] | 191 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 192 | import t5 |
| 193 | s = """ |
| 194 | from t5 import * |
| 195 | self.assertEqual(dir(), ['foo', 'self', 'string', 't5']) |
| 196 | """ |
| 197 | self.run_code(s) |
Guido van Rossum | 10887a3 | 1997-09-07 06:12:11 +0000 | [diff] [blame] | 198 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 199 | import t5 |
| 200 | self.assertEqual(fixdir(dir(t5)), |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 201 | ['__cached__', '__doc__', '__file__', '__loader__', |
| 202 | '__name__', '__package__', '__path__', 'foo', |
| 203 | 'string', 't5']) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 204 | self.assertEqual(fixdir(dir(t5.foo)), |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 205 | ['__cached__', '__doc__', '__file__', '__loader__', |
| 206 | '__name__', '__package__', 'string']) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 207 | self.assertEqual(fixdir(dir(t5.string)), |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 208 | ['__cached__', '__doc__', '__file__', '__loader__', |
| 209 | '__name__', '__package__', 'spam']) |
Guido van Rossum | 5f4fb91 | 1998-05-19 15:09:42 +0000 | [diff] [blame] | 210 | |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 211 | def test_6(self): |
| 212 | hier = [ |
| 213 | ("t6", None), |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 214 | ("t6 __init__.py", |
| 215 | "__all__ = ['spam', 'ham', 'eggs']"), |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 216 | ("t6 spam.py", ""), |
| 217 | ("t6 ham.py", ""), |
| 218 | ("t6 eggs.py", ""), |
| 219 | ] |
| 220 | self.mkhier(hier) |
| 221 | |
| 222 | import t6 |
| 223 | self.assertEqual(fixdir(dir(t6)), |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 224 | ['__all__', '__cached__', '__doc__', '__file__', |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 225 | '__loader__', '__name__', '__package__', '__path__']) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 226 | s = """ |
| 227 | import t6 |
| 228 | from t6 import * |
| 229 | self.assertEqual(fixdir(dir(t6)), |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 230 | ['__all__', '__cached__', '__doc__', '__file__', |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 231 | '__loader__', '__name__', '__package__', |
| 232 | '__path__', 'eggs', 'ham', 'spam']) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 233 | self.assertEqual(dir(), ['eggs', 'ham', 'self', 'spam', 't6']) |
| 234 | """ |
| 235 | self.run_code(s) |
| 236 | |
| 237 | def test_7(self): |
| 238 | hier = [ |
| 239 | ("t7.py", ""), |
| 240 | ("t7", None), |
| 241 | ("t7 __init__.py", ""), |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 242 | ("t7 sub.py", |
| 243 | "raise RuntimeError('Shouldnt load sub.py')"), |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 244 | ("t7 sub", None), |
| 245 | ("t7 sub __init__.py", ""), |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 246 | ("t7 sub .py", |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 247 | "raise RuntimeError('Shouldnt load subsub.py')"), |
| 248 | ("t7 sub subsub", None), |
| 249 | ("t7 sub subsub __init__.py", |
| 250 | "spam = 1"), |
| 251 | ] |
| 252 | self.mkhier(hier) |
| 253 | |
| 254 | |
| 255 | t7, sub, subsub = None, None, None |
| 256 | import t7 as tas |
| 257 | self.assertEqual(fixdir(dir(tas)), |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 258 | ['__cached__', '__doc__', '__file__', '__loader__', |
| 259 | '__name__', '__package__', '__path__']) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 260 | self.assertFalse(t7) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 261 | from t7 import sub as subpar |
| 262 | self.assertEqual(fixdir(dir(subpar)), |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 263 | ['__cached__', '__doc__', '__file__', '__loader__', |
| 264 | '__name__', '__package__', '__path__']) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 265 | self.assertFalse(t7) |
| 266 | self.assertFalse(sub) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 267 | from t7.sub import subsub as subsubsub |
| 268 | self.assertEqual(fixdir(dir(subsubsub)), |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 269 | ['__cached__', '__doc__', '__file__', '__loader__', |
| 270 | '__name__', '__package__', '__path__', 'spam']) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 271 | self.assertFalse(t7) |
| 272 | self.assertFalse(sub) |
| 273 | self.assertFalse(subsub) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 274 | from t7.sub.subsub import spam as ham |
| 275 | self.assertEqual(ham, 1) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 276 | self.assertFalse(t7) |
| 277 | self.assertFalse(sub) |
| 278 | self.assertFalse(subsub) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 279 | |
R. David Murray | 378c0cf | 2010-02-24 01:46:21 +0000 | [diff] [blame] | 280 | @unittest.skipIf(sys.flags.optimize >= 2, |
| 281 | "Docstrings are omitted with -O2 and above") |
| 282 | def test_8(self): |
| 283 | hier = [ |
| 284 | ("t8", None), |
| 285 | ("t8 __init__"+os.extsep+"py", "'doc for t8'"), |
| 286 | ] |
| 287 | self.mkhier(hier) |
| 288 | |
| 289 | import t8 |
| 290 | self.assertEqual(t8.__doc__, "doc for t8") |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 291 | |
| 292 | def test_main(): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 293 | support.run_unittest(__name__) |
Collin Winter | 11e065b | 2007-08-24 19:15:12 +0000 | [diff] [blame] | 294 | |
| 295 | |
| 296 | if __name__ == "__main__": |
| 297 | test_main() |