Python_检查程序规范

时间：2022-03-24 03:33:45
 '''

     检查Python程序的一些基本规范，例如，运算符两测是否有空格，是否每次只导入一个模块，在不同的功能模块之间是否有空行，注释是否够多，等等

 '''

 import sys

 import re

 def checkFormats(lines,desFileName):

     fp=open(desFileName,'w')

     for i, line in enumerate(lines):

         print('='*30)

         print('Line:',i+1)

         if line.strip().startwith('#'):

             print(' '*10+'Comments.Pass.')

             fp.write(line)

             continue

         flag=True

         #check operator symbols

         symbols=[',','+','-','*','/','//','**','>>','<<','+=','-=','*=','/=']

         temp_line=line

         for symbol in symbols:

             pattern=re.compile(r'\s*'+re.escape(symbol)+r'\s*')

             temp_lie=pattern.split(temp_line)

             sep=' '+symbol+' '

             temp_line=sep.join(temp_line)

         if line !=temp_line:

             flag=False

             print(' '*10+'You may miss some blank spaces in this line.' )

         #check import statement

         if line.strip().startwith('import'):

             if ',' in line:

                 flag = False

                 print(' '*10+"You'd bbetter import one module at a time.")

                 temp_line=line.strip()

                 modules=modules.strip()

                 pattern=re.compile(r'\s*,\s*')

                 modules=pattern.split(modules)

                 temp_line=''

                 for module in modules:

                     temp_line +=line[:line.index('import')] + 'import '+module+'\n'

                 line=temp_line

             pri_line=lines[i-1].strip()

             if pri_line and(not pri_line.startwith('import'))and (not pri_line.startwith('#')):

                 falg=False

                 print(' '*10+'You should add a blank line before this line.')

                 line='\n'+line

             after_line=lines[i+1].strip()

             if after_line and(not after_line.startwith('import')):

                 flag=False

                 print(' '*10+'You should add a blank line after this line.')

                 line=line+'\n'

         #check if there is a blank line before new funtional code block

         #including the class/function definition

             if line.strip() and not line.startswith(' ')and i>0:

                 pri_line=lines[i-1]

                 if pri_line.strip() and pri_line.startwith(' '):

                     flag=False

                     print(' '*10 +"You'd better add a blank line before this line.")

                     line='\n'+line

             if flag:

                 print(' '*10+'Pass.')

             fp.write(line)

     fp.close()

 if __name__ == '__main__':

     fileName=sys.argv[1]    #命令行参数

     fileLines=[]

     with open(fileName,'r') as fp:

         fileLines=fp.readline()

     desFileName=fileName[:-3]+'_new.py'

     checkFormats(fileLines,desFileName)

     #check the ratio of comment lines to all lines

     comments=[line for line in fileLines if line.strip().startswith('#')]

     ratio=len(comments)/len(fileLines)

     if ratio <= 0.3:

         print('='*30)

         print('Comments in the file is less than 30%')

         print('Perhaps you should add some comments at appropriate position.')

相关文章