BaseTools: Refactor python print statements

[mirror_edk2.git] / BaseTools / Source / Python / Ecc / Exception.py

## @file\r
# This file is used to parse exception items found by ECC tool\r
#\r
# Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
##\r
# Import Modules\r
#\r
from __future__ import print_function\r
from Xml.XmlRoutines import *\r
import Common.LongFilePathOs as os\r
\r
# ExceptionXml to parse Exception Node of XML file\r
class ExceptionXml(object):\r
    def __init__(self):\r
        self.KeyWord = ''\r
        self.ErrorID = ''\r
        self.FilePath = ''\r
        \r
    def FromXml(self, Item, Key):\r
        self.KeyWord = XmlElement(Item, '%s/KeyWord' % Key)\r
        self.ErrorID = XmlElement(Item, '%s/ErrorID' % Key)\r
        self.FilePath = os.path.normpath(XmlElement(Item, '%s/FilePath' % Key))\r
        \r
    def __str__(self):\r
        return 'ErrorID = %s KeyWord = %s FilePath = %s' %(self.ErrorID, self.KeyWord, self.FilePath)\r
\r
# ExceptionListXml to parse Exception Node List of XML file\r
class ExceptionListXml(object):\r
    def __init__(self):\r
        self.List = []\r
    \r
    def FromXmlFile(self, FilePath):\r
        XmlContent = XmlParseFile(FilePath)\r
        for Item in XmlList(XmlContent, '/ExceptionList/Exception'):\r
            Exp = ExceptionXml()\r
            Exp.FromXml(Item, 'Exception')\r
            self.List.append(Exp)\r
    \r
    def ToList(self):\r
        RtnList = []\r
        for Item in self.List:\r
            #RtnList.append((Item.ErrorID, Item.KeyWord, Item.FilePath))\r
            RtnList.append((Item.ErrorID, Item.KeyWord))\r
    \r
        return RtnList\r
        \r
    def __str__(self):\r
        RtnStr = ''\r
        if self.List:\r
            for Item in self.List:\r
                RtnStr = RtnStr + str(Item) + '\n'\r
        return RtnStr\r
\r
# A class to check exception\r
class ExceptionCheck(object):\r
    def __init__(self, FilePath = None):\r
        self.ExceptionList = []\r
        self.ExceptionListXml = ExceptionListXml()\r
        self.LoadExceptionListXml(FilePath)\r
\r
    def LoadExceptionListXml(self, FilePath):\r
        if FilePath and os.path.isfile(FilePath):\r
            self.ExceptionListXml.FromXmlFile(FilePath)\r
            self.ExceptionList = self.ExceptionListXml.ToList()\r
    \r
    def IsException(self, ErrorID, KeyWord, FileID=-1):\r
        if (str(ErrorID), KeyWord.replace('\r\n', '\n')) in self.ExceptionList:\r
            return True\r
        else:\r
            return False\r
\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
#\r
if __name__ == '__main__':\r
    El = ExceptionCheck('C:\\Hess\\Project\\BuildTool\\src\\Ecc\\exception.xml')\r
    print(El.ExceptionList)\r