BaseTools/UPT:merge UPT Tool use Python2 and Python3

In UPT Tool,merge python2 and python3

Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Zhiju.Fan <zhijux.fan@intel.com>
Tested-by: Laszlo Ersek <lersek@redhat.com>
Tested-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Bob Feng <bob.c.feng@intel.com>

8 files changed, 61 insertions, 193 deletions

diff --git a/BaseTools/Source/Python/UPT/Library/CommentGenerating.py b/BaseTools/Source/Python/UPT/Library/CommentGenerating.py
index 4726629695..bd3514bc49 100644
--- a/BaseTools/Source/Python/UPT/Library/CommentGenerating.py
+++ b/BaseTools/Source/Python/UPT/Library/CommentGenerating.py
@@ -124,10 +124,8 @@ def GenHeaderCommentSection(Abstract, Description, Copyright, License, IsBinaryH
     #

     # Convert special character to (c), (r) and (tm).

     #

-    if isinstance(Abstract, unicode):

-        Abstract = ConvertSpecialUnicodes(Abstract)

-    if isinstance(Description, unicode):

-        Description = ConvertSpecialUnicodes(Description)

+    Abstract = ConvertSpecialUnicodes(Abstract)

+    Description = ConvertSpecialUnicodes(Description)

     if IsBinaryHeader:

         Content += CommChar * 2 + TAB_SPACE_SPLIT + TAB_BINARY_HEADER_COMMENT + '\r\n'

     elif CommChar == TAB_COMMENT_EDK1_SPLIT:

diff --git a/BaseTools/Source/Python/UPT/Library/CommentParsing.py b/BaseTools/Source/Python/UPT/Library/CommentParsing.py
index 285812c9c2..a09a530ffb 100644
--- a/BaseTools/Source/Python/UPT/Library/CommentParsing.py
+++ b/BaseTools/Source/Python/UPT/Library/CommentParsing.py
@@ -74,7 +74,7 @@ def ParseHeaderCommentSection(CommentList, FileName = None, IsBinaryHeader = Fal
     # first find the last copyright line

     #

     Last = 0

-    for Index in xrange(len(CommentList)-1, 0, -1):

+    for Index in range(len(CommentList)-1, 0, -1):

         Line = CommentList[Index][0]

         if _IsCopyrightLine(Line):

             Last = Index

@@ -206,17 +206,15 @@ def ParsePcdErrorCode (Value = None, ContainerFile = None, LineNum = None):
             Base = 16

         else:

             Base = 10

-        ErrorCode = long(Value, Base)

+        ErrorCode = int(Value, Base)

         if ErrorCode > PCD_ERR_CODE_MAX_SIZE or ErrorCode < 0:

             Logger.Error('Parser',

                         FORMAT_NOT_SUPPORTED,

                         "The format %s of ErrorCode is not valid, should be UNIT32 type or long type" % Value,

                         File = ContainerFile,

                         Line = LineNum)

-        #

-        # To delete the tailing 'L'

-        #

-        return hex(ErrorCode)[:-1]

+        ErrorCode = '0x%x' % ErrorCode

+        return ErrorCode

     except ValueError as XStr:

         if XStr:

             pass

diff --git a/BaseTools/Source/Python/UPT/Library/Misc.py b/BaseTools/Source/Python/UPT/Library/Misc.py
index 8c2a6787f0..d69b161420 100644
--- a/BaseTools/Source/Python/UPT/Library/Misc.py
+++ b/BaseTools/Source/Python/UPT/Library/Misc.py
@@ -32,7 +32,7 @@ from os import linesep
 from os import walk

 from os import environ

 import re

-from UserDict import IterableUserDict

+from collections import OrderedDict

 

 import Logger.Log as Logger

 from Logger import StringTable as ST

@@ -160,23 +160,35 @@ def RemoveDirectory(Directory, Recursively=False):
 #                              or not

 #

 def SaveFileOnChange(File, Content, IsBinaryFile=True):

-    if not IsBinaryFile:

-        Content = Content.replace("\n", linesep)

-

     if os.path.exists(File):

-        try:

-            if Content == __FileHookOpen__(File, "rb").read():

-                return False

-        except BaseException:

-            Logger.Error(None, ToolError.FILE_OPEN_FAILURE, ExtraData=File)

+        if IsBinaryFile:

+            try:

+                if Content == __FileHookOpen__(File, "rb").read():

+                    return False

+            except BaseException:

+                Logger.Error(None, ToolError.FILE_OPEN_FAILURE, ExtraData=File)

+        else:

+            try:

+                if Content == __FileHookOpen__(File, "r").read():

+                    return False

+            except BaseException:

+                Logger.Error(None, ToolError.FILE_OPEN_FAILURE, ExtraData=File)

 

     CreateDirectory(os.path.dirname(File))

-    try:

-        FileFd = __FileHookOpen__(File, "wb")

-        FileFd.write(Content)

-        FileFd.close()

-    except BaseException:

-        Logger.Error(None, ToolError.FILE_CREATE_FAILURE, ExtraData=File)

+    if IsBinaryFile:

+        try:

+            FileFd = __FileHookOpen__(File, "wb")

+            FileFd.write(Content)

+            FileFd.close()

+        except BaseException:

+            Logger.Error(None, ToolError.FILE_CREATE_FAILURE, ExtraData=File)

+    else:

+        try:

+            FileFd = __FileHookOpen__(File, "w")

+            FileFd.write(Content)

+            FileFd.close()

+        except BaseException:

+            Logger.Error(None, ToolError.FILE_CREATE_FAILURE, ExtraData=File)

 

     return True

 

@@ -288,148 +300,6 @@ def RealPath2(File, Dir='', OverrideDir=''):
 

     return None, None

 

-## A dict which can access its keys and/or values orderly

-#

-#  The class implements a new kind of dict which its keys or values can be

-#  accessed in the order they are added into the dict. It guarantees the order

-#  by making use of an internal list to keep a copy of keys.

-#

-class Sdict(IterableUserDict):

-    ## Constructor

-    #

-    def __init__(self):

-        IterableUserDict.__init__(self)

-        self._key_list = []

-

-    ## [] operator

-    #

-    def __setitem__(self, Key, Value):

-        if Key not in self._key_list:

-            self._key_list.append(Key)

-        IterableUserDict.__setitem__(self, Key, Value)

-

-    ## del operator

-    #

-    def __delitem__(self, Key):

-        self._key_list.remove(Key)

-        IterableUserDict.__delitem__(self, Key)

-

-    ## used in "for k in dict" loop to ensure the correct order

-    #

-    def __iter__(self):

-        return self.iterkeys()

-

-    ## len() support

-    #

-    def __len__(self):

-        return len(self._key_list)

-

-    ## "in" test support

-    #

-    def __contains__(self, Key):

-        return Key in self._key_list

-

-    ## indexof support

-    #

-    def index(self, Key):

-        return self._key_list.index(Key)

-

-    ## insert support

-    #

-    def insert(self, Key, Newkey, Newvalue, Order):

-        Index = self._key_list.index(Key)

-        if Order == 'BEFORE':

-            self._key_list.insert(Index, Newkey)

-            IterableUserDict.__setitem__(self, Newkey, Newvalue)

-        elif Order == 'AFTER':

-            self._key_list.insert(Index + 1, Newkey)

-            IterableUserDict.__setitem__(self, Newkey, Newvalue)

-

-    ## append support

-    #

-    def append(self, Sdict2):

-        for Key in Sdict2:

-            if Key not in self._key_list:

-                self._key_list.append(Key)

-            IterableUserDict.__setitem__(self, Key, Sdict2[Key])

-    ## hash key

-    #

-    def has_key(self, Key):

-        return Key in self._key_list

-

-    ## Empty the dict

-    #

-    def clear(self):

-        self._key_list = []

-        IterableUserDict.clear(self)

-

-    ## Return a copy of keys

-    #

-    def keys(self):

-        Keys = []

-        for Key in self._key_list:

-            Keys.append(Key)

-        return Keys

-

-    ## Return a copy of values

-    #

-    def values(self):

-        Values = []

-        for Key in self._key_list:

-            Values.append(self[Key])

-        return Values

-

-    ## Return a copy of (key, value) list

-    #

-    def items(self):

-        Items = []

-        for Key in self._key_list:

-            Items.append((Key, self[Key]))

-        return Items

-

-    ## Iteration support

-    #

-    def iteritems(self):

-        return iter(self.items())

-

-    ## Keys interation support

-    #

-    def iterkeys(self):

-        return iter(self.keys())

-

-    ## Values interation support

-    #

-    def itervalues(self):

-        return iter(self.values())

-

-    ## Return value related to a key, and remove the (key, value) from the dict

-    #

-    def pop(self, Key, *Dv):

-        Value = None

-        if Key in self._key_list:

-            Value = self[Key]

-            self.__delitem__(Key)

-        elif len(Dv) != 0 :

-            Value = Dv[0]

-        return Value

-

-    ## Return (key, value) pair, and remove the (key, value) from the dict

-    #

-    def popitem(self):

-        Key = self._key_list[-1]

-        Value = self[Key]

-        self.__delitem__(Key)

-        return Key, Value

-    ## update method

-    #

-    def update(self, Dict=None, **Kwargs):

-        if Dict is not None:

-            for Key1, Val1 in Dict.items():

-                self[Key1] = Val1

-        if len(Kwargs):

-            for Key1, Val1 in Kwargs.items():

-                self[Key1] = Val1

-

 ## CommonPath

 #

 # @param PathList: PathList

@@ -437,7 +307,7 @@ class Sdict(IterableUserDict):
 def CommonPath(PathList):

     Path1 = min(PathList).split(os.path.sep)

     Path2 = max(PathList).split(os.path.sep)

-    for Index in xrange(min(len(Path1), len(Path2))):

+    for Index in range(min(len(Path1), len(Path2))):

         if Path1[Index] != Path2[Index]:

             return os.path.sep.join(Path1[:Index])

     return os.path.sep.join(Path1)

@@ -890,7 +760,7 @@ def ProcessEdkComment(LineList):
             if FindEdkBlockComment:

                 if FirstPos == -1:

                     FirstPos = StartPos

-                for Index in xrange(StartPos, EndPos+1):

+                for Index in range(StartPos, EndPos+1):

                     LineList[Index] = ''

                 FindEdkBlockComment = False

         elif Line.find("//") != -1 and not Line.startswith("#"):

@@ -957,7 +827,7 @@ def GetLibInstanceInfo(String, WorkSpace, LineNo):
         FileLinesList = []

 

         try:

-            FInputfile = open(FullFileName, "rb", 0)

+            FInputfile = open(FullFileName, "r")

             try:

                 FileLinesList = FInputfile.readlines()

             except BaseException:

diff --git a/BaseTools/Source/Python/UPT/Library/ParserValidate.py b/BaseTools/Source/Python/UPT/Library/ParserValidate.py
index 31b9b68cd5..87d156fa4c 100644
--- a/BaseTools/Source/Python/UPT/Library/ParserValidate.py
+++ b/BaseTools/Source/Python/UPT/Library/ParserValidate.py
@@ -727,7 +727,7 @@ def IsValidUserId(UserId):
 #

 def CheckUTF16FileHeader(File):

     FileIn = open(File, 'rb').read(2)

-    if FileIn != '\xff\xfe':

+    if FileIn != b'\xff\xfe':

         return False

 

     return True

diff --git a/BaseTools/Source/Python/UPT/Library/Parsing.py b/BaseTools/Source/Python/UPT/Library/Parsing.py
index 81729d6cdb..3eca8e3849 100644
--- a/BaseTools/Source/Python/UPT/Library/Parsing.py
+++ b/BaseTools/Source/Python/UPT/Library/Parsing.py
@@ -974,7 +974,7 @@ def GenSection(SectionName, SectionDict, SplitArch=True, NeedBlankLine=False):
                     ArchList = GetSplitValueList(SectionAttrs, DataType.TAB_COMMENT_SPLIT)

                 else:

                     ArchList = [SectionAttrs]

-            for Index in xrange(0, len(ArchList)):

+            for Index in range(0, len(ArchList)):

                 ArchList[Index] = ConvertArchForInstall(ArchList[Index])

             Section = '[' + SectionName + '.' + (', ' + SectionName + '.').join(ArchList) + ']'

         else:

diff --git a/BaseTools/Source/Python/UPT/Library/StringUtils.py b/BaseTools/Source/Python/UPT/Library/StringUtils.py
index 2be382fa17..90946337d0 100644
--- a/BaseTools/Source/Python/UPT/Library/StringUtils.py
+++ b/BaseTools/Source/Python/UPT/Library/StringUtils.py
@@ -20,7 +20,6 @@ StringUtils
 #

 import re

 import os.path

-from string import strip

 import Logger.Log as Logger

 import Library.DataType as DataType

 from Logger.ToolError import FORMAT_INVALID

@@ -44,7 +43,7 @@ gMACRO_PATTERN = re.compile("\$\(([_A-Z][_A-Z0-9]*)\)", re.UNICODE)
 #

 #

 def GetSplitValueList(String, SplitTag=DataType.TAB_VALUE_SPLIT, MaxSplit= -1):

-    return map(lambda l: l.strip(), String.split(SplitTag, MaxSplit))

+    return list(map(lambda l: l.strip(), String.split(SplitTag, MaxSplit)))

 

 ## MergeArches

 #

@@ -435,7 +434,7 @@ def GetSingleValueOfKeyFromLines(Lines, Dictionary, CommentCharacter, KeySplitCh
                 #

                 LineList[1] = CleanString(LineList[1], CommentCharacter)

                 if ValueSplitFlag:

-                    Value = map(strip, LineList[1].split(ValueSplitCharacter))

+                    Value = list(map(lambda x: x.strip(), LineList[1].split(ValueSplitCharacter)))

                 else:

                     Value = CleanString(LineList[1], CommentCharacter).splitlines()

 

@@ -632,7 +631,7 @@ def SplitString(String):
 # @param StringList:  A list for strings to be converted

 #

 def ConvertToSqlString(StringList):

-    return map(lambda s: s.replace("'", "''"), StringList)

+    return list(map(lambda s: s.replace("'", "''"), StringList))

 

 ## Convert To Sql String

 #

@@ -940,23 +939,24 @@ def SplitPcdEntry(String):
 def IsMatchArch(Arch1, Arch2):

     if 'COMMON' in Arch1 or 'COMMON' in Arch2:

         return True

-    if isinstance(Arch1, basestring) and isinstance(Arch2, basestring):

-        if Arch1 == Arch2:

-            return True

-

-    if isinstance(Arch1, basestring) and isinstance(Arch2, list):

-        return Arch1 in Arch2

+    try:

+        if isinstance(Arch1, list) and isinstance(Arch2, list):

+            for Item1 in Arch1:

+                for Item2 in Arch2:

+                    if Item1 == Item2:

+                        return True

 

-    if isinstance(Arch2, basestring) and isinstance(Arch1, list):

-        return Arch2 in Arch1

+        elif isinstance(Arch1, list):

+            return Arch2 in Arch1

 

-    if isinstance(Arch1, list) and isinstance(Arch2, list):

-        for Item1 in Arch1:

-            for Item2 in Arch2:

-                if Item1 == Item2:

-                    return True

+        elif isinstance(Arch2, list):

+            return Arch1 in Arch2

 

-    return False

+        else:

+            if Arch1 == Arch2:

+                return True

+    except:

+        return False

 

 # Search all files in FilePath to find the FileName with the largest index

 # Return the FileName with index +1 under the FilePath

diff --git a/BaseTools/Source/Python/UPT/Library/UniClassObject.py b/BaseTools/Source/Python/UPT/Library/UniClassObject.py
index cd575d5a34..bd7804b753 100644
--- a/BaseTools/Source/Python/UPT/Library/UniClassObject.py
+++ b/BaseTools/Source/Python/UPT/Library/UniClassObject.py
@@ -119,10 +119,12 @@ def UniToHexList(Uni):
 # @retval NewUni:  The converted unicode string

 #

 def ConvertSpecialUnicodes(Uni):

-    NewUni = Uni

+    OldUni = NewUni = Uni

     NewUni = NewUni.replace(u'\u00A9', '(c)')

     NewUni = NewUni.replace(u'\u00AE', '(r)')

     NewUni = NewUni.replace(u'\u2122', '(tm)')

+    if OldUni == NewUni:

+        NewUni = OldUni

     return NewUni

 

 ## GetLanguageCode1766

@@ -513,7 +515,7 @@ class UniFileClassObject(object):
                     FileIn[LineCount-1] = Line

                     FileIn[LineCount] = '\r\n'

                     LineCount -= 1

-                    for Index in xrange (LineCount + 1, len (FileIn) - 1):

+                    for Index in range (LineCount + 1, len (FileIn) - 1):

                         if (Index == len(FileIn) -1):

                             FileIn[Index] = '\r\n'

                         else:

diff --git a/BaseTools/Source/Python/UPT/Library/Xml/XmlRoutines.py b/BaseTools/Source/Python/UPT/Library/Xml/XmlRoutines.py
index ee158f33d9..b24e3ed01b 100644
--- a/BaseTools/Source/Python/UPT/Library/Xml/XmlRoutines.py
+++ b/BaseTools/Source/Python/UPT/Library/Xml/XmlRoutines.py
@@ -180,7 +180,7 @@ def XmlElementData(Dom):
 # @param  String             A XPath style path.

 #

 def XmlElementList(Dom, String):

-    return map(XmlElementData, XmlList(Dom, String))

+    return list(map(XmlElementData, XmlList(Dom, String)))

 

 

 ## Get the XML attribute of the current node.