blob: fa74e7770ede292f0209516252a56cb28f997804 [file] [log] [blame]
Brett Cannon0096e262004-06-05 01:12:51 +00001"""Tests for 'site'.
2
3Tests assume the initial paths in sys.path once the interpreter has begun
4executing have not been removed.
5
6"""
7import unittest
Senthil Kumaran8ef519b2013-09-07 13:59:17 -07008import test.support
Victor Stinnerf2f45552018-12-05 16:49:35 +01009from test import support
Hai Shi79bb2c92020-08-06 19:51:29 +080010from test.support import os_helper
Serhiy Storchakabfb1cf42020-04-29 10:36:20 +030011from test.support import socket_helper
Hai Shic7decc22020-08-04 23:53:12 +080012from test.support import captured_stderr
13from test.support.os_helper import TESTFN, EnvironmentVarGuard, change_cwd
Georg Brandl1a3284e2007-12-02 09:40:06 +000014import builtins
Brett Cannon0096e262004-06-05 01:12:51 +000015import encodings
Victor Stinnerd18de462020-03-18 18:27:32 +010016import glob
native-api2145c8c2020-06-12 09:20:11 +030017import io
Victor Stinnerd18de462020-03-18 18:27:32 +010018import os
19import re
Steve Dower1da055e2016-10-29 08:50:31 -070020import shutil
Christian Heimes8dc226f2008-05-06 23:45:46 +000021import subprocess
Victor Stinnerd18de462020-03-18 18:27:32 +010022import sys
Tarek Ziadéedacea32010-01-29 11:41:03 +000023import sysconfig
Zachary Wared48214f2017-05-14 15:49:46 -050024import tempfile
Victor Stinnerd18de462020-03-18 18:27:32 +010025import urllib.error
26import urllib.request
Victor Stinnerf2f45552018-12-05 16:49:35 +010027from unittest import mock
Tarek Ziadéedacea32010-01-29 11:41:03 +000028from copy import copy
29
Zachary Ware36193e72013-12-11 16:59:44 -060030# These tests are not particularly useful if Python was invoked with -S.
31# If you add tests that are useful under -S, this skip should be moved
32# to the class level.
33if sys.flags.no_site:
34 raise unittest.SkipTest("Python was invoked with -S")
35
36import site
Brett Cannon0096e262004-06-05 01:12:51 +000037
Victor Stinnerb85c1362017-04-20 13:39:39 +020038
pxinwrab74c012020-12-21 06:27:42 +080039HAS_USER_SITE = (site.USER_SITE is not None)
Victor Stinnerb85c1362017-04-20 13:39:39 +020040OLD_SYS_PATH = None
41
42
43def setUpModule():
44 global OLD_SYS_PATH
45 OLD_SYS_PATH = sys.path[:]
46
47 if site.ENABLE_USER_SITE and not os.path.isdir(site.USER_SITE):
48 # need to add user site directory for tests
49 try:
50 os.makedirs(site.USER_SITE)
51 # modify sys.path: will be restored by tearDownModule()
52 site.addsitedir(site.USER_SITE)
53 except PermissionError as exc:
54 raise unittest.SkipTest('unable to create user site directory (%r): %s'
55 % (site.USER_SITE, exc))
56
57
58def tearDownModule():
59 sys.path[:] = OLD_SYS_PATH
Victor Stinner21d0e1b2016-03-14 17:47:03 +010060
Christian Heimes8dc226f2008-05-06 23:45:46 +000061
Brett Cannon0096e262004-06-05 01:12:51 +000062class HelperFunctionsTests(unittest.TestCase):
63 """Tests for helper functions.
Brett Cannon0096e262004-06-05 01:12:51 +000064 """
65
66 def setUp(self):
67 """Save a copy of sys.path"""
68 self.sys_path = sys.path[:]
Tarek Ziadé4a608c02009-08-20 21:28:05 +000069 self.old_base = site.USER_BASE
70 self.old_site = site.USER_SITE
71 self.old_prefixes = site.PREFIXES
Brett Cannon8ac95ee2012-04-04 17:31:16 -040072 self.original_vars = sysconfig._CONFIG_VARS
Tarek Ziadéedacea32010-01-29 11:41:03 +000073 self.old_vars = copy(sysconfig._CONFIG_VARS)
Brett Cannon0096e262004-06-05 01:12:51 +000074
Alexandre Vassalottie9f305f2008-05-16 04:39:54 +000075 def tearDown(self):
Brett Cannon0096e262004-06-05 01:12:51 +000076 """Restore sys.path"""
Nick Coghlan6ead5522009-10-18 13:19:33 +000077 sys.path[:] = self.sys_path
Tarek Ziadé4a608c02009-08-20 21:28:05 +000078 site.USER_BASE = self.old_base
79 site.USER_SITE = self.old_site
80 site.PREFIXES = self.old_prefixes
Brett Cannon8ac95ee2012-04-04 17:31:16 -040081 sysconfig._CONFIG_VARS = self.original_vars
Miss Islington (bot)43897112021-05-20 03:42:00 -070082 # _CONFIG_VARS is None before get_config_vars() is called
83 if sysconfig._CONFIG_VARS is not None:
84 sysconfig._CONFIG_VARS.clear()
85 sysconfig._CONFIG_VARS.update(self.old_vars)
Raymond Hettingerebd95222004-06-27 03:02:18 +000086
Brett Cannon0096e262004-06-05 01:12:51 +000087 def test_makepath(self):
88 # Test makepath() have an absolute path for its first return value
89 # and a case-normalized version of the absolute path for its
90 # second value.
91 path_parts = ("Beginning", "End")
92 original_dir = os.path.join(*path_parts)
93 abs_dir, norm_dir = site.makepath(*path_parts)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000094 self.assertEqual(os.path.abspath(original_dir), abs_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000095 if original_dir == os.path.normcase(original_dir):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000096 self.assertEqual(abs_dir, norm_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000097 else:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000098 self.assertEqual(os.path.normcase(abs_dir), norm_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000099
100 def test_init_pathinfo(self):
101 dir_set = site._init_pathinfo()
102 for entry in [site.makepath(path)[1] for path in sys.path
Brett Cannon5f0507d2016-04-08 15:04:28 -0700103 if path and os.path.exists(path)]:
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000104 self.assertIn(entry, dir_set,
105 "%s from sys.path not found in set returned "
106 "by _init_pathinfo(): %s" % (entry, dir_set))
Raymond Hettingerebd95222004-06-27 03:02:18 +0000107
Brett Cannonee86a662004-07-13 07:12:25 +0000108 def pth_file_tests(self, pth_file):
109 """Contain common code for testing results of reading a .pth file"""
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000110 self.assertIn(pth_file.imported, sys.modules,
111 "%s not in sys.modules" % pth_file.imported)
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000112 self.assertIn(site.makepath(pth_file.good_dir_path)[0], sys.path)
113 self.assertFalse(os.path.exists(pth_file.bad_dir_path))
Brett Cannonee86a662004-07-13 07:12:25 +0000114
Brett Cannon0096e262004-06-05 01:12:51 +0000115 def test_addpackage(self):
116 # Make sure addpackage() imports if the line starts with 'import',
Brett Cannon64a84702004-07-10 02:10:45 +0000117 # adds directories to sys.path for any line in the file that is not a
118 # comment or import that is a valid directory name for where the .pth
119 # file resides; invalid directories are not added
120 pth_file = PthFile()
Brett Cannonee86a662004-07-13 07:12:25 +0000121 pth_file.cleanup(prep=True) # to make sure that nothing is
122 # pre-existing that shouldn't be
Brett Cannon0096e262004-06-05 01:12:51 +0000123 try:
Brett Cannon64a84702004-07-10 02:10:45 +0000124 pth_file.create()
125 site.addpackage(pth_file.base_dir, pth_file.filename, set())
Brett Cannonee86a662004-07-13 07:12:25 +0000126 self.pth_file_tests(pth_file)
Brett Cannon0096e262004-06-05 01:12:51 +0000127 finally:
Brett Cannon64a84702004-07-10 02:10:45 +0000128 pth_file.cleanup()
Raymond Hettingerebd95222004-06-27 03:02:18 +0000129
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000130 def make_pth(self, contents, pth_dir='.', pth_name=TESTFN):
131 # Create a .pth file and return its (abspath, basename).
132 pth_dir = os.path.abspath(pth_dir)
133 pth_basename = pth_name + '.pth'
134 pth_fn = os.path.join(pth_dir, pth_basename)
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200135 with open(pth_fn, 'w', encoding='utf-8') as pth_file:
136 self.addCleanup(lambda: os.remove(pth_fn))
137 pth_file.write(contents)
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000138 return pth_dir, pth_basename
139
140 def test_addpackage_import_bad_syntax(self):
141 # Issue 10642
Serhiy Storchaka94cf3082018-12-17 17:34:14 +0200142 pth_dir, pth_fn = self.make_pth("import bad-syntax\n")
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000143 with captured_stderr() as err_out:
144 site.addpackage(pth_dir, pth_fn, set())
145 self.assertRegex(err_out.getvalue(), "line 1")
R. David Murrayab9d8d62010-12-27 00:03:13 +0000146 self.assertRegex(err_out.getvalue(),
147 re.escape(os.path.join(pth_dir, pth_fn)))
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000148 # XXX: the previous two should be independent checks so that the
149 # order doesn't matter. The next three could be a single check
150 # but my regex foo isn't good enough to write it.
151 self.assertRegex(err_out.getvalue(), 'Traceback')
Serhiy Storchaka94cf3082018-12-17 17:34:14 +0200152 self.assertRegex(err_out.getvalue(), r'import bad-syntax')
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000153 self.assertRegex(err_out.getvalue(), 'SyntaxError')
154
155 def test_addpackage_import_bad_exec(self):
156 # Issue 10642
157 pth_dir, pth_fn = self.make_pth("randompath\nimport nosuchmodule\n")
158 with captured_stderr() as err_out:
159 site.addpackage(pth_dir, pth_fn, set())
160 self.assertRegex(err_out.getvalue(), "line 2")
R. David Murrayab9d8d62010-12-27 00:03:13 +0000161 self.assertRegex(err_out.getvalue(),
162 re.escape(os.path.join(pth_dir, pth_fn)))
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000163 # XXX: ditto previous XXX comment.
164 self.assertRegex(err_out.getvalue(), 'Traceback')
Eric Snow46f97b82016-09-07 16:56:15 -0700165 self.assertRegex(err_out.getvalue(), 'ModuleNotFoundError')
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000166
idomic0c71a662020-09-19 15:13:29 -0400167 def test_addpackage_empty_lines(self):
168 # Issue 33689
169 pth_dir, pth_fn = self.make_pth("\n\n \n\n")
170 known_paths = site.addpackage(pth_dir, pth_fn, set())
171 self.assertEqual(known_paths, set())
172
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000173 def test_addpackage_import_bad_pth_file(self):
174 # Issue 5258
175 pth_dir, pth_fn = self.make_pth("abc\x00def\n")
176 with captured_stderr() as err_out:
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300177 self.assertFalse(site.addpackage(pth_dir, pth_fn, set()))
Steve Dower04732ca2021-04-07 01:02:07 +0100178 self.maxDiff = None
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300179 self.assertEqual(err_out.getvalue(), "")
180 for path in sys.path:
181 if isinstance(path, str):
182 self.assertNotIn("abc\x00def", path)
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000183
Brett Cannon0096e262004-06-05 01:12:51 +0000184 def test_addsitedir(self):
Brett Cannon64a84702004-07-10 02:10:45 +0000185 # Same tests for test_addpackage since addsitedir() essentially just
186 # calls addpackage() for every .pth file in the directory
187 pth_file = PthFile()
Brett Cannonee86a662004-07-13 07:12:25 +0000188 pth_file.cleanup(prep=True) # Make sure that nothing is pre-existing
189 # that is tested for
Brett Cannon0096e262004-06-05 01:12:51 +0000190 try:
Brett Cannonee86a662004-07-13 07:12:25 +0000191 pth_file.create()
Brett Cannon64a84702004-07-10 02:10:45 +0000192 site.addsitedir(pth_file.base_dir, set())
Brett Cannonee86a662004-07-13 07:12:25 +0000193 self.pth_file_tests(pth_file)
Brett Cannon0096e262004-06-05 01:12:51 +0000194 finally:
Brett Cannon64a84702004-07-10 02:10:45 +0000195 pth_file.cleanup()
Brett Cannon0096e262004-06-05 01:12:51 +0000196
native-api45d8d242019-03-03 19:05:19 +0300197 # This tests _getuserbase, hence the double underline
198 # to distinguish from a test for getuserbase
199 def test__getuserbase(self):
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900200 self.assertEqual(site._getuserbase(), sysconfig._getuserbase())
201
pxinwrab74c012020-12-21 06:27:42 +0800202 @unittest.skipUnless(HAS_USER_SITE, 'need user site')
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900203 def test_get_path(self):
INADA Naokiba9ddb72017-07-28 21:28:19 +0900204 if sys.platform == 'darwin' and sys._framework:
205 scheme = 'osx_framework_user'
206 else:
207 scheme = os.name + '_user'
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900208 self.assertEqual(site._get_path(site._getuserbase()),
INADA Naokiba9ddb72017-07-28 21:28:19 +0900209 sysconfig.get_path('purelib', scheme))
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900210
Ned Deily316f5732011-10-31 16:16:35 -0700211 @unittest.skipUnless(site.ENABLE_USER_SITE, "requires access to PEP 370 "
212 "user-site (site.ENABLE_USER_SITE)")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000213 def test_s_option(self):
Eric Snow6b4be192017-05-22 21:36:03 -0700214 # (ncoghlan) Change this to use script_helper...
Christian Heimes8dc226f2008-05-06 23:45:46 +0000215 usersite = site.USER_SITE
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000216 self.assertIn(usersite, sys.path)
Christian Heimes8dc226f2008-05-06 23:45:46 +0000217
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000218 env = os.environ.copy()
Christian Heimes8dc226f2008-05-06 23:45:46 +0000219 rc = subprocess.call([sys.executable, '-c',
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000220 'import sys; sys.exit(%r in sys.path)' % usersite],
221 env=env)
Christian Heimes8dc226f2008-05-06 23:45:46 +0000222 self.assertEqual(rc, 1)
223
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000224 env = os.environ.copy()
Christian Heimes8dc226f2008-05-06 23:45:46 +0000225 rc = subprocess.call([sys.executable, '-s', '-c',
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000226 'import sys; sys.exit(%r in sys.path)' % usersite],
227 env=env)
Antoine Pitroua1782e12013-10-23 22:03:22 +0200228 if usersite == site.getsitepackages()[0]:
229 self.assertEqual(rc, 1)
230 else:
Eric Snow6b4be192017-05-22 21:36:03 -0700231 self.assertEqual(rc, 0, "User site still added to path with -s")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000232
233 env = os.environ.copy()
234 env["PYTHONNOUSERSITE"] = "1"
235 rc = subprocess.call([sys.executable, '-c',
Benjamin Petersonfea6a942008-07-02 16:11:42 +0000236 'import sys; sys.exit(%r in sys.path)' % usersite],
Christian Heimes8dc226f2008-05-06 23:45:46 +0000237 env=env)
Antoine Pitroua1782e12013-10-23 22:03:22 +0200238 if usersite == site.getsitepackages()[0]:
239 self.assertEqual(rc, 1)
240 else:
Eric Snow6b4be192017-05-22 21:36:03 -0700241 self.assertEqual(rc, 0,
242 "User site still added to path with PYTHONNOUSERSITE")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000243
244 env = os.environ.copy()
245 env["PYTHONUSERBASE"] = "/tmp"
246 rc = subprocess.call([sys.executable, '-c',
247 'import sys, site; sys.exit(site.USER_BASE.startswith("/tmp"))'],
248 env=env)
Eric Snow6b4be192017-05-22 21:36:03 -0700249 self.assertEqual(rc, 1,
250 "User base not set by PYTHONUSERBASE")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000251
pxinwrab74c012020-12-21 06:27:42 +0800252 @unittest.skipUnless(HAS_USER_SITE, 'need user site')
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000253 def test_getuserbase(self):
254 site.USER_BASE = None
255 user_base = site.getuserbase()
256
257 # the call sets site.USER_BASE
Ezio Melottib3aedd42010-11-20 19:04:17 +0000258 self.assertEqual(site.USER_BASE, user_base)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000259
260 # let's set PYTHONUSERBASE and see if it uses it
261 site.USER_BASE = None
Tarek Ziadéedacea32010-01-29 11:41:03 +0000262 import sysconfig
263 sysconfig._CONFIG_VARS = None
264
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000265 with EnvironmentVarGuard() as environ:
266 environ['PYTHONUSERBASE'] = 'xoxo'
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000267 self.assertTrue(site.getuserbase().startswith('xoxo'),
268 site.getuserbase())
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000269
pxinwrab74c012020-12-21 06:27:42 +0800270 @unittest.skipUnless(HAS_USER_SITE, 'need user site')
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000271 def test_getusersitepackages(self):
272 site.USER_SITE = None
273 site.USER_BASE = None
274 user_site = site.getusersitepackages()
275
276 # the call sets USER_BASE *and* USER_SITE
Ezio Melottib3aedd42010-11-20 19:04:17 +0000277 self.assertEqual(site.USER_SITE, user_site)
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000278 self.assertTrue(user_site.startswith(site.USER_BASE), user_site)
Victor Stinnerf2f45552018-12-05 16:49:35 +0100279 self.assertEqual(site.USER_BASE, site.getuserbase())
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000280
281 def test_getsitepackages(self):
282 site.PREFIXES = ['xoxo']
283 dirs = site.getsitepackages()
Ned Deily763f0942018-01-30 05:14:09 -0500284 if os.sep == '/':
285 # OS X, Linux, FreeBSD, etc
Victor Stinner8510f432020-03-10 09:53:09 +0100286 if sys.platlibdir != "lib":
287 self.assertEqual(len(dirs), 2)
288 wanted = os.path.join('xoxo', sys.platlibdir,
289 'python%d.%d' % sys.version_info[:2],
290 'site-packages')
291 self.assertEqual(dirs[0], wanted)
292 else:
293 self.assertEqual(len(dirs), 1)
Serhiy Storchaka885bdc42016-02-11 13:10:36 +0200294 wanted = os.path.join('xoxo', 'lib',
295 'python%d.%d' % sys.version_info[:2],
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000296 'site-packages')
Victor Stinner8510f432020-03-10 09:53:09 +0100297 self.assertEqual(dirs[-1], wanted)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000298 else:
Ned Deilyd531b292012-02-06 00:58:18 +0100299 # other platforms
Ezio Melottifc8b2052010-08-17 08:35:41 +0000300 self.assertEqual(len(dirs), 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000301 self.assertEqual(dirs[0], 'xoxo')
Tarek Ziadé8c0e2172009-10-27 21:24:21 +0000302 wanted = os.path.join('xoxo', 'lib', 'site-packages')
Ezio Melottib3aedd42010-11-20 19:04:17 +0000303 self.assertEqual(dirs[1], wanted)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000304
pxinwrab74c012020-12-21 06:27:42 +0800305 @unittest.skipUnless(HAS_USER_SITE, 'need user site')
Victor Stinnerf2f45552018-12-05 16:49:35 +0100306 def test_no_home_directory(self):
307 # bpo-10496: getuserbase() and getusersitepackages() must not fail if
308 # the current user has no home directory (if expanduser() returns the
309 # path unchanged).
310 site.USER_SITE = None
311 site.USER_BASE = None
312
313 with EnvironmentVarGuard() as environ, \
314 mock.patch('os.path.expanduser', lambda path: path):
315
316 del environ['PYTHONUSERBASE']
317 del environ['APPDATA']
318
319 user_base = site.getuserbase()
320 self.assertTrue(user_base.startswith('~' + os.sep),
321 user_base)
322
323 user_site = site.getusersitepackages()
324 self.assertTrue(user_site.startswith(user_base), user_site)
325
326 with mock.patch('os.path.isdir', return_value=False) as mock_isdir, \
327 mock.patch.object(site, 'addsitedir') as mock_addsitedir, \
328 support.swap_attr(site, 'ENABLE_USER_SITE', True):
329
330 # addusersitepackages() must not add user_site to sys.path
331 # if it is not an existing directory
332 known_paths = set()
333 site.addusersitepackages(known_paths)
334
335 mock_isdir.assert_called_once_with(user_site)
336 mock_addsitedir.assert_not_called()
337 self.assertFalse(known_paths)
338
native-api2145c8c2020-06-12 09:20:11 +0300339 def test_trace(self):
340 message = "bla-bla-bla"
341 for verbose, out in (True, message + "\n"), (False, ""):
342 with mock.patch('sys.flags', mock.Mock(verbose=verbose)), \
343 mock.patch('sys.stderr', io.StringIO()):
344 site._trace(message)
345 self.assertEqual(sys.stderr.getvalue(), out)
346
Victor Stinnerf2f45552018-12-05 16:49:35 +0100347
Brett Cannon64a84702004-07-10 02:10:45 +0000348class PthFile(object):
349 """Helper class for handling testing of .pth files"""
Brett Cannon0096e262004-06-05 01:12:51 +0000350
Brett Cannon64a84702004-07-10 02:10:45 +0000351 def __init__(self, filename_base=TESTFN, imported="time",
352 good_dirname="__testdir__", bad_dirname="__bad"):
353 """Initialize instance variables"""
354 self.filename = filename_base + ".pth"
355 self.base_dir = os.path.abspath('')
356 self.file_path = os.path.join(self.base_dir, self.filename)
Brett Cannonee86a662004-07-13 07:12:25 +0000357 self.imported = imported
Brett Cannon64a84702004-07-10 02:10:45 +0000358 self.good_dirname = good_dirname
359 self.bad_dirname = bad_dirname
360 self.good_dir_path = os.path.join(self.base_dir, self.good_dirname)
361 self.bad_dir_path = os.path.join(self.base_dir, self.bad_dirname)
Brett Cannon0096e262004-06-05 01:12:51 +0000362
Brett Cannon64a84702004-07-10 02:10:45 +0000363 def create(self):
364 """Create a .pth file with a comment, blank lines, an ``import
365 <self.imported>``, a line with self.good_dirname, and a line with
366 self.bad_dirname.
Tim Peters182b5ac2004-07-18 06:16:08 +0000367
Brett Cannon64a84702004-07-10 02:10:45 +0000368 Creation of the directory for self.good_dir_path (based off of
369 self.good_dirname) is also performed.
Brett Cannon0096e262004-06-05 01:12:51 +0000370
Brett Cannon64a84702004-07-10 02:10:45 +0000371 Make sure to call self.cleanup() to undo anything done by this method.
Tim Peters182b5ac2004-07-18 06:16:08 +0000372
Brett Cannon64a84702004-07-10 02:10:45 +0000373 """
Michael W. Hudsonff522862005-05-27 14:58:06 +0000374 FILE = open(self.file_path, 'w')
Brett Cannon64a84702004-07-10 02:10:45 +0000375 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000376 print("#import @bad module name", file=FILE)
377 print("\n", file=FILE)
378 print("import %s" % self.imported, file=FILE)
379 print(self.good_dirname, file=FILE)
380 print(self.bad_dirname, file=FILE)
Brett Cannon64a84702004-07-10 02:10:45 +0000381 finally:
382 FILE.close()
383 os.mkdir(self.good_dir_path)
384
Brett Cannonee86a662004-07-13 07:12:25 +0000385 def cleanup(self, prep=False):
Brett Cannon64a84702004-07-10 02:10:45 +0000386 """Make sure that the .pth file is deleted, self.imported is not in
387 sys.modules, and that both self.good_dirname and self.bad_dirname are
388 not existing directories."""
Brett Cannonee86a662004-07-13 07:12:25 +0000389 if os.path.exists(self.file_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000390 os.remove(self.file_path)
Brett Cannonee86a662004-07-13 07:12:25 +0000391 if prep:
392 self.imported_module = sys.modules.get(self.imported)
393 if self.imported_module:
394 del sys.modules[self.imported]
395 else:
396 if self.imported_module:
397 sys.modules[self.imported] = self.imported_module
398 if os.path.exists(self.good_dir_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000399 os.rmdir(self.good_dir_path)
Brett Cannonee86a662004-07-13 07:12:25 +0000400 if os.path.exists(self.bad_dir_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000401 os.rmdir(self.bad_dir_path)
Brett Cannon0096e262004-06-05 01:12:51 +0000402
403class ImportSideEffectTests(unittest.TestCase):
404 """Test side-effects from importing 'site'."""
405
406 def setUp(self):
407 """Make a copy of sys.path"""
408 self.sys_path = sys.path[:]
409
410 def tearDown(self):
411 """Restore sys.path"""
Nick Coghlan6ead5522009-10-18 13:19:33 +0000412 sys.path[:] = self.sys_path
Brett Cannon0096e262004-06-05 01:12:51 +0000413
INADA Naokid4c76d92018-10-01 21:10:37 +0900414 def test_abs_paths_cached_None(self):
415 """Test for __cached__ is None.
416
417 Regarding to PEP 3147, __cached__ can be None.
418
419 See also: https://bugs.python.org/issue30167
420 """
421 sys.modules['test'].__cached__ = None
422 site.abs_paths()
423 self.assertIsNone(sys.modules['test'].__cached__)
424
Brett Cannon0096e262004-06-05 01:12:51 +0000425 def test_no_duplicate_paths(self):
426 # No duplicate paths should exist in sys.path
427 # Handled by removeduppaths()
428 site.removeduppaths()
429 seen_paths = set()
430 for path in sys.path:
Benjamin Peterson577473f2010-01-19 00:09:57 +0000431 self.assertNotIn(path, seen_paths)
Brett Cannon0096e262004-06-05 01:12:51 +0000432 seen_paths.add(path)
433
Zachary Ware9fe6d862013-12-08 00:20:35 -0600434 @unittest.skip('test not implemented')
Brett Cannon0096e262004-06-05 01:12:51 +0000435 def test_add_build_dir(self):
436 # Test that the build directory's Modules directory is used when it
437 # should be.
438 # XXX: implement
439 pass
440
Brett Cannon0096e262004-06-05 01:12:51 +0000441 def test_setting_quit(self):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000442 # 'quit' and 'exit' should be injected into builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000443 self.assertTrue(hasattr(builtins, "quit"))
444 self.assertTrue(hasattr(builtins, "exit"))
Brett Cannon0096e262004-06-05 01:12:51 +0000445
446 def test_setting_copyright(self):
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700447 # 'copyright', 'credits', and 'license' should be in builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000448 self.assertTrue(hasattr(builtins, "copyright"))
449 self.assertTrue(hasattr(builtins, "credits"))
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700450 self.assertTrue(hasattr(builtins, "license"))
Brett Cannon0096e262004-06-05 01:12:51 +0000451
452 def test_setting_help(self):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000453 # 'help' should be set in builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000454 self.assertTrue(hasattr(builtins, "help"))
Brett Cannon0096e262004-06-05 01:12:51 +0000455
456 def test_aliasing_mbcs(self):
457 if sys.platform == "win32":
458 import locale
459 if locale.getdefaultlocale()[1].startswith('cp'):
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000460 for value in encodings.aliases.aliases.values():
Brett Cannon0096e262004-06-05 01:12:51 +0000461 if value == "mbcs":
462 break
463 else:
464 self.fail("did not alias mbcs")
465
Brett Cannon0096e262004-06-05 01:12:51 +0000466 def test_sitecustomize_executed(self):
467 # If sitecustomize is available, it should have been imported.
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000468 if "sitecustomize" not in sys.modules:
Brett Cannon0096e262004-06-05 01:12:51 +0000469 try:
470 import sitecustomize
471 except ImportError:
472 pass
473 else:
474 self.fail("sitecustomize not imported automatically")
475
R David Murray1bc6ceb2013-09-14 13:28:37 -0400476 @test.support.requires_resource('network')
Benjamin Peterson337578b2015-02-01 20:16:59 -0500477 @test.support.system_must_validate_cert
Ned Deily5a507f02014-03-26 23:31:39 -0700478 @unittest.skipUnless(hasattr(urllib.request, "HTTPSHandler"),
479 'need SSL support to download license')
R David Murray1bc6ceb2013-09-14 13:28:37 -0400480 def test_license_exists_at_url(self):
Ned Deily944d5972014-03-26 23:43:26 -0700481 # This test is a bit fragile since it depends on the format of the
R David Murray1bc6ceb2013-09-14 13:28:37 -0400482 # string displayed by license in the absence of a LICENSE file.
483 url = license._Printer__data.split()[1]
484 req = urllib.request.Request(url, method='HEAD')
Victor Stinner1fce2402020-10-05 18:24:00 +0200485 # Reset global urllib.request._opener
486 self.addCleanup(urllib.request.urlcleanup)
R David Murray1bc6ceb2013-09-14 13:28:37 -0400487 try:
Serhiy Storchakabfb1cf42020-04-29 10:36:20 +0300488 with socket_helper.transient_internet(url):
R David Murray1bc6ceb2013-09-14 13:28:37 -0400489 with urllib.request.urlopen(req) as data:
490 code = data.getcode()
491 except urllib.error.HTTPError as e:
492 code = e.code
493 self.assertEqual(code, 200, msg="Can't find " + url)
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700494
Brett Cannon0096e262004-06-05 01:12:51 +0000495
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200496class StartupImportTests(unittest.TestCase):
497
498 def test_startup_imports(self):
Victor Stinnerd18de462020-03-18 18:27:32 +0100499 # Get sys.path in isolated mode (python3 -I)
500 popen = subprocess.Popen([sys.executable, '-I', '-c',
501 'import sys; print(repr(sys.path))'],
502 stdout=subprocess.PIPE,
503 encoding='utf-8')
504 stdout = popen.communicate()[0]
505 self.assertEqual(popen.returncode, 0, repr(stdout))
506 isolated_paths = eval(stdout)
507
508 # bpo-27807: Even with -I, the site module executes all .pth files
509 # found in sys.path (see site.addpackage()). Skip the test if at least
510 # one .pth file is found.
511 for path in isolated_paths:
Serhiy Storchaka93558682020-06-20 11:10:31 +0300512 pth_files = glob.glob(os.path.join(glob.escape(path), "*.pth"))
Victor Stinnerd18de462020-03-18 18:27:32 +0100513 if pth_files:
514 self.skipTest(f"found {len(pth_files)} .pth files in: {path}")
515
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200516 # This tests checks which modules are loaded by Python when it
517 # initially starts upon startup.
Christian Heimes179a3db2013-10-12 12:32:21 +0200518 popen = subprocess.Popen([sys.executable, '-I', '-v', '-c',
519 'import sys; print(set(sys.modules))'],
520 stdout=subprocess.PIPE,
Steve Dower313523c2016-09-17 12:22:41 -0700521 stderr=subprocess.PIPE,
522 encoding='utf-8')
Christian Heimes179a3db2013-10-12 12:32:21 +0200523 stdout, stderr = popen.communicate()
Victor Stinnerd18de462020-03-18 18:27:32 +0100524 self.assertEqual(popen.returncode, 0, (stdout, stderr))
Christian Heimes179a3db2013-10-12 12:32:21 +0200525 modules = eval(stdout)
526
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200527 self.assertIn('site', modules)
528
Christian Heimes25827622013-10-12 01:27:08 +0200529 # http://bugs.python.org/issue19205
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200530 re_mods = {'re', '_sre', 'sre_compile', 'sre_constants', 'sre_parse'}
Inada Naokic4d92c82019-05-05 18:06:30 +0900531 self.assertFalse(modules.intersection(re_mods), stderr)
532
Christian Heimes25827622013-10-12 01:27:08 +0200533 # http://bugs.python.org/issue9548
Christian Heimes179a3db2013-10-12 12:32:21 +0200534 self.assertNotIn('locale', modules, stderr)
Inada Naokic4d92c82019-05-05 18:06:30 +0900535
536 # http://bugs.python.org/issue19209
537 self.assertNotIn('copyreg', modules, stderr)
538
539 # http://bugs.python.org/issue19218
Christian Heimesf1dc3ee2013-10-13 02:04:20 +0200540 collection_mods = {'_collections', 'collections', 'functools',
541 'heapq', 'itertools', 'keyword', 'operator',
doko@ubuntu.com95743552014-04-15 20:37:54 +0200542 'reprlib', 'types', 'weakref'
543 }.difference(sys.builtin_module_names)
Ned Deilyc22bd582017-07-28 03:02:10 -0400544 self.assertFalse(modules.intersection(collection_mods), stderr)
Christian Heimes1a5fb4e2013-10-12 01:00:51 +0200545
Steve Dower6dd8eca2016-09-17 14:35:32 -0700546 def test_startup_interactivehook(self):
547 r = subprocess.Popen([sys.executable, '-c',
548 'import sys; sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
549 self.assertTrue(r, "'__interactivehook__' not added by site")
550
551 def test_startup_interactivehook_isolated(self):
552 # issue28192 readline is not automatically enabled in isolated mode
553 r = subprocess.Popen([sys.executable, '-I', '-c',
554 'import sys; sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
555 self.assertFalse(r, "'__interactivehook__' added in isolated mode")
556
557 def test_startup_interactivehook_isolated_explicit(self):
558 # issue28192 readline can be explicitly enabled in isolated mode
559 r = subprocess.Popen([sys.executable, '-I', '-c',
560 'import site, sys; site.enablerlcompleter(); sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
561 self.assertTrue(r, "'__interactivehook__' not added by enablerlcompleter()")
562
Zachary Wared48214f2017-05-14 15:49:46 -0500563@unittest.skipUnless(sys.platform == 'win32', "only supported on Windows")
564class _pthFileTests(unittest.TestCase):
565
Steve Dower936a6602020-07-15 22:56:49 +0100566 def _create_underpth_exe(self, lines, exe_pth=True):
567 import _winapi
Zachary Wared48214f2017-05-14 15:49:46 -0500568 temp_dir = tempfile.mkdtemp()
Hai Shi79bb2c92020-08-06 19:51:29 +0800569 self.addCleanup(os_helper.rmtree, temp_dir)
Zachary Wared48214f2017-05-14 15:49:46 -0500570 exe_file = os.path.join(temp_dir, os.path.split(sys.executable)[1])
Steve Dower936a6602020-07-15 22:56:49 +0100571 dll_src_file = _winapi.GetModuleFileName(sys.dllhandle)
572 dll_file = os.path.join(temp_dir, os.path.split(dll_src_file)[1])
Steve Dower1da055e2016-10-29 08:50:31 -0700573 shutil.copy(sys.executable, exe_file)
Steve Dower936a6602020-07-15 22:56:49 +0100574 shutil.copy(dll_src_file, dll_file)
575 if exe_pth:
576 _pth_file = os.path.splitext(exe_file)[0] + '._pth'
577 else:
578 _pth_file = os.path.splitext(dll_file)[0] + '._pth'
Zachary Wared48214f2017-05-14 15:49:46 -0500579 with open(_pth_file, 'w') as f:
580 for line in lines:
581 print(line, file=f)
582 return exe_file
Steve Dower1da055e2016-10-29 08:50:31 -0700583
Steve Dower5f9193a2017-02-04 15:19:29 -0800584 def _calc_sys_path_for_underpth_nosite(self, sys_prefix, lines):
585 sys_path = []
586 for line in lines:
587 if not line or line[0] == '#':
588 continue
589 abs_path = os.path.abspath(os.path.join(sys_prefix, line))
590 sys_path.append(abs_path)
591 return sys_path
592
Steve Dowerc6dd4152016-10-27 14:28:07 -0700593 def test_underpth_nosite_file(self):
Steve Dower1da055e2016-10-29 08:50:31 -0700594 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
595 exe_prefix = os.path.dirname(sys.executable)
Steve Dower5f9193a2017-02-04 15:19:29 -0800596 pth_lines = [
Steve Dower1da055e2016-10-29 08:50:31 -0700597 'fake-path-name',
598 *[libpath for _ in range(200)],
Steve Dower5f9193a2017-02-04 15:19:29 -0800599 '',
Steve Dower1da055e2016-10-29 08:50:31 -0700600 '# comment',
Steve Dower5f9193a2017-02-04 15:19:29 -0800601 ]
602 exe_file = self._create_underpth_exe(pth_lines)
603 sys_path = self._calc_sys_path_for_underpth_nosite(
604 os.path.dirname(exe_file),
605 pth_lines)
Steve Dowerc6dd4152016-10-27 14:28:07 -0700606
Zachary Wared48214f2017-05-14 15:49:46 -0500607 env = os.environ.copy()
608 env['PYTHONPATH'] = 'from-env'
609 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
Steve Dower9b33bf52017-05-23 16:25:25 -0700610 output = subprocess.check_output([exe_file, '-c',
611 'import sys; print("\\n".join(sys.path) if sys.flags.no_site else "")'
612 ], env=env, encoding='ansi')
613 actual_sys_path = output.rstrip().split('\n')
Serhiy Storchaka95c32622018-02-04 18:14:47 +0200614 self.assertTrue(actual_sys_path, "sys.flags.no_site was False")
Steve Dower9b33bf52017-05-23 16:25:25 -0700615 self.assertEqual(
616 actual_sys_path,
617 sys_path,
618 "sys.path is incorrect"
619 )
Steve Dowerc6dd4152016-10-27 14:28:07 -0700620
Steve Dowerc6dd4152016-10-27 14:28:07 -0700621 def test_underpth_file(self):
Steve Dower1da055e2016-10-29 08:50:31 -0700622 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
623 exe_prefix = os.path.dirname(sys.executable)
624 exe_file = self._create_underpth_exe([
625 'fake-path-name',
626 *[libpath for _ in range(200)],
Steve Dower5f9193a2017-02-04 15:19:29 -0800627 '',
Steve Dower1da055e2016-10-29 08:50:31 -0700628 '# comment',
629 'import site'
630 ])
Steve Dower5f9193a2017-02-04 15:19:29 -0800631 sys_prefix = os.path.dirname(exe_file)
Zachary Wared48214f2017-05-14 15:49:46 -0500632 env = os.environ.copy()
633 env['PYTHONPATH'] = 'from-env'
634 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
635 rc = subprocess.call([exe_file, '-c',
636 'import sys; sys.exit(not sys.flags.no_site and '
637 '%r in sys.path and %r in sys.path and %r not in sys.path and '
638 'all("\\r" not in p and "\\n" not in p for p in sys.path))' % (
639 os.path.join(sys_prefix, 'fake-path-name'),
640 libpath,
641 os.path.join(sys_prefix, 'from-env'),
642 )], env=env)
Steve Dower5f9193a2017-02-04 15:19:29 -0800643 self.assertTrue(rc, "sys.path is incorrect")
Steve Dowerc6dd4152016-10-27 14:28:07 -0700644
Steve Dower6dd8eca2016-09-17 14:35:32 -0700645
Steve Dower936a6602020-07-15 22:56:49 +0100646 def test_underpth_dll_file(self):
647 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
648 exe_prefix = os.path.dirname(sys.executable)
649 exe_file = self._create_underpth_exe([
650 'fake-path-name',
651 *[libpath for _ in range(200)],
652 '',
653 '# comment',
654 'import site'
655 ], exe_pth=False)
656 sys_prefix = os.path.dirname(exe_file)
657 env = os.environ.copy()
658 env['PYTHONPATH'] = 'from-env'
659 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
660 rc = subprocess.call([exe_file, '-c',
661 'import sys; sys.exit(not sys.flags.no_site and '
662 '%r in sys.path and %r in sys.path and %r not in sys.path and '
663 'all("\\r" not in p and "\\n" not in p for p in sys.path))' % (
664 os.path.join(sys_prefix, 'fake-path-name'),
665 libpath,
666 os.path.join(sys_prefix, 'from-env'),
667 )], env=env)
668 self.assertTrue(rc, "sys.path is incorrect")
669
670
Brett Cannon0096e262004-06-05 01:12:51 +0000671if __name__ == "__main__":
Brett Cannon3e9a9ae2013-06-12 21:25:59 -0400672 unittest.main()