blob: 6060288248efba878c4545d1f26f764189eb69ba [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
82 sysconfig._CONFIG_VARS.clear()
83 sysconfig._CONFIG_VARS.update(self.old_vars)
Raymond Hettingerebd95222004-06-27 03:02:18 +000084
Brett Cannon0096e262004-06-05 01:12:51 +000085 def test_makepath(self):
86 # Test makepath() have an absolute path for its first return value
87 # and a case-normalized version of the absolute path for its
88 # second value.
89 path_parts = ("Beginning", "End")
90 original_dir = os.path.join(*path_parts)
91 abs_dir, norm_dir = site.makepath(*path_parts)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000092 self.assertEqual(os.path.abspath(original_dir), abs_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000093 if original_dir == os.path.normcase(original_dir):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000094 self.assertEqual(abs_dir, norm_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000095 else:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000096 self.assertEqual(os.path.normcase(abs_dir), norm_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000097
98 def test_init_pathinfo(self):
99 dir_set = site._init_pathinfo()
100 for entry in [site.makepath(path)[1] for path in sys.path
Brett Cannon5f0507d2016-04-08 15:04:28 -0700101 if path and os.path.exists(path)]:
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000102 self.assertIn(entry, dir_set,
103 "%s from sys.path not found in set returned "
104 "by _init_pathinfo(): %s" % (entry, dir_set))
Raymond Hettingerebd95222004-06-27 03:02:18 +0000105
Brett Cannonee86a662004-07-13 07:12:25 +0000106 def pth_file_tests(self, pth_file):
107 """Contain common code for testing results of reading a .pth file"""
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000108 self.assertIn(pth_file.imported, sys.modules,
109 "%s not in sys.modules" % pth_file.imported)
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000110 self.assertIn(site.makepath(pth_file.good_dir_path)[0], sys.path)
111 self.assertFalse(os.path.exists(pth_file.bad_dir_path))
Brett Cannonee86a662004-07-13 07:12:25 +0000112
Brett Cannon0096e262004-06-05 01:12:51 +0000113 def test_addpackage(self):
114 # Make sure addpackage() imports if the line starts with 'import',
Brett Cannon64a84702004-07-10 02:10:45 +0000115 # adds directories to sys.path for any line in the file that is not a
116 # comment or import that is a valid directory name for where the .pth
117 # file resides; invalid directories are not added
118 pth_file = PthFile()
Brett Cannonee86a662004-07-13 07:12:25 +0000119 pth_file.cleanup(prep=True) # to make sure that nothing is
120 # pre-existing that shouldn't be
Brett Cannon0096e262004-06-05 01:12:51 +0000121 try:
Brett Cannon64a84702004-07-10 02:10:45 +0000122 pth_file.create()
123 site.addpackage(pth_file.base_dir, pth_file.filename, set())
Brett Cannonee86a662004-07-13 07:12:25 +0000124 self.pth_file_tests(pth_file)
Brett Cannon0096e262004-06-05 01:12:51 +0000125 finally:
Brett Cannon64a84702004-07-10 02:10:45 +0000126 pth_file.cleanup()
Raymond Hettingerebd95222004-06-27 03:02:18 +0000127
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000128 def make_pth(self, contents, pth_dir='.', pth_name=TESTFN):
129 # Create a .pth file and return its (abspath, basename).
130 pth_dir = os.path.abspath(pth_dir)
131 pth_basename = pth_name + '.pth'
132 pth_fn = os.path.join(pth_dir, pth_basename)
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200133 with open(pth_fn, 'w', encoding='utf-8') as pth_file:
134 self.addCleanup(lambda: os.remove(pth_fn))
135 pth_file.write(contents)
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000136 return pth_dir, pth_basename
137
138 def test_addpackage_import_bad_syntax(self):
139 # Issue 10642
Serhiy Storchaka94cf3082018-12-17 17:34:14 +0200140 pth_dir, pth_fn = self.make_pth("import bad-syntax\n")
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000141 with captured_stderr() as err_out:
142 site.addpackage(pth_dir, pth_fn, set())
143 self.assertRegex(err_out.getvalue(), "line 1")
R. David Murrayab9d8d62010-12-27 00:03:13 +0000144 self.assertRegex(err_out.getvalue(),
145 re.escape(os.path.join(pth_dir, pth_fn)))
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000146 # XXX: the previous two should be independent checks so that the
147 # order doesn't matter. The next three could be a single check
148 # but my regex foo isn't good enough to write it.
149 self.assertRegex(err_out.getvalue(), 'Traceback')
Serhiy Storchaka94cf3082018-12-17 17:34:14 +0200150 self.assertRegex(err_out.getvalue(), r'import bad-syntax')
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000151 self.assertRegex(err_out.getvalue(), 'SyntaxError')
152
153 def test_addpackage_import_bad_exec(self):
154 # Issue 10642
155 pth_dir, pth_fn = self.make_pth("randompath\nimport nosuchmodule\n")
156 with captured_stderr() as err_out:
157 site.addpackage(pth_dir, pth_fn, set())
158 self.assertRegex(err_out.getvalue(), "line 2")
R. David Murrayab9d8d62010-12-27 00:03:13 +0000159 self.assertRegex(err_out.getvalue(),
160 re.escape(os.path.join(pth_dir, pth_fn)))
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000161 # XXX: ditto previous XXX comment.
162 self.assertRegex(err_out.getvalue(), 'Traceback')
Eric Snow46f97b82016-09-07 16:56:15 -0700163 self.assertRegex(err_out.getvalue(), 'ModuleNotFoundError')
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000164
idomic0c71a662020-09-19 15:13:29 -0400165 def test_addpackage_empty_lines(self):
166 # Issue 33689
167 pth_dir, pth_fn = self.make_pth("\n\n \n\n")
168 known_paths = site.addpackage(pth_dir, pth_fn, set())
169 self.assertEqual(known_paths, set())
170
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000171 def test_addpackage_import_bad_pth_file(self):
172 # Issue 5258
173 pth_dir, pth_fn = self.make_pth("abc\x00def\n")
174 with captured_stderr() as err_out:
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300175 self.assertFalse(site.addpackage(pth_dir, pth_fn, set()))
176 self.assertEqual(err_out.getvalue(), "")
177 for path in sys.path:
178 if isinstance(path, str):
179 self.assertNotIn("abc\x00def", path)
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000180
Brett Cannon0096e262004-06-05 01:12:51 +0000181 def test_addsitedir(self):
Brett Cannon64a84702004-07-10 02:10:45 +0000182 # Same tests for test_addpackage since addsitedir() essentially just
183 # calls addpackage() for every .pth file in the directory
184 pth_file = PthFile()
Brett Cannonee86a662004-07-13 07:12:25 +0000185 pth_file.cleanup(prep=True) # Make sure that nothing is pre-existing
186 # that is tested for
Brett Cannon0096e262004-06-05 01:12:51 +0000187 try:
Brett Cannonee86a662004-07-13 07:12:25 +0000188 pth_file.create()
Brett Cannon64a84702004-07-10 02:10:45 +0000189 site.addsitedir(pth_file.base_dir, set())
Brett Cannonee86a662004-07-13 07:12:25 +0000190 self.pth_file_tests(pth_file)
Brett Cannon0096e262004-06-05 01:12:51 +0000191 finally:
Brett Cannon64a84702004-07-10 02:10:45 +0000192 pth_file.cleanup()
Brett Cannon0096e262004-06-05 01:12:51 +0000193
native-api45d8d242019-03-03 19:05:19 +0300194 # This tests _getuserbase, hence the double underline
195 # to distinguish from a test for getuserbase
196 def test__getuserbase(self):
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900197 self.assertEqual(site._getuserbase(), sysconfig._getuserbase())
198
pxinwrab74c012020-12-21 06:27:42 +0800199 @unittest.skipUnless(HAS_USER_SITE, 'need user site')
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900200 def test_get_path(self):
INADA Naokiba9ddb72017-07-28 21:28:19 +0900201 if sys.platform == 'darwin' and sys._framework:
202 scheme = 'osx_framework_user'
203 else:
204 scheme = os.name + '_user'
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900205 self.assertEqual(site._get_path(site._getuserbase()),
INADA Naokiba9ddb72017-07-28 21:28:19 +0900206 sysconfig.get_path('purelib', scheme))
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900207
Ned Deily316f5732011-10-31 16:16:35 -0700208 @unittest.skipUnless(site.ENABLE_USER_SITE, "requires access to PEP 370 "
209 "user-site (site.ENABLE_USER_SITE)")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000210 def test_s_option(self):
Eric Snow6b4be192017-05-22 21:36:03 -0700211 # (ncoghlan) Change this to use script_helper...
Christian Heimes8dc226f2008-05-06 23:45:46 +0000212 usersite = site.USER_SITE
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000213 self.assertIn(usersite, sys.path)
Christian Heimes8dc226f2008-05-06 23:45:46 +0000214
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000215 env = os.environ.copy()
Christian Heimes8dc226f2008-05-06 23:45:46 +0000216 rc = subprocess.call([sys.executable, '-c',
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000217 'import sys; sys.exit(%r in sys.path)' % usersite],
218 env=env)
Christian Heimes8dc226f2008-05-06 23:45:46 +0000219 self.assertEqual(rc, 1)
220
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000221 env = os.environ.copy()
Christian Heimes8dc226f2008-05-06 23:45:46 +0000222 rc = subprocess.call([sys.executable, '-s', '-c',
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000223 'import sys; sys.exit(%r in sys.path)' % usersite],
224 env=env)
Antoine Pitroua1782e12013-10-23 22:03:22 +0200225 if usersite == site.getsitepackages()[0]:
226 self.assertEqual(rc, 1)
227 else:
Eric Snow6b4be192017-05-22 21:36:03 -0700228 self.assertEqual(rc, 0, "User site still added to path with -s")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000229
230 env = os.environ.copy()
231 env["PYTHONNOUSERSITE"] = "1"
232 rc = subprocess.call([sys.executable, '-c',
Benjamin Petersonfea6a942008-07-02 16:11:42 +0000233 'import sys; sys.exit(%r in sys.path)' % usersite],
Christian Heimes8dc226f2008-05-06 23:45:46 +0000234 env=env)
Antoine Pitroua1782e12013-10-23 22:03:22 +0200235 if usersite == site.getsitepackages()[0]:
236 self.assertEqual(rc, 1)
237 else:
Eric Snow6b4be192017-05-22 21:36:03 -0700238 self.assertEqual(rc, 0,
239 "User site still added to path with PYTHONNOUSERSITE")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000240
241 env = os.environ.copy()
242 env["PYTHONUSERBASE"] = "/tmp"
243 rc = subprocess.call([sys.executable, '-c',
244 'import sys, site; sys.exit(site.USER_BASE.startswith("/tmp"))'],
245 env=env)
Eric Snow6b4be192017-05-22 21:36:03 -0700246 self.assertEqual(rc, 1,
247 "User base not set by PYTHONUSERBASE")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000248
pxinwrab74c012020-12-21 06:27:42 +0800249 @unittest.skipUnless(HAS_USER_SITE, 'need user site')
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000250 def test_getuserbase(self):
251 site.USER_BASE = None
252 user_base = site.getuserbase()
253
254 # the call sets site.USER_BASE
Ezio Melottib3aedd42010-11-20 19:04:17 +0000255 self.assertEqual(site.USER_BASE, user_base)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000256
257 # let's set PYTHONUSERBASE and see if it uses it
258 site.USER_BASE = None
Tarek Ziadéedacea32010-01-29 11:41:03 +0000259 import sysconfig
260 sysconfig._CONFIG_VARS = None
261
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000262 with EnvironmentVarGuard() as environ:
263 environ['PYTHONUSERBASE'] = 'xoxo'
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000264 self.assertTrue(site.getuserbase().startswith('xoxo'),
265 site.getuserbase())
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000266
pxinwrab74c012020-12-21 06:27:42 +0800267 @unittest.skipUnless(HAS_USER_SITE, 'need user site')
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000268 def test_getusersitepackages(self):
269 site.USER_SITE = None
270 site.USER_BASE = None
271 user_site = site.getusersitepackages()
272
273 # the call sets USER_BASE *and* USER_SITE
Ezio Melottib3aedd42010-11-20 19:04:17 +0000274 self.assertEqual(site.USER_SITE, user_site)
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000275 self.assertTrue(user_site.startswith(site.USER_BASE), user_site)
Victor Stinnerf2f45552018-12-05 16:49:35 +0100276 self.assertEqual(site.USER_BASE, site.getuserbase())
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000277
278 def test_getsitepackages(self):
279 site.PREFIXES = ['xoxo']
280 dirs = site.getsitepackages()
Ned Deily763f0942018-01-30 05:14:09 -0500281 if os.sep == '/':
282 # OS X, Linux, FreeBSD, etc
Victor Stinner8510f432020-03-10 09:53:09 +0100283 if sys.platlibdir != "lib":
284 self.assertEqual(len(dirs), 2)
285 wanted = os.path.join('xoxo', sys.platlibdir,
286 'python%d.%d' % sys.version_info[:2],
287 'site-packages')
288 self.assertEqual(dirs[0], wanted)
289 else:
290 self.assertEqual(len(dirs), 1)
Serhiy Storchaka885bdc42016-02-11 13:10:36 +0200291 wanted = os.path.join('xoxo', 'lib',
292 'python%d.%d' % sys.version_info[:2],
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000293 'site-packages')
Victor Stinner8510f432020-03-10 09:53:09 +0100294 self.assertEqual(dirs[-1], wanted)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000295 else:
Ned Deilyd531b292012-02-06 00:58:18 +0100296 # other platforms
Ezio Melottifc8b2052010-08-17 08:35:41 +0000297 self.assertEqual(len(dirs), 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000298 self.assertEqual(dirs[0], 'xoxo')
Tarek Ziadé8c0e2172009-10-27 21:24:21 +0000299 wanted = os.path.join('xoxo', 'lib', 'site-packages')
Ezio Melottib3aedd42010-11-20 19:04:17 +0000300 self.assertEqual(dirs[1], wanted)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000301
pxinwrab74c012020-12-21 06:27:42 +0800302 @unittest.skipUnless(HAS_USER_SITE, 'need user site')
Victor Stinnerf2f45552018-12-05 16:49:35 +0100303 def test_no_home_directory(self):
304 # bpo-10496: getuserbase() and getusersitepackages() must not fail if
305 # the current user has no home directory (if expanduser() returns the
306 # path unchanged).
307 site.USER_SITE = None
308 site.USER_BASE = None
309
310 with EnvironmentVarGuard() as environ, \
311 mock.patch('os.path.expanduser', lambda path: path):
312
313 del environ['PYTHONUSERBASE']
314 del environ['APPDATA']
315
316 user_base = site.getuserbase()
317 self.assertTrue(user_base.startswith('~' + os.sep),
318 user_base)
319
320 user_site = site.getusersitepackages()
321 self.assertTrue(user_site.startswith(user_base), user_site)
322
323 with mock.patch('os.path.isdir', return_value=False) as mock_isdir, \
324 mock.patch.object(site, 'addsitedir') as mock_addsitedir, \
325 support.swap_attr(site, 'ENABLE_USER_SITE', True):
326
327 # addusersitepackages() must not add user_site to sys.path
328 # if it is not an existing directory
329 known_paths = set()
330 site.addusersitepackages(known_paths)
331
332 mock_isdir.assert_called_once_with(user_site)
333 mock_addsitedir.assert_not_called()
334 self.assertFalse(known_paths)
335
native-api2145c8c2020-06-12 09:20:11 +0300336 def test_trace(self):
337 message = "bla-bla-bla"
338 for verbose, out in (True, message + "\n"), (False, ""):
339 with mock.patch('sys.flags', mock.Mock(verbose=verbose)), \
340 mock.patch('sys.stderr', io.StringIO()):
341 site._trace(message)
342 self.assertEqual(sys.stderr.getvalue(), out)
343
Victor Stinnerf2f45552018-12-05 16:49:35 +0100344
Brett Cannon64a84702004-07-10 02:10:45 +0000345class PthFile(object):
346 """Helper class for handling testing of .pth files"""
Brett Cannon0096e262004-06-05 01:12:51 +0000347
Brett Cannon64a84702004-07-10 02:10:45 +0000348 def __init__(self, filename_base=TESTFN, imported="time",
349 good_dirname="__testdir__", bad_dirname="__bad"):
350 """Initialize instance variables"""
351 self.filename = filename_base + ".pth"
352 self.base_dir = os.path.abspath('')
353 self.file_path = os.path.join(self.base_dir, self.filename)
Brett Cannonee86a662004-07-13 07:12:25 +0000354 self.imported = imported
Brett Cannon64a84702004-07-10 02:10:45 +0000355 self.good_dirname = good_dirname
356 self.bad_dirname = bad_dirname
357 self.good_dir_path = os.path.join(self.base_dir, self.good_dirname)
358 self.bad_dir_path = os.path.join(self.base_dir, self.bad_dirname)
Brett Cannon0096e262004-06-05 01:12:51 +0000359
Brett Cannon64a84702004-07-10 02:10:45 +0000360 def create(self):
361 """Create a .pth file with a comment, blank lines, an ``import
362 <self.imported>``, a line with self.good_dirname, and a line with
363 self.bad_dirname.
Tim Peters182b5ac2004-07-18 06:16:08 +0000364
Brett Cannon64a84702004-07-10 02:10:45 +0000365 Creation of the directory for self.good_dir_path (based off of
366 self.good_dirname) is also performed.
Brett Cannon0096e262004-06-05 01:12:51 +0000367
Brett Cannon64a84702004-07-10 02:10:45 +0000368 Make sure to call self.cleanup() to undo anything done by this method.
Tim Peters182b5ac2004-07-18 06:16:08 +0000369
Brett Cannon64a84702004-07-10 02:10:45 +0000370 """
Michael W. Hudsonff522862005-05-27 14:58:06 +0000371 FILE = open(self.file_path, 'w')
Brett Cannon64a84702004-07-10 02:10:45 +0000372 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000373 print("#import @bad module name", file=FILE)
374 print("\n", file=FILE)
375 print("import %s" % self.imported, file=FILE)
376 print(self.good_dirname, file=FILE)
377 print(self.bad_dirname, file=FILE)
Brett Cannon64a84702004-07-10 02:10:45 +0000378 finally:
379 FILE.close()
380 os.mkdir(self.good_dir_path)
381
Brett Cannonee86a662004-07-13 07:12:25 +0000382 def cleanup(self, prep=False):
Brett Cannon64a84702004-07-10 02:10:45 +0000383 """Make sure that the .pth file is deleted, self.imported is not in
384 sys.modules, and that both self.good_dirname and self.bad_dirname are
385 not existing directories."""
Brett Cannonee86a662004-07-13 07:12:25 +0000386 if os.path.exists(self.file_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000387 os.remove(self.file_path)
Brett Cannonee86a662004-07-13 07:12:25 +0000388 if prep:
389 self.imported_module = sys.modules.get(self.imported)
390 if self.imported_module:
391 del sys.modules[self.imported]
392 else:
393 if self.imported_module:
394 sys.modules[self.imported] = self.imported_module
395 if os.path.exists(self.good_dir_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000396 os.rmdir(self.good_dir_path)
Brett Cannonee86a662004-07-13 07:12:25 +0000397 if os.path.exists(self.bad_dir_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000398 os.rmdir(self.bad_dir_path)
Brett Cannon0096e262004-06-05 01:12:51 +0000399
400class ImportSideEffectTests(unittest.TestCase):
401 """Test side-effects from importing 'site'."""
402
403 def setUp(self):
404 """Make a copy of sys.path"""
405 self.sys_path = sys.path[:]
406
407 def tearDown(self):
408 """Restore sys.path"""
Nick Coghlan6ead5522009-10-18 13:19:33 +0000409 sys.path[:] = self.sys_path
Brett Cannon0096e262004-06-05 01:12:51 +0000410
Barry Warsaw28a691b2010-04-17 00:19:56 +0000411 def test_abs_paths(self):
412 # Make sure all imported modules have their __file__ and __cached__
413 # attributes as absolute paths. Arranging to put the Lib directory on
414 # PYTHONPATH would cause the os module to have a relative path for
415 # __file__ if abs_paths() does not get run. sys and builtins (the
416 # only other modules imported before site.py runs) do not have
417 # __file__ or __cached__ because they are built-in.
Steve Dowerf14c28f2018-09-20 13:38:34 -0700418 try:
419 parent = os.path.relpath(os.path.dirname(os.__file__))
420 cwd = os.getcwd()
421 except ValueError:
422 # Failure to get relpath probably means we need to chdir
423 # to the same drive.
424 cwd, parent = os.path.split(os.path.dirname(os.__file__))
425 with change_cwd(cwd):
426 env = os.environ.copy()
427 env['PYTHONPATH'] = parent
428 code = ('import os, sys',
429 # use ASCII to avoid locale issues with non-ASCII directories
430 'os_file = os.__file__.encode("ascii", "backslashreplace")',
431 r'sys.stdout.buffer.write(os_file + b"\n")',
432 'os_cached = os.__cached__.encode("ascii", "backslashreplace")',
433 r'sys.stdout.buffer.write(os_cached + b"\n")')
434 command = '\n'.join(code)
435 # First, prove that with -S (no 'import site'), the paths are
436 # relative.
437 proc = subprocess.Popen([sys.executable, '-S', '-c', command],
438 env=env,
439 stdout=subprocess.PIPE)
440 stdout, stderr = proc.communicate()
Victor Stinnerf3bc2582010-04-18 07:59:53 +0000441
Steve Dowerf14c28f2018-09-20 13:38:34 -0700442 self.assertEqual(proc.returncode, 0)
443 os__file__, os__cached__ = stdout.splitlines()[:2]
444 self.assertFalse(os.path.isabs(os__file__))
445 self.assertFalse(os.path.isabs(os__cached__))
446 # Now, with 'import site', it works.
447 proc = subprocess.Popen([sys.executable, '-c', command],
448 env=env,
449 stdout=subprocess.PIPE)
450 stdout, stderr = proc.communicate()
451 self.assertEqual(proc.returncode, 0)
452 os__file__, os__cached__ = stdout.splitlines()[:2]
453 self.assertTrue(os.path.isabs(os__file__),
454 "expected absolute path, got {}"
455 .format(os__file__.decode('ascii')))
456 self.assertTrue(os.path.isabs(os__cached__),
457 "expected absolute path, got {}"
458 .format(os__cached__.decode('ascii')))
Brett Cannon0096e262004-06-05 01:12:51 +0000459
INADA Naokid4c76d92018-10-01 21:10:37 +0900460 def test_abs_paths_cached_None(self):
461 """Test for __cached__ is None.
462
463 Regarding to PEP 3147, __cached__ can be None.
464
465 See also: https://bugs.python.org/issue30167
466 """
467 sys.modules['test'].__cached__ = None
468 site.abs_paths()
469 self.assertIsNone(sys.modules['test'].__cached__)
470
Brett Cannon0096e262004-06-05 01:12:51 +0000471 def test_no_duplicate_paths(self):
472 # No duplicate paths should exist in sys.path
473 # Handled by removeduppaths()
474 site.removeduppaths()
475 seen_paths = set()
476 for path in sys.path:
Benjamin Peterson577473f2010-01-19 00:09:57 +0000477 self.assertNotIn(path, seen_paths)
Brett Cannon0096e262004-06-05 01:12:51 +0000478 seen_paths.add(path)
479
Zachary Ware9fe6d862013-12-08 00:20:35 -0600480 @unittest.skip('test not implemented')
Brett Cannon0096e262004-06-05 01:12:51 +0000481 def test_add_build_dir(self):
482 # Test that the build directory's Modules directory is used when it
483 # should be.
484 # XXX: implement
485 pass
486
Brett Cannon0096e262004-06-05 01:12:51 +0000487 def test_setting_quit(self):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000488 # 'quit' and 'exit' should be injected into builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000489 self.assertTrue(hasattr(builtins, "quit"))
490 self.assertTrue(hasattr(builtins, "exit"))
Brett Cannon0096e262004-06-05 01:12:51 +0000491
492 def test_setting_copyright(self):
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700493 # 'copyright', 'credits', and 'license' should be in builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000494 self.assertTrue(hasattr(builtins, "copyright"))
495 self.assertTrue(hasattr(builtins, "credits"))
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700496 self.assertTrue(hasattr(builtins, "license"))
Brett Cannon0096e262004-06-05 01:12:51 +0000497
498 def test_setting_help(self):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000499 # 'help' should be set in builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000500 self.assertTrue(hasattr(builtins, "help"))
Brett Cannon0096e262004-06-05 01:12:51 +0000501
502 def test_aliasing_mbcs(self):
503 if sys.platform == "win32":
504 import locale
505 if locale.getdefaultlocale()[1].startswith('cp'):
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000506 for value in encodings.aliases.aliases.values():
Brett Cannon0096e262004-06-05 01:12:51 +0000507 if value == "mbcs":
508 break
509 else:
510 self.fail("did not alias mbcs")
511
Brett Cannon0096e262004-06-05 01:12:51 +0000512 def test_sitecustomize_executed(self):
513 # If sitecustomize is available, it should have been imported.
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000514 if "sitecustomize" not in sys.modules:
Brett Cannon0096e262004-06-05 01:12:51 +0000515 try:
516 import sitecustomize
517 except ImportError:
518 pass
519 else:
520 self.fail("sitecustomize not imported automatically")
521
R David Murray1bc6ceb2013-09-14 13:28:37 -0400522 @test.support.requires_resource('network')
Benjamin Peterson337578b2015-02-01 20:16:59 -0500523 @test.support.system_must_validate_cert
Ned Deily5a507f02014-03-26 23:31:39 -0700524 @unittest.skipUnless(hasattr(urllib.request, "HTTPSHandler"),
525 'need SSL support to download license')
R David Murray1bc6ceb2013-09-14 13:28:37 -0400526 def test_license_exists_at_url(self):
Ned Deily944d5972014-03-26 23:43:26 -0700527 # This test is a bit fragile since it depends on the format of the
R David Murray1bc6ceb2013-09-14 13:28:37 -0400528 # string displayed by license in the absence of a LICENSE file.
529 url = license._Printer__data.split()[1]
530 req = urllib.request.Request(url, method='HEAD')
Victor Stinner1fce2402020-10-05 18:24:00 +0200531 # Reset global urllib.request._opener
532 self.addCleanup(urllib.request.urlcleanup)
R David Murray1bc6ceb2013-09-14 13:28:37 -0400533 try:
Serhiy Storchakabfb1cf42020-04-29 10:36:20 +0300534 with socket_helper.transient_internet(url):
R David Murray1bc6ceb2013-09-14 13:28:37 -0400535 with urllib.request.urlopen(req) as data:
536 code = data.getcode()
537 except urllib.error.HTTPError as e:
538 code = e.code
539 self.assertEqual(code, 200, msg="Can't find " + url)
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700540
Brett Cannon0096e262004-06-05 01:12:51 +0000541
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200542class StartupImportTests(unittest.TestCase):
543
544 def test_startup_imports(self):
Victor Stinnerd18de462020-03-18 18:27:32 +0100545 # Get sys.path in isolated mode (python3 -I)
546 popen = subprocess.Popen([sys.executable, '-I', '-c',
547 'import sys; print(repr(sys.path))'],
548 stdout=subprocess.PIPE,
549 encoding='utf-8')
550 stdout = popen.communicate()[0]
551 self.assertEqual(popen.returncode, 0, repr(stdout))
552 isolated_paths = eval(stdout)
553
554 # bpo-27807: Even with -I, the site module executes all .pth files
555 # found in sys.path (see site.addpackage()). Skip the test if at least
556 # one .pth file is found.
557 for path in isolated_paths:
Serhiy Storchaka93558682020-06-20 11:10:31 +0300558 pth_files = glob.glob(os.path.join(glob.escape(path), "*.pth"))
Victor Stinnerd18de462020-03-18 18:27:32 +0100559 if pth_files:
560 self.skipTest(f"found {len(pth_files)} .pth files in: {path}")
561
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200562 # This tests checks which modules are loaded by Python when it
563 # initially starts upon startup.
Christian Heimes179a3db2013-10-12 12:32:21 +0200564 popen = subprocess.Popen([sys.executable, '-I', '-v', '-c',
565 'import sys; print(set(sys.modules))'],
566 stdout=subprocess.PIPE,
Steve Dower313523c2016-09-17 12:22:41 -0700567 stderr=subprocess.PIPE,
568 encoding='utf-8')
Christian Heimes179a3db2013-10-12 12:32:21 +0200569 stdout, stderr = popen.communicate()
Victor Stinnerd18de462020-03-18 18:27:32 +0100570 self.assertEqual(popen.returncode, 0, (stdout, stderr))
Christian Heimes179a3db2013-10-12 12:32:21 +0200571 modules = eval(stdout)
572
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200573 self.assertIn('site', modules)
574
Christian Heimes25827622013-10-12 01:27:08 +0200575 # http://bugs.python.org/issue19205
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200576 re_mods = {'re', '_sre', 'sre_compile', 'sre_constants', 'sre_parse'}
Inada Naokic4d92c82019-05-05 18:06:30 +0900577 self.assertFalse(modules.intersection(re_mods), stderr)
578
Christian Heimes25827622013-10-12 01:27:08 +0200579 # http://bugs.python.org/issue9548
Christian Heimes179a3db2013-10-12 12:32:21 +0200580 self.assertNotIn('locale', modules, stderr)
Inada Naokic4d92c82019-05-05 18:06:30 +0900581
582 # http://bugs.python.org/issue19209
583 self.assertNotIn('copyreg', modules, stderr)
584
585 # http://bugs.python.org/issue19218
Christian Heimesf1dc3ee2013-10-13 02:04:20 +0200586 collection_mods = {'_collections', 'collections', 'functools',
587 'heapq', 'itertools', 'keyword', 'operator',
doko@ubuntu.com95743552014-04-15 20:37:54 +0200588 'reprlib', 'types', 'weakref'
589 }.difference(sys.builtin_module_names)
Ned Deilyc22bd582017-07-28 03:02:10 -0400590 self.assertFalse(modules.intersection(collection_mods), stderr)
Christian Heimes1a5fb4e2013-10-12 01:00:51 +0200591
Steve Dower6dd8eca2016-09-17 14:35:32 -0700592 def test_startup_interactivehook(self):
593 r = subprocess.Popen([sys.executable, '-c',
594 'import sys; sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
595 self.assertTrue(r, "'__interactivehook__' not added by site")
596
597 def test_startup_interactivehook_isolated(self):
598 # issue28192 readline is not automatically enabled in isolated mode
599 r = subprocess.Popen([sys.executable, '-I', '-c',
600 'import sys; sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
601 self.assertFalse(r, "'__interactivehook__' added in isolated mode")
602
603 def test_startup_interactivehook_isolated_explicit(self):
604 # issue28192 readline can be explicitly enabled in isolated mode
605 r = subprocess.Popen([sys.executable, '-I', '-c',
606 'import site, sys; site.enablerlcompleter(); sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
607 self.assertTrue(r, "'__interactivehook__' not added by enablerlcompleter()")
608
Zachary Wared48214f2017-05-14 15:49:46 -0500609@unittest.skipUnless(sys.platform == 'win32', "only supported on Windows")
610class _pthFileTests(unittest.TestCase):
611
Steve Dower936a6602020-07-15 22:56:49 +0100612 def _create_underpth_exe(self, lines, exe_pth=True):
613 import _winapi
Zachary Wared48214f2017-05-14 15:49:46 -0500614 temp_dir = tempfile.mkdtemp()
Hai Shi79bb2c92020-08-06 19:51:29 +0800615 self.addCleanup(os_helper.rmtree, temp_dir)
Zachary Wared48214f2017-05-14 15:49:46 -0500616 exe_file = os.path.join(temp_dir, os.path.split(sys.executable)[1])
Steve Dower936a6602020-07-15 22:56:49 +0100617 dll_src_file = _winapi.GetModuleFileName(sys.dllhandle)
618 dll_file = os.path.join(temp_dir, os.path.split(dll_src_file)[1])
Steve Dower1da055e2016-10-29 08:50:31 -0700619 shutil.copy(sys.executable, exe_file)
Steve Dower936a6602020-07-15 22:56:49 +0100620 shutil.copy(dll_src_file, dll_file)
621 if exe_pth:
622 _pth_file = os.path.splitext(exe_file)[0] + '._pth'
623 else:
624 _pth_file = os.path.splitext(dll_file)[0] + '._pth'
Zachary Wared48214f2017-05-14 15:49:46 -0500625 with open(_pth_file, 'w') as f:
626 for line in lines:
627 print(line, file=f)
628 return exe_file
Steve Dower1da055e2016-10-29 08:50:31 -0700629
Steve Dower5f9193a2017-02-04 15:19:29 -0800630 def _calc_sys_path_for_underpth_nosite(self, sys_prefix, lines):
631 sys_path = []
632 for line in lines:
633 if not line or line[0] == '#':
634 continue
635 abs_path = os.path.abspath(os.path.join(sys_prefix, line))
636 sys_path.append(abs_path)
637 return sys_path
638
Steve Dowerc6dd4152016-10-27 14:28:07 -0700639 def test_underpth_nosite_file(self):
Steve Dower1da055e2016-10-29 08:50:31 -0700640 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
641 exe_prefix = os.path.dirname(sys.executable)
Steve Dower5f9193a2017-02-04 15:19:29 -0800642 pth_lines = [
Steve Dower1da055e2016-10-29 08:50:31 -0700643 'fake-path-name',
644 *[libpath for _ in range(200)],
Steve Dower5f9193a2017-02-04 15:19:29 -0800645 '',
Steve Dower1da055e2016-10-29 08:50:31 -0700646 '# comment',
Steve Dower5f9193a2017-02-04 15:19:29 -0800647 ]
648 exe_file = self._create_underpth_exe(pth_lines)
649 sys_path = self._calc_sys_path_for_underpth_nosite(
650 os.path.dirname(exe_file),
651 pth_lines)
Steve Dowerc6dd4152016-10-27 14:28:07 -0700652
Zachary Wared48214f2017-05-14 15:49:46 -0500653 env = os.environ.copy()
654 env['PYTHONPATH'] = 'from-env'
655 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
Steve Dower9b33bf52017-05-23 16:25:25 -0700656 output = subprocess.check_output([exe_file, '-c',
657 'import sys; print("\\n".join(sys.path) if sys.flags.no_site else "")'
658 ], env=env, encoding='ansi')
659 actual_sys_path = output.rstrip().split('\n')
Serhiy Storchaka95c32622018-02-04 18:14:47 +0200660 self.assertTrue(actual_sys_path, "sys.flags.no_site was False")
Steve Dower9b33bf52017-05-23 16:25:25 -0700661 self.assertEqual(
662 actual_sys_path,
663 sys_path,
664 "sys.path is incorrect"
665 )
Steve Dowerc6dd4152016-10-27 14:28:07 -0700666
Steve Dowerc6dd4152016-10-27 14:28:07 -0700667 def test_underpth_file(self):
Steve Dower1da055e2016-10-29 08:50:31 -0700668 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
669 exe_prefix = os.path.dirname(sys.executable)
670 exe_file = self._create_underpth_exe([
671 'fake-path-name',
672 *[libpath for _ in range(200)],
Steve Dower5f9193a2017-02-04 15:19:29 -0800673 '',
Steve Dower1da055e2016-10-29 08:50:31 -0700674 '# comment',
675 'import site'
676 ])
Steve Dower5f9193a2017-02-04 15:19:29 -0800677 sys_prefix = os.path.dirname(exe_file)
Zachary Wared48214f2017-05-14 15:49:46 -0500678 env = os.environ.copy()
679 env['PYTHONPATH'] = 'from-env'
680 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
681 rc = subprocess.call([exe_file, '-c',
682 'import sys; sys.exit(not sys.flags.no_site and '
683 '%r in sys.path and %r in sys.path and %r not in sys.path and '
684 'all("\\r" not in p and "\\n" not in p for p in sys.path))' % (
685 os.path.join(sys_prefix, 'fake-path-name'),
686 libpath,
687 os.path.join(sys_prefix, 'from-env'),
688 )], env=env)
Steve Dower5f9193a2017-02-04 15:19:29 -0800689 self.assertTrue(rc, "sys.path is incorrect")
Steve Dowerc6dd4152016-10-27 14:28:07 -0700690
Steve Dower6dd8eca2016-09-17 14:35:32 -0700691
Steve Dower936a6602020-07-15 22:56:49 +0100692 def test_underpth_dll_file(self):
693 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
694 exe_prefix = os.path.dirname(sys.executable)
695 exe_file = self._create_underpth_exe([
696 'fake-path-name',
697 *[libpath for _ in range(200)],
698 '',
699 '# comment',
700 'import site'
701 ], exe_pth=False)
702 sys_prefix = os.path.dirname(exe_file)
703 env = os.environ.copy()
704 env['PYTHONPATH'] = 'from-env'
705 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
706 rc = subprocess.call([exe_file, '-c',
707 'import sys; sys.exit(not sys.flags.no_site and '
708 '%r in sys.path and %r in sys.path and %r not in sys.path and '
709 'all("\\r" not in p and "\\n" not in p for p in sys.path))' % (
710 os.path.join(sys_prefix, 'fake-path-name'),
711 libpath,
712 os.path.join(sys_prefix, 'from-env'),
713 )], env=env)
714 self.assertTrue(rc, "sys.path is incorrect")
715
716
Brett Cannon0096e262004-06-05 01:12:51 +0000717if __name__ == "__main__":
Brett Cannon3e9a9ae2013-06-12 21:25:59 -0400718 unittest.main()