bpo-29585: optimize site.py startup time (GH-136)
Avoid importing `sysconfig` from `site` by copying minimum code.
Python startup is 5% faster on Linux and 30% faster on macOS
diff --git a/Lib/site.py b/Lib/site.py
index 8797938..fcf7dde 100644
--- a/Lib/site.py
+++ b/Lib/site.py
@@ -124,7 +124,7 @@
# if they only differ in case); turn relative paths into absolute
# paths.
dir, dircase = makepath(dir)
- if not dircase in known_paths:
+ if dircase not in known_paths:
L.append(dir)
known_paths.add(dircase)
sys.path[:] = L
@@ -234,6 +234,46 @@
return True
+
+# NOTE: sysconfig and it's dependencies are relatively large but site module
+# needs very limited part of them.
+# To speedup startup time, we have copy of them.
+#
+# See https://bugs.python.org/issue29585
+
+# Copy of sysconfig._getuserbase()
+def _getuserbase():
+ env_base = os.environ.get("PYTHONUSERBASE", None)
+ if env_base:
+ return env_base
+
+ def joinuser(*args):
+ return os.path.expanduser(os.path.join(*args))
+
+ if os.name == "nt":
+ base = os.environ.get("APPDATA") or "~"
+ return joinuser(base, "Python")
+
+ if sys.platform == "darwin" and sys._framework:
+ return joinuser("~", "Library", sys._framework,
+ "%d.%d" % sys.version_info[:2])
+
+ return joinuser("~", ".local")
+
+
+# Same to sysconfig.get_path('purelib', os.name+'_user')
+def _get_path(userbase):
+ version = sys.version_info
+
+ if os.name == 'nt':
+ return f'{userbase}/Python{version[0]}{version[1]}/site-packages'
+
+ if sys.platform == 'darwin' and sys._framework:
+ return f'{userbase}/lib/python/site-packages'
+
+ return f'{userbase}/lib/python{version[0]}.{version[1]}/site-packages'
+
+
def getuserbase():
"""Returns the `user base` directory path.
@@ -242,12 +282,11 @@
it.
"""
global USER_BASE
- if USER_BASE is not None:
- return USER_BASE
- from sysconfig import get_config_var
- USER_BASE = get_config_var('userbase')
+ if USER_BASE is None:
+ USER_BASE = _getuserbase()
return USER_BASE
+
def getusersitepackages():
"""Returns the user-specific site-packages directory path.
@@ -255,20 +294,11 @@
function will also set it.
"""
global USER_SITE
- user_base = getuserbase() # this will also set USER_BASE
+ userbase = getuserbase() # this will also set USER_BASE
- if USER_SITE is not None:
- return USER_SITE
+ if USER_SITE is None:
+ USER_SITE = _get_path(userbase)
- from sysconfig import get_path
-
- if sys.platform == 'darwin':
- from sysconfig import get_config_var
- if get_config_var('PYTHONFRAMEWORK'):
- USER_SITE = get_path('purelib', 'osx_framework_user')
- return USER_SITE
-
- USER_SITE = get_path('purelib', '%s_user' % os.name)
return USER_SITE
def addusersitepackages(known_paths):
@@ -310,15 +340,11 @@
else:
sitepackages.append(prefix)
sitepackages.append(os.path.join(prefix, "lib", "site-packages"))
- if sys.platform == "darwin":
- # for framework builds *only* we add the standard Apple
- # locations.
- from sysconfig import get_config_var
- framework = get_config_var("PYTHONFRAMEWORK")
- if framework:
- sitepackages.append(
- os.path.join("/Library", framework,
- '%d.%d' % sys.version_info[:2], "site-packages"))
+ # for framework builds *only* we add the standard Apple locations.
+ if sys.platform == "darwin" and sys._framework:
+ sitepackages.append(
+ os.path.join("/Library", framework,
+ '%d.%d' % sys.version_info[:2], "site-packages"))
return sitepackages
def addsitepackages(known_paths, prefixes=None):
diff --git a/Lib/sysconfig.py b/Lib/sysconfig.py
index ed0a34d..e6618b1 100644
--- a/Lib/sysconfig.py
+++ b/Lib/sysconfig.py
@@ -51,6 +51,7 @@
'scripts': '{base}/Scripts',
'data': '{base}',
},
+ # NOTE: When modifying "purelib" scheme, update site._get_path() too.
'nt_user': {
'stdlib': '{userbase}/Python{py_version_nodot}',
'platstdlib': '{userbase}/Python{py_version_nodot}',
@@ -177,32 +178,25 @@
return os.name
+# NOTE: site.py has copy of this function.
+# Sync it when modify this function.
def _getuserbase():
env_base = os.environ.get("PYTHONUSERBASE", None)
+ if env_base:
+ return env_base
def joinuser(*args):
return os.path.expanduser(os.path.join(*args))
if os.name == "nt":
base = os.environ.get("APPDATA") or "~"
- if env_base:
- return env_base
- else:
- return joinuser(base, "Python")
+ return joinuser(base, "Python")
- if sys.platform == "darwin":
- framework = get_config_var("PYTHONFRAMEWORK")
- if framework:
- if env_base:
- return env_base
- else:
- return joinuser("~", "Library", framework, "%d.%d" %
- sys.version_info[:2])
+ if sys.platform == "darwin" and sys._framework:
+ return joinuser("~", "Library", sys._framework,
+ "%d.%d" % sys.version_info[:2])
- if env_base:
- return env_base
- else:
- return joinuser("~", ".local")
+ return joinuser("~", ".local")
def _parse_makefile(filename, vars=None):
diff --git a/Lib/test/test_site.py b/Lib/test/test_site.py
index 1501622..bf7be4e 100644
--- a/Lib/test/test_site.py
+++ b/Lib/test/test_site.py
@@ -180,6 +180,13 @@
finally:
pth_file.cleanup()
+ def test_getuserbase(self):
+ self.assertEqual(site._getuserbase(), sysconfig._getuserbase())
+
+ def test_get_path(self):
+ self.assertEqual(site._get_path(site._getuserbase()),
+ sysconfig.get_path('purelib', os.name + '_user'))
+
@unittest.skipUnless(site.ENABLE_USER_SITE, "requires access to PEP 370 "
"user-site (site.ENABLE_USER_SITE)")
def test_s_option(self):