blob: 9f4a8bc64f7eee14cb16030b806f2489c328ae13 [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
Serhiy Storchakabfb1cf42020-04-29 10:36:20 +030010from test.support import socket_helper
Steve Dowerf14c28f2018-09-20 13:38:34 -070011from test.support import (captured_stderr, TESTFN, EnvironmentVarGuard,
12 change_cwd)
Georg Brandl1a3284e2007-12-02 09:40:06 +000013import builtins
Brett Cannon0096e262004-06-05 01:12:51 +000014import encodings
Victor Stinnerd18de462020-03-18 18:27:32 +010015import glob
native-api2145c8c2020-06-12 09:20:11 +030016import io
Victor Stinnerd18de462020-03-18 18:27:32 +010017import os
18import re
Steve Dower1da055e2016-10-29 08:50:31 -070019import shutil
Christian Heimes8dc226f2008-05-06 23:45:46 +000020import subprocess
Victor Stinnerd18de462020-03-18 18:27:32 +010021import sys
Tarek Ziadéedacea32010-01-29 11:41:03 +000022import sysconfig
Zachary Wared48214f2017-05-14 15:49:46 -050023import tempfile
Victor Stinnerd18de462020-03-18 18:27:32 +010024import urllib.error
25import urllib.request
Victor Stinnerf2f45552018-12-05 16:49:35 +010026from unittest import mock
Tarek Ziadéedacea32010-01-29 11:41:03 +000027from copy import copy
28
Zachary Ware36193e72013-12-11 16:59:44 -060029# These tests are not particularly useful if Python was invoked with -S.
30# If you add tests that are useful under -S, this skip should be moved
31# to the class level.
32if sys.flags.no_site:
33 raise unittest.SkipTest("Python was invoked with -S")
34
35import site
Brett Cannon0096e262004-06-05 01:12:51 +000036
Victor Stinnerb85c1362017-04-20 13:39:39 +020037
38OLD_SYS_PATH = None
39
40
41def setUpModule():
42 global OLD_SYS_PATH
43 OLD_SYS_PATH = sys.path[:]
44
45 if site.ENABLE_USER_SITE and not os.path.isdir(site.USER_SITE):
46 # need to add user site directory for tests
47 try:
48 os.makedirs(site.USER_SITE)
49 # modify sys.path: will be restored by tearDownModule()
50 site.addsitedir(site.USER_SITE)
51 except PermissionError as exc:
52 raise unittest.SkipTest('unable to create user site directory (%r): %s'
53 % (site.USER_SITE, exc))
54
55
56def tearDownModule():
57 sys.path[:] = OLD_SYS_PATH
Victor Stinner21d0e1b2016-03-14 17:47:03 +010058
Christian Heimes8dc226f2008-05-06 23:45:46 +000059
Brett Cannon0096e262004-06-05 01:12:51 +000060class HelperFunctionsTests(unittest.TestCase):
61 """Tests for helper functions.
Brett Cannon0096e262004-06-05 01:12:51 +000062 """
63
64 def setUp(self):
65 """Save a copy of sys.path"""
66 self.sys_path = sys.path[:]
Tarek Ziadé4a608c02009-08-20 21:28:05 +000067 self.old_base = site.USER_BASE
68 self.old_site = site.USER_SITE
69 self.old_prefixes = site.PREFIXES
Brett Cannon8ac95ee2012-04-04 17:31:16 -040070 self.original_vars = sysconfig._CONFIG_VARS
Tarek Ziadéedacea32010-01-29 11:41:03 +000071 self.old_vars = copy(sysconfig._CONFIG_VARS)
Brett Cannon0096e262004-06-05 01:12:51 +000072
Alexandre Vassalottie9f305f2008-05-16 04:39:54 +000073 def tearDown(self):
Brett Cannon0096e262004-06-05 01:12:51 +000074 """Restore sys.path"""
Nick Coghlan6ead5522009-10-18 13:19:33 +000075 sys.path[:] = self.sys_path
Tarek Ziadé4a608c02009-08-20 21:28:05 +000076 site.USER_BASE = self.old_base
77 site.USER_SITE = self.old_site
78 site.PREFIXES = self.old_prefixes
Brett Cannon8ac95ee2012-04-04 17:31:16 -040079 sysconfig._CONFIG_VARS = self.original_vars
80 sysconfig._CONFIG_VARS.clear()
81 sysconfig._CONFIG_VARS.update(self.old_vars)
Raymond Hettingerebd95222004-06-27 03:02:18 +000082
Brett Cannon0096e262004-06-05 01:12:51 +000083 def test_makepath(self):
84 # Test makepath() have an absolute path for its first return value
85 # and a case-normalized version of the absolute path for its
86 # second value.
87 path_parts = ("Beginning", "End")
88 original_dir = os.path.join(*path_parts)
89 abs_dir, norm_dir = site.makepath(*path_parts)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000090 self.assertEqual(os.path.abspath(original_dir), abs_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000091 if original_dir == os.path.normcase(original_dir):
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000092 self.assertEqual(abs_dir, norm_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000093 else:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000094 self.assertEqual(os.path.normcase(abs_dir), norm_dir)
Brett Cannon0096e262004-06-05 01:12:51 +000095
96 def test_init_pathinfo(self):
97 dir_set = site._init_pathinfo()
98 for entry in [site.makepath(path)[1] for path in sys.path
Brett Cannon5f0507d2016-04-08 15:04:28 -070099 if path and os.path.exists(path)]:
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000100 self.assertIn(entry, dir_set,
101 "%s from sys.path not found in set returned "
102 "by _init_pathinfo(): %s" % (entry, dir_set))
Raymond Hettingerebd95222004-06-27 03:02:18 +0000103
Brett Cannonee86a662004-07-13 07:12:25 +0000104 def pth_file_tests(self, pth_file):
105 """Contain common code for testing results of reading a .pth file"""
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000106 self.assertIn(pth_file.imported, sys.modules,
107 "%s not in sys.modules" % pth_file.imported)
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000108 self.assertIn(site.makepath(pth_file.good_dir_path)[0], sys.path)
109 self.assertFalse(os.path.exists(pth_file.bad_dir_path))
Brett Cannonee86a662004-07-13 07:12:25 +0000110
Brett Cannon0096e262004-06-05 01:12:51 +0000111 def test_addpackage(self):
112 # Make sure addpackage() imports if the line starts with 'import',
Brett Cannon64a84702004-07-10 02:10:45 +0000113 # adds directories to sys.path for any line in the file that is not a
114 # comment or import that is a valid directory name for where the .pth
115 # file resides; invalid directories are not added
116 pth_file = PthFile()
Brett Cannonee86a662004-07-13 07:12:25 +0000117 pth_file.cleanup(prep=True) # to make sure that nothing is
118 # pre-existing that shouldn't be
Brett Cannon0096e262004-06-05 01:12:51 +0000119 try:
Brett Cannon64a84702004-07-10 02:10:45 +0000120 pth_file.create()
121 site.addpackage(pth_file.base_dir, pth_file.filename, set())
Brett Cannonee86a662004-07-13 07:12:25 +0000122 self.pth_file_tests(pth_file)
Brett Cannon0096e262004-06-05 01:12:51 +0000123 finally:
Brett Cannon64a84702004-07-10 02:10:45 +0000124 pth_file.cleanup()
Raymond Hettingerebd95222004-06-27 03:02:18 +0000125
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000126 def make_pth(self, contents, pth_dir='.', pth_name=TESTFN):
127 # Create a .pth file and return its (abspath, basename).
128 pth_dir = os.path.abspath(pth_dir)
129 pth_basename = pth_name + '.pth'
130 pth_fn = os.path.join(pth_dir, pth_basename)
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200131 with open(pth_fn, 'w', encoding='utf-8') as pth_file:
132 self.addCleanup(lambda: os.remove(pth_fn))
133 pth_file.write(contents)
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000134 return pth_dir, pth_basename
135
136 def test_addpackage_import_bad_syntax(self):
137 # Issue 10642
Serhiy Storchaka94cf3082018-12-17 17:34:14 +0200138 pth_dir, pth_fn = self.make_pth("import bad-syntax\n")
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000139 with captured_stderr() as err_out:
140 site.addpackage(pth_dir, pth_fn, set())
141 self.assertRegex(err_out.getvalue(), "line 1")
R. David Murrayab9d8d62010-12-27 00:03:13 +0000142 self.assertRegex(err_out.getvalue(),
143 re.escape(os.path.join(pth_dir, pth_fn)))
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000144 # XXX: the previous two should be independent checks so that the
145 # order doesn't matter. The next three could be a single check
146 # but my regex foo isn't good enough to write it.
147 self.assertRegex(err_out.getvalue(), 'Traceback')
Serhiy Storchaka94cf3082018-12-17 17:34:14 +0200148 self.assertRegex(err_out.getvalue(), r'import bad-syntax')
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000149 self.assertRegex(err_out.getvalue(), 'SyntaxError')
150
151 def test_addpackage_import_bad_exec(self):
152 # Issue 10642
153 pth_dir, pth_fn = self.make_pth("randompath\nimport nosuchmodule\n")
154 with captured_stderr() as err_out:
155 site.addpackage(pth_dir, pth_fn, set())
156 self.assertRegex(err_out.getvalue(), "line 2")
R. David Murrayab9d8d62010-12-27 00:03:13 +0000157 self.assertRegex(err_out.getvalue(),
158 re.escape(os.path.join(pth_dir, pth_fn)))
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000159 # XXX: ditto previous XXX comment.
160 self.assertRegex(err_out.getvalue(), 'Traceback')
Eric Snow46f97b82016-09-07 16:56:15 -0700161 self.assertRegex(err_out.getvalue(), 'ModuleNotFoundError')
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000162
163 def test_addpackage_import_bad_pth_file(self):
164 # Issue 5258
165 pth_dir, pth_fn = self.make_pth("abc\x00def\n")
166 with captured_stderr() as err_out:
Serhiy Storchaka0185f342018-09-18 11:28:51 +0300167 self.assertFalse(site.addpackage(pth_dir, pth_fn, set()))
168 self.assertEqual(err_out.getvalue(), "")
169 for path in sys.path:
170 if isinstance(path, str):
171 self.assertNotIn("abc\x00def", path)
R. David Murrayb4ca59b2010-12-26 19:54:29 +0000172
Brett Cannon0096e262004-06-05 01:12:51 +0000173 def test_addsitedir(self):
Brett Cannon64a84702004-07-10 02:10:45 +0000174 # Same tests for test_addpackage since addsitedir() essentially just
175 # calls addpackage() for every .pth file in the directory
176 pth_file = PthFile()
Brett Cannonee86a662004-07-13 07:12:25 +0000177 pth_file.cleanup(prep=True) # Make sure that nothing is pre-existing
178 # that is tested for
Brett Cannon0096e262004-06-05 01:12:51 +0000179 try:
Brett Cannonee86a662004-07-13 07:12:25 +0000180 pth_file.create()
Brett Cannon64a84702004-07-10 02:10:45 +0000181 site.addsitedir(pth_file.base_dir, set())
Brett Cannonee86a662004-07-13 07:12:25 +0000182 self.pth_file_tests(pth_file)
Brett Cannon0096e262004-06-05 01:12:51 +0000183 finally:
Brett Cannon64a84702004-07-10 02:10:45 +0000184 pth_file.cleanup()
Brett Cannon0096e262004-06-05 01:12:51 +0000185
native-api45d8d242019-03-03 19:05:19 +0300186 # This tests _getuserbase, hence the double underline
187 # to distinguish from a test for getuserbase
188 def test__getuserbase(self):
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900189 self.assertEqual(site._getuserbase(), sysconfig._getuserbase())
190
191 def test_get_path(self):
INADA Naokiba9ddb72017-07-28 21:28:19 +0900192 if sys.platform == 'darwin' and sys._framework:
193 scheme = 'osx_framework_user'
194 else:
195 scheme = os.name + '_user'
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900196 self.assertEqual(site._get_path(site._getuserbase()),
INADA Naokiba9ddb72017-07-28 21:28:19 +0900197 sysconfig.get_path('purelib', scheme))
INADA Naokia8f8d5b2017-06-29 00:31:53 +0900198
Ned Deily316f5732011-10-31 16:16:35 -0700199 @unittest.skipUnless(site.ENABLE_USER_SITE, "requires access to PEP 370 "
200 "user-site (site.ENABLE_USER_SITE)")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000201 def test_s_option(self):
Eric Snow6b4be192017-05-22 21:36:03 -0700202 # (ncoghlan) Change this to use script_helper...
Christian Heimes8dc226f2008-05-06 23:45:46 +0000203 usersite = site.USER_SITE
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000204 self.assertIn(usersite, sys.path)
Christian Heimes8dc226f2008-05-06 23:45:46 +0000205
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000206 env = os.environ.copy()
Christian Heimes8dc226f2008-05-06 23:45:46 +0000207 rc = subprocess.call([sys.executable, '-c',
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000208 'import sys; sys.exit(%r in sys.path)' % usersite],
209 env=env)
Christian Heimes8dc226f2008-05-06 23:45:46 +0000210 self.assertEqual(rc, 1)
211
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000212 env = os.environ.copy()
Christian Heimes8dc226f2008-05-06 23:45:46 +0000213 rc = subprocess.call([sys.executable, '-s', '-c',
Éric Araujo63ebe1c2011-01-03 17:51:11 +0000214 'import sys; sys.exit(%r in sys.path)' % usersite],
215 env=env)
Antoine Pitroua1782e12013-10-23 22:03:22 +0200216 if usersite == site.getsitepackages()[0]:
217 self.assertEqual(rc, 1)
218 else:
Eric Snow6b4be192017-05-22 21:36:03 -0700219 self.assertEqual(rc, 0, "User site still added to path with -s")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000220
221 env = os.environ.copy()
222 env["PYTHONNOUSERSITE"] = "1"
223 rc = subprocess.call([sys.executable, '-c',
Benjamin Petersonfea6a942008-07-02 16:11:42 +0000224 'import sys; sys.exit(%r in sys.path)' % usersite],
Christian Heimes8dc226f2008-05-06 23:45:46 +0000225 env=env)
Antoine Pitroua1782e12013-10-23 22:03:22 +0200226 if usersite == site.getsitepackages()[0]:
227 self.assertEqual(rc, 1)
228 else:
Eric Snow6b4be192017-05-22 21:36:03 -0700229 self.assertEqual(rc, 0,
230 "User site still added to path with PYTHONNOUSERSITE")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000231
232 env = os.environ.copy()
233 env["PYTHONUSERBASE"] = "/tmp"
234 rc = subprocess.call([sys.executable, '-c',
235 'import sys, site; sys.exit(site.USER_BASE.startswith("/tmp"))'],
236 env=env)
Eric Snow6b4be192017-05-22 21:36:03 -0700237 self.assertEqual(rc, 1,
238 "User base not set by PYTHONUSERBASE")
Christian Heimes8dc226f2008-05-06 23:45:46 +0000239
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000240 def test_getuserbase(self):
241 site.USER_BASE = None
242 user_base = site.getuserbase()
243
244 # the call sets site.USER_BASE
Ezio Melottib3aedd42010-11-20 19:04:17 +0000245 self.assertEqual(site.USER_BASE, user_base)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000246
247 # let's set PYTHONUSERBASE and see if it uses it
248 site.USER_BASE = None
Tarek Ziadéedacea32010-01-29 11:41:03 +0000249 import sysconfig
250 sysconfig._CONFIG_VARS = None
251
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000252 with EnvironmentVarGuard() as environ:
253 environ['PYTHONUSERBASE'] = 'xoxo'
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000254 self.assertTrue(site.getuserbase().startswith('xoxo'),
255 site.getuserbase())
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000256
257 def test_getusersitepackages(self):
258 site.USER_SITE = None
259 site.USER_BASE = None
260 user_site = site.getusersitepackages()
261
262 # the call sets USER_BASE *and* USER_SITE
Ezio Melottib3aedd42010-11-20 19:04:17 +0000263 self.assertEqual(site.USER_SITE, user_site)
Antoine Pitrou9166e6a2009-11-01 23:55:40 +0000264 self.assertTrue(user_site.startswith(site.USER_BASE), user_site)
Victor Stinnerf2f45552018-12-05 16:49:35 +0100265 self.assertEqual(site.USER_BASE, site.getuserbase())
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000266
267 def test_getsitepackages(self):
268 site.PREFIXES = ['xoxo']
269 dirs = site.getsitepackages()
Ned Deily763f0942018-01-30 05:14:09 -0500270 if os.sep == '/':
271 # OS X, Linux, FreeBSD, etc
Victor Stinner8510f432020-03-10 09:53:09 +0100272 if sys.platlibdir != "lib":
273 self.assertEqual(len(dirs), 2)
274 wanted = os.path.join('xoxo', sys.platlibdir,
275 'python%d.%d' % sys.version_info[:2],
276 'site-packages')
277 self.assertEqual(dirs[0], wanted)
278 else:
279 self.assertEqual(len(dirs), 1)
Serhiy Storchaka885bdc42016-02-11 13:10:36 +0200280 wanted = os.path.join('xoxo', 'lib',
281 'python%d.%d' % sys.version_info[:2],
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000282 'site-packages')
Victor Stinner8510f432020-03-10 09:53:09 +0100283 self.assertEqual(dirs[-1], wanted)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000284 else:
Ned Deilyd531b292012-02-06 00:58:18 +0100285 # other platforms
Ezio Melottifc8b2052010-08-17 08:35:41 +0000286 self.assertEqual(len(dirs), 2)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000287 self.assertEqual(dirs[0], 'xoxo')
Tarek Ziadé8c0e2172009-10-27 21:24:21 +0000288 wanted = os.path.join('xoxo', 'lib', 'site-packages')
Ezio Melottib3aedd42010-11-20 19:04:17 +0000289 self.assertEqual(dirs[1], wanted)
Tarek Ziadé4a608c02009-08-20 21:28:05 +0000290
Victor Stinnerf2f45552018-12-05 16:49:35 +0100291 def test_no_home_directory(self):
292 # bpo-10496: getuserbase() and getusersitepackages() must not fail if
293 # the current user has no home directory (if expanduser() returns the
294 # path unchanged).
295 site.USER_SITE = None
296 site.USER_BASE = None
297
298 with EnvironmentVarGuard() as environ, \
299 mock.patch('os.path.expanduser', lambda path: path):
300
301 del environ['PYTHONUSERBASE']
302 del environ['APPDATA']
303
304 user_base = site.getuserbase()
305 self.assertTrue(user_base.startswith('~' + os.sep),
306 user_base)
307
308 user_site = site.getusersitepackages()
309 self.assertTrue(user_site.startswith(user_base), user_site)
310
311 with mock.patch('os.path.isdir', return_value=False) as mock_isdir, \
312 mock.patch.object(site, 'addsitedir') as mock_addsitedir, \
313 support.swap_attr(site, 'ENABLE_USER_SITE', True):
314
315 # addusersitepackages() must not add user_site to sys.path
316 # if it is not an existing directory
317 known_paths = set()
318 site.addusersitepackages(known_paths)
319
320 mock_isdir.assert_called_once_with(user_site)
321 mock_addsitedir.assert_not_called()
322 self.assertFalse(known_paths)
323
native-api2145c8c2020-06-12 09:20:11 +0300324 def test_trace(self):
325 message = "bla-bla-bla"
326 for verbose, out in (True, message + "\n"), (False, ""):
327 with mock.patch('sys.flags', mock.Mock(verbose=verbose)), \
328 mock.patch('sys.stderr', io.StringIO()):
329 site._trace(message)
330 self.assertEqual(sys.stderr.getvalue(), out)
331
Victor Stinnerf2f45552018-12-05 16:49:35 +0100332
Brett Cannon64a84702004-07-10 02:10:45 +0000333class PthFile(object):
334 """Helper class for handling testing of .pth files"""
Brett Cannon0096e262004-06-05 01:12:51 +0000335
Brett Cannon64a84702004-07-10 02:10:45 +0000336 def __init__(self, filename_base=TESTFN, imported="time",
337 good_dirname="__testdir__", bad_dirname="__bad"):
338 """Initialize instance variables"""
339 self.filename = filename_base + ".pth"
340 self.base_dir = os.path.abspath('')
341 self.file_path = os.path.join(self.base_dir, self.filename)
Brett Cannonee86a662004-07-13 07:12:25 +0000342 self.imported = imported
Brett Cannon64a84702004-07-10 02:10:45 +0000343 self.good_dirname = good_dirname
344 self.bad_dirname = bad_dirname
345 self.good_dir_path = os.path.join(self.base_dir, self.good_dirname)
346 self.bad_dir_path = os.path.join(self.base_dir, self.bad_dirname)
Brett Cannon0096e262004-06-05 01:12:51 +0000347
Brett Cannon64a84702004-07-10 02:10:45 +0000348 def create(self):
349 """Create a .pth file with a comment, blank lines, an ``import
350 <self.imported>``, a line with self.good_dirname, and a line with
351 self.bad_dirname.
Tim Peters182b5ac2004-07-18 06:16:08 +0000352
Brett Cannon64a84702004-07-10 02:10:45 +0000353 Creation of the directory for self.good_dir_path (based off of
354 self.good_dirname) is also performed.
Brett Cannon0096e262004-06-05 01:12:51 +0000355
Brett Cannon64a84702004-07-10 02:10:45 +0000356 Make sure to call self.cleanup() to undo anything done by this method.
Tim Peters182b5ac2004-07-18 06:16:08 +0000357
Brett Cannon64a84702004-07-10 02:10:45 +0000358 """
Michael W. Hudsonff522862005-05-27 14:58:06 +0000359 FILE = open(self.file_path, 'w')
Brett Cannon64a84702004-07-10 02:10:45 +0000360 try:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000361 print("#import @bad module name", file=FILE)
362 print("\n", file=FILE)
363 print("import %s" % self.imported, file=FILE)
364 print(self.good_dirname, file=FILE)
365 print(self.bad_dirname, file=FILE)
Brett Cannon64a84702004-07-10 02:10:45 +0000366 finally:
367 FILE.close()
368 os.mkdir(self.good_dir_path)
369
Brett Cannonee86a662004-07-13 07:12:25 +0000370 def cleanup(self, prep=False):
Brett Cannon64a84702004-07-10 02:10:45 +0000371 """Make sure that the .pth file is deleted, self.imported is not in
372 sys.modules, and that both self.good_dirname and self.bad_dirname are
373 not existing directories."""
Brett Cannonee86a662004-07-13 07:12:25 +0000374 if os.path.exists(self.file_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000375 os.remove(self.file_path)
Brett Cannonee86a662004-07-13 07:12:25 +0000376 if prep:
377 self.imported_module = sys.modules.get(self.imported)
378 if self.imported_module:
379 del sys.modules[self.imported]
380 else:
381 if self.imported_module:
382 sys.modules[self.imported] = self.imported_module
383 if os.path.exists(self.good_dir_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000384 os.rmdir(self.good_dir_path)
Brett Cannonee86a662004-07-13 07:12:25 +0000385 if os.path.exists(self.bad_dir_path):
Brett Cannon64a84702004-07-10 02:10:45 +0000386 os.rmdir(self.bad_dir_path)
Brett Cannon0096e262004-06-05 01:12:51 +0000387
388class ImportSideEffectTests(unittest.TestCase):
389 """Test side-effects from importing 'site'."""
390
391 def setUp(self):
392 """Make a copy of sys.path"""
393 self.sys_path = sys.path[:]
394
395 def tearDown(self):
396 """Restore sys.path"""
Nick Coghlan6ead5522009-10-18 13:19:33 +0000397 sys.path[:] = self.sys_path
Brett Cannon0096e262004-06-05 01:12:51 +0000398
Barry Warsaw28a691b2010-04-17 00:19:56 +0000399 def test_abs_paths(self):
400 # Make sure all imported modules have their __file__ and __cached__
401 # attributes as absolute paths. Arranging to put the Lib directory on
402 # PYTHONPATH would cause the os module to have a relative path for
403 # __file__ if abs_paths() does not get run. sys and builtins (the
404 # only other modules imported before site.py runs) do not have
405 # __file__ or __cached__ because they are built-in.
Steve Dowerf14c28f2018-09-20 13:38:34 -0700406 try:
407 parent = os.path.relpath(os.path.dirname(os.__file__))
408 cwd = os.getcwd()
409 except ValueError:
410 # Failure to get relpath probably means we need to chdir
411 # to the same drive.
412 cwd, parent = os.path.split(os.path.dirname(os.__file__))
413 with change_cwd(cwd):
414 env = os.environ.copy()
415 env['PYTHONPATH'] = parent
416 code = ('import os, sys',
417 # use ASCII to avoid locale issues with non-ASCII directories
418 'os_file = os.__file__.encode("ascii", "backslashreplace")',
419 r'sys.stdout.buffer.write(os_file + b"\n")',
420 'os_cached = os.__cached__.encode("ascii", "backslashreplace")',
421 r'sys.stdout.buffer.write(os_cached + b"\n")')
422 command = '\n'.join(code)
423 # First, prove that with -S (no 'import site'), the paths are
424 # relative.
425 proc = subprocess.Popen([sys.executable, '-S', '-c', command],
426 env=env,
427 stdout=subprocess.PIPE)
428 stdout, stderr = proc.communicate()
Victor Stinnerf3bc2582010-04-18 07:59:53 +0000429
Steve Dowerf14c28f2018-09-20 13:38:34 -0700430 self.assertEqual(proc.returncode, 0)
431 os__file__, os__cached__ = stdout.splitlines()[:2]
432 self.assertFalse(os.path.isabs(os__file__))
433 self.assertFalse(os.path.isabs(os__cached__))
434 # Now, with 'import site', it works.
435 proc = subprocess.Popen([sys.executable, '-c', command],
436 env=env,
437 stdout=subprocess.PIPE)
438 stdout, stderr = proc.communicate()
439 self.assertEqual(proc.returncode, 0)
440 os__file__, os__cached__ = stdout.splitlines()[:2]
441 self.assertTrue(os.path.isabs(os__file__),
442 "expected absolute path, got {}"
443 .format(os__file__.decode('ascii')))
444 self.assertTrue(os.path.isabs(os__cached__),
445 "expected absolute path, got {}"
446 .format(os__cached__.decode('ascii')))
Brett Cannon0096e262004-06-05 01:12:51 +0000447
INADA Naokid4c76d92018-10-01 21:10:37 +0900448 def test_abs_paths_cached_None(self):
449 """Test for __cached__ is None.
450
451 Regarding to PEP 3147, __cached__ can be None.
452
453 See also: https://bugs.python.org/issue30167
454 """
455 sys.modules['test'].__cached__ = None
456 site.abs_paths()
457 self.assertIsNone(sys.modules['test'].__cached__)
458
Brett Cannon0096e262004-06-05 01:12:51 +0000459 def test_no_duplicate_paths(self):
460 # No duplicate paths should exist in sys.path
461 # Handled by removeduppaths()
462 site.removeduppaths()
463 seen_paths = set()
464 for path in sys.path:
Benjamin Peterson577473f2010-01-19 00:09:57 +0000465 self.assertNotIn(path, seen_paths)
Brett Cannon0096e262004-06-05 01:12:51 +0000466 seen_paths.add(path)
467
Zachary Ware9fe6d862013-12-08 00:20:35 -0600468 @unittest.skip('test not implemented')
Brett Cannon0096e262004-06-05 01:12:51 +0000469 def test_add_build_dir(self):
470 # Test that the build directory's Modules directory is used when it
471 # should be.
472 # XXX: implement
473 pass
474
Brett Cannon0096e262004-06-05 01:12:51 +0000475 def test_setting_quit(self):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000476 # 'quit' and 'exit' should be injected into builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000477 self.assertTrue(hasattr(builtins, "quit"))
478 self.assertTrue(hasattr(builtins, "exit"))
Brett Cannon0096e262004-06-05 01:12:51 +0000479
480 def test_setting_copyright(self):
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700481 # 'copyright', 'credits', and 'license' should be in builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000482 self.assertTrue(hasattr(builtins, "copyright"))
483 self.assertTrue(hasattr(builtins, "credits"))
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700484 self.assertTrue(hasattr(builtins, "license"))
Brett Cannon0096e262004-06-05 01:12:51 +0000485
486 def test_setting_help(self):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000487 # 'help' should be set in builtins
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000488 self.assertTrue(hasattr(builtins, "help"))
Brett Cannon0096e262004-06-05 01:12:51 +0000489
490 def test_aliasing_mbcs(self):
491 if sys.platform == "win32":
492 import locale
493 if locale.getdefaultlocale()[1].startswith('cp'):
Guido van Rossumcc2b0162007-02-11 06:12:03 +0000494 for value in encodings.aliases.aliases.values():
Brett Cannon0096e262004-06-05 01:12:51 +0000495 if value == "mbcs":
496 break
497 else:
498 self.fail("did not alias mbcs")
499
Brett Cannon0096e262004-06-05 01:12:51 +0000500 def test_sitecustomize_executed(self):
501 # If sitecustomize is available, it should have been imported.
Guido van Rossume2b70bc2006-08-18 22:13:04 +0000502 if "sitecustomize" not in sys.modules:
Brett Cannon0096e262004-06-05 01:12:51 +0000503 try:
504 import sitecustomize
505 except ImportError:
506 pass
507 else:
508 self.fail("sitecustomize not imported automatically")
509
R David Murray1bc6ceb2013-09-14 13:28:37 -0400510 @test.support.requires_resource('network')
Benjamin Peterson337578b2015-02-01 20:16:59 -0500511 @test.support.system_must_validate_cert
Georg Brandl78abc9d2013-10-27 09:41:57 +0100512 @unittest.skipUnless(sys.version_info[3] == 'final',
513 'only for released versions')
Ned Deily5a507f02014-03-26 23:31:39 -0700514 @unittest.skipUnless(hasattr(urllib.request, "HTTPSHandler"),
515 'need SSL support to download license')
R David Murray1bc6ceb2013-09-14 13:28:37 -0400516 def test_license_exists_at_url(self):
Ned Deily944d5972014-03-26 23:43:26 -0700517 # This test is a bit fragile since it depends on the format of the
R David Murray1bc6ceb2013-09-14 13:28:37 -0400518 # string displayed by license in the absence of a LICENSE file.
519 url = license._Printer__data.split()[1]
520 req = urllib.request.Request(url, method='HEAD')
521 try:
Serhiy Storchakabfb1cf42020-04-29 10:36:20 +0300522 with socket_helper.transient_internet(url):
R David Murray1bc6ceb2013-09-14 13:28:37 -0400523 with urllib.request.urlopen(req) as data:
524 code = data.getcode()
525 except urllib.error.HTTPError as e:
526 code = e.code
527 self.assertEqual(code, 200, msg="Can't find " + url)
Senthil Kumaran8ef519b2013-09-07 13:59:17 -0700528
Brett Cannon0096e262004-06-05 01:12:51 +0000529
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200530class StartupImportTests(unittest.TestCase):
531
532 def test_startup_imports(self):
Victor Stinnerd18de462020-03-18 18:27:32 +0100533 # Get sys.path in isolated mode (python3 -I)
534 popen = subprocess.Popen([sys.executable, '-I', '-c',
535 'import sys; print(repr(sys.path))'],
536 stdout=subprocess.PIPE,
537 encoding='utf-8')
538 stdout = popen.communicate()[0]
539 self.assertEqual(popen.returncode, 0, repr(stdout))
540 isolated_paths = eval(stdout)
541
542 # bpo-27807: Even with -I, the site module executes all .pth files
543 # found in sys.path (see site.addpackage()). Skip the test if at least
544 # one .pth file is found.
545 for path in isolated_paths:
546 pth_files = glob.glob(os.path.join(path, "*.pth"))
547 if pth_files:
548 self.skipTest(f"found {len(pth_files)} .pth files in: {path}")
549
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200550 # This tests checks which modules are loaded by Python when it
551 # initially starts upon startup.
Christian Heimes179a3db2013-10-12 12:32:21 +0200552 popen = subprocess.Popen([sys.executable, '-I', '-v', '-c',
553 'import sys; print(set(sys.modules))'],
554 stdout=subprocess.PIPE,
Steve Dower313523c2016-09-17 12:22:41 -0700555 stderr=subprocess.PIPE,
556 encoding='utf-8')
Christian Heimes179a3db2013-10-12 12:32:21 +0200557 stdout, stderr = popen.communicate()
Victor Stinnerd18de462020-03-18 18:27:32 +0100558 self.assertEqual(popen.returncode, 0, (stdout, stderr))
Christian Heimes179a3db2013-10-12 12:32:21 +0200559 modules = eval(stdout)
560
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200561 self.assertIn('site', modules)
562
Christian Heimes25827622013-10-12 01:27:08 +0200563 # http://bugs.python.org/issue19205
Christian Heimes8c9cd5a2013-10-12 00:24:55 +0200564 re_mods = {'re', '_sre', 'sre_compile', 'sre_constants', 'sre_parse'}
Inada Naokic4d92c82019-05-05 18:06:30 +0900565 self.assertFalse(modules.intersection(re_mods), stderr)
566
Christian Heimes25827622013-10-12 01:27:08 +0200567 # http://bugs.python.org/issue9548
Christian Heimes179a3db2013-10-12 12:32:21 +0200568 self.assertNotIn('locale', modules, stderr)
Inada Naokic4d92c82019-05-05 18:06:30 +0900569
570 # http://bugs.python.org/issue19209
571 self.assertNotIn('copyreg', modules, stderr)
572
573 # http://bugs.python.org/issue19218
Christian Heimesf1dc3ee2013-10-13 02:04:20 +0200574 collection_mods = {'_collections', 'collections', 'functools',
575 'heapq', 'itertools', 'keyword', 'operator',
doko@ubuntu.com95743552014-04-15 20:37:54 +0200576 'reprlib', 'types', 'weakref'
577 }.difference(sys.builtin_module_names)
Ned Deilyc22bd582017-07-28 03:02:10 -0400578 self.assertFalse(modules.intersection(collection_mods), stderr)
Christian Heimes1a5fb4e2013-10-12 01:00:51 +0200579
Steve Dower6dd8eca2016-09-17 14:35:32 -0700580 def test_startup_interactivehook(self):
581 r = subprocess.Popen([sys.executable, '-c',
582 'import sys; sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
583 self.assertTrue(r, "'__interactivehook__' not added by site")
584
585 def test_startup_interactivehook_isolated(self):
586 # issue28192 readline is not automatically enabled in isolated mode
587 r = subprocess.Popen([sys.executable, '-I', '-c',
588 'import sys; sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
589 self.assertFalse(r, "'__interactivehook__' added in isolated mode")
590
591 def test_startup_interactivehook_isolated_explicit(self):
592 # issue28192 readline can be explicitly enabled in isolated mode
593 r = subprocess.Popen([sys.executable, '-I', '-c',
594 'import site, sys; site.enablerlcompleter(); sys.exit(hasattr(sys, "__interactivehook__"))']).wait()
595 self.assertTrue(r, "'__interactivehook__' not added by enablerlcompleter()")
596
Zachary Wared48214f2017-05-14 15:49:46 -0500597
598@unittest.skipUnless(sys.platform == 'win32', "only supported on Windows")
599class _pthFileTests(unittest.TestCase):
600
Steve Dower1da055e2016-10-29 08:50:31 -0700601 def _create_underpth_exe(self, lines):
Zachary Wared48214f2017-05-14 15:49:46 -0500602 temp_dir = tempfile.mkdtemp()
603 self.addCleanup(test.support.rmtree, temp_dir)
604 exe_file = os.path.join(temp_dir, os.path.split(sys.executable)[1])
Steve Dower1da055e2016-10-29 08:50:31 -0700605 shutil.copy(sys.executable, exe_file)
Steve Dower1da055e2016-10-29 08:50:31 -0700606 _pth_file = os.path.splitext(exe_file)[0] + '._pth'
Zachary Wared48214f2017-05-14 15:49:46 -0500607 with open(_pth_file, 'w') as f:
608 for line in lines:
609 print(line, file=f)
610 return exe_file
Steve Dower1da055e2016-10-29 08:50:31 -0700611
Steve Dower5f9193a2017-02-04 15:19:29 -0800612 def _calc_sys_path_for_underpth_nosite(self, sys_prefix, lines):
613 sys_path = []
614 for line in lines:
615 if not line or line[0] == '#':
616 continue
617 abs_path = os.path.abspath(os.path.join(sys_prefix, line))
618 sys_path.append(abs_path)
619 return sys_path
620
Steve Dowerc6dd4152016-10-27 14:28:07 -0700621 def test_underpth_nosite_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)
Steve Dower5f9193a2017-02-04 15:19:29 -0800624 pth_lines = [
Steve Dower1da055e2016-10-29 08:50:31 -0700625 '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',
Steve Dower5f9193a2017-02-04 15:19:29 -0800629 ]
630 exe_file = self._create_underpth_exe(pth_lines)
631 sys_path = self._calc_sys_path_for_underpth_nosite(
632 os.path.dirname(exe_file),
633 pth_lines)
Steve Dowerc6dd4152016-10-27 14:28:07 -0700634
Zachary Wared48214f2017-05-14 15:49:46 -0500635 env = os.environ.copy()
636 env['PYTHONPATH'] = 'from-env'
637 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
Steve Dower9b33bf52017-05-23 16:25:25 -0700638 output = subprocess.check_output([exe_file, '-c',
639 'import sys; print("\\n".join(sys.path) if sys.flags.no_site else "")'
640 ], env=env, encoding='ansi')
641 actual_sys_path = output.rstrip().split('\n')
Serhiy Storchaka95c32622018-02-04 18:14:47 +0200642 self.assertTrue(actual_sys_path, "sys.flags.no_site was False")
Steve Dower9b33bf52017-05-23 16:25:25 -0700643 self.assertEqual(
644 actual_sys_path,
645 sys_path,
646 "sys.path is incorrect"
647 )
Steve Dowerc6dd4152016-10-27 14:28:07 -0700648
Steve Dowerc6dd4152016-10-27 14:28:07 -0700649 def test_underpth_file(self):
Steve Dower1da055e2016-10-29 08:50:31 -0700650 libpath = os.path.dirname(os.path.dirname(encodings.__file__))
651 exe_prefix = os.path.dirname(sys.executable)
652 exe_file = self._create_underpth_exe([
653 'fake-path-name',
654 *[libpath for _ in range(200)],
Steve Dower5f9193a2017-02-04 15:19:29 -0800655 '',
Steve Dower1da055e2016-10-29 08:50:31 -0700656 '# comment',
657 'import site'
658 ])
Steve Dower5f9193a2017-02-04 15:19:29 -0800659 sys_prefix = os.path.dirname(exe_file)
Zachary Wared48214f2017-05-14 15:49:46 -0500660 env = os.environ.copy()
661 env['PYTHONPATH'] = 'from-env'
662 env['PATH'] = '{};{}'.format(exe_prefix, os.getenv('PATH'))
663 rc = subprocess.call([exe_file, '-c',
664 'import sys; sys.exit(not sys.flags.no_site and '
665 '%r in sys.path and %r in sys.path and %r not in sys.path and '
666 'all("\\r" not in p and "\\n" not in p for p in sys.path))' % (
667 os.path.join(sys_prefix, 'fake-path-name'),
668 libpath,
669 os.path.join(sys_prefix, 'from-env'),
670 )], env=env)
Steve Dower5f9193a2017-02-04 15:19:29 -0800671 self.assertTrue(rc, "sys.path is incorrect")
Steve Dowerc6dd4152016-10-27 14:28:07 -0700672
Steve Dower6dd8eca2016-09-17 14:35:32 -0700673
Brett Cannon0096e262004-06-05 01:12:51 +0000674if __name__ == "__main__":
Brett Cannon3e9a9ae2013-06-12 21:25:59 -0400675 unittest.main()