cmsCodeRulesChecker Namespace Reference

Functions
def	omitLine (lines, line, regEx=None)
def	printOut (listOfResult, filePath=None)
def	runRules (ruleNumberList, directory)
def	splitPaths (listRule, pathHead)

Variables
	__author__
	__date__
	arg
	argvLen
	checkPath
	configuration
	createPickle
	createTxt
	cwd
	goodParameters
	help
	html
	i
	picklePath
	printResult
	result
	ruleNumbers
	RULES
	rules
	txtPath

Function Documentation

omitLine()

def cmsCodeRulesChecker.omitLine	(		lines,
			line,
			regEx = None
	)

Definition at line 106 of file cmsCodeRulesChecker.py.

def omitLine(lines, line, regEx=None):
    fileLines = lines
    if re.match('^\d+$',line):
        xline = int(line)-1
        try:
            if (not regEx) or (re.search(regEx,fileLines[xline].strip())):
                fileLines[xline] = ''
        except IndexError:
            pass
    else:
        for i,lineData in enumerate(fileLines):
            if re.match(line,str(i)):
                lineData = lineData.strip()
                if (not regEx) or (re.search(regEx,lineData)):
                    fileLines[i] = ''
    return fileLines
 

References createfilelist.int, str, and digitizers_cfi.strip.

Referenced by runRules().

printOut()

def cmsCodeRulesChecker.printOut	(		listOfResult,
			filePath = None
	)

Definition at line 123 of file cmsCodeRulesChecker.py.

def printOut(listOfResult, filePath = None):
    file = None
    try:
        for rule, result in listOfResult:
            if filePath:
                file = open('%s/cmsCodeRule%s.txt'%(filePath, rule), 'w')
                for path, lineNumbers in result:
                    file.write('%s\n'%path)
                    file.write('%s\n'%str(lineNumbers))
                file.close()
            else:
                if not result or result == -1:
                    print('No results for rule %s'%rule)
                else:
                    print('Rule %s:' %rule)
                    for path, lineNumbers in result:
                        print(path)
                        print(lineNumbers)
    except TypeError:
        print("Error: wrong type of parameter in function printOut")
 

References print(), and str.

runRules()

def cmsCodeRulesChecker.runRules	(		ruleNumberList,
			directory
	)

Definition at line 34 of file cmsCodeRulesChecker.py.

def runRules(ruleNumberList, directory):
 
    result = []
    osWalk = []
    
    for rule in ruleNumberList:
        if str(rule) not in RULES:
            print('Error: wrong rule parameter. There is no such rule: "'+rule+'"\n\n' + rulesDescription)
            print('\nWrite -h for help')
            return -1
 
    for rule in configuration.keys():
        configuration[rule]['filter'] = re.compile(configuration[rule]['filter'])
 
    osWalk.extend(os.walk(directory))
 
    exceptPathsForEachRule = []
    for path in exceptPaths:
        exceptPathsForEachRule.append(join(checkPath, path))
 
    for ruleNr in ruleNumberList:
        files = []
        rule = str(ruleNr)
        rule = configuration[ruleNr]
 
        filesToMatch = rule['filesToMatch']
        exceptRuleLines = []
        exceptRulePaths = []
        for path in rule['exceptPaths']:
            try:
                file, line = path.split(":",1)
                xline = line
                xdata = None
                try:
                    xline, xdata = line.split(":",1)
                    if not xline: xline = '.*'
                except ValueError:
                    pass
                exceptRuleLines.append((pathToRegEx(file), xline,xdata))
            except ValueError:
                exceptRulePaths.append(pathToRegEx(path))
        for fileType in filesToMatch:
            fileList = getFilePathsFromWalk(osWalk, fileType, exceptPathsForEachRule)
# ------------------------------------------------------------------------------
            for path in exceptRulePaths:
                xFileList = []
                for file in fileList:
                    xFile = file.replace(join(checkPath, ""), "")
                    if not re.match(path, xFile):
                        xFileList.append(file)
                fileList = xFileList
# ------------------------------------------------------------------------------
            filesLinesList = fileList
            if rule['skip']:
                for skipper in rule['skip']:
                    filesLinesList = skipper(filesLinesList)
            else:
                for i,xFile in enumerate(filesLinesList):
                    filesLinesList[i]=((xFile,open(xFile).readlines()))
# ------------------------------------------------------------------------------
            for Nr, fileLine in enumerate(exceptRuleLines):
                regEx, line, lineEx = fileLine
                for index, file in enumerate(fileList):
                    xFile = file.replace(join(checkPath, ""), "")
                    if re.match(regEx, xFile):
                        filesLinesList[index] = (filesLinesList[index][0], omitLine(filesLinesList[index][1], line,lineEx))
            files.extend(filesLinesList)
# ------------------------------------------------------------------------------
        listRule = finds(files, rule['filter'], rule['exceptFilter'])
        result.append((ruleNr, splitPaths(listRule, checkPath)))
    return result
 

References keyFinder.finds(), filesFinder.getFilePathsFromWalk(), join(), omitLine(), print(), splitPaths(), and str.

splitPaths()

def cmsCodeRulesChecker.splitPaths	(		listRule,
			pathHead
	)

Definition at line 25 of file cmsCodeRulesChecker.py.

def splitPaths(listRule, pathHead):
    try:
        for i in range(len(listRule)):
            path, linesNumbers = listRule[i]
            listRule[i] = (path.replace(pathHead, '', 1), linesNumbers)
    except TypeError:
        print("Error: given wrong type of parameter in function splitPaths.")
    return listRule
 

References print(), and FastTimerService_cff.range.

Referenced by runRules().

Variable Documentation

__author__

cmsCodeRulesChecker.__author__

private

Definition at line 5 of file cmsCodeRulesChecker.py.

__date__

cmsCodeRulesChecker.__date__

private

Definition at line 6 of file cmsCodeRulesChecker.py.

arg

cmsCodeRulesChecker.arg

Definition at line 161 of file cmsCodeRulesChecker.py.

argvLen

cmsCodeRulesChecker.argvLen

Definition at line 155 of file cmsCodeRulesChecker.py.

checkPath

cmsCodeRulesChecker.checkPath

Definition at line 21 of file cmsCodeRulesChecker.py.

configuration

cmsCodeRulesChecker.configuration

Definition at line 19 of file cmsCodeRulesChecker.py.

createPickle

cmsCodeRulesChecker.createPickle

Definition at line 148 of file cmsCodeRulesChecker.py.

createTxt

cmsCodeRulesChecker.createTxt

Definition at line 149 of file cmsCodeRulesChecker.py.

cwd

cmsCodeRulesChecker.cwd

Definition at line 146 of file cmsCodeRulesChecker.py.

goodParameters

cmsCodeRulesChecker.goodParameters

Definition at line 154 of file cmsCodeRulesChecker.py.

help

cmsCodeRulesChecker.help

Definition at line 151 of file cmsCodeRulesChecker.py.

html

cmsCodeRulesChecker.html

Definition at line 150 of file cmsCodeRulesChecker.py.

i

cmsCodeRulesChecker.i

Definition at line 159 of file cmsCodeRulesChecker.py.

picklePath

cmsCodeRulesChecker.picklePath

Definition at line 22 of file cmsCodeRulesChecker.py.

printResult

cmsCodeRulesChecker.printResult

Definition at line 156 of file cmsCodeRulesChecker.py.

Referenced by sistrip::SpyUtilities.getMajorityHeader().

result

cmsCodeRulesChecker.result

Definition at line 220 of file cmsCodeRulesChecker.py.

ruleNumbers

cmsCodeRulesChecker.ruleNumbers

Definition at line 157 of file cmsCodeRulesChecker.py.

RULES

cmsCodeRulesChecker.RULES

Definition at line 20 of file cmsCodeRulesChecker.py.

rules

cmsCodeRulesChecker.rules

Definition at line 152 of file cmsCodeRulesChecker.py.

Referenced by edm::FileLocator.applyRules(), edm::FileLocator.convert(), edm::RootFile.dropOnInputAndReorder(), edm::EmbeddedRootSource.dropUnwantedBranches_(), edm::ProductSelector.initialize(), and edm::FileLocator.parseRule().

txtPath

cmsCodeRulesChecker.txtPath

Definition at line 23 of file cmsCodeRulesChecker.py.