beautiful further fix to show parent frames of

Philip Guo · Philip Guo · commit 618bcef82c83 · 2012-10-02T16:30:17.000-07:00
functions nested within data structures (by John DeNero)
diff --git a/v3/example-code/closures/student-torture.golden_py3 b/v3/example-code/closures/student-torture.golden_py3
@@ -460,7 +460,7 @@
         "5": [
           "FUNCTION", 
           "<lambda>()", 
-          null
+          2
         ]
       }, 
       "line": 10, 
@@ -699,7 +699,7 @@
         "7": [
           "FUNCTION", 
           "<lambda>()", 
-          null
+          1
         ]
       }, 
       "line": 12, 
diff --git a/v3/pg_encoder.py b/v3/pg_encoder.py
@@ -122,7 +122,8 @@ def set_function_parent_frame_ID(self, ref_obj, enclosing_frame_id):
 
   # return either a primitive object or an object reference;
   # and as a side effect, update encoded_heap_objects
-  def encode(self, dat):
+  def encode(self, dat, get_parent):
+    """Encode a data value DAT using the GET_PARENT function for parent ids."""
     # primitive type
     if type(dat) in (int, long, float, str, bool, type(None)):
       if type(dat) is float:
@@ -159,21 +160,21 @@ def encode(self, dat):
       if typ == list:
         new_obj.append('LIST')
         for e in dat:
-          new_obj.append(self.encode(e))
+          new_obj.append(self.encode(e, get_parent))
       elif typ == tuple:
         new_obj.append('TUPLE')
         for e in dat:
-          new_obj.append(self.encode(e))
+          new_obj.append(self.encode(e, get_parent))
       elif typ == set:
         new_obj.append('SET')
         for e in dat:
-          new_obj.append(self.encode(e))
+          new_obj.append(self.encode(e, get_parent))
       elif typ == dict:
         new_obj.append('DICT')
         for (k, v) in dat.items():
           # don't display some built-in locals ...
           if k not in ('__module__', '__return__', '__locals__'):
-            new_obj.append([self.encode(k), self.encode(v)])
+            new_obj.append([self.encode(k, get_parent), self.encode(v, get_parent)])
       elif typ in (types.FunctionType, types.MethodType):
         if is_python3:
           argspec = inspect.getfullargspec(dat)
@@ -195,7 +196,11 @@ def encode(self, dat):
 
         func_name = get_name(dat)
         pretty_name = func_name + '(' + ', '.join(printed_args) + ')'
-        new_obj.extend(['FUNCTION', pretty_name, None]) # the final element will be filled in later
+        encoded_val = ['FUNCTION', pretty_name, None]
+        if get_parent:
+          enclosing_frame_id = get_parent(dat)
+          encoded_val[2] = enclosing_frame_id
+        new_obj.extend(encoded_val)
       elif typ is types.BuiltinFunctionType:
         pretty_name = get_name(dat) + '(...)'
         new_obj.extend(['FUNCTION', pretty_name, None])
@@ -247,5 +252,5 @@ def encode_class_or_instance(self, dat, new_obj):
       user_attrs = []
 
     for attr in user_attrs:
-      new_obj.append([self.encode(attr), self.encode(dat.__dict__[attr])])
+      new_obj.append([self.encode(attr, None), self.encode(dat.__dict__[attr], None)])
 
diff --git a/v3/pg_logger.py b/v3/pg_logger.py
@@ -247,6 +247,12 @@ def __init__(self, cumulative_mode, finalizer_func):
     def get_frame_id(self, cur_frame):
       return self.frame_ordered_ids[cur_frame]
 
+    # Returns the (lexical) parent of a function value.
+    def get_parent_of_function(self, val):
+      if val not in self.closures:
+        return None
+      return self.get_frame_id(self.closures[val])
+
 
     # Returns the (lexical) parent frame of the function that was called
     # to create the stack frame 'frame'.
@@ -467,20 +473,7 @@ def create_encoded_stack_entry(cur_frame):
             if k == '__module__':
               continue
 
-            encoded_val = self.encoder.encode(v)
-
-            # UGH, this is SUPER ugly but needed for nested function defs
-            #
-            # NB: Known limitation -- this will work only for functions
-            # defined on the top level, not those that are nested within,
-            # say, tuples or lists
-            if type(v) in (types.FunctionType, types.MethodType):
-              try:
-                enclosing_frame = self.closures[v]
-                enclosing_frame_id = self.get_frame_id(enclosing_frame)
-                self.encoder.set_function_parent_frame_ID(encoded_val, enclosing_frame_id)
-              except KeyError:
-                pass
+            encoded_val = self.encoder.encode(v, self.get_parent_of_function)
             encoded_locals[k] = encoded_val
 
 
@@ -590,20 +583,7 @@ def create_encoded_stack_entry(cur_frame):
         # effects of aliasing later down the line ...
         encoded_globals = {}
         for (k, v) in get_user_globals(tos[0]).items():
-          encoded_val = self.encoder.encode(v)
-
-          # UGH, this is SUPER ugly but needed for nested function defs
-          #
-          # NB: Known limitation -- this will work only for functions
-          # defined on the top level, not those that are nested within,
-          # say, tuples or lists
-          if type(v) in (types.FunctionType, types.MethodType):
-            try:
-              enclosing_frame = self.closures[v]
-              enclosing_frame_id = self.get_frame_id(enclosing_frame)
-              self.encoder.set_function_parent_frame_ID(encoded_val, enclosing_frame_id)
-            except KeyError:
-              pass
+          encoded_val = self.encoder.encode(v, self.get_parent_of_function)
           encoded_globals[k] = encoded_val
 
           if k not in self.all_globals_in_order:
diff --git a/v3/tests/backend-tests/john-lambda-lambda.golden b/v3/tests/backend-tests/john-lambda-lambda.golden
@@ -326,7 +326,7 @@
         "4": [
           "FUNCTION", 
           "<lambda>(b)", 
-          null
+          2
         ]
       }, 
       "line": 5, 
@@ -462,7 +462,7 @@
         "4": [
           "FUNCTION", 
           "<lambda>(b)", 
-          null
+          2
         ]
       }, 
       "line": 5, 
diff --git a/v3/tests/backend-tests/john-lambda-lambda.golden_py3 b/v3/tests/backend-tests/john-lambda-lambda.golden_py3
@@ -326,7 +326,7 @@
         "4": [
           "FUNCTION", 
           "<lambda>(b)", 
-          null
+          2
         ]
       }, 
       "line": 5, 
@@ -462,7 +462,7 @@
         "4": [
           "FUNCTION", 
           "<lambda>(b)", 
-          null
+          2
         ]
       }, 
       "line": 5, 
diff --git a/v3/tests/backend-tests/john-triple-nesting.golden_py3 b/v3/tests/backend-tests/john-triple-nesting.golden_py3
@@ -460,7 +460,7 @@
         "5": [
           "FUNCTION", 
           "<lambda>()", 
-          null
+          2
         ]
       }, 
       "line": 7, 
@@ -699,7 +699,7 @@
         "7": [
           "FUNCTION", 
           "<lambda>()", 
-          null
+          1
         ]
       }, 
       "line": 9, 
