pyparsing简介

pyparsing 是一个 Python 库，用于解析文本。它使用类似于 EBNF 的语法来描述文本格式，并提供了一组高级 API 来执行解析。pyparsing 的主要优点是它具有良好的可读性和可维护性，因此非常适合用于解析复杂的文本格式。

pyparsing 提供了一组基本的解析元素，如字符串、正则表达式、整数、浮点数等，还提供了一些高级的解析元素，如语法规则、可选元素、循环元素等。

下面是一个简单的例子，该示例演示了如何使用 pyparsing 解析一个简单的数学表达式:

from pyparsing import *
'''
我们首先从 pyparsing 库中导入了一些函数，如 Word，Literal，ZeroOrMore 等。
这些函数是 pyparsing 提供的基本解析元素，它们用于描述文本格式。
Word(nums) 表示一个整数，其中 nums 是一个字符串，包含了所有可能的数字。
Literal("+") 表示一个字符 "+"。
ZeroOrMore(...) 表示在括号内的元素可以重复出现 0 次或多次。
'''
# define the grammar of the expression
integer = Word(nums)
plus = Literal("+")
minus = Literal("-")
mult = Literal("*")
div = Literal("/")
lpar = Literal("(").suppress()
rpar = Literal(")").suppress()
'''
然后，我们定义了一些变量，如 integer，plus，minus，mult，div，lpar，rpar，
这些变量分别表示一个整数、加号、减号、乘号、除号、左括号和右括号。
'''
expr = Forward()
term = integer | (lpar + expr + rpar)
factor = term + ZeroOrMore((mult | div) + term)
expr << factor + ZeroOrMore((plus | minus) + factor)
'''
接着，我们定义了三个变量 expr，term和factor，这三个变量是我们用来描述数学表达式格式的。

expr 表示一个表达式，它由一个或多个加减运算符和多个因子组成。
term 表示一个项，它由一个或多个乘除运算符和多个整数或表达式组成。
factor 表示一个因子，它可以是一个整数或一个表达式。
'''
# parse the expression
print(expr.parseString("1+2*(3+4)"))
'''
最后，我们使用 expr.parseString("1+2*(3+4)") 将字符串 "1+2*(3+4)"解析，
这个函数会尝试匹配该字符串与我们定义的表达式格式。
在这个例子中，解析器会将字符串 "1+2*(3+4)" 分解成一个由字符串组成的列表，
列表中的每个元素都对应着表达式中的一个部分。
'''

输出结果是:

[['1', '+', '2', '*', '(', '3', '+', '4', ')']
'''
这个例子中，表达式被分解成了一系列符号，如数字、运算符和括号。这些符号可以在之后使用，
如计算表达式的值。
'''

需要注意的是，这个例子只是简单的演示了如何使用 pyparsing 解析一个简单的数学表达式，pyparsing 是一个非常强大的工具，它可以用来解析各种各样的文本格式，并且支持自定义语法规则。

+

在pyparsing中，加号(+)表示一个元素至少出现一次，即出现一次或多次。例如，如果定义一个语法规则如下：

word = Word(alphanums) + "." + Word(alphanums)

它表示一个单词必须是一个字母数字组成的字符串，后面紧跟着一个“.”号，然后是另一个字母数字组成的字符串。因此，该语法将匹配字符串如“word1.word2”，但不匹配“word1”。

word + 就表示一个或多个连续的word。
也可以使用pyparsing的OneOrMore类实现，如下所示：

word = ...
word_list = OneOrMore(word)

<<

在pyparsing中，“<<” 操作符表示合并两个语法单元（expression）。它把一个语法单元附加到另一个语法单元的结尾，并返回合并后的结果。这种操作可以方便地用于构造复杂的语法规则。

Forward()

Forward 函数在 PyParsing 模块中是用来定义预处理的概念的，它用于定义一个前向引用的语法定义。

前向引用通常用于解决语法定义的循环引用问题，比如说当一个语法需要被另一个语法引用，并且需要定义在它之前时，可以使用 Forward 函数。

语法示例：

expr = Forward()
expr <<= (expr + '+' + number) | number

在这个例子中，我们在定义 expr 语法时使用了 Forward 函数，在后面可以用 <<= 操作符，来给语法定义一个新的值。

OneOrMore

pyparsing 中的 OneOrMore 类是 ParserElement 类的子类，它定义了一个解析器，用于匹配一个或多个指定解析元素的连续出现。使用 OneOrMore 类的语法如下：

expression = OneOrMore(element)

其中，element 是要匹配一次或多次的解析元素，expression 是匹配一个或多个连续出现的 element 的解析器。

Optional

Optional是pyparsing模块中的一个类，表示一个可选项，即当前元素出现或不出现都是合法的。例如，如果我们解析数字时希望匹配到数字后面的单位（如果有的话），我们可以用Optional类实现。使用方法是在数字的表达式后面加上一个 Optional 对象。

suppress()

suppress()是pyparsing中的一个函数，它的作用是在解析的过程中不输出该语法单元的结果。它主要用在需要使用该语法单元来分割输入字符串，但不需要将其包含在最终结果中的情况。