一个用python实现的统计代码行数的小工具

先立个flag, 新年新目标,希望2018年代码行数可以写到五万行。

实现功能

  • 计算出某一目录以及子目录下代码文件的行数
  • 在计算代码的过程中,只对标准命名的文件进行统计,如[文件名.文件类型]
  • 排除了以“#”开头的包含文件,宏定义等,如#include, #define, #pragma等
  • 排除了c,cpp文件中的“//”, “//”等的注释
  • 排除了python文件中import, from 等开头的导入

使用方法

新建countLines.py文件,复制代码到文件中,将其放在想计算行数的代码目录下,直接使用Python运行即可算出该目录以及所有子目录下代码文件的行数。

  1. 将该python文件命名为countLines.py,放到想计算代码行数的文件目录下
  2. 其中helloworld.c文件内容如下:
  3. 用python.exe直接打开该文件或者使用python countLines.py,运行文件即可。

    我们可以看到,统计代码行的时候我们排除了两个空行以及开头的包含文件行,因此有效代码行为5行

代码实现

#!/usr/bin/env python
# -- coding: utf-8 --
# @Time    : 2018/3/5 13:55
# @Author  : likewind
# @mail    : likewind1993@163.com
# @File    : countLines.py
# @Software: sky-studio.cn
import os
'''
返回每个文件行数,其中行数不包括以“#”开头的包含文件,宏定义等,
排除了c,cpp文件中的“//”, “/*...*/”等的注释,
排除了python文件中import, from 等开头的导入
'''

def get_lines(file_name):
    f = open(file_name)
    #flag用于处理c,cpp中“/*...*/”多行注释
    flag = False
    count = 0
    while True:
        #读取文件并去除开头的空格,制表符
        line = f.readline()
        line = line.lstrip(' \t')
        if not line:
            break
        #如果该行有“#”, “import”等打头的字符,忽略该行
        if flag == False:
            if line[0:1] == "#" or line[0:6] == "import" or line[0:4] == "from" or line == "\n" or line[0:2] == "//":
                continue
        #如果该行存在“/*”并且不存在“*/”,表明多行注释未在一行结束,flag=True
        if line.find("/*") != -1 :
            if line.find("*/") != -1:
                continue
            else:
                flag = True
                continue
        #如果flag=True,表明处于多行注释中,判断是否有“*/”结尾
        if flag == True :
            if line.find("*/") != -1:
                flag = False
                if line[-2:] != "*/":
                    count = count+1
            continue
        #排除以上条件后,行数增加一
        count = count+1
    f.close()
    return count
'''
计算该文件目录下所有符合条件的行数
'''
def count_lines(file_dir):
    #total_lines表示总行数,file_nums表示总文件数
    total_lines = 0
    file_nums = 0
    for root, dirs, files in os.walk(file_dir):
        for file in files:
            #不计算本文件的行数
            if file == "countLines.py":
                continue
            #只计算规范命名文件, 如[文件名.文件类型]
            file_type = file.split('.')
            if len(file_type) > 1 :
                #如果想计算其他类型的文件,可以在这里进行修改
                if file_type[1] not in ["py", "c", "cc", "cpp", "h"]:
                    continue
            else:
                continue
            file_name = root +"\\" + file
            lines = get_lines(file_name)
            total_lines = total_lines + lines
            print file_name + " contains lines : " + repr(lines)
            file_nums = file_nums + 1
    #输出结果
    print "------------------------------------"
    print "Total Files : " + repr(file_nums)
    print "Total lines : " + repr(total_lines)
    print "------------------------------------"

if __name__ == '__main__':
    cur_path = os.path.split(os.path.realpath(__file__))[0]
    count_lines(cur_path)
    raw_input("Press any key to exit...")