Issue 10220: switch to using string constants rather than integers for inspect.getgeneratorstate() return values and make debugging friendly str() and repr() for generator states a requirement in the test suite

2 files changed, 12 insertions, 1 deletions

diff --git a/Lib/inspect.py b/Lib/inspect.py
index e410dba..ed10ac5 100644
--- a/Lib/inspect.py
+++ b/Lib/inspect.py
@@ -1130,7 +1130,10 @@ def getattr_static(obj, attr, default=_sentinel):
     raise AttributeError(attr)
 
 
-GEN_CREATED, GEN_RUNNING, GEN_SUSPENDED, GEN_CLOSED = range(4)
+GEN_CREATED = 'GEN_CREATED'
+GEN_RUNNING = 'GEN_RUNNING'
+GEN_SUSPENDED = 'GEN_SUSPENDED'
+GEN_CLOSED = 'GEN_CLOSED'
 
 def getgeneratorstate(generator):
     """Get current state of a generator-iterator.
diff --git a/Lib/test/test_inspect.py b/Lib/test/test_inspect.py
index 97c47ac..71f0e8a 100644
--- a/Lib/test/test_inspect.py
+++ b/Lib/test/test_inspect.py
@@ -931,6 +931,14 @@ class TestGetGeneratorState(unittest.TestCase):
         # Running after the first yield
         next(self.generator)
 
+    def test_easy_debugging(self):
+        # repr() and str() of a generator state should contain the state name
+        names = 'GEN_CREATED GEN_RUNNING GEN_SUSPENDED GEN_CLOSED'.split()
+        for name in names:
+            state = getattr(inspect, name)
+            self.assertIn(name, repr(state))
+            self.assertIn(name, str(state))
+
 
 def test_main():
     run_unittest(