BaseTools/BinToPcd: Update for Python 3 compatibility
[mirror_edk2.git] / BaseTools / Scripts / BinToPcd.py
index 54cb844..52c2316 100644 (file)
@@ -24,7 +24,6 @@ import xdrlib
 # Globals for help information\r
 #\r
 __prog__        = 'BinToPcd'\r
-__version__     = '%s Version %s' % (__prog__, '0.91 ')\r
 __copyright__   = 'Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.'\r
 __description__ = 'Convert one or more binary files to a VOID* PCD value or DSC file VOID* PCD statement.\n'\r
 \r
@@ -33,22 +32,22 @@ if __name__ == '__main__':
     try:\r
       Value = int (Argument, 0)\r
     except:\r
-      Message = '%s is not a valid integer value.' % (Argument)\r
+      Message = '{Argument} is not a valid integer value.'.format (Argument = Argument)\r
       raise argparse.ArgumentTypeError(Message)\r
     if Value < 0:\r
-      Message = '%s is a negative value.' % (Argument)\r
+      Message = '{Argument} is a negative value.'.format (Argument = Argument)\r
       raise argparse.ArgumentTypeError(Message)\r
     return Value\r
 \r
   def ValidatePcdName (Argument):\r
-    if re.split('[a-zA-Z\_][a-zA-Z0-9\_]*\.[a-zA-Z\_][a-zA-Z0-9\_]*', Argument) <> ['','']:\r
-      Message = '%s is not in the form <PcdTokenSpaceGuidCName>.<PcdCName>' % (Argument)\r
+    if re.split('[a-zA-Z\_][a-zA-Z0-9\_]*\.[a-zA-Z\_][a-zA-Z0-9\_]*', Argument) != ['','']:\r
+      Message = '{Argument} is not in the form <PcdTokenSpaceGuidCName>.<PcdCName>'.format (Argument = Argument)\r
       raise argparse.ArgumentTypeError(Message)\r
     return Argument\r
 \r
   def ValidateGuidName (Argument):\r
-    if re.split('[a-zA-Z\_][a-zA-Z0-9\_]*', Argument) <> ['','']:\r
-      Message = '%s is not a valid GUID C name' % (Argument)\r
+    if re.split('[a-zA-Z\_][a-zA-Z0-9\_]*', Argument) != ['','']:\r
+      Message = '{Argument} is not a valid GUID C name'.format (Argument = Argument)\r
       raise argparse.ArgumentTypeError(Message)\r
     return Argument\r
 \r
@@ -61,21 +60,21 @@ if __name__ == '__main__':
       XdrEncoder = xdrlib.Packer()\r
       for Item in Buffer:\r
         XdrEncoder.pack_bytes(Item)\r
-      Buffer = XdrEncoder.get_buffer()\r
+      Buffer = bytearray(XdrEncoder.get_buffer())\r
     else:\r
       #\r
       # If Xdr flag is not set, then concatenate all the data\r
       #\r
-      Buffer = ''.join(Buffer)\r
+      Buffer = b''.join(Buffer)\r
     #\r
     # Return a PCD value of the form '{0x01, 0x02, ...}' along with the PCD length in bytes\r
     #\r
-    return '{%s}' % (', '.join(['0x%02x' % (ord(Item)) for Item in Buffer])), len (Buffer)\r
+    return '{' + (', '.join(['0x{Byte:02X}'.format(Byte = Item) for Item in Buffer])) + '}', len (Buffer)\r
 \r
   #\r
   # Create command line argument parser object\r
   #\r
-  parser = argparse.ArgumentParser(prog = __prog__, version = __version__,\r
+  parser = argparse.ArgumentParser(prog = __prog__,\r
                                    description = __description__ + __copyright__,\r
                                    conflict_handler = 'resolve')\r
   parser.add_argument("-i", "--input", dest = 'InputFile', type = argparse.FileType('rb'), action='append', required = True,\r
@@ -117,8 +116,8 @@ if __name__ == '__main__':
       Buffer.append(File.read())\r
       File.close()\r
     except:\r
-      print 'BinToPcd: error: can not read binary input file', File\r
-      sys.exit()\r
+      print ('BinToPcd: error: can not read binary input file {File}'.format (File = File))\r
+      sys.exit(1)\r
 \r
   #\r
   # Convert PCD to an encoded string of hex values and determine the size of\r
@@ -135,7 +134,7 @@ if __name__ == '__main__':
     #\r
     Pcd = PcdValue\r
     if args.Verbose:\r
-      print 'BinToPcd: Convert binary file to PCD Value'\r
+      print ('BinToPcd: Convert binary file to PCD Value')\r
   elif args.PcdType is None:\r
     #\r
     # If --type is neither VPD nor HII, then use PCD statement syntax that is\r
@@ -147,19 +146,19 @@ if __name__ == '__main__':
       # If --max-size is not provided, then do not generate the syntax that\r
       # includes the maximum size.\r
       #\r
-      Pcd = '  %s|%s' % (args.PcdName, PcdValue)\r
+      Pcd = '  {Name}|{Value}'.format (Name = args.PcdName, Value = PcdValue)\r
     elif args.MaxSize < PcdSize:\r
-      print 'BinToPcd: error: argument --max-size is smaller than input file.'\r
-      sys.exit()\r
+      print ('BinToPcd: error: argument --max-size is smaller than input file.')\r
+      sys.exit(1)\r
     else:\r
-      Pcd = '  %s|%s|VOID*|%d' % (args.PcdName, PcdValue, args.MaxSize)\r
+      Pcd = '  {Name}|{Value}|VOID*|{Size}'.format (Name = args.PcdName, Value = PcdValue, Size = args.MaxSize)\r
 \r
     if args.Verbose:\r
-      print 'BinToPcd: Convert binary file to PCD statement compatible with PCD sections:'\r
-      print '    [PcdsFixedAtBuild]'\r
-      print '    [PcdsPatchableInModule]'\r
-      print '    [PcdsDynamicDefault]'\r
-      print '    [PcdsDynamicExDefault]'\r
+      print ('BinToPcd: Convert binary file to PCD statement compatible with PCD sections:')\r
+      print ('    [PcdsFixedAtBuild]')\r
+      print ('    [PcdsPatchableInModule]')\r
+      print ('    [PcdsDynamicDefault]')\r
+      print ('    [PcdsDynamicExDefault]')\r
   elif args.PcdType == 'VPD':\r
     if args.MaxSize is None:\r
       #\r
@@ -168,33 +167,33 @@ if __name__ == '__main__':
       #\r
       args.MaxSize = PcdSize\r
     if args.MaxSize < PcdSize:\r
-      print 'BinToPcd: error: argument --max-size is smaller than input file.'\r
-      sys.exit()\r
+      print ('BinToPcd: error: argument --max-size is smaller than input file.')\r
+      sys.exit(1)\r
     if args.Offset is None:\r
       #\r
       # if --offset is not provided, then set offset field to '*' so build\r
       # tools will compute offset of PCD in VPD region.\r
       #\r
-      Pcd = '  %s|*|%d|%s' % (args.PcdName, args.MaxSize, PcdValue)\r
+      Pcd = '  {Name}|*|{Size}|{Value}'.format (Name = args.PcdName, Size = args.MaxSize, Value = PcdValue)\r
     else:\r
       #\r
       # --offset value must be 8-byte aligned\r
       #\r
       if (args.Offset % 8) != 0:\r
-        print 'BinToPcd: error: argument --offset must be 8-byte aligned.'\r
-        sys.exit()\r
+        print ('BinToPcd: error: argument --offset must be 8-byte aligned.')\r
+        sys.exit(1)\r
       #\r
       # Use the --offset value provided.\r
       #\r
-      Pcd = '  %s|%d|%d|%s' % (args.PcdName, args.Offset, args.MaxSize, PcdValue)\r
+      Pcd = '  {Name}|{Offset}|{Size}|{Value}'.format (Name = args.PcdName, Offset = args.Offset, Size = args.MaxSize, Value = PcdValue)\r
     if args.Verbose:\r
-      print 'BinToPcd: Convert binary file to PCD statement compatible with PCD sections'\r
-      print '    [PcdsDynamicVpd]'\r
-      print '    [PcdsDynamicExVpd]'\r
+      print ('BinToPcd: Convert binary file to PCD statement compatible with PCD sections')\r
+      print ('    [PcdsDynamicVpd]')\r
+      print ('    [PcdsDynamicExVpd]')\r
   elif args.PcdType == 'HII':\r
     if args.VariableGuid is None or args.VariableName is None:\r
-      print 'BinToPcd: error: arguments --variable-guid and --variable-name are required for --type HII.'\r
-      sys.exit()\r
+      print ('BinToPcd: error: arguments --variable-guid and --variable-name are required for --type HII.')\r
+      sys.exit(1)\r
     if args.Offset is None:\r
       #\r
       # Use UEFI Variable offset of 0 if --offset is not provided\r
@@ -204,13 +203,13 @@ if __name__ == '__main__':
     # --offset value must be 8-byte aligned\r
     #\r
     if (args.Offset % 8) != 0:\r
-      print 'BinToPcd: error: argument --offset must be 8-byte aligned.'\r
-      sys.exit()\r
-    Pcd = '  %s|L"%s"|%s|%d|%s' % (args.PcdName, args.VariableName, args.VariableGuid, args.Offset, PcdValue)\r
+      print ('BinToPcd: error: argument --offset must be 8-byte aligned.')\r
+      sys.exit(1)\r
+    Pcd = '  {Name}|L"{VarName}"|{VarGuid}|{Offset}|{Value}'.format (Name = args.PcdName, VarName = args.VariableName, VarGuid = args.VariableGuid, Offset = args.Offset, Value = PcdValue)\r
     if args.Verbose:\r
-      print 'BinToPcd: Convert binary file to PCD statement compatible with PCD sections'\r
-      print '    [PcdsDynamicHii]'\r
-      print '    [PcdsDynamicExHii]'\r
+      print ('BinToPcd: Convert binary file to PCD statement compatible with PCD sections')\r
+      print ('    [PcdsDynamicHii]')\r
+      print ('    [PcdsDynamicExHii]')\r
 \r
   #\r
   # Write PCD value or PCD statement to the output file\r
@@ -223,4 +222,4 @@ if __name__ == '__main__':
     # If output file is not specified or it can not be written, then write the\r
     # PCD value or PCD statement to the console\r
     #\r
-    print Pcd\r
+    print (Pcd)\r