Python统计代码、注释及空行数的实现方法

统计代码、注释及空行数的核心逻辑

在Python中统计文件行数时，最基础的操作是遍历每一行。然而，准确区分“代码”、“注释”和“空行”需要处理两种不同的注释格式：以 # 开头的单行注释，以及以 ''' 或 """ 包裹的多行文档字符串（Docstring）。
处理多行注释的关键在于维护一个状态变量（如 is_comment）。当遇到多行注释的起始符时，将状态设为 True；在状态为 True 期间，所有行均计入注释行数，直到遇到结束符时，将状态重置为 False。

Python实现代码

以下代码演示了如何读取文件并统计行数。它使用 strip() 去除行首尾空白，以此判断是否为空行，并根据行首和行尾的符号来判定注释类型。

# -*- coding:utf-8 -*-
#!python3
path = 'test.py'
with open(path,'r',encoding='utf-8') as f:
  code_lines = 0    #代码行数
  comment_lines = 0  #注释行数
  blank_lines = 0   #空白行数 内容为'\n',strip()后为''
  is_comment = False
  start_comment_index = 0 #记录以'''或"""开头的注释位置
  for index,line in enumerate(f,start=1):
    line = line.strip() #去除开头和结尾的空白符
    #判断多行注释是否已经开始
    if not is_comment:
      if line.startswith("'''") or line.startswith('"""'):
        is_comment = True
        start_comment_index = index
      #单行注释
      elif line.startswith('#'):
        comment_lines += 1
      #空白行
      elif line == '':
        blank_lines += 1
      #代码行
      else:
        code_lines += 1
    #多行注释已经开始
    else:
      if line.endswith("'''") or line.endswith('"""'):
        is_comment = False
        comment_lines += index - start_comment_index + 1
      else:
        pass
print("注释:%d" % comment_lines)
print("空行:%d" % blank_lines)
print("代码:%d" % code_lines)

测试用例与结果分析

为了验证上述逻辑，我们可以使用包含不同注释格式的测试文件。例如，一个包含多行文档字符串和单行注释的文件 test.py。运行上述统计脚本后，程序会输出对应的代码、注释和空行数量。在实际测试中，该脚本能够准确识别并统计出文件中的各项行数。

总结

通过维护状态变量并逐行检查，我们可以有效区分Python文件中的代码、注释和空行。这种方法不仅适用于简单的脚本，也可以扩展用于更复杂的代码分析工具中。以上就是Python统计代码、注释及空行数的详细内容，更多关于Python文件处理的资料请关注本站其它相关文章！