Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-120057: Add os.environ.refresh() method #120059

Merged
merged 13 commits into from
Jun 10, 2024
7 changes: 7 additions & 0 deletions Doc/library/os.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,10 @@ process and user.
to the environment made after this time are not reflected in :data:`os.environ`,
except for changes made by modifying :data:`os.environ` directly.

The :meth:`!os.environ.refresh()` method updates
:data:`os.environ` with changes to the environment made in the same process
outside Python.
vstinner marked this conversation as resolved.
Show resolved Hide resolved

This mapping may be used to modify the environment as well as query the
environment. :func:`putenv` will be called automatically when the mapping
is modified.
Expand Down Expand Up @@ -225,6 +229,9 @@ process and user.
.. versionchanged:: 3.9
Updated to support :pep:`584`'s merge (``|``) and update (``|=``) operators.

.. versionchanged:: 3.14
Added the :meth:`!os.environ.refresh()` method.


.. data:: environb

Expand Down
7 changes: 7 additions & 0 deletions Doc/whatsnew/3.14.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,13 @@ ast
Added :func:`ast.compare` for comparing two ASTs.
(Contributed by Batuhan Taskaya and Jeremy Hylton in :issue:`15987`.)

os
--

* Added the :meth:`os.environ.refresh() <os.environ>` method to update
:data:`os.environ` with environment changes made in the same process outside
Python.
(Contributed by Victor Stinner in :gh:`120057`.)


Optimizations
Expand Down
27 changes: 24 additions & 3 deletions Lib/os.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ def _get_exports_list(module):
from posix import _have_functions
except ImportError:
pass
try:
from posix import _create_environ
except ImportError:
pass

import posix
__all__.extend(_get_exports_list(posix))
Expand All @@ -88,6 +92,10 @@ def _get_exports_list(module):
from nt import _have_functions
except ImportError:
pass
try:
from nt import _create_environ
except ImportError:
pass

else:
raise ImportError('no os specific module found')
Expand Down Expand Up @@ -773,7 +781,20 @@ def __ror__(self, other):
new.update(self)
return new

def _createenviron():
if _exists("_create_environ"):
def refresh(self):
environ = _create_environ()
if name == 'nt':
data = {self.encodekey(key): value
vstinner marked this conversation as resolved.
Show resolved Hide resolved
for key, value in environ.items()}
else:
data = environ

# modify in-place to keep os.environb in sync
self._data.clear()
self._data.update(data)

def _create_environ_mapping():
if name == 'nt':
# Where Env Var Names Must Be UPPERCASE
def check_str(value):
Expand Down Expand Up @@ -803,8 +824,8 @@ def decode(value):
encode, decode)

# unicode environ
environ = _createenviron()
del _createenviron
environ = _create_environ_mapping()
del _create_environ_mapping


def getenv(key, default=None):
Expand Down
32 changes: 32 additions & 0 deletions Lib/test/test_os.py
Original file line number Diff line number Diff line change
Expand Up @@ -1298,6 +1298,38 @@ def test_ror_operator(self):
self._test_underlying_process_env('_A_', '')
self._test_underlying_process_env(overridden_key, original_value)

@unittest.skipUnless(hasattr(os.environ, 'refresh'),
vstinner marked this conversation as resolved.
Show resolved Hide resolved
'need os.environ.refresh()')
def test_refresh(self):
# Use putenv() which doesn't update os.environ
has_environb = hasattr(os, 'environb')
try:
from posix import putenv
except ImportError:
from nt import putenv

os.environ['test_env'] = 'python_value'
putenv("test_env", "new_value")
self.assertEqual(os.environ['test_env'], 'python_value')
if has_environb:
self.assertEqual(os.environb[b'test_env'], b'python_value')

os.environ.refresh()
self.assertEqual(os.environ['test_env'], 'new_value')
if has_environb:
self.assertEqual(os.environb[b'test_env'], b'new_value')

if has_environb:
# test os.environb.refresh()
os.environb[b'test_env'] = b'python_value2'
putenv("test_env", "new_value2")
self.assertEqual(os.environb[b'test_env'], b'python_value2')
self.assertEqual(os.environ['test_env'], 'python_value2')

os.environb.refresh()
self.assertEqual(os.environb[b'test_env'], b'new_value2')
self.assertEqual(os.environ['test_env'], 'new_value2')


class WalkTests(unittest.TestCase):
"""Tests for os.walk()."""
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Added the :meth:`os.environ.refresh() <os.environ>` method to update
:data:`os.environ` with environment changes made in the same process outside
Python. Patch by Victor Stinner.
20 changes: 19 additions & 1 deletion Modules/clinic/posixmodule.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 15 additions & 0 deletions Modules/posixmodule.c
Original file line number Diff line number Diff line change
Expand Up @@ -16816,6 +16816,20 @@ os__is_inputhook_installed_impl(PyObject *module)
return PyBool_FromLong(PyOS_InputHook != NULL);
}

/*[clinic input]
os._create_environ

Create the environment dictionary.
[clinic start generated code]*/

static PyObject *
os__create_environ_impl(PyObject *module)
/*[clinic end generated code: output=19d9039ab14f8ad4 input=a4c05686b34635e8]*/
{
return convertenviron();
}


static PyMethodDef posix_methods[] = {

OS_STAT_METHODDEF
Expand Down Expand Up @@ -17030,6 +17044,7 @@ static PyMethodDef posix_methods[] = {
OS__SUPPORTS_VIRTUAL_TERMINAL_METHODDEF
OS__INPUTHOOK_METHODDEF
OS__IS_INPUTHOOK_INSTALLED_METHODDEF
OS__CREATE_ENVIRON_METHODDEF
{NULL, NULL} /* Sentinel */
};

Expand Down
Loading