Pyga/Parsley 语法解析器参考指南

概述

Pyga/Parsley 是一个基于Python的语法解析器库，它提供了一种声明式的语法来描述和解析文本。本文将详细介绍Parsley的基本语法规则、Python API接口以及内置规则，帮助开发者快速掌握这一强大的解析工具。

基本语法规则

规则定义与组合

1. 规则定义：使用foo = ...的形式定义一个名为foo的解析规则。

2. 顺序匹配：expr1 expr2表示先匹配expr1，成功后继续匹配expr2，返回expr2的结果值。类似于Python中的and操作。

3. 选择匹配：expr1 | expr2表示尝试匹配expr1，如果失败则匹配expr2。类似于Python中的or操作。

量词匹配

1. expr*：匹配expr零次或多次，返回匹配结果的列表
2. expr+：匹配expr一次或多次，返回匹配结果的列表
3. expr?：尝试匹配expr，失败时返回None
4. expr{n,m}：匹配expr至少n次，最多m次
5. expr{n}：精确匹配expr n次

高级匹配特性

1. 负向先行断言：~expr表示如果输入的下一个项匹配expr则失败，但不消耗输入
2. 正向先行断言：~~expr表示如果输入的下一个项不匹配expr则失败，但不消耗输入
3. 规则调用：ruleName或ruleName(arg1 arg2)调用其他规则，可带参数
4. 字面量匹配：'x'匹配字符'x'
5. 捕获匹配文本：<expr>返回匹配expr时消耗的字符串，适用于词法分析

变量绑定与Python交互

1. 变量绑定：expr:name将expr的匹配结果绑定到局部变量name
2. Python表达式：-> pythonExpression执行Python表达式并返回结果
3. Python动作：!(pythonExpression)执行Python表达式作为动作
4. 条件判断：?(pythonExpression)当表达式为假时失败，否则返回True

错误处理

expr ^(CustomLabel)：当expr匹配失败时，抛出的异常会包含CustomLabel，便于提供更详细的错误上下文。CustomLabel可以包含除"("和")"外的任何字符。

Python API

Parsley提供了丰富的Python API接口，主要包括：

1. 核心解析功能：创建和管理语法解析器
2. 规则定义与调用：在Python代码中定义和使用解析规则
3. 结果处理：对解析结果进行进一步处理和分析

协议解析API

Parsley特别适合处理流式协议数据，提供了专门的协议解析功能：

1. ParserProtocol类：Twisted Protocol的子类，用于流式协议解析

   • sender属性：连接建立后指向发送方
   • receiver属性：连接建立后指向接收方

2. Receiver接口：定义了接收方必须实现的API

   • currentRule属性：决定当前使用的解析规则
   • prepareParsing()方法：连接建立后初始化解析
   • finishParsing()方法：解析结束时清理资源

内置解析规则

Parsley提供了一系列开箱即用的基础解析规则：

1. anything：匹配任意单个字符
2. letter：匹配单个ASCII字母
3. digit：匹配单个十进制数字
4. letterOrDigit：匹配字母或数字
5. end：匹配输入结束
6. ws：匹配零个或多个空白字符（空格、制表符、换行符）
7. exactly(char)：精确匹配指定字符

实际应用建议

1. 语法设计：先设计好语法结构，再逐步实现解析规则
2. 模块化：将复杂语法分解为多个小规则组合
3. 错误处理：合理使用CustomLabel提高错误信息可读性
4. 性能优化：避免过度复杂的嵌套规则，必要时使用Python代码辅助

Parsley的强大之处在于它将声明式语法与Python代码无缝结合，既保持了语法描述的可读性，又能利用Python的强大功能处理复杂逻辑。掌握这些核心概念后，开发者可以轻松构建各种文本解析器，从简单的配置文件解析到复杂的编程语言解析都能胜任。