如何使用Python tokenize模块对源码进行词法分析以提取注释?

浅辰酱_4454

浅辰酱_4454

2026-06-23

282人浏览

原创

tokenize.generate_tokens() 是提取注释的正确入口,需逐个检查 token.type == tokenize.comment,构造完整可解析输入流,过滤编码声明,单次遍历分类收集以兼顾准确性和性能。

如何使用python tokenize模块对源码进行词法分析以提取注释?

tokenize.generate_tokens() 是提取注释的正确入口

Python 标准库 tokenize 模块不提供“直接获取所有注释”的快捷函数,必须用 generate_tokens() 迭代器逐个检查 token 类型。注释在词法层面被识别为 tokenize.COMMENT 类型,但仅当源码以合法 Python 语法形式传入时才可靠触发——这意味着不能直接对字符串片段(如 "# hello")调用,而必须构造完整可解析的输入流。

常见错误是试图用 tokenize.tokenize()(需要 bytes 流且以 encoding 开头)或误把文档字符串(tokenize.STRING)当成注释。文档字符串本质是字符串字面量,不属于注释 token。

实操建议:

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载
  • 用 io.StringIO(source_code).readline 构造 readline 函数,传给 generate_tokens()
  • 严格过滤 tok.type == tokenize.COMMENT,忽略 tokenize.NL(空行)和 tokenize.NEWLINE
  • 确保源码末尾有换行符,否则最后一行注释可能被截断(generate_tokens 内部依赖换行结束 token 解析)

处理多行注释和嵌套井号的边界情况

Python 本身不支持多行注释语法,所有 # 后内容均视为单行注释,但实际代码中常出现形如 """# not a comment""" 或 print("# inside string") 的干扰项。这些不会产生 COMMENT token,因为 tokenize 在字符串和注释之间有明确优先级:字符串字面量先于注释识别。

真正需警惕的是缩进后紧跟 # 的场景,比如:

if True:
    x = 1  # inline comment
# standalone comment

两者都会生成 COMMENT token,但位置信息不同:tok.start 和 tok.end 是 (行号, 列号) 元组,inline 注释的起始列号大于缩进列数。

实操建议:

  • 用 tok.string 获取原始注释文本(含开头 #),用 .lstrip('#').strip() 提取内容
  • 若需区分 inline / standalone,比较 tok.start[1] 与该行首非空白字符列号(需自行从 tok.line 计算)
  • 不要依赖正则匹配 #.*,它会误伤字符串内、f-string 中的 #

兼容性陷阱:Python 3.7+ 的 token.EXACT_TOKEN_TYPES 影响注释识别

Python 3.7 引入了 token.EXACT_TOKEN_TYPES,但 tokenize.COMMENT 不在此映射中,它始终是独立常量。不过,某些旧脚本会错误地用 token.NAME 或 token.OP 做兜底判断,导致漏掉注释。

更隐蔽的问题是编码声明:如果源码开头含 # -*- coding: utf-8 -*-,它会被识别为 COMMENT,但这是编码声明而非业务注释。是否过滤取决于需求——多数静态分析工具会跳过首行或前两行的编码/模式声明。

实操建议:

  • 显式导入 import tokenize,不要用 from token import *,避免混淆 token 和 tokenize 模块
  • 检查 tok.line.strip().startswith('# -*- coding:') or 'coding:' in tok.line 来跳过编码行
  • 在 CI 或多版本环境中测试 Python 3.6–3.12,确认 tokenize.COMMENT 值未变化(目前恒为 54)

性能敏感场景下避免重复解析

每次调用 generate_tokens() 都会重新做完整的词法扫描,若需同时提取注释、函数名、import 行等,不要多次遍历;应一次迭代中分类收集。反复调用 tokenize.detect_encoding() 或 tokenize.open() 也会引入开销。

另一个易忽略点:generate_tokens() 对空文件或只有空白符的输入会抛 TokenError: EOF in multi-line statement,需包裹 try-except。

实操建议:

  • 用单次循环 + 字典分组:comments = [], imports = [], funcs = [],按 tok.type 分流
  • 对大文件(>1MB),考虑用 tokenize.TokenInfo 的 line 属性做懒加载,避免提前读取整行内容
  • 若只需注释位置而不需内容,用 tok.start 和 len(tok.string) 推算范围,比切片 tok.line 更快

注释 token 的行号列号是基于原始源码的,一旦源码经过 minify、preprocess 或 AST 修改,tokenize 输出的位置信息就不再对齐。这点在构建 LSP 插件或代码高亮时最容易被忽略。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1771

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4584

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1729

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27097

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3287

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3287

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2543

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习