mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-08 03:45:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

gh-131277: allow EnvironmentVarGuard to unset more than one environment variable at once (#131280)

Browse source 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
This commit is contained in:
Bénédikt Tran 2025-03-16 14:09:33 +01:00 • committed by GitHub
parent 9558d22ac3
commit 3185e3115c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 38 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Doc/library/test.rst
View file

@ -1435,9 +1435,12 @@ The :mod:`test.support.os_helper` module provides support for os tests.
``value``.
.. method:: EnvironmentVarGuard.unset(envvar)
.. method:: EnvironmentVarGuard.unset(envvar, *others)
Temporarily unset the environment variable ``envvar``.
Temporarily unset one or more environment variables.
.. versionchanged:: next
More than one environment variable can be unset.
.. function:: can_symlink()

3
Lib/test/support/__init__.py
View file

@ -2855,8 +2855,7 @@ def no_color():
swap_attr(_colorize, "can_colorize", lambda file=None: False),
EnvironmentVarGuard() as env,
):
for var in {"FORCE_COLOR", "NO_COLOR", "PYTHON_COLORS"}:
env.unset(var)
env.unset("FORCE_COLOR", "NO_COLOR", "PYTHON_COLORS")
env.set("NO_COLOR", "1")
yield

11
Lib/test/support/os_helper.py
View file

@ -720,9 +720,10 @@ else:
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
@ -756,8 +757,10 @@ class EnvironmentVarGuard(collections.abc.MutableMapping):
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.

3
Lib/test/test__colorize.py
View file

@ -10,8 +10,7 @@ from test.support.os_helper import EnvironmentVarGuard
@contextlib.contextmanager
def clear_env():
with EnvironmentVarGuard() as mock_env:
for var in "FORCE_COLOR", "NO_COLOR", "PYTHON_COLORS", "TERM":
mock_env.unset(var)
mock_env.unset("FORCE_COLOR", "NO_COLOR", "PYTHON_COLORS", "TERM")
yield mock_env

13
Lib/test/test__osx_support.py
View file

@ -20,12 +20,13 @@ class Test_OSXSupport(unittest.TestCase):
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

3
Lib/test/test_builtin.py
View file

@ -1568,8 +1568,7 @@ class BuiltinTest(ComplexesAreIdenticalMixin, unittest.TestCase):
# try to get a user preferred encoding different than the current
# locale encoding to check that open() uses the current locale
# encoding and not the user preferred encoding
for key in ('LC_ALL', 'LANG', 'LC_CTYPE'):
env.unset(key)
env.unset('LC_ALL', 'LANG', 'LC_CTYPE')
self.write_testfile()
current_locale_encoding = locale.getencoding()

3
Lib/test/test_getopt.py
View file

@ -13,8 +13,7 @@ sentinel = object()
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)

3
Lib/test/test_io.py
View file

@ -2896,8 +2896,7 @@ class TextIOWrapperTest(unittest.TestCase):
# try to get a user preferred encoding different than the current
# locale encoding to check that TextIOWrapper() uses the current
# locale encoding and not the user preferred encoding
for key in ('LC_ALL', 'LANG', 'LC_CTYPE'):
env.unset(key)
env.unset('LC_ALL', 'LANG', 'LC_CTYPE')
current_locale_encoding = locale.getencoding()
b = self.BytesIO()

4
Lib/test/test_locale.py
View file

@ -500,9 +500,7 @@ class TestMiscellaneous(unittest.TestCase):
try:
with os_helper.EnvironmentVarGuard() as env:
for key in ('LC_ALL', 'LC_CTYPE', 'LANG', 'LANGUAGE'):
env.unset(key)
env.unset('LC_ALL', 'LC_CTYPE', 'LANG', 'LANGUAGE')
env.set('LC_CTYPE', 'UTF-8')
with check_warnings(('', DeprecationWarning)):

10
Lib/test/test_pathlib/test_pathlib.py
View file

@ -3232,7 +3232,7 @@ class PathTest(PurePathTest):
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')
@ -3345,10 +3345,7 @@ class PathTest(PurePathTest):
def test_expanduser_windows(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
@ -3386,8 +3383,7 @@ class PathTest(PurePathTest):
env['HOMEPATH'] = 'Users\\alice'
check()
env.pop('HOMEDRIVE', None)
env.pop('HOMEPATH', None)
env.unset('HOMEDRIVE', 'HOMEPATH')
env['USERPROFILE'] = 'C:\\Users\\alice'
check()

3
Lib/test/test_platform.py
View file

@ -368,8 +368,7 @@ class PlatformTest(unittest.TestCase):
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()

3
Lib/test/test_regrtest.py
View file

@ -422,8 +422,7 @@ class ParseArgsTestCase(unittest.TestCase):
# 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)

10
Lib/test/test_shutil.py
View file

@ -2458,7 +2458,7 @@ class TestWhich(BaseTest, unittest.TestCase):
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, \
@ -2484,7 +2484,7 @@ class TestWhich(BaseTest, unittest.TestCase):
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)
@ -3446,8 +3446,7 @@ class TestGetTerminalSize(unittest.TestCase):
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)
@ -3455,8 +3454,7 @@ class TestGetTerminalSize(unittest.TestCase):
@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):

4
Lib/test/test_site.py
View file

@ -355,9 +355,7 @@ class HelperFunctionsTests(unittest.TestCase):
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),

3
Misc/NEWS.d/next/Tests/2025-03-15-12-44-54.gh-issue-131277.JaMlVa.rst Normal file
View file

@ -0,0 +1,3 @@
Allow to unset one or more environment variables at once via
:meth:`EnvironmentVarGuard.unset()
<test.support.os_helper.EnvironmentVarGuard.unset>`. Patch by Bénédikt Tran.