integrated more of john's changes for python 3 compatibility

Philip Guo · Philip Guo · commit d8f7b0dbf4c8 · 2012-08-10T12:05:22.000-07:00
diff --git a/PyTutorGAE/README b/PyTutorGAE/README
@@ -0,0 +1,4 @@
+Thanks to John DeNero, this version of Online Python Tutor (v3) should work on both Python 2 and 3.
+
+TODO: write more detailed instructions for running on Google App Engine (Python 2.7) and CGI (Python 2.X or 3.X)
+
diff --git a/PyTutorGAE/pg_encoder.py b/PyTutorGAE/pg_encoder.py
@@ -22,6 +22,8 @@
 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+# Thanks to John DeNero for making the encoder work on both Python 2 and 3
+
 
 # Given an arbitrary piece of Python data, encode it in such a manner
 # that it can be later encoded into JSON.
@@ -50,11 +52,17 @@
 
 
 import re, types
+import sys
 typeRE = re.compile("<type '(.*)'>")
 classRE = re.compile("<class '(.*)'>")
 
 import inspect
 
+is_python3 = (sys.version_info[0] == 3)
+if is_python3:
+  long = None # Avoid NameError when evaluating "long"
+
+
 def get_name(obj):
   """Return the name of an object."""
   return obj.__name__ if hasattr(obj, '__name__') else get_name(type(obj))
@@ -141,23 +149,6 @@ def encode(self, dat):
           # don't display some built-in locals ...
           if k not in ('__module__', '__return__', '__locals__'):
             new_obj.append([self.encode(k), self.encode(v)])
-
-      elif typ in (types.InstanceType, types.ClassType, types.TypeType) or \
-           classRE.match(str(typ)):
-        # ugh, classRE match is a bit of a hack :(
-        if typ == types.InstanceType or classRE.match(str(typ)):
-          new_obj.extend(['INSTANCE', dat.__class__.__name__])
-        else:
-          superclass_names = [e.__name__ for e in dat.__bases__]
-          new_obj.extend(['CLASS', dat.__name__, superclass_names])
-
-        # traverse inside of its __dict__ to grab attributes
-        # (filter out useless-seeming ones):
-        user_attrs = sorted([e for e in dat.__dict__.keys() 
-                             if e not in ('__doc__', '__module__', '__return__')])
-
-        for attr in user_attrs:
-          new_obj.append([self.encode(attr), self.encode(dat.__dict__[attr])])
       elif typ in (types.FunctionType, types.MethodType):
         # NB: In Python 3.0, getargspec is deprecated in favor of getfullargspec
         argspec = inspect.getargspec(dat)
@@ -173,6 +164,8 @@ def encode(self, dat):
           func_name = u"\u03BB" # Unicode lambda :)
         pretty_name = func_name + '(' + ', '.join(printed_args) + ')'
         new_obj.extend(['FUNCTION', pretty_name, None]) # the final element will be filled in later
+      elif self.is_class(dat) or self.is_instance(dat):
+        self.encode_class_or_instance(dat, new_obj)
       else:
         typeStr = str(typ)
         m = typeRE.match(typeStr)
@@ -181,3 +174,41 @@ def encode(self, dat):
 
       return ret
 
+
+  def is_class(self, dat):
+    """Return whether dat is a class."""
+    if is_python3:
+      return isinstance(dat, type)
+    else:
+      return type(dat) in (types.ClassType, types.TypeType)
+
+
+  def is_instance(self, dat):
+    """Return whether dat is an instance of a class."""
+    if is_python3:
+      return isinstance(type(dat), type) and not isinstance(dat, type)
+    else:
+      # ugh, classRE match is a bit of a hack :(
+      return type(dat) == types.InstanceType or classRE.match(str(type(dat)))
+
+
+  def encode_class_or_instance(self, dat, new_obj):
+    """Encode dat as a class or instance."""
+    if self.is_instance(dat):
+      new_obj.extend(['INSTANCE', get_name(dat.__class__)])
+    else:
+      superclass_names = [e.__name__ for e in dat.__bases__ if e is not object]
+      new_obj.extend(['CLASS', get_name(dat), superclass_names])
+
+    # traverse inside of its __dict__ to grab attributes
+    # (filter out useless-seeming ones):
+    hidden = ('__doc__', '__module__', '__return__', '__dict__',
+        '__locals__', '__weakref__')
+    if hasattr(dat, '__dict__'):
+      user_attrs = sorted([e for e in dat.__dict__ if e not in hidden])
+    else:
+      user_attrs = []
+
+    for attr in user_attrs:
+      new_obj.append([self.encode(attr), self.encode(dat.__dict__[attr])])
+
diff --git a/PyTutorGAE/pg_logger.py b/PyTutorGAE/pg_logger.py
@@ -128,7 +128,6 @@ def __init__(self, finalizer_func):
     # to make an educated guess based on the contents of local
     # variables inherited from possible parent frame candidates.
     def get_parent_frame(self, frame):
-      # TODO(denero) Is this true in Python 3?!?
       for (func_obj, parent_frame) in self.closures.items():
         # ok, there's a possible match, but let's compare the
         # local variables in parent_frame to those of frame
@@ -280,7 +279,6 @@ def create_encoded_stack_entry(cur_frame):
             for pid in parent_frame_id_list:
               parent_frame = self.lookup_zombie_frame_by_id(pid)
               if k in parent_frame.f_locals:
-                # TODO(denero) Check Python3
                 # ignore __return__, which is never copied
                 if k != '__return__':
                   # these values SHOULD BE ALIASES
@@ -298,7 +296,6 @@ def create_encoded_stack_entry(cur_frame):
             encoded_val = self.encoder.encode(v)
 
             # UGH, this is SUPER ugly but needed for nested function defs
-            # TODO(denero) Is this true in Python 3?!?
             if type(v) in (types.FunctionType, types.MethodType):
               try:
                 enclosing_frame = self.closures[v]

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +Thanks to John DeNero, this version of Online Python Tutor (v3) should work on both Python 2 and 3.
++
 +TODO: write more detailed instructions for running on Google App Engine (Python 2.7) and CGI (Python 2.X or 3.X)
++