<腳本>用python檢測python | 批量檢查注釋率是否達标

一份好的代碼一定要有很好的可讀性,是以在實際開發過程中,注釋要占源碼一定的比例,才是一份合格的代碼,我這裡寫了一個腳本,可以用來檢測同一目錄下,所有python源碼的注釋比例(将下面的腳本放到源碼目錄下執行即可)

以python3.5/lib目錄下執行結果為例:

目錄結構

執行結果:

執行結果圖

import os
import sys
import re

"""
author: zhaozhao
"""

"""
本程式通過計算python源碼中"注釋的行數",檢查源碼是否合格
1.本程式可對"#"開頭的注釋,以及 成對的"三雙引号"源碼進行計數
2.本程式使用了正則比對
3.注釋占源碼比例 = 源碼内注釋行數/源碼總行數
"""

# 擷取代碼檔案所在路徑
dir_paths = os.listdir(os.getcwd())
#print(dir_paths)

#dir_path = os.getcwd() + "/" +sys.argv[0]

dir_path = ""

for dir in dir_paths:
    #print("=="*10)
    #print (dir)
    if re.match(r".*py$", dir):
        dir_path_pure = dir
        #print ("--->",dir_path)

        dir_path = os.getcwd() + "/" +dir_path_pure

        code_sum = 0
        with open(dir_path, "r") as my_code:

            my_lines = my_code.readlines()
            serial_num_list = [[],[]]
            
            for serial_num, line in enumerate(my_lines):
                serial_num = serial_num + 1
                if re.match(r"\s*#+.*",line):
                    serial_num_list[0].append(serial_num)

                if re.match(r".*\"\"\".*", line):
                    serial_num_list[1].append(serial_num)

                code_sum += 1

                


        serial_num_sum1 = 0
        serial_num_sum2 = 0

        for ser in serial_num_list[0]:
            serial_num_sum1 +=1
        try:
            for ser_num, value in enumerate(serial_num_list[1]):
                if ser_num%2 == 0:
                    top_num = value
                else:
                    end_num = value
                    serial_num_sum2 += (int(end_num) - int(top_num) + 1)
        except:
            print("%s源碼注釋不規範!自動跳過!"%dir_path_pure)
            continue


        serial_num_sum = serial_num_sum1 + serial_num_sum2
        exp_rate = 100*(serial_num_sum/code_sum)
        print ("%s| 注釋的行數為:%d,總行數為%d | 注釋率為%d%%"%(dir_path_pure,serial_num_sum, code_sum,exp_rate))