blob: 97b5c5de95bbc2425cc15c02008be3aa4f01b90f [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
39OLD_SYS_PATH = None
40
41
42def setUpModule():
43 global OLD_SYS_PATH
44 OLD_SYS_PATH = sys.path[:]
45
46 if site.ENABLE_USER_SITE and not os.path.isdir(site.USER_SITE):
47 # need to add user site directory for tests
48 try:
49 os.makedirs(site.USER_SITE)
50 # modify sys.path: will be restored by tearDownModule()
51 site.addsitedir(site.USER_SITE)
52 except PermissionError as exc:
53 raise unittest.SkipTest('unable to create user site directory (%r): %s'
54 % (site.USER_SITE, exc))
55
56
57def tearDownModule():
58 sys.path[:] = OLD_SYS_PATH
Victor Stinner21d0e1b2016-03-14 17:47:03 +010059
Christian Heimes8dc226f2008-05-06 23:45:46 +000060
Brett Cannon0096e262004-06-05 01:12:51 +000061class HelperFunctionsTests(unittest.TestCase):
62 """Tests for helper functions.
Brett Cannon0096e262004-06-05 01:12:51 +000063 """
64
65 def setUp(self):
66 """Save a copy of sys.path"""
67 self.sys_path = sys.path[:]
Tarek Ziadé4a608c02009-08-20 21:28:05 +000068 self.old_base = site.USER_BASE
69 self.old_site = site.USER_SITE
70 self.old_prefixes = site.PREFIXES
Brett Cannon8ac95ee2012-04-04 17:31:16 -040071 self.original_vars = sysconfig._CONFIG_VARS
Tarek Ziadéedacea32010-01-29 11:41:03 +000072 self.old_vars = copy(sysconfig._CONFIG_VARS)
Brett Cannon0096e262004-06-05 01:12:51 +000073
Alexandre Vassalottie9f305f2008-05-16 04:39:54 +000074 def tearDown(self):
Brett Cannon0096e262004-06-05 01:12:51 +000075 """Restore sys.path"""
Nick Coghlan6ead5522009-10-18 13:19:33 +000076 sys.path[:] = self.sys_path
Tarek Ziadé4a608c02009-08-20 21:28:05 +000077 site.USER_BASE = self.old_base
78 site.USER_SITE = self.old_site
79 site.PREFIXES = self.old_prefixes
Brett Cannon8ac95ee2012-04-04 17:31:16 -040080 sysconfig._CONFIG_VARS = self.original_vars
81 sysconfig._CONFIG_VARS.clear()
82 sysconfig._CONFIG_VARS.update(self.old_vars)
Raymond Hettingerebd95222004-06-27 03:02:18 +000083
Brett Cannon0096e262004-06-05 01:12:51 +000084 def test_makepath(self):
85 # Test makepath() have an absolute path for its first return value
86 # and a case-normalized version of the absolute path for its
87 # second value.
88 path_parts = ("Beginning", "End")
89 original_dir = os.path.join(*path_parts)
90 abs_dir, norm_dir = site.makepath(*path_parts)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000091 self.assertEqual(os.path.abspath(original_dir), abs_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000092 if original_dir == os.path.normcase(original_dir):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000093 self.assertEqual(abs_dir, norm_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000094 else:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000095 self.assertEqual(os.path.normcase(abs_dir), norm_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000096
97 def test_init_pathinfo(self):
98 dir_set = site._init_pathinfo()
99 for entry in [site.makepath(path)[1] for path in sys.path
Brett Cannon5f0507d2016-04-08 15:04:28 -0700100 if path and os.path.exists(path)]:
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000101 self.assertIn(entry, dir_set,
102 "%s from sys.path not found in set returned "
103 "by _init_pathinfo(): %s" % (entry, dir_set))
Raymond Hettingerebd95222004-06-27 03:02:18 +0000104
Brett Cannonee86a662004-07-13 07:12:25 +0000105 def pth_file_tests(self, pth_file):
106 """Contain common code for testing results of reading a .pth file"""
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000107 self.assertIn(pth_file.imported, sys.modules,
108 "%s not in sys.modules" % pth_file.imported)
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000109 self.assertIn(site.makepath(pth_file.good_dir_path)[0], sys.path)
110 self.assertFalse(os.path.exists(pth_file.bad_dir_path))
Brett Cannonee86a662004-07-13 07:12:25 +0000111
Brett Cannon0096e262004-06-05 01:12:51 +0000112 def test_addpackage(self):
113 # Make sure addpackage() imports if the line starts with 'import',
Brett Cannon64a84702004-07-10 02:10:45 +0000114 # adds directories to sys.path for any line in the file that is not a
115 # comment or import that is a valid directory name for where the .pth
116 # file resides; invalid directories are not added
117 pth_file = PthFile()
Brett Cannonee86a662004-07-13 07:12:25 +0000118 pth_file.cleanup(prep=True) # to make sure that nothing is
119 # pre-existing that shouldn't be
Brett Cannon0096e262004-06-05 01:12:51 +0000120 try:
Brett Cannon64a84702004-07-10 02:10:45 +0000121 pth_file.create()
122 site.addpackage(pth_file.base_dir, pth_file.filename, set())
Brett Cannonee86a662004-07-13 07:12:25 +0000123 self.pth_file_tests(pth_file)
Brett Cannon0096e262004-06-05 01:12:51 +0000124 finally:
Brett Cannon64a84702004-07-10 02:10:45 +0000125 pth_file.cleanup()
Raymond Hettingerebd95222004-06-27 03:02:18 +0000126
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000127 def make_pth(self, contents, pth_dir='.', pth_name=TESTFN):
128 # Create a .pth file and return its (abspath, basename).
129 pth_dir = os.path.abspath(pth_dir)
130 pth_basename = pth_name + '.pth'
131 pth_fn = os.path.join(pth_dir, pth_basename)
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200132 with open(pth_fn, 'w', encoding='utf-8') as pth_file:
133 self.addCleanup(lambda: os.remove(pth_fn))
134 pth_file.write(contents)
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000135 return pth_dir, pth_basename
136
137 def test_addpackage_import_bad_syntax(self):
138 # Issue 10642
Serhiy Storchaka94cf3082018-12-17 17:34:14 +0200139 pth_dir, pth_fn = self.make_pth("import bad-syntax\n")
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000140 with captured_stderr() as err_out:
141 site.addpackage(pth_dir, pth_fn, set())
142 self.assertRegex(err_out.getvalue(), "line 1")
R. David Murrayab9d8d62010-12-27 00:03:13 +0000143 self.assertRegex(err_out.getvalue(),
144 re.escape(os.path.join(pth_dir, pth_fn)))
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000145 # XXX: the previous two should be independent checks so that the
146 # order doesn't matter. The next three could be a single check
147 # but my regex foo isn't good enough to write it.
148 self.assertRegex(err_out.getvalue(), 'Traceback')
Serhiy Storchaka94cf3082018-12-17 17:34:14 +0200149 self.assertRegex(err_out.getvalue(), r'import bad-syntax')
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000150 self.assertRegex(err_out.getvalue(), 'SyntaxError')
151
152 def test_addpackage_import_bad_exec(self):
153 # Issue 10642
154 pth_dir, pth_fn = self.make_pth("randompath\nimport nosuchmodule\n")
155 with captured_stderr() as err_out:
156 site.addpackage(pth_dir, pth_fn, set())
157 self.assertRegex(err_out.getvalue(), "line 2")
R. David Murrayab9d8d62010-12-27 00:03:13 +0000158 self.assertRegex(err_out.getvalue(),
159 re.escape(os.path.join(pth_dir, pth_fn)))
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000160 # XXX: ditto previous XXX comment.
161 self.assertRegex(err_out.getvalue(), 'Traceback')
Eric Snow46f97b82016-09-07 16:56:15 -0700162 self.assertRegex(err_out.getvalue(), 'ModuleNotFoundError')
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000163
164 def test_addpackage_import_bad_pth_file(self):
165 # Issue 5258
166 pth_dir, pth_fn = self.make_pth("abc\x00def\n")
167 with captured_stderr() as err_out:
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300168 self.assertFalse(site.addpackage(pth_dir, pth_fn, set()))
169 self.assertEqual(err_out.getvalue(), "")
170 for path in sys.path:
171 if isinstance(path, str):
172 self.assertNotIn("abc\x00def", path)
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000173
Brett Cannon0096e262004-06-05 01:12:51 +0000174 def test_addsitedir(self):
Brett Cannon64a84702004-07-10 02:10:45 +0000175 # Same tests for test_addpackage since addsitedir() essentially just
176 # calls addpackage() for every .pth file in the directory
177 pth_file = PthFile()
Brett Cannonee86a662004-07-13 07:12:25 +0000178 pth_file.cleanup(prep=True) # Make sure that nothing is pre-existing
179 # that is tested for
Brett Cannon0096e262004-06-05 01:12:51 +0000180 try:
Brett Cannonee86a662004-07-13 07:12:25 +0000181 pth_file.create()
Brett Cannon64a84702004-07-10 02:10:45 +0000182 site.addsitedir(pth_file.base_dir, set())
Brett Cannonee86a662004-07-13 07:12:25 +0000183 self.pth_file_tests(pth_file)
Brett Cannon0096e262004-06-05 01:12:51 +0000184 finally:
Brett Cannon64a84702004-07-10 02:10:45 +0000185 pth_file.cleanup()
Brett Cannon0096e262004-06-05 01:12:51 +0000186
native-api45d8d242019-03-03 19:05:19 +0300187 # This tests _getuserbase, hence the double underline
188 # to distinguish from a test for getuserbase
189 def test__getuserbase(self):
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900190 self.assertEqual(site._getuserbase(), sysconfig._getuserbase())
191
192 def test_get_path(self):
INADA Naokiba9ddb72017-07-28 21:28:19 +0900193 if sys.platform == 'darwin' and sys._framework:
194 scheme = 'osx_framework_user'
195 else:
196 scheme = os.name + '_user'
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900197 self.assertEqual(site._get_path(site._getuserbase()),
INADA Naokiba9ddb72017-07-28 21:28:19 +0900198 sysconfig.get_path('purelib', scheme))
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900199
Ned Deily316f5732011-10-31 16:16:35 -0700200 @unittest.skipUnless(site.ENABLE_USER_SITE, "requires access to PEP 370 "
201 "user-site (site.ENABLE_USER_SITE)")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000202 def test_s_option(self):
Eric Snow6b4be192017-05-22 21:36:03 -0700203 # (ncoghlan) Change this to use script_helper...
Christian Heimes8dc226f2008-05-06 23:45:46 +0000204 usersite = site.USER_SITE
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000205 self.assertIn(usersite, sys.path)
Christian Heimes8dc226f2008-05-06 23:45:46 +0000206
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000207 env = os.environ.copy()
Christian Heimes8dc226f2008-05-06 23:45:46 +0000208 rc = subprocess.call([sys.executable, '-c',
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000209 'import sys; sys.exit(%r in sys.path)' % usersite],
210 env=env)
Christian Heimes8dc226f2008-05-06 23:45:46 +0000211 self.assertEqual(rc, 1)
212
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000213 env = os.environ.copy()
Christian Heimes8dc226f2008-05-06 23:45:46 +0000214 rc = subprocess.call([sys.executable, '-s', '-c',
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000215 'import sys; sys.exit(%r in sys.path)' % usersite],
216 env=env)
Antoine Pitroua1782e12013-10-23 22:03:22 +0200217 if usersite == site.getsitepackages()[0]:
218 self.assertEqual(rc, 1)
219 else:
Eric Snow6b4be192017-05-22 21:36:03 -0700220 self.assertEqual(rc, 0, "User site still added to path with -s")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000221
222 env = os.environ.copy()
223 env["PYTHONNOUSERSITE"] = "1"
224 rc = subprocess.call([sys.executable, '-c',
Benjamin Petersonfea6a942008-07-02 16:11:42 +0000225 'import sys; sys.exit(%r in sys.path)' % usersite],
Christian Heimes8dc226f2008-05-06 23:45:46 +0000226 env=env)
Antoine Pitroua1782e12013-10-23 22:03:22 +0200227 if usersite == site.getsitepackages()[0]:
228 self.assertEqual(rc, 1)
229 else:
Eric Snow6b4be192017-05-22 21:36:03 -0700230 self.assertEqual(rc, 0,
231 "User site still added to path with PYTHONNOUSERSITE")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000232
233 env = os.environ.copy()
234 env["PYTHONUSERBASE"] = "/tmp"
235 rc = subprocess.call([sys.executable, '-c',
236 'import sys, site; sys.exit(site.USER_BASE.startswith("/tmp"))'],
237 env=env)
Eric Snow6b4be192017-05-22 21:36:03 -0700238 self.assertEqual(rc, 1,
239 "User base not set by PYTHONUSERBASE")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000240
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000241 def test_getuserbase(self):
242 site.USER_BASE = None
243 user_base = site.getuserbase()
244
245 # the call sets site.USER_BASE
Ezio Melottib3aedd42010-11-20 19:04:17 +0000246 self.assertEqual(site.USER_BASE, user_base)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000247
248 # let's set PYTHONUSERBASE and see if it uses it
249 site.USER_BASE = None
Tarek Ziadéedacea32010-01-29 11:41:03 +0000250 import sysconfig
251 sysconfig._CONFIG_VARS = None
252
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000253 with EnvironmentVarGuard() as environ:
254 environ['PYTHONUSERBASE'] = 'xoxo'
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000255 self.assertTrue(site.getuserbase().startswith('xoxo'),
256 site.getuserbase())
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000257
258 def test_getusersitepackages(self):
259 site.USER_SITE = None
260 site.USER_BASE = None
261 user_site = site.getusersitepackages()
262
263 # the call sets USER_BASE *and* USER_SITE
Ezio Melottib3aedd42010-11-20 19:04:17 +0000264 self.assertEqual(site.USER_SITE, user_site)
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000265 self.assertTrue(user_site.startswith(site.USER_BASE), user_site)
Victor Stinnerf2f45552018-12-05 16:49:35 +0100266 self.assertEqual(site.USER_BASE, site.getuserbase())
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000267
268 def test_getsitepackages(self):
269 site.PREFIXES = ['xoxo']
270 dirs = site.getsitepackages()
Ned Deily763f0942018-01-30 05:14:09 -0500271 if os.sep == '/':
272 # OS X, Linux, FreeBSD, etc
Victor Stinner8510f432020-03-10 09:53:09 +0100273 if sys.platlibdir != "lib":
274 self.assertEqual(len(dirs), 2)
275 wanted = os.path.join('xoxo', sys.platlibdir,
276 'python%d.%d' % sys.version_info[:2],
277 'site-packages')
278 self.assertEqual(dirs[0], wanted)
279 else:
280 self.assertEqual(len(dirs), 1)
Serhiy Storchaka885bdc42016-02-11 13:10:36 +0200281 wanted = os.path.join('xoxo', 'lib',
282 'python%d.%d' % sys.version_info[:2],
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000283 'site-packages')
Victor Stinner8510f432020-03-10 09:53:09 +0100284 self.assertEqual(dirs[-1], wanted)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000285 else:
Ned Deilyd531b292012-02-06 00:58:18 +0100286 # other platforms
Ezio Melottifc8b2052010-08-17 08:35:41 +0000287 self.assertEqual(len(dirs), 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000288 self.assertEqual(dirs[0], 'xoxo')
Tarek Ziadé8c0e2172009-10-27 21:24:21 +0000289 wanted = os.path.join('xoxo', 'lib', 'site-packages')
Ezio Melottib3aedd42010-11-20 19:04:17 +0000290 self.assertEqual(dirs[1], wanted)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000291
Victor Stinnerf2f45552018-12-05 16:49:35 +0100292 def test_no_home_directory(self):
293 # bpo-10496: getuserbase() and getusersitepackages() must not fail if
294 # the current user has no home directory (if expanduser() returns the
295 # path unchanged).
296 site.USER_SITE = None
297 site.USER_BASE = None
298
299 with EnvironmentVarGuard() as environ, \
300 mock.patch('os.path.expanduser', lambda path: path):
301
302 del environ['PYTHONUSERBASE']
303 del environ['APPDATA']
304
305 user_base = site.getuserbase()
306 self.assertTrue(user_base.startswith('~' + os.sep),
307 user_base)
308
309 user_site = site.getusersitepackages()
310 self.assertTrue(user_site.startswith(user_base), user_site)
311
312 with mock.patch('os.path.isdir', return_value=False) as mock_isdir, \
313 mock.patch.object(site, 'addsitedir') as mock_addsitedir, \
314 support.swap_attr(site, 'ENABLE_USER_SITE', True):
315
316 # addusersitepackages() must not add user_site to sys.path
317 # if it is not an existing directory
318 known_paths = set()
319 site.addusersitepackages(known_paths)
320
321 mock_isdir.assert_called_once_with(user_site)
322 mock_addsitedir.assert_not_called()
323 self.assertFalse(known_paths)
324
native-api2145c8c2020-06-12 09:20:11 +0300325 def test_trace(self):
326 message = "bla-bla-bla"
327 for verbose, out in (True, message + "\n"), (False, ""):
328 with mock.patch('sys.flags', mock.Mock(verbose=verbose)), \
329 mock.patch('sys.stderr', io.StringIO()):
330 site._trace(message)
331 self.assertEqual(sys.stderr.getvalue(), out)
332
Victor Stinnerf2f45552018-12-05 16:49:35 +0100333
Brett Cannon64a84702004-07-10 02:10:45 +0000334class PthFile(object):
335 """Helper class for handling testing of .pth files"""
Brett Cannon0096e262004-06-05 01:12:51 +0000336
Brett Cannon64a84702004-07-10 02:10:45 +0000337 def __init__(self, filename_base=TESTFN, imported="time",
338 good_dirname="__testdir__", bad_dirname="__bad"):
339 """Initialize instance variables"""
340 self.filename = filename_base + ".pth"
341 self.base_dir = os.path.abspath('')
342 self.file_path = os.path.join(self.base_dir, self.filename)
Brett Cannonee86a662004-07-13 07:12:25 +0000343 self.imported = imported
Brett Cannon64a84702004-07-10 02:10:45 +0000344 self.good_dirname = good_dirname
345 self.bad_dirname = bad_dirname
346 self.good_dir_path = os.path.join(self.base_dir, self.good_dirname)
347 self.bad_dir_path = os.path.join(self.base_dir, self.bad_dirname)
Brett Cannon0096e262004-06-05 01:12:51 +0000348
Brett Cannon64a84702004-07-10 02:10:45 +0000349 def create(self):
350 """Create a .pth file with a comment, blank lines, an ``import
351 <self.imported>``, a line with self.good_dirname, and a line with
352 self.bad_dirname.
Tim Peters182b5ac2004-07-18 06:16:08 +0000353
Brett Cannon64a84702004-07-10 02:10:45 +0000354 Creation of the directory for self.good_dir_path (based off of
355 self.good_dirname) is also performed.
Brett Cannon0096e262004-06-05 01:12:51 +0000356
Brett Cannon64a84702004-07-10 02:10:45 +0000357 Make sure to call self.cleanup() to undo anything done by this method.
Tim Peters182b5ac2004-07-18 06:16:08 +0000358
Brett Cannon64a84702004-07-10 02:10:45 +0000359 """
Michael W. Hudsonff522862005-05-27 14:58:06 +0000360 FILE = open(self.file_path, 'w')
Brett Cannon64a84702004-07-10 02:10:45 +0000361 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000362 print("#import @bad module name", file=FILE)
363 print("\n", file=FILE)
364 print("import %s" % self.imported, file=FILE)
365 print(self.good_dirname, file=FILE)
366 print(self.bad_dirname, file=FILE)
Brett Cannon64a84702004-07-10 02:10:45 +0000367 finally:
368 FILE.close()
369 os.mkdir(self.good_dir_path)
370
Brett Cannonee86a662004-07-13 07:12:25 +0000371 def cleanup(self, prep=False):
Brett Cannon64a84702004-07-10 02:10:45 +0000372 """Make sure that the .pth file is deleted, self.imported is not in
373 sys.modules, and that both self.good_dirname and self.bad_dirname are
374 not existing directories."""
Brett Cannonee86a662004-07-13 07:12:25 +0000375 if os.path.exists(self.file_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000376 os.remove(self.file_path)
Brett Cannonee86a662004-07-13 07:12:25 +0000377 if prep:
378 self.imported_module = sys.modules.get(self.imported)
379 if self.imported_module:
380 del sys.modules[self.imported]
381 else:
382 if self.imported_module:
383 sys.modules[self.imported] = self.imported_module
384 if os.path.exists(self.good_dir_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000385 os.rmdir(self.good_dir_path)
Brett Cannonee86a662004-07-13 07:12:25 +0000386 if os.path.exists(self.bad_dir_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000387 os.rmdir(self.bad_dir_path)
Brett Cannon0096e262004-06-05 01:12:51 +0000388
389class ImportSideEffectTests(unittest.TestCase):
390 """Test side-effects from importing 'site'."""
391
392 def setUp(self):
393 """Make a copy of sys.path"""
394 self.sys_path = sys.path[:]
395
396 def tearDown(self):
397 """Restore sys.path"""
Nick Coghlan6ead5522009-10-18 13:19:33 +0000398 sys.path[:] = self.sys_path
Brett Cannon0096e262004-06-05 01:12:51 +0000399
Barry Warsaw28a691b2010-04-17 00:19:56 +0000400 def test_abs_paths(self):
401 # Make sure all imported modules have their __file__ and __cached__
402 # attributes as absolute paths. Arranging to put the Lib directory on
403 # PYTHONPATH would cause the os module to have a relative path for
404 # __file__ if abs_paths() does not get run. sys and builtins (the
405 # only other modules imported before site.py runs) do not have
406 # __file__ or __cached__ because they are built-in.
Steve Dowerf14c28f2018-09-20 13:38:34 -0700407 try:
408 parent = os.path.relpath(os.path.dirname(os.__file__))
409 cwd = os.getcwd()
410 except ValueError:
411 # Failure to get relpath probably means we need to chdir
412 # to the same drive.
413 cwd, parent = os.path.split(os.path.dirname(os.__file__))
414 with change_cwd(cwd):
415 env = os.environ.copy()
416 env['PYTHONPATH'] = parent
417 code = ('import os, sys',
418 # use ASCII to avoid locale issues with non-ASCII directories
419 'os_file = os.__file__.encode("ascii", "backslashreplace")',
420 r'sys.stdout.buffer.write(os_file + b"\n")',
421 'os_cached = os.__cached__.encode("ascii", "backslashreplace")',
422 r'sys.stdout.buffer.write(os_cached + b"\n")')
423 command = '\n'.join(code)
424 # First, prove that with -S (no 'import site'), the paths are
425 # relative.
426 proc = subprocess.Popen([sys.executable, '-S', '-c', command],
427 env=env,
428 stdout=subprocess.PIPE)
429 stdout, stderr = proc.communicate()
Victor Stinnerf3bc2582010-04-18 07:59:53 +0000430
Steve Dowerf14c28f2018-09-20 13:38:34 -0700431 self.assertEqual(proc.returncode, 0)
432 os__file__, os__cached__ = stdout.splitlines()[:2]
433 self.assertFalse(os.path.isabs(os__file__))
434 self.assertFalse(os.path.isabs(os__cached__))
435 # Now, with 'import site', it works.
436 proc = subprocess.Popen([sys.executable, '-c', command],
437 env=env,
438 stdout=subprocess.PIPE)
439 stdout, stderr = proc.communicate()
440 self.assertEqual(proc.returncode, 0)
441 os__file__, os__cached__ = stdout.splitlines()[:2]
442 self.assertTrue(os.path.isabs(os__file__),
443 "expected absolute path, got {}"
444 .format(os__file__.decode('ascii')))
445 self.assertTrue(os.path.isabs(os__cached__),
446 "expected absolute path, got {}"
447 .format(os__cached__.decode('ascii')))
Brett Cannon0096e262004-06-05 01:12:51 +0000448
INADA Naokid4c76d92018-10-01 21:10:37 +0900449 def test_abs_paths_cached_None(self):
450 """Test for __cached__ is None.
451
452 Regarding to PEP 3147, __cached__ can be None.
453
454 See also: https://bugs.python.org/issue30167
455 """
456 sys.modules['test'].__cached__ = None
457 site.abs_paths()
458 self.assertIsNone(sys.modules['test'].__cached__)
459
Brett Cannon0096e262004-06-05 01:12:51 +0000460 def test_no_duplicate_paths(self):
461 # No duplicate paths should exist in sys.path
462 # Handled by removeduppaths()
463 site.removeduppaths()
464 seen_paths = set()
465 for path in sys.path:
Benjamin Peterson577473f2010-01-19 00:09:57 +0000466 self.assertNotIn(path, seen_paths)
Brett Cannon0096e262004-06-05 01:12:51 +0000467 seen_paths.add(path)
468
Zachary Ware9fe6d862013-12-08 00:20:35 -0600469 @unittest.skip('test not implemented')
Brett Cannon0096e262004-06-05 01:12:51 +0000470 def test_add_build_dir(self):
471 # Test that the build directory's Modules directory is used when it
472 # should be.
473 # XXX: implement
474 pass
475
Brett Cannon0096e262004-06-05 01:12:51 +0000476 def test_setting_quit(self):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000477 # 'quit' and 'exit' should be injected into builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000478 self.assertTrue(hasattr(builtins, "quit"))
479 self.assertTrue(hasattr(builtins, "exit"))
Brett Cannon0096e262004-06-05 01:12:51 +0000480
481 def test_setting_copyright(self):
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700482 # 'copyright', 'credits', and 'license' should be in builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000483 self.assertTrue(hasattr(builtins, "copyright"))
484 self.assertTrue(hasattr(builtins, "credits"))
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700485 self.assertTrue(hasattr(builtins, "license"))
Brett Cannon0096e262004-06-05 01:12:51 +0000486
487 def test_setting_help(self):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000488 # 'help' should be set in builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000489 self.assertTrue(hasattr(builtins, "help"))
Brett Cannon0096e262004-06-05 01:12:51 +0000490
491 def test_aliasing_mbcs(self):
492 if sys.platform == "win32":
493 import locale
494 if locale.getdefaultlocale()[1].startswith('cp'):
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000495 for value in encodings.aliases.aliases.values():
Brett Cannon0096e262004-06-05 01:12:51 +0000496 if value == "mbcs":
497 break
498 else:
499 self.fail("did not alias mbcs")
500
Brett Cannon0096e262004-06-05 01:12:51 +0000501 def test_sitecustomize_executed(self):
502 # If sitecustomize is available, it should have been imported.
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000503 if "sitecustomize" not in sys.modules:
Brett Cannon0096e262004-06-05 01:12:51 +0000504 try:
505 import sitecustomize
506 except ImportError:
507 pass
508 else:
509 self.fail("sitecustomize not imported automatically")
510
R David Murray1bc6ceb2013-09-14 13:28:37 -0400511 @test.support.requires_resource('network')
Benjamin Peterson337578b2015-02-01 20:16:59 -0500512 @test.support.system_must_validate_cert
Georg Brandl78abc9d2013-10-27 09:41:57 +0100513 @unittest.skipUnless(sys.version_info[3] == 'final',
514 'only for released versions')
Ned Deily5a507f02014-03-26 23:31:39 -0700515 @unittest.skipUnless(hasattr(urllib.request, "HTTPSHandler"),
516 'need SSL support to download license')
R David Murray1bc6ceb2013-09-14 13:28:37 -0400517 def test_license_exists_at_url(self):
Ned Deily944d5972014-03-26 23:43:26 -0700518 # This test is a bit fragile since it depends on the format of the
R David Murray1bc6ceb2013-09-14 13:28:37 -0400519 # string displayed by license in the absence of a LICENSE file.
520 url = license._Printer__data.split()[1]
521 req = urllib.request.Request(url, method='HEAD')
522 try:
Serhiy Storchakabfb1cf42020-04-29 10:36:20 +0300523 with socket_helper.transient_internet(url):
R David Murray1bc6ceb2013-09-14 13:28:37 -0400524 with urllib.request.urlopen(req) as data:
525 code = data.getcode()
526 except urllib.error.HTTPError as e:
527 code = e.code
528 self.assertEqual(code, 200, msg="Can't find " + url)
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700529
Brett Cannon0096e262004-06-05 01:12:51 +0000530
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200531class StartupImportTests(unittest.TestCase):
532
533 def test_startup_imports(self):
Victor Stinnerd18de462020-03-18 18:27:32 +0100534 # Get sys.path in isolated mode (python3 -I)
535 popen = subprocess.Popen([sys.executable, '-I', '-c',
536 'import sys; print(repr(sys.path))'],
537 stdout=subprocess.PIPE,
538 encoding='utf-8')
539 stdout = popen.communicate()[0]
540 self.assertEqual(popen.returncode, 0, repr(stdout))
541 isolated_paths = eval(stdout)
542
543 # bpo-27807: Even with -I, the site module executes all .pth files
544 # found in sys.path (see site.addpackage()). Skip the test if at least
545 # one .pth file is found.
546 for path in isolated_paths:
Serhiy Storchaka93558682020-06-20 11:10:31 +0300547 pth_files = glob.glob(os.path.join(glob.escape(path), "*.pth"))
Victor Stinnerd18de462020-03-18 18:27:32 +0100548 if pth_files:
549 self.skipTest(f"found {len(pth_files)} .pth files in: {path}")
550
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200551 # This tests checks which modules are loaded by Python when it
552 # initially starts upon startup.
Christian Heimes179a3db2013-10-12 12:32:21 +0200553 popen = subprocess.Popen([sys.executable, '-I', '-v', '-c',
554 'import sys; print(set(sys.modules))'],
555 stdout=subprocess.PIPE,
Steve Dower313523c2016-09-17 12:22:41 -0700556 stderr=subprocess.PIPE,
557 encoding='utf-8')
Christian Heimes179a3db2013-10-12 12:32:21 +0200558 stdout, stderr = popen.communicate()
Victor Stinnerd18de462020-03-18 18:27:32 +0100559 self.assertEqual(popen.returncode, 0, (stdout, stderr))
Christian Heimes179a3db2013-10-12 12:32:21 +0200560 modules = eval(stdout)
561
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200562 self.assertIn('site', modules)
563
Christian Heimes25827622013-10-12 01:27:08 +0200564 # http://bugs.python.org/issue19205
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200565 re_mods = {'re', '_sre', 'sre_compile', 'sre_constants', 'sre_parse'}
Inada Naokic4d92c82019-05-05 18:06:30 +0900566 self.assertFalse(modules.intersection(re_mods), stderr)
567
Christian Heimes25827622013-10-12 01:27:08 +0200568 # http://bugs.python.org/issue9548
Christian Heimes179a3db2013-10-12 12:32:21 +0200569 self.assertNotIn('locale', modules, stderr)
Inada Naokic4d92c82019-05-05 18:06:30 +0900570
571 # http://bugs.python.org/issue19209
572 self.assertNotIn('copyreg', modules, stderr)
573
574 # http://bugs.python.org/issue19218
Christian Heimesf1dc3ee2013-10-13 02:04:20 +0200575 collection_mods = {'_collections', 'collections', 'functools',
576 'heapq', 'itertools', 'keyword', 'operator',
doko@ubuntu.com95743552014-04-15 20:37:54 +0200577 'reprlib', 'types', 'weakref'
578 }.difference(sys.builtin_module_names)
Ned Deilyc22bd582017-07-28 03:02:10 -0400579 self.assertFalse(modules.intersection(collection_mods), stderr)
Christian Heimes1a5fb4e2013-10-12 01:00:51 +0200580
Steve Dower6dd8eca2016-09-17 14:35:32 -0700581 def test_startup_interactivehook(self):
582 r = subprocess.Popen([sys.executable, '-c',
583 'import sys; sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
584 self.assertTrue(r, "'__interactivehook__' not added by site")
585
586 def test_startup_interactivehook_isolated(self):
587 # issue28192 readline is not automatically enabled in isolated mode
588 r = subprocess.Popen([sys.executable, '-I', '-c',
589 'import sys; sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
590 self.assertFalse(r, "'__interactivehook__' added in isolated mode")
591
592 def test_startup_interactivehook_isolated_explicit(self):
593 # issue28192 readline can be explicitly enabled in isolated mode
594 r = subprocess.Popen([sys.executable, '-I', '-c',
595 'import site, sys; site.enablerlcompleter(); sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
596 self.assertTrue(r, "'__interactivehook__' not added by enablerlcompleter()")
597
Zachary Wared48214f2017-05-14 15:49:46 -0500598
599@unittest.skipUnless(sys.platform == 'win32', "only supported on Windows")
600class _pthFileTests(unittest.TestCase):
601
Steve Dower936a6602020-07-15 22:56:49 +0100602 def _create_underpth_exe(self, lines, exe_pth=True):
603 import _winapi
Zachary Wared48214f2017-05-14 15:49:46 -0500604 temp_dir = tempfile.mkdtemp()
Hai Shi79bb2c92020-08-06 19:51:29 +0800605 self.addCleanup(os_helper.rmtree, temp_dir)
Zachary Wared48214f2017-05-14 15:49:46 -0500606 exe_file = os.path.join(temp_dir, os.path.split(sys.executable)[1])
Steve Dower936a6602020-07-15 22:56:49 +0100607 dll_src_file = _winapi.GetModuleFileName(sys.dllhandle)
608 dll_file = os.path.join(temp_dir, os.path.split(dll_src_file)[1])
Steve Dower1da055e2016-10-29 08:50:31 -0700609 shutil.copy(sys.executable, exe_file)
Steve Dower936a6602020-07-15 22:56:49 +0100610 shutil.copy(dll_src_file, dll_file)
611 if exe_pth:
612 _pth_file = os.path.splitext(exe_file)[0] + '._pth'
613 else:
614 _pth_file = os.path.splitext(dll_file)[0] + '._pth'
Zachary Wared48214f2017-05-14 15:49:46 -0500615 with open(_pth_file, 'w') as f:
616 for line in lines:
617 print(line, file=f)
618 return exe_file
Steve Dower1da055e2016-10-29 08:50:31 -0700619
Steve Dower5f9193a2017-02-04 15:19:29 -0800620 def _calc_sys_path_for_underpth_nosite(self, sys_prefix, lines):
621 sys_path = []
622 for line in lines:
623 if not line or line[0] == '#':
624 continue
625 abs_path = os.path.abspath(os.path.join(sys_prefix, line))
626 sys_path.append(abs_path)
627 return sys_path
628
Steve Dowerc6dd4152016-10-27 14:28:07 -0700629 def test_underpth_nosite_file(self):
Steve Dower1da055e2016-10-29 08:50:31 -0700630 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
631 exe_prefix = os.path.dirname(sys.executable)
Steve Dower5f9193a2017-02-04 15:19:29 -0800632 pth_lines = [
Steve Dower1da055e2016-10-29 08:50:31 -0700633 'fake-path-name',
634 *[libpath for _ in range(200)],
Steve Dower5f9193a2017-02-04 15:19:29 -0800635 '',
Steve Dower1da055e2016-10-29 08:50:31 -0700636 '# comment',
Steve Dower5f9193a2017-02-04 15:19:29 -0800637 ]
638 exe_file = self._create_underpth_exe(pth_lines)
639 sys_path = self._calc_sys_path_for_underpth_nosite(
640 os.path.dirname(exe_file),
641 pth_lines)
Steve Dowerc6dd4152016-10-27 14:28:07 -0700642
Zachary Wared48214f2017-05-14 15:49:46 -0500643 env = os.environ.copy()
644 env['PYTHONPATH'] = 'from-env'
645 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
Steve Dower9b33bf52017-05-23 16:25:25 -0700646 output = subprocess.check_output([exe_file, '-c',
647 'import sys; print("\\n".join(sys.path) if sys.flags.no_site else "")'
648 ], env=env, encoding='ansi')
649 actual_sys_path = output.rstrip().split('\n')
Serhiy Storchaka95c32622018-02-04 18:14:47 +0200650 self.assertTrue(actual_sys_path, "sys.flags.no_site was False")
Steve Dower9b33bf52017-05-23 16:25:25 -0700651 self.assertEqual(
652 actual_sys_path,
653 sys_path,
654 "sys.path is incorrect"
655 )
Steve Dowerc6dd4152016-10-27 14:28:07 -0700656
Steve Dowerc6dd4152016-10-27 14:28:07 -0700657 def test_underpth_file(self):
Steve Dower1da055e2016-10-29 08:50:31 -0700658 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
659 exe_prefix = os.path.dirname(sys.executable)
660 exe_file = self._create_underpth_exe([
661 'fake-path-name',
662 *[libpath for _ in range(200)],
Steve Dower5f9193a2017-02-04 15:19:29 -0800663 '',
Steve Dower1da055e2016-10-29 08:50:31 -0700664 '# comment',
665 'import site'
666 ])
Steve Dower5f9193a2017-02-04 15:19:29 -0800667 sys_prefix = os.path.dirname(exe_file)
Zachary Wared48214f2017-05-14 15:49:46 -0500668 env = os.environ.copy()
669 env['PYTHONPATH'] = 'from-env'
670 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
671 rc = subprocess.call([exe_file, '-c',
672 'import sys; sys.exit(not sys.flags.no_site and '
673 '%r in sys.path and %r in sys.path and %r not in sys.path and '
674 'all("\\r" not in p and "\\n" not in p for p in sys.path))' % (
675 os.path.join(sys_prefix, 'fake-path-name'),
676 libpath,
677 os.path.join(sys_prefix, 'from-env'),
678 )], env=env)
Steve Dower5f9193a2017-02-04 15:19:29 -0800679 self.assertTrue(rc, "sys.path is incorrect")
Steve Dowerc6dd4152016-10-27 14:28:07 -0700680
Steve Dower6dd8eca2016-09-17 14:35:32 -0700681
Steve Dower936a6602020-07-15 22:56:49 +0100682 def test_underpth_dll_file(self):
683 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
684 exe_prefix = os.path.dirname(sys.executable)
685 exe_file = self._create_underpth_exe([
686 'fake-path-name',
687 *[libpath for _ in range(200)],
688 '',
689 '# comment',
690 'import site'
691 ], exe_pth=False)
692 sys_prefix = os.path.dirname(exe_file)
693 env = os.environ.copy()
694 env['PYTHONPATH'] = 'from-env'
695 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
696 rc = subprocess.call([exe_file, '-c',
697 'import sys; sys.exit(not sys.flags.no_site and '
698 '%r in sys.path and %r in sys.path and %r not in sys.path and '
699 'all("\\r" not in p and "\\n" not in p for p in sys.path))' % (
700 os.path.join(sys_prefix, 'fake-path-name'),
701 libpath,
702 os.path.join(sys_prefix, 'from-env'),
703 )], env=env)
704 self.assertTrue(rc, "sys.path is incorrect")
705
706
Brett Cannon0096e262004-06-05 01:12:51 +0000707if __name__ == "__main__":
Brett Cannon3e9a9ae2013-06-12 21:25:59 -0400708 unittest.main()