https://github.com/python/cpython/commit/865bd6de991dae966ec4bf4eb698ab8c19afdb21
commit: 865bd6de991dae966ec4bf4eb698ab8c19afdb21
branch: 3.12
author: Bénédikt Tran <10796600+picn...@users.noreply.github.com>
committer: picnixz <10796600+picn...@users.noreply.github.com>
date: 2025-03-18T13:46:24+01:00
summary:
[3.12] gh-131277: allow EnvironmentVarGuard to unset more than one environment
variable at once (GH-131280) (#131410)
(cherry picked from commit 3185e3115c918ec189e16cf9f5b51a13a0146556)
---------
Co-authored-by: Hugo van Kemenade <1324225+hug...@users.noreply.github.com>
files:
M Lib/test/support/os_helper.py
M Lib/test/test__osx_support.py
M Lib/test/test_getopt.py
M Lib/test/test_pathlib.py
M Lib/test/test_platform.py
M Lib/test/test_regrtest.py
M Lib/test/test_shutil.py
M Lib/test/test_site.py
diff --git a/Lib/test/support/os_helper.py b/Lib/test/support/os_helper.py
index 20f38fd36a8876..de7ca79dc81e9b 100644
--- a/Lib/test/support/os_helper.py
+++ b/Lib/test/support/os_helper.py
@@ -676,9 +676,10 @@ def temp_umask(umask):
class EnvironmentVarGuard(collections.abc.MutableMapping):
+ """Class to help protect the environment variable properly.
- """Class to help protect the environment variable properly. Can be used as
- a context manager."""
+ Can be used as a context manager.
+ """
def __init__(self):
self._environ = os.environ
@@ -712,8 +713,10 @@ def __len__(self):
def set(self, envvar, value):
self[envvar] = value
- def unset(self, envvar):
- del self[envvar]
+ def unset(self, envvar, /, *envvars):
+ """Unset one or more environment variables."""
+ for ev in (envvar, *envvars):
+ del self[ev]
def copy(self):
# We do what os.environ.copy() does.
diff --git a/Lib/test/test__osx_support.py b/Lib/test/test__osx_support.py
index 4a14cb352138ef..53aa26620a6475 100644
--- a/Lib/test/test__osx_support.py
+++ b/Lib/test/test__osx_support.py
@@ -20,12 +20,13 @@ def setUp(self):
self.prog_name = 'bogus_program_xxxx'
self.temp_path_dir = os.path.abspath(os.getcwd())
self.env = self.enterContext(os_helper.EnvironmentVarGuard())
- for cv in ('CFLAGS', 'LDFLAGS', 'CPPFLAGS',
- 'BASECFLAGS', 'BLDSHARED', 'LDSHARED', 'CC',
- 'CXX', 'PY_CFLAGS', 'PY_LDFLAGS', 'PY_CPPFLAGS',
- 'PY_CORE_CFLAGS', 'PY_CORE_LDFLAGS'):
- if cv in self.env:
- self.env.unset(cv)
+
+ self.env.unset(
+ 'CFLAGS', 'LDFLAGS', 'CPPFLAGS',
+ 'BASECFLAGS', 'BLDSHARED', 'LDSHARED', 'CC',
+ 'CXX', 'PY_CFLAGS', 'PY_LDFLAGS', 'PY_CPPFLAGS',
+ 'PY_CORE_CFLAGS', 'PY_CORE_LDFLAGS'
+ )
def add_expected_saved_initial_values(self, config_vars, expected_vars):
# Ensure that the initial values for all modified config vars
diff --git a/Lib/test/test_getopt.py b/Lib/test/test_getopt.py
index 2b7d0c4c84ead4..295a2c81363e10 100644
--- a/Lib/test/test_getopt.py
+++ b/Lib/test/test_getopt.py
@@ -13,8 +13,7 @@
class GetoptTests(unittest.TestCase):
def setUp(self):
self.env = self.enterContext(EnvironmentVarGuard())
- if "POSIXLY_CORRECT" in self.env:
- del self.env["POSIXLY_CORRECT"]
+ del self.env["POSIXLY_CORRECT"]
def assertError(self, *args, **kwargs):
self.assertRaises(getopt.GetoptError, *args, **kwargs)
diff --git a/Lib/test/test_pathlib.py b/Lib/test/test_pathlib.py
index 4437f878004c70..34a53ed91fc547 100644
--- a/Lib/test/test_pathlib.py
+++ b/Lib/test/test_pathlib.py
@@ -3111,7 +3111,7 @@ def test_expanduser(self):
p7 = P(f'~{fakename}/Documents')
with os_helper.EnvironmentVarGuard() as env:
- env.pop('HOME', None)
+ env.unset('HOME')
self.assertEqual(p1.expanduser(), P(userhome) / 'Documents')
self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
@@ -3222,10 +3222,7 @@ def test_rglob(self):
def test_expanduser(self):
P = self.cls
with os_helper.EnvironmentVarGuard() as env:
- env.pop('HOME', None)
- env.pop('USERPROFILE', None)
- env.pop('HOMEPATH', None)
- env.pop('HOMEDRIVE', None)
+ env.unset('HOME', 'USERPROFILE', 'HOMEPATH', 'HOMEDRIVE')
env['USERNAME'] = 'alice'
# test that the path returns unchanged
@@ -3263,8 +3260,7 @@ def check():
env['HOMEPATH'] = 'Users\\alice'
check()
- env.pop('HOMEDRIVE', None)
- env.pop('HOMEPATH', None)
+ env.unset('HOMEDRIVE', 'HOMEPATH')
env['USERPROFILE'] = 'C:\\Users\\alice'
check()
diff --git a/Lib/test/test_platform.py b/Lib/test/test_platform.py
index b62a9e3897797c..4a16ff6939c6da 100644
--- a/Lib/test/test_platform.py
+++ b/Lib/test/test_platform.py
@@ -304,8 +304,7 @@ def raises_oserror(*a):
with support.swap_attr(platform, '_wmi_query', raises_oserror):
with os_helper.EnvironmentVarGuard() as environ:
try:
- if 'PROCESSOR_ARCHITEW6432' in environ:
- del environ['PROCESSOR_ARCHITEW6432']
+ del environ['PROCESSOR_ARCHITEW6432']
environ['PROCESSOR_ARCHITECTURE'] = 'foo'
platform._uname_cache = None
system, node, release, version, machine, processor =
platform.uname()
diff --git a/Lib/test/test_regrtest.py b/Lib/test/test_regrtest.py
index 0e8ec60c60ab38..89c01cd605d021 100644
--- a/Lib/test/test_regrtest.py
+++ b/Lib/test/test_regrtest.py
@@ -409,8 +409,7 @@ def create_regrtest(self, args):
# which has an unclear API
with os_helper.EnvironmentVarGuard() as env:
# Ignore SOURCE_DATE_EPOCH env var if it's set
- if 'SOURCE_DATE_EPOCH' in env:
- del env['SOURCE_DATE_EPOCH']
+ del env['SOURCE_DATE_EPOCH']
regrtest = main.Regrtest(ns)
diff --git a/Lib/test/test_shutil.py b/Lib/test/test_shutil.py
index c553ea09e07d55..669f6a28781a50 100644
--- a/Lib/test/test_shutil.py
+++ b/Lib/test/test_shutil.py
@@ -2377,7 +2377,7 @@ def test_environ_path_cwd(self):
def test_environ_path_missing(self):
with os_helper.EnvironmentVarGuard() as env:
- env.pop('PATH', None)
+ del env['PATH']
# without confstr
with unittest.mock.patch('os.confstr', side_effect=ValueError, \
@@ -2403,7 +2403,7 @@ def test_empty_path(self):
def test_empty_path_no_PATH(self):
with os_helper.EnvironmentVarGuard() as env:
- env.pop('PATH', None)
+ del env['PATH']
rv = shutil.which(self.file)
self.assertIsNone(rv)
@@ -3335,8 +3335,7 @@ def test_stty_match(self):
expected = (int(size[1]), int(size[0])) # reversed order
with os_helper.EnvironmentVarGuard() as env:
- del env['LINES']
- del env['COLUMNS']
+ env.unset('LINES', 'COLUMNS')
actual = shutil.get_terminal_size()
self.assertEqual(expected, actual)
@@ -3344,8 +3343,7 @@ def test_stty_match(self):
@unittest.skipIf(support.is_wasi, "WASI has no /dev/null")
def test_fallback(self):
with os_helper.EnvironmentVarGuard() as env:
- del env['LINES']
- del env['COLUMNS']
+ env.unset('LINES', 'COLUMNS')
# sys.__stdout__ has no fileno()
with support.swap_attr(sys, '__stdout__', None):
diff --git a/Lib/test/test_site.py b/Lib/test/test_site.py
index 1a9c81d0d56aaf..249e6b5c07166d 100644
--- a/Lib/test/test_site.py
+++ b/Lib/test/test_site.py
@@ -354,9 +354,7 @@ def test_no_home_directory(self):
with EnvironmentVarGuard() as environ, \
mock.patch('os.path.expanduser', lambda path: path):
-
- del environ['PYTHONUSERBASE']
- del environ['APPDATA']
+ environ.unset('PYTHONUSERBASE', 'APPDATA')
user_base = site.getuserbase()
self.assertTrue(user_base.startswith('~' + os.sep),
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
