使用Python設計一個程式碼統計工具

這篇文章主要介紹了使用Python設計一個程式碼統計工具的相關資料，包括檔案個數，程式碼行數，註解行數，空行行數。有興趣的朋友跟隨腳本之家小編一起看看吧

問題

設計一個程序，用於統計一個項目中的程式碼行數，包括檔案個數，程式碼行數，註解行數，空行行數。盡量設計靈活一點可以透過輸入不同參數來統計不同語言的項目，例如：

# type用于指定文件类型
python counter.py --type python

輸出：

files: 10
code_lines:200
comments:100
blanks:20

分析

這是一個看起來很簡單，但做起來有點複雜的設計題，我們可以把問題化小，只要能正確統計一個文件的程式碼行數，那麼統計一個目錄也不成問題，其中最複雜的就是關於多行註釋，以Python 為例，註解程式碼行有下列幾種情況：

1、井號開頭的單行註解

# 單行註解

2、多行註解符在同一行的情況

"""這是多行註解"""
'''這也是多行註解'''
3、多行註解符號

#"""
這3行都是註解符號
"""

我們的思路採取逐行解析的方式，多行註解需要一個額外的標識符in_multi_comment 來標識當前行是不是處於多行註解符當中，預設為False，多行註解開始時，置為True，遇到下一個多行註解符時置為False。從多行註解開始符號直到下一個結束符號之間的程式碼都應該屬於註解行。

知識點

如何正確讀取文件，讀出的文件當字串處理時，字串的常用方法

簡化版

我們逐步進行迭代，先實作一個簡化版程序，只統計Python程式碼的單文件，而且不考慮多行註解的情況，這是任何入門Python 的人都能實現的功能。關鍵地方是把每一行讀出來之後，先用strip() 方法把字串兩邊的空格、回車去掉

# -*- coding: utf-8 -*-
"""
只能统计单行注释的py文件
"""
def parse(path):
 comments = 0
 blanks = 0
 codes = 0
 with open(path, encoding='utf-8') as f:
 for line in f.readlines():
  line = line.strip()
  if line == "":
  blanks += 1
  elif line.startswith("#"):
  comments += 1
  else:
  codes += 1
 return {"comments": comments, "blanks": blanks, "codes": codes}
if __name__ == '__main__':
 print(parse("xxx.py"))

#多行註解版

如果只能統計單行註解的程式碼，意義並不大，要解決多行註解的統計才能算是一個真正的程式碼統計器

# -*- coding: utf-8 -*-
"""

可以統計包含有多行註解的py檔案

#

"""
def parse(path):
 in_multi_comment = False # 多行注释符标识符号
 comments = 0
 blanks = 0
 codes = 0
 with open(path, encoding="utf-8") as f:
 for line in f.readlines():
  line = line.strip()
  # 多行注释中的空行当做注释处理
  if line == "" and not in_multi_comment:
  blanks += 1
  # 注释有4种
  # 1. # 井号开头的单行注释
  # 2. 多行注释符在同一行的情况
  # 3. 多行注释符之间的行
  elif line.startswith("#") or \
    (line.startswith('"""') and line.endswith('"""') and len(line)) > 3 or \
   (line.startswith("'''") and line.endswith("'''") and len(line) > 3) or \
   (in_multi_comment and not (line.startswith('"""') or line.startswith("'''"))):
  comments += 1
  # 4. 多行注释符的开始行和结束行
  elif line.startswith('"""') or line.startswith("'''"):
  in_multi_comment = not in_multi_comment
  comments += 1
  else:
  codes += 1
 return {"comments": comments, "blanks": blanks, "codes": codes}
if __name__ == '__main__':
 print(parse("xxx.py"))

上面的第4種情況，遇到多行註解符號時，in_multi_comment 識別碼進行取反操作是關鍵操作，而不是單純地置為False 或True，第一次遇到""" 時為True，第二次遇到"""就是多行註解的結束符，取反為False，以此類推，第三次又是開始，取反又是True。

那麼判斷其它語言是不是要重新寫一個解析函數呢？如果你仔細觀察的話，多行註釋的4種情況可以抽像出4個判斷條件，因為大部分語言都有單行註釋，多行註釋，只是他們的符號不一樣而已。

CONF = {"py": {"start_comment": ['"""', "'''"], "end_comment": ['"""', "'''"], "single": "#"},
 "java": {"start_comment": ["/*"], "end_comment": ["*/"], "single": "//"}}
start_comment = CONF.get(exstansion).get("start_comment")
end_comment = CONF.get(exstansion).get("end_comment")
cond2 = False
cond3 = False
cond4 = False
for index, item in enumerate(start_comment):
 cond2 = line.startswith(item) and line.endswith(end_comment[index]) and len(line) > len(item)
 if cond2:
 break
for item in end_comment:
 if line.startswith(item):
 cond3 = True
 break
for item in start_comment+end_comment:
 if line.startswith(item):
 cond4 = True
 break
if line == "" and not in_multi_comment:
 blanks += 1
# 注释有4种
# 1. # 井号开头的单行注释
# 2. 多行注释符在同一行的情况
# 3. 多行注释符之间的行
elif line.startswith(CONF.get(exstansion).get("single")) or cond2 or \
 (in_multi_comment and not cond3):
 comments += 1
# 4. 多行注释符分布在多行时，开始行和结束行
elif cond4:
 in_multi_comment = not in_multi_comment
 comments += 1
else:
 codes += 1

只需要一個配置常數把所有語言的單行、多行註解的符號標記出來，對應出 cond1到cond4幾種情況就ok。剩下的任務就是解析多個文件，可以用 os.walk 方法。

def counter(path):
 """
 可以统计目录或者某个文件
 :param path:
 :return:
 """
 if os.path.isdir(path):
 comments, blanks, codes = 0, 0, 0
 list_dirs = os.walk(path)
 for root, dirs, files in list_dirs:
  for f in files:
  file_path = os.path.join(root, f)
  stats = parse(file_path)
  comments += stats.get("comments")
  blanks += stats.get("blanks")
  codes += stats.get("codes")
 return {"comments": comments, "blanks": blanks, "codes": codes}
 else:
 return parse(path)

當然，想要把這個程式做完善，還有很多工作要多，包括命令列解析，根據指定參數只解析某種語言。

補充：

Python實作程式碼行數統計工具

我們常常想要統計專案的程式碼行數，但如果想統計功能比較完善可能就不是那麼簡單了， 今天我們來看看如何用python來實作一個程式碼行統計工具。

想法：

首先取得所有文件，然後統計每個文件中程式碼的行數，最後將行數相加.

#實現的功能：

統計每個檔案的行數；
統計總行數；
統計運行時間；
支援指定統計文件類型，排除不想統計的檔案類型；
遞歸統計資料夾下包含子檔案件下的檔案的行數；

排除空白行；

# coding=utf-8
import os
import time
basedir = '/root/script'
filelists = []
# 指定想要统计的文件类型
whitelist = ['php', 'py']
#遍历文件, 递归遍历文件夹中的所有
def getFile(basedir):
 global filelists
 for parent,dirnames,filenames in os.walk(basedir):
  #for dirname in dirnames:
  # getFile(os.path.join(parent,dirname)) #递归
  for filename in filenames:
   ext = filename.split('.')[-1]
   #只统计指定的文件类型，略过一些log和cache文件
   if ext in whitelist:
    filelists.append(os.path.join(parent,filename))
#统计一个文件的行数
def countLine(fname):
 count = 0
 for file_line in open(fname).xreadlines():
  if file_line != '' and file_line != '\n': #过滤掉空行
   count += 1
 print fname + '----' , count
 return count
if __name__ == '__main__' :
 startTime = time.clock()
 getFile(basedir)
 totalline = 0
 for filelist in filelists:
  totalline = totalline + countLine(filelist)
 print 'total lines:',totalline
 print 'Done! Cost Time: %0.2f second' % (time.clock() - startTime)

結果：

#[root@pythontab script]# python countCodeLine.py
/root/script/test /gametest.php---- 16
/root/script/smtp.php---- 284
/root/script/gametest.php---- 16
/root/script/countCodeLine .py---- 33
/root/script/sendmail.php---- 17
/root/script/test/gametest.php---- 16
total lines: 382
Done! Cost Time: 0.00 second
[root@pythontab script]

#只會統計php和python文件，非常方便。

相關推薦：

Python設計計算器功能實現的完整實例分享

Python設計模式程式設計中的訪客與觀察者模式範例介紹

以上是使用Python設計一個程式碼統計工具的詳細內容。更多資訊請關注PHP中文網其他相關文章！