Update swig generation shell scripts to run under Python 3.x

[zturner]

Summary

Todd, I'm putting you as the reviewer since you seem to be the most knowledgeable about Python. If you can think of someone better, let me know.

The goal here is for these scripts to be able to run successfully under both Python 2.x and Python 3.5. In most cases this was fairly straightforward. Only 1 or 2 places needed a version-switch.

[tfiala]

Todd, I'm putting you as the reviewer since you seem to be the most knowledgeable about Python. If you can think of someone better, let me know.

I'll have a look tonight.

[tfiala]

In D13448#260194, @tfiala wrote:

Todd, I'm putting you as the reviewer since you seem to be the most knowledgeable about Python. If you can think of someone better, let me know.

I'll have a look tonight.

I may try to switch over the Xcode build to use it as well, at the same time.

[tfiala]

In D13448#260195, @tfiala wrote:

In D13448#260194, @tfiala wrote:

Todd, I'm putting you as the reviewer since you seem to be the most knowledgeable about Python. If you can think of someone better, let me know.

I'll have a look tonight.

I may try to switch over the Xcode build to use it as well, at the same time.

I attempted to drop in the script on the OS X Xcode build tonight. Detailed here:
https://llvm.org/bugs/show_bug.cgi?id=25062

It ends up not being a fast operation. I've spent a few hours getting it going but I still have link errors.

I was hoping I could have that working, and then make sure this doesn't break it, but at this point I don't have my desired starting condition (plugged into Xcode) satisfied.

I'll have to look at this tomorrow and I'll do it from a Linux slant since I may not have time at the moment to put more effort into getting it running on the Xcode side.

[tfiala]

Okay all that said, the change itself looks fine. Have you tried it on Linux? I'll give it a go there in the morning. If it doesn't break there, I have no issues with this change.

[tfiala]

LGTM. I saw no issues on Ubuntu 14.04 x86_64 and the changes all look reasonable.

[tfiala]

Hey Zachary, I think this one went in, didn't it? Can you close it out if so? Thanks!

[zturner]

Yes this went in

[tfiala]

Great! Closing out.

scripts/Python/buildSwigPython.py

             "/include/lldb/API/SBValue.h",
             "/include/lldb/API/SBValueList.h",
             "/include/lldb/API/SBWatchpoint.h" ];
-  bDebug = vDictArgs.has_key( "-d" );
+  bDebug = "-d" in vDictArgs;
   strRt = vDictArgs[ "--srcRoot" ];
   strRt = os.path.normcase( strRt );
   

     strHeaderFiles += " %s%s" % (strRt, strHdr);
   
   if bDebug:
-    print strMsgHdrFiles;
-    print strHeaderFiles;
+    print(strMsgHdrFiles);
+    print(strHeaderFiles);
     
   vDictArgs[ "--headerFiles" ] = strHeaderFiles;
   

             "/scripts/interface/SBValue.i",
             "/scripts/interface/SBValueList.i",
             "/scripts/interface/SBWatchpoint.i" ];  
-  bDebug = vDictArgs.has_key( "-d" );
+  bDebug = "-d" in vDictArgs;
   strRt = vDictArgs[ "--srcRoot" ];
   strRt = os.path.normcase( strRt );
   

     strInterfaceFiles += " %s%s" % (strRt, strIFace);
   
   if bDebug:
-    print strMsgIFaceFiles;
-    print strInterfaceFiles;
+    print(strMsgIFaceFiles);
+    print(strInterfaceFiles);
   
   vDictArgs[ "--ifaceFiles" ] = strInterfaceFiles;
     

 #--
 def check_file_exists( vDictArgs, vstrFileNamePath ):
   bExists = False;
-  bDebug = vDictArgs.has_key( "-d" );
+  bDebug = "-d" in vDictArgs;
   
   if os.path.exists( vstrFileNamePath ):
     bExists = True;
   elif bDebug:
-    print strMsgFileNotExist % vstrFileNamePath;
+    print(strMsgFileNotExist % vstrFileNamePath);
   
   return bExists;
 

 #--
 def check_newer_file( vDictArgs, vstrSwigOpFileNamePath, vstrFileNamePath ):
   bNeedUpdate = False;
-  bDebug = vDictArgs.has_key( "-d" );
+  bDebug = "-d" in vDictArgs;
   
   strMsg = "";
   nResult = which_file_is_newer( vstrFileNamePath, vstrSwigOpFileNamePath );

     bNeedUpdate = True;
   
   if bNeedUpdate and bDebug:
-    print strMsg;
+    print(strMsg);
   
   return bNeedUpdate;
 

   # on the system other stuff may need to be put here as well.
   from distutils.sysconfig import get_python_lib;
   strPythonInstallDir = "";
-  bHaveArgPrefix = vDictArgs.has_key( "--prefix" );
+  bHaveArgPrefix = "--prefix" in vDictArgs;
   if bHaveArgPrefix: 
     strPythonInstallDir = vDictArgs[ "--prefix" ];
   if strPythonInstallDir.__len__() != 0:

   bOk = True;
   strWkDir = "";
   strErrMsg = "";
-  bDbg = vDictArgs.has_key( "-d" );
+  bDbg = "-d" in vDictArgs;
   
-  bMakeFileCalled = vDictArgs.has_key( "-m" );
+  bMakeFileCalled = "-m" in vDictArgs;
   if bMakeFileCalled:
     dbg.dump_text( "Built by LLVM" );
     return get_framework_python_dir_windows( vDictArgs );

     strWkDir += "/LLDB.framework";
     if os.path.exists( strWkDir ):
       if bDbg:
-        print strMsgFoundLldbFrameWkDir % strWkDir;
+        print(strMsgFoundLldbFrameWkDir % strWkDir);
       strWkDir += "/Resources/Python/lldb";
       strWkDir = os.path.normcase( strWkDir );
     else:

   strErrMsg = "";
   
   strConfigBldDir = "";
-  bHaveConfigBldDir = vDictArgs.has_key( "--cfgBldDir" );
+  bHaveConfigBldDir = "--cfgBldDir" in vDictArgs;
   if bHaveConfigBldDir:
     strConfigBldDir = vDictArgs[ "--cfgBldDir" ];
   if (bHaveConfigBldDir == False) or (strConfigBldDir.__len__() == 0):

   dbg = utilsDebug.CDebugFnVerbose( "Python script do_swig_rebuild()" );
   bOk = True;
   strMsg = "";
-  bDbg = vDictArgs.has_key( "-d" );
-  bGenDependencies = vDictArgs.has_key( "-M" );
+  bDbg = "-d" in vDictArgs;
+  bGenDependencies = "-M" in vDictArgs;
   strSwigExePath = vDictArgs[ "--swigExePath" ];
   strSwigExeName = vDictArgs[ "--swigExeName" ];
   strSrcRoot = vDictArgs[ "--srcRoot" ];

   strCmd += "-o \"%s\" " % strOp;
   strCmd += "\"%s\" " % strIp;
   if bDbg:
-    print strMsgSwigExecute % strCmd;
+    print(strMsgSwigExecute % strCmd);
 
   # Execute SWIG
   process = subprocess.Popen( strCmd, stdout=subprocess.PIPE, 

   dbg = utilsDebug.CDebugFnVerbose( "Python script run_python_script()" );
   bOk = True;
   strMsg = "";
-  bDbg = vDictArgs.has_key( "-d" );
+  bDbg = "-d" in vDictArgs;
   
   strPy = "%s %s" % (sys.executable, vstrArgs);
   process = subprocess.Popen( strPy, shell=True );

   dbg = utilsDebug.CDebugFnVerbose( "Python script do_modify_python_lldb()" );
   bOk = True;
   strMsg = "";
-  bDbg = vDictArgs.has_key( "-d" );
+  bDbg = "-d" in vDictArgs;
   strCwd = vDictArgs[ "--srcRoot" ]; # /llvm/tools/lldb
   strCwd += "/scripts/Python";
   strPyScript = "modify-python-lldb.py";

   strMsg = "";
   strErrMsgProgFail = "";
   
-  if not( vDictArgs.has_key( "--swigExePath" ) and vDictArgs.has_key( "--swigExeName" ) ):
+  if not("--swigExePath" in vDictArgs) and ("--swigExeName" in vDictArgs):
     strErrMsgProgFail += strErrMsgSwigParamsMissing;
     return (-100, strErrMsgProgFail );  
   
-  bDebug = vDictArgs.has_key( "-d" );
+  bDebug = "-d" in vDictArgs;
   
   strSwigDepFile = "";
   strSwigDepOptions = "";
-  bGenDependencies = vDictArgs.has_key( "-M" );
+  bGenDependencies = "-M" in vDictArgs;
   if bGenDependencies:
     strSwigDepFile = vDictArgs[ "--targetDir" ] + "/LLDBWrapPython.cpp.d";
     strSwigDepOptions = "-MMD -MF \"%s.tmp\"" % strSwigDepFile;
     strSwigDepFile = os.path.normcase( strSwigDepFile );
     strSwigDepOptions = os.path.normcase( strSwigDepOptions );
     
-  bMakeFileCalled = vDictArgs.has_key( "-m" );      
+  bMakeFileCalled = "-m" in vDictArgs;
   strSwigOutputFile = ""
   if bMakeFileCalled:
     strSwigOutputFile = vDictArgs[ "--targetDir" ] + "/LLDBWrapPython.cpp";

   if bOk and (bNeedUpdate == False):
     strInitPiPath = strFrameworkPythonDir + "/__init__.py";
     strInitPiPath = os.path.normcase( strInitPiPath );
-    print strInitPiPath
+    print(strInitPiPath)
     bNeedUpdate = not check_file_exists( vDictArgs, strInitPiPath );
     dbg.dump_object( "check_file_exists( vDictArgs, strInitPiPath ), bNeedUpdate =", bNeedUpdate);
     

       strMsg = strMsgNotNeedUpdate;
       return (0, strMsg );
     else:
-      print strMsgSwigNeedRebuild;
+      print(strMsgSwigNeedRebuild);
       bOk, strMsg, nExitResult = do_swig_rebuild( vDictArgs, strSwigDepFile, 
                             strCfgBldDir, 
                             strSwigOutputFile,
                             strSwigInputFile );
-      bGenDependencies = vDictArgs.has_key( "-M" );
+      bGenDependencies = "-M" in vDictArgs;
       if bGenDependencies == True:
         return (nExitResult, strMsg);
             

 # This script can be called by another Python script by calling the main() 
 # function directly
 if __name__ == "__main__":
-  print "Script cannot be called directly, called by buildSwigWrapperClasses.py";
+  print("Script cannot be called directly, called by buildSwigWrapperClasses.py");
   

scripts/Python/modify-python-lldb.py

 # subsystem.
 #
 
-import sys, re, StringIO
+import sys, re
+if sys.version_info.major >= 3:
+    import io as StringIO
+else:
+    import StringIO
 
 if len (sys.argv) != 2:
     output_name = "./lldb.py"

     def add_line(self, a_line):
         """Add a line to the content, if there is a previous line, commit it."""
         if self.prev_line != None:
-            print >> self, self.prev_line
+            self.write(self.prev_line + "\n")
         self.prev_line = a_line
     def del_line(self):
         """Forget about the previous line, do not commit it."""

     def finish(self):
         """Call this when you're finished with populating content."""
         if self.prev_line != None:
-            print >> self, self.prev_line
+            self.write(self.prev_line + "\n")
         self.prev_line = None
 
 # The new content will have the iteration protocol defined for our lldb objects.

scripts/buildSwigWrapperClasses.py

 
     if vMsg.__len__() != 0:
         strMsg = "%s: %s (%d)" % (strExitMsgSuccess, vMsg, vnResult);
-        print strMsg;
+        print(strMsg);
 
     sys.exit( vnResult );
 

 # Throws:   None.
 #--
 def program_exit_on_failure( vnResult, vMsg ):
-    print "%s%s (%d)" % (strExitMsgError, vMsg, vnResult);
+    print("%s%s (%d)" % (strExitMsgError, vMsg, vnResult));
     sys.exit( vnResult );
 
 #++---------------------------------------------------------------------------

         if val.__len__() != 0:
             strEqs = " =";
             strQ = "\"";
-        print "%s%s%s %s%s%s\n" % (strParameter, arg, strEqs, strQ, val, strQ);
+        print("%s%s%s %s%s%s\n" % (strParameter, arg, strEqs, strQ, val, strQ));
 
 #++---------------------------------------------------------------------------
 # Details:  Locate the lldb.swig file. No checking for path correctness is

     bOk = os.path.isfile( strFullPath );
     if bOk:
         if gbDbgFlag:
-            print strSwigFileFound;
+            print(strSwigFileFound);
     else:
         strStatusMsg = strSwigFileFoundNotFound % strFullPath;
 

         return (-9, strStatusMsg);
 
     if gbDbgFlag:
-        print strSwigScriptLangFound % vStrScriptLang;
-        print strSwigExecuteMsg % vStrScriptLang;
+        print(strSwigScriptLangFound % vStrScriptLang);
+        print(strSwigExecuteMsg % vStrScriptLang);
 
     # Change where Python looks for our modules
     strDir = os.path.normcase( strScriptFileDir );

         listDirs.remove('.svn')
 
     if gbDbgFlag:
-        print strSwigScriptLangsFound,
+        sys.stdout.write(strSwigScriptLangsFound)
         for dir in listDirs:
-            print dir,
-        print "\n";
+            sys.stdout.write(dir)
+        print("\n");
 
     # Iterate script directory find any script language directories
     for scriptLang in listDirs:
-        dbg.dump_text( "Executing language script for \'%s\'" % scriptLang );
-        nResult, strStatusMsg = run_swig( scriptLang, strSwigBuildFileName,
-                                          vDictArgs );
+        # __pycache__ is a magic directory in Python 3 that holds .pyc files
+        if scriptLang != "__pycache__":
+            dbg.dump_text( "Executing language script for \'%s\'" % scriptLang );
+            nResult, strStatusMsg = run_swig( scriptLang, strSwigBuildFileName,
+                                              vDictArgs );
         if nResult < 0:
             break;
 

         program_exit( -4, strMsgErrorOsTypeUnknown );
 
     global gbDbgFlag;
-    gbDbgFlag = dictArgs.has_key( "-d" );
+    gbDbgFlag = "-d" in dictArgs;
     if gbDbgFlag:
         print_out_input_parameters( dictArgs );
 

     # called by this program
     global gbMakeFileFlag;
     global gbSwigGenDepFileFlag;
-    gbMakeFileFlag = dictArgs.has_key( "-m" );
-    gbSwigGenDepFileFlag = dictArgs.has_key( "-M" );
+    gbMakeFileFlag = "-m" in dictArgs;
+    gbSwigGenDepFileFlag = "-M" in dictArgs;
 
     bOk, strMsg = check_lldb_swig_file_exists( dictArgs[ "--srcRoot" ], eOSType );
     if bOk == False:

scripts/finishSwigWrapperClasses.py

 
     if vMsg.__len__() != 0:
         strMsg = "%s: %s (%d)" % (strExitMsgSuccess, vMsg, vnResult);
-        print strMsg;
+        print(strMsg);
 
     sys.exit( vnResult );
 

 # Throws:   None.
 #--
 def program_exit_on_failure( vnResult, vMsg ):
-    print "%s%s (%d)" % (strExitMsgError, vMsg, vnResult);
+    print("%s%s (%d)" % (strExitMsgError, vMsg, vnResult));
     sys.exit( vnResult );
 
 #++---------------------------------------------------------------------------

         if val.__len__() != 0:
             strEqs = " =";
             strQ = "\"";
-        print "%s%s%s %s%s%s\n" % (strParameter, arg, strEqs, strQ, val, strQ);
+        print("%s%s%s %s%s%s\n" % (strParameter, arg, strEqs, strQ, val, strQ));
 
 #++---------------------------------------------------------------------------
 # Details:  Validate the arguments passed to the program. This function exits

         return (-9, strStatusMsg);
 
     if gbDbgFlag:
-        print strScriptLangFound % vStrScriptLang;
-        print strExecuteMsg % vStrScriptLang;
+        print(strScriptLangFound % vStrScriptLang);
+        print(strExecuteMsg % vStrScriptLang);
 
     # Change where Python looks for our modules
     strDir = os.path.normcase( strScriptFileDir );

         listDirs.remove('.svn')
 
     if gbDbgFlag:
-        print strScriptLangsFound,
+        sys.stdout.write(strScriptLangsFound)
         for dir in listDirs:
-            print dir,
-        print "\n";
+            sys.stdout.write(dir)
+        print("\n")
 
     # Iterate script directory find any script language directories
     for scriptLang in listDirs:

scripts/utilsArgsParse.py

   
   # Count the number of mandatory args required (if any one found)
   countMandatory = 0;
-  for opt, man in vDictArgReq.iteritems():
+  for opt, man in vDictArgReq.items():
     if man == "m":
       countMandatory = countMandatory + 1;
   

scripts/utilsDebug.py

   def dump_object( self, vstrText, vObject ):
     if CDebugFnVerbose.bVerboseOn == False:
       return;
-    print "%d%s> Dp: %s" % (CDebugFnVerbose.__nLevel, self.__get_dots(), 
-                vstrText),;
-    print vObject;
+    sys.stdout.write("%d%s> Dp: %s" % (CDebugFnVerbose.__nLevel, self.__get_dots(), 
+                vstrText));
+    print(vObject);
   
   #++------------------------------------------------------------------------
   # Details:  Print out some progress text given by the client.

   def dump_text( self, vstrText ):
     if CDebugFnVerbose.bVerboseOn == False:
       return;
-    print "%d%s> Dp: %s" % (CDebugFnVerbose.__nLevel, self.__get_dots(),
-                vstrText);
+    print("%d%s> Dp: %s" % (CDebugFnVerbose.__nLevel, self.__get_dots(),
+                vstrText));
         
   # Private methods:
   def __init__( self, vstrFnName ):

   #--
   def __indent_back( self ):
     if CDebugFnVerbose.bVerboseOn:
-      print "%d%s< fn: %s" % (CDebugFnVerbose.__nLevel, self.__get_dots(),
-                  self.__strFnName);
+      print("%d%s< fn: %s" % (CDebugFnVerbose.__nLevel, self.__get_dots(),
+                  self.__strFnName));
     CDebugFnVerbose.__nLevel -= 1;
 
   #++------------------------------------------------------------------------

     CDebugFnVerbose.__nLevel += 1;
     self.__strFnName = vstrFnName;
     if CDebugFnVerbose.bVerboseOn:
-      print "%d%s> fn: %s" % ( CDebugFnVerbose.__nLevel, self.__get_dots(), 
-                   self.__strFnName);
+      print("%d%s> fn: %s" % ( CDebugFnVerbose.__nLevel, self.__get_dots(), 
+                   self.__strFnName));
 
   # Private statics attributes:
   __nLevel = 0; # Indentation level counter

scripts/utilsOsType.py

 # Authors:  Illya Rudkin 28/11/2013.
 # Changes:  None.
 #--
-class EnumOsType( object ):
-    values = [  "Unknown",
-                "Darwin",
-                "FreeBSD",
-                "Linux", 
-                "NetBSD",
-                "Windows" ]
-    class __metaclass__( type ):
+if sys.version_info.major >= 3:
+    from enum import Enum
+    class EnumOsType(Enum):
+        Unknown = 0
+        Darwin = 1
+        FreeBSD = 2
+        Linux = 3
+        NetBSD = 4
+        Windows = 5
+else:
+    class EnumOsType( object ):
+        values = [  "Unknown",
+                    "Darwin",
+                    "FreeBSD",
+                    "Linux", 
+                    "NetBSD",
+                    "Windows" ]
+        class __metaclass__( type ):
 #++---------------------------------------------------------------------------
 # Details:  Fn acts as an enumeration.
 # Args:     vName - (R) Enumeration to match.
 # Returns:  Int - Matching enumeration/index.
 # Throws:   None.
 #--
             def __getattr__( self, vName ):
                 return self.values.index( vName );
 
 #++---------------------------------------------------------------------------
 # Details:  Reverse fast lookup of the values list.

 # Returns:  Str - text description matching enumeration.
 # Throws:   None.
 #--
             def name_of( self, vI ):
                 return EnumOsType.values[ vI ];
 
 #-----------------------------------------------------------------------------
 #-----------------------------------------------------------------------------