8000 00251: Change user install location · fedora-python/cpython@ceea794 · GitHub
[go: up one dir, main page]
Skip to content

Commit ceea794

Browse files
hroncokencukoumcyprianfrenzymadness
authored and
befeleme
committed
00251: Change user install location
Set values of base and platbase in sysconfig from /usr to /usr/local when RPM build is not detected to make pip and similar tools install into separate location. Fedora Change: https://fedoraproject.org/wiki/Changes/Making_sudo_pip_safe Downstream only. We've tried to rework in Fedora 36/Python 3.10 to follow https://bugs.python.org/issue43976 but we have identified serious problems with that approach, see https://bugzilla.redhat.com/2026979 or https://bugzilla.redhat.com/2097183 pypa/distutils integration: pypa/distutils#70 Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Miro Hrončok <miro@hroncok.cz> Co-authored-by: Michal Cyprian <m.cyprian@gmail.com> Co-authored-by: Lumír Balhar <frenzy.madness@gmail.com>
1 parent f26daa9 commit ceea794

File tree

3 files changed

+72
-4
lines changed

3 files changed

+72
-4
lines changed

‎Lib/site.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,8 +420,15 @@ def getsitepackages(prefixes=None):
420420
return sitepackages
421421

422422
def addsitepackages(known_paths, prefixes=None):
423-
"""Add site-packages to sys.path"""
423+
"""Add site-packages to sys.path
424+
425+
'/usr/local' is included in PREFIXES if RPM build is not detected
426+
to make packages installed into this location visible.
427+
428+
"""
424429
_trace("Processing global site-packages")
430+
if ENABLE_USER_SITE and 'RPM_BUILD_ROOT' not in os.environ:
431+
PREFIXES.insert(0, "/usr/local")
425432
for sitedir in getsitepackages(prefixes):
426433
if os.path.isdir(sitedir):
427434
addsitedir(sitedir, known_paths)

‎Lib/sysconfig/__init__.py

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,12 @@
106106
else:
107107
_INSTALL_SCHEMES['venv'] = _INSTALL_SCHEMES['posix_venv']
108108

109+
# For a brief period of time in the Fedora 36 life cycle,
110+
# this installation scheme existed and was documented in the release notes.
111+
# For backwards compatibility, we keep it here (at least on 3.10 and 3.11).
112+
_INSTALL_SCHEMES['rpm_prefix'] = _INSTALL_SCHEMES['posix_prefix']
113+
114+
109115
def _get_implementation():
110116
return 'Python'
111117

@@ -167,6 +173,19 @@ def joinuser(*args):
167173
},
168174
}
169175

176+
# This is used by distutils.command.install in the stdlib
177+
# as well as pypa/distutils (e.g. bundled in setuptools).
178+
# The self.prefix value is set to sys.prefix + /local/
179+
# if neither RPM build nor virtual environment is
180+
# detected to make distutils install packages
181+
# into the separate location.
182+
# https://fedoraproject.org/wiki/Changes/Making_sudo_pip_safe
183+
if (not (hasattr(sys, 'real_prefix') or
184+
sys.prefix != sys.base_prefix) and
185+
'RPM_BUILD_ROOT' not in os.environ):
186+
_prefix_addition = '/local'
187+
188+
170189
_SCHEME_KEYS = ('stdlib', 'platstdlib', 'purelib', 'platlib', 'include',
171190
'scripts', 'data')
172191

@@ -259,11 +278,40 @@ def _extend_dict(target_dict, other_dict):
259278
target_dict[key] = value
260279

261280

281+
_CONFIG_VARS_LOCAL = None
282+
283+
284+
def _config_vars_local():
285+
# This function returns the config vars with prefixes amended to /usr/local
286+
# https://fedoraproject.org/wiki/Changes/Making_sudo_pip_safe
287+
global _CONFIG_VARS_LOCAL
288+
if _CONFIG_VARS_LOCAL is None:
289+
_CONFIG_VARS_LOCAL = dict(get_config_vars())
290+
_CONFIG_VARS_LOCAL['base'] = '/usr/local'
291+
_CONFIG_VARS_LOCAL['platbase'] = '/usr/local'
292+
return _CONFIG_VARS_LOCAL
293+
294+
262295
def _expand_vars(scheme, vars):
263296
res = {}
264297
if vars is None:
265298
vars = {}
266-
_extend_dict(vars, get_config_vars())
299+
300+
# when we are not in a virtual environment or an RPM build
301+
# we change '/usr' to '/usr/local'
302+
# to avoid surprises, we explicitly check for the /usr/ prefix
303+
# Python virtual environments have different prefixes
304+
# we only do this for posix_prefix, not to mangle the venv scheme
305+
# posix_prefix is used by sudo pip install
306+
# we only change the defaults here, so explicit --prefix will take precedence
307+
# https://fedoraproject.org/wiki/Changes/Making_sudo_pip_safe
308+
if (scheme == 'posix_prefix' and
309+
sys.prefix == '/usr' and
310+
'RPM_BUILD_ROOT' not in os.environ):
311+
_extend_dict(vars, _config_vars_local())
312+
else:
313+
_extend_dict(vars, get_config_vars())
314+
267315
if os.name == 'nt':
268316
# On Windows we want to substitute 'lib' for schemes rather
269317
# than the native value (without modifying vars, in case it

‎Lib/test/test_sysconfig.py

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,19 @@ def test_get_path(self):
138138
for scheme in _INSTALL_SCHEMES:
139139
for name in _INSTALL_SCHEMES[scheme]:
140140
expected = _INSTALL_SCHEMES[scheme][name].format(**config_vars)
141+
tested = get_path(name, scheme)
142+
# https://fedoraproject.org/wiki/Changes/Making_sudo_pip_safe
143+
if tested.startswith('/usr/local'):
144+
# /usr/local should only be used in posix_prefix
145+
self.assertEqual(scheme, 'posix_prefix')
146+
# Fedora CI runs tests for venv and virtualenv that check for other prefixes
147+
self.assertEqual(sys.prefix, '/usr')
148+
# When building the RPM of Python, %check runs this with RPM_BUILD_ROOT set
149+
# Fedora CI runs this with RPM_BUILD_ROOT unset
150+
self.assertNotIn('RPM_BUILD_ROOT', os.environ)
151+
tested = tested.replace('/usr/local', '/usr')
141152
self.assertEqual(
142-
os.path.normpath(get_path(name, scheme)),
153+
os.path.normpath(tested),
143154
os.path.normpath(expected),
144155
)
145156

@@ -394,7 +405,7 @@ def test_get_config_h_filename(self):
394405
self.assertTrue(os.path.isfile(config_h), config_h)
395406

396407
def test_get_scheme_names(self):
397-
wanted = ['nt', 'posix_home', 'posix_prefix', 'posix_venv', 'nt_venv', 'venv']
408+
wanted = ['nt', 'posix_home', 'posix_prefix', 'posix_venv', 'nt_venv', 'venv', 'rpm_prefix']
398409
if HAS_USER_BASE:
399410
wanted.extend(['nt_user', 'osx_framework_user', 'posix_user'])
400411
self.assertEqual(get_scheme_names(), tuple(sorted(wanted)))
@@ -406,6 +417,8 @@ def test_symlink(self): # Issue 7880
406417
cmd = "-c", "import sysconfig; print(sysconfig.get_platform())"
407418
self.assertEqual(py.call_real(*cmd), py.call_link(*cmd))
408419

420+
@unittest.skipIf('RPM_BUILD_ROOT' not in os.environ,
421+
"Test doesn't expect Fedora's paths")
409422
def test_user_similar(self):
410423
# Issue #8759: make sure the posix scheme for the users
411424
# is similar to the global posix_prefix one

0 commit comments

Comments
 (0)
0