gh-120057: Rename os.environ.refresh() to invalidate_cache()

Doc/library/os.rst

@@ -193,8 +193,8 @@ 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 by :func:`os.putenv`, by
+   The :meth:`!os.environ.invalidate_cache()` method updates :data:`os.environ`
+   with changes to the environment made by :func:`os.putenv`, by
    :func:`os.unsetenv`, or made outside Python in the same process.
 
    This mapping may be used to modify the environment as well as query the
@@ -230,7 +230,7 @@ process and user.
       Updated to support :pep:`584`'s merge (``|``) and update (``|=``) operators.
 
    .. versionchanged:: 3.14
-      Added the :meth:`!os.environ.refresh()` method.
+      Added the :meth:`!os.environ.invalidate_cache()` method.
 
 
 .. data:: environb
@@ -568,7 +568,7 @@ process and user.
    of :data:`os.environ`. This also applies to :func:`getenv` and :func:`getenvb`, which
    respectively use :data:`os.environ` and :data:`os.environb` in their implementations.
 
-   See also the :data:`os.environ.refresh() <os.environ>` method.
+   See also the :data:`os.environ.invalidate_cache() <os.environ>` method.
 
    .. note::
 
@@ -818,7 +818,7 @@ process and user.
    don't update :data:`os.environ`, so it is actually preferable to delete items of
    :data:`os.environ`.
 
-   See also the :data:`os.environ.refresh() <os.environ>` method.
+   See also the :data:`os.environ.invalidate_cache() <os.environ>` method.
 
    .. audit-event:: os.unsetenv key os.unsetenv
 

Doc/whatsnew/3.14.rst

@@ -95,7 +95,7 @@ Added :func:`ast.compare` for comparing two ASTs.
 os
 --
 
-* Added the :data:`os.environ.refresh() <os.environ>` method to update
+* Added the :data:`os.environ.invalidate_cache() <os.environ>` method to update
   :data:`os.environ` with changes to the environment made by :func:`os.putenv`,
   by :func:`os.unsetenv`, or made outside Python in the same process.
   (Contributed by Victor Stinner in :gh:`120057`.)

Lib/os.py

@@ -782,7 +782,7 @@ def __ror__(self, other):
         return new
 
     if _exists("_create_environ"):
-        def refresh(self):
+        def invalidate_cache(self):
             data = _create_environ()
             if name == 'nt':
                 data = {self.encodekey(key): value

Lib/test/test_os.py

@@ -1298,8 +1298,8 @@ def test_ror_operator(self):
         self._test_underlying_process_env('_A_', '')
         self._test_underlying_process_env(overridden_key, original_value)
 
-    def test_refresh(self):
-        # Test os.environ.refresh()
+    def test_invalidate_cache(self):
+        # Test os.environ.invalidate_cache()
         has_environb = hasattr(os, 'environb')
 
         # Test with putenv() which doesn't update os.environ
@@ -1309,7 +1309,7 @@ def test_refresh(self):
         if has_environb:
             self.assertEqual(os.environb[b'test_env'], b'python_value')
 
-        os.environ.refresh()
+        os.environ.invalidate_cache()
         self.assertEqual(os.environ['test_env'], 'new_value')
         if has_environb:
             self.assertEqual(os.environb[b'test_env'], b'new_value')
@@ -1320,28 +1320,28 @@ def test_refresh(self):
         if has_environb:
             self.assertEqual(os.environb[b'test_env'], b'new_value')
 
-        os.environ.refresh()
+        os.environ.invalidate_cache()
         self.assertNotIn('test_env', os.environ)
         if has_environb:
             self.assertNotIn(b'test_env', os.environb)
 
         if has_environb:
-            # test os.environb.refresh() with putenv()
+            # test os.environb.invalidate_cache() with putenv()
             os.environb[b'test_env'] = b'python_value2'
             os.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()
+            os.environb.invalidate_cache()
             self.assertEqual(os.environb[b'test_env'], b'new_value2')
             self.assertEqual(os.environ['test_env'], 'new_value2')
 
-            # test os.environb.refresh() with unsetenv()
+            # test os.environb.invalidate_cache() with unsetenv()
             os.unsetenv('test_env')
             self.assertEqual(os.environb[b'test_env'], b'new_value2')
             self.assertEqual(os.environ['test_env'], 'new_value2')
 
-            os.environb.refresh()
+            os.environb.invalidate_cache()
             self.assertNotIn(b'test_env', os.environb)
             self.assertNotIn('test_env', os.environ)
 

Misc/NEWS.d/next/Library/2024-06-04-18-53-10.gh-issue-120057.RSD9_Z.rst

@@ -1,4 +1,4 @@
-Added the :data:`os.environ.refresh() <os.environ>` method to update
+Added the :data:`os.environ.invalidate_cache() <os.environ>` method to update
 :data:`os.environ` with changes to the environment made by :func:`os.putenv`,
 by :func:`os.unsetenv`, or made outside Python in the same process.
 Patch by Victor Stinner.