Issue #10859: Make `contextlib.GeneratorContextManager` officially

private by renaming it to `_GeneratorContextManager`.

diff --git a/Lib/contextlib.py b/Lib/contextlib.py
index e37fde8a020900b1a398122b7caac1d2daa734e6..4633cff7a48277881c1912ab48b42dc29784eca1 100644 (file)
--- a/Lib/contextlib.py
+++ b/Lib/contextlib.py
@@ -17,7 +17,7 @@ class ContextDecorator(object):
         return inner
 
 
-class GeneratorContextManager(ContextDecorator):
+class _GeneratorContextManager(ContextDecorator):
     """Helper for @contextmanager decorator."""
 
     def __init__(self, gen):
@@ -92,7 +92,7 @@ def contextmanager(func):
     """
     @wraps(func)
     def helper(*args, **kwds):
-        return GeneratorContextManager(func(*args, **kwds))
+        return _GeneratorContextManager(func(*args, **kwds))
     return helper
 
 

diff --git a/Lib/test/test_with.py b/Lib/test/test_with.py
index d6308e4fa4795c56a91656d7f1696b8fff7ff244..a9d374b3244d1c4d1bf538743ecccd5355c07b3f 100644 (file)
--- a/Lib/test/test_with.py
+++ b/Lib/test/test_with.py
@@ -9,26 +9,26 @@ __email__ = "mbland at acm dot org"
 import sys
 import unittest
 from collections import deque
-from contextlib import GeneratorContextManager, contextmanager
+from contextlib import _GeneratorContextManager, contextmanager
 from test.support import run_unittest
 
 
-class MockContextManager(GeneratorContextManager):
+class MockContextManager(_GeneratorContextManager):
     def __init__(self, gen):
-        GeneratorContextManager.__init__(self, gen)
+        _GeneratorContextManager.__init__(self, gen)
         self.enter_called = False
         self.exit_called = False
         self.exit_args = None
 
     def __enter__(self):
         self.enter_called = True
-        return GeneratorContextManager.__enter__(self)
+        return _GeneratorContextManager.__enter__(self)
 
     def __exit__(self, type, value, traceback):
         self.exit_called = True
         self.exit_args = (type, value, traceback)
-        return GeneratorContextManager.__exit__(self, type,
-                                                value, traceback)
+        return _GeneratorContextManager.__exit__(self, type,
+                                                 value, traceback)
 
 
 def mock_contextmanager(func):

diff --git a/Misc/NEWS b/Misc/NEWS
index 06832452f2bb0b6fe5171d625363aa03a926ab07..0b2d346eddf7fa54a2797c2fc9a95b87346b0687 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -40,6 +40,9 @@ Core and Builtins
 Library
 -------
 
+- Issue #10859: Make ``contextlib.GeneratorContextManager`` officially
+  private by renaming it to ``_GeneratorContextManager``.
+
 - Issue #10042: Fixed the total_ordering decorator to handle cross-type
   comparisons that could lead to infinite recursion.