使用 Python 开发一个 Python 解释器

时间:2022-02-21 00:40:56

使用 Python 开发一个 Python 解释器

计算机只能理解机器码。归根结底,编程语言只是一串文字,目的是为了让人类更容易编写他们想让计算机做的事情。真正的魔法是由编译器和解释器完成,它们弥合了两者之间的差距。解释器逐行读取代码并将其转换为机器码。

在本文中,我们将设计一个可以执行算术运算的解释器。

我们不会重新造*。文章将使用由 David M. Beazley 开发的词法解析器 —— PLY(Python Lex-Yacc(https://github.com/dabeaz/ply))。

PLY 可以通过以下方式下载:

  1. $ pip install ply

我们将粗略地浏览一下创建解释器所需的基础知识。欲了解更多,请参阅这个 GitHub 仓库(https://github.com/dabeaz/ply)。

使用 Python 开发一个 Python 解释器

标记(Token)

标记是为解释器提供有意义信息的最小字符单位。标记包含一对名称和属性值。

让我们从创建标记名称列表开始。这是一个必要的步骤。

  1. tokens = (
  2. # 数据类型
  3. "NUM",
  4. "FLOAT",
  5. # 算术运算
  6. "PLUS",
  7. "MINUS",
  8. "MUL",
  9. "DIV",
  10. # 括号
  11. "LPAREN",
  12. "RPAREN",
  13. )

词法分析器(Lexer)

将语句转换为标记的过程称为标记化或词法分析。执行词法分析的程序是词法分析器。

  1. # 标记的正则表达
  2. t_PLUS = r"\+"
  3. t_MINUS = r"\-"
  4. t_MUL = r"\*"
  5. t_DIV = r"/"
  6. t_LPAREN = r"\("
  7. t_RPAREN = r"\)"
  8. t_POW = r"\^"
  9. # 忽略空格和制表符
  10. t_ignore = " \t"
  11. # 为每个规则添加动作
  12. def t_FLOAT(t):
  13. r"""\d+\.\d+"""
  14. t.value = float(t.value)
  15. return t
  16. def t_NUM(t):
  17. r"""\d+"""
  18. t.value = int(t.value)
  19. return t
  20. # 未定义规则字符的错误处理
  21. def t_error(t):
  22. # 此处的 t.value 包含未标记的其余输入
  23. print(f"keyword not found: {t.value[0]}\nline {t.lineno}")
  24. t.lexer.skip(1)
  25. # 如果遇到 \n 则将其设为新的一行
  26. def t_newline(t):
  27. r"""\n+"""
  28. t.lexer.lineno += t.value.count("\n")

为导入词法分析器,我们将使用:

import ply.lex as lex

t_ 是一个特殊的前缀,表示定义标记的规则。每条词法规则都是用正则表达式制作的,与 Python 中的 re 模块兼容。正则表达式能够根据规则扫描输入并搜索符合的符号串。正则表达式定义的文法称为正则文法。正则文法定义的语言则称为正则语言。

定义好了规则,我们将构建词法分析器。

  1. data = 'a = 2 +(10 -8)/1.0'
  2. lexlexer = lex.lex()
  3. lexer.input(data)
  4. while tok := lexer.token():
  5. print(tok)

为了传递输入字符串,我们使用 lexer.input(data)。lexer.token() 将返回下一个 LexToken 实例,最后返回 None。根据上述规则,代码 2 + ( 10 -8)/1.0 的标记将是:

使用 Python 开发一个 Python 解释器

紫色字符代表的是标记的名称,其后是标记的具体内容。

巴科斯-诺尔范式(Backus-Naur Form,BNF)

大多数编程语言都可以用上下文无关文法来编写。它比常规语言更复杂。对于上下文无关文法,我们用上下文无关语法,它是描述语言中所有可能语法的规则集。BNF 是一种定义语法的方式,它描述了编程语言的语法。让我们看看例子:

symbol : alternative1 | alternative2 …

根据产生式,: 的左侧被替换为右侧的其中一个值替换。右侧的值由 | 分隔(可理解为 symbol 定义为 alternative1 或 alternative2或…… 等等)。对于我们的这个算术解释器,语法规格如下:

  1. expression : expression '+' expression
  2. | expression '-' expression
  3. | expression '/' expression
  4. | expression '*' expression
  5. | expression '^' expression
  6. | +expression
  7. | -expression
  8. | ( expression )
  9. | NUM
  10. | FLOAT

输入的标记是诸如 NUM、FLOAT、+、-、*、/ 之类的符号,称作终端(无法继续分解或产生其他符号的字符)。一个表达式由终端和规则集组成,例如 expression 则称为非终端。

解析器(Parser)

我们将使用 YACC(Yet Another Compiler Compiler) 作为解析器生成器。导入模块:import ply.yacc as yacc。

  1. from operator import (add, sub, mul, truediv, pow)
  2. # 我们的解释器支持的运算符列表
  3. ops = {
  4. "+": add,
  5. "-": sub,
  6. "*": mul,
  7. "/": truediv,
  8. "^": pow,
  9. }
  10. def p_expression(p):
  11. """expression : expression PLUS expression
  12. | expression MINUS expression
  13. | expression DIV expression
  14. | expression MUL expression
  15. | expression POW expression"""
  16. if (p[2], p[3]) == ("/", 0):
  17. # 如果除以 0,则将“INF”(无限)作为值
  18. p[0] = float("INF")
  19. else:
  20. p[0] = ops[p[2]](p[1], p[3])
  21. def p_expression_uplus_or_expr(p):
  22. """expression : PLUS expression %prec UPLUS
  23. | LPAREN expression RPAREN"""
  24. p[0] = p[2]
  25. def p_expression_uminus(p):
  26. """expression : MINUS expression %prec UMINUS"""
  27. p[0] = -p[2]
  28. def p_expression_num(p):
  29. """expression : NUM
  30. | FLOAT"""
  31. p[0] = p[1]
  32. # 语法错误时的规则
  33. def p_error(p):
  34. print(f"Syntax error in {p.value}")

在文档字符串中,我们将添加适当的语法规范。p 列表中的的元素与语法符号一一对应,如下所示:

  1. expression : expression PLUS expression
  2. p[0] p[1] p[2] p[3]

在上文中,%prec UPLUS 和 %prec UMINUS 是用来表示自定义运算的。%prec 即是 precedence 的缩写。在符号中本来没有 UPLUS 和 UMINUS 这个说法(在本文中这两个自定义运算表示一元正号和符号,其实 UPLUS 和 UMINUS 只是个名字,想取什么就取什么)。之后,我们可以添加基于表达式的规则。YACC 允许为每个令牌分配优先级。我们可以使用以下方法设置它:

  1. precedence = (
  2. ("left", "PLUS", "MINUS"),
  3. ("left", "MUL", "DIV"),
  4. ("left", "POW"),
  5. ("right", "UPLUS", "UMINUS")
  6. )

在优先级声明中,标记按优先级从低到高的顺序排列。PLUS 和 MINUS 优先级相同并且具有左结合性(运算从左至右执行)。MUL 和 DIV 的优先级高于 PLUS 和 MINUS,也具有左结合性。POW 亦是如此,不过优先级更高。UPLUS 和 UMINUS 则是具有右结合性(运算从右至左执行)。

要解析输入我们将使用:

  1. parser = yacc.yacc()
  2. result = parser.parse(data)
  3. print(result)

完整代码如下:

  1. #####################################
  2. # 引入模块 #
  3. #####################################
  4. from logging import (basicConfig, INFO, getLogger)
  5. from operator import (add, sub, mul, truediv, pow)
  6. import ply.lex as lex
  7. import ply.yacc as yacc
  8. # 我们的解释器支持的运算符列表
  9. ops = {
  10. "+": add,
  11. "-": sub,
  12. "*": mul,
  13. "/": truediv,
  14. "^": pow,
  15. }
  16. #####################################
  17. # 标记集 #
  18. #####################################
  19. tokens = (
  20. # 数据类型
  21. "NUM",
  22. "FLOAT",
  23. # 算术运算
  24. "PLUS",
  25. "MINUS",
  26. "MUL",
  27. "DIV",
  28. "POW",
  29. # 括号
  30. "LPAREN",
  31. "RPAREN",
  32. )
  33. #####################################
  34. # 标记的正则表达式 #
  35. #####################################
  36. t_PLUS = r"\+"
  37. t_MINUS = r"\-"
  38. t_MUL = r"\*"
  39. t_DIV = r"/"
  40. t_LPAREN = r"\("
  41. t_RPAREN = r"\)"
  42. t_POW = r"\^"
  43. # 忽略空格和制表符
  44. t_ignore = " \t"
  45. # 为每个规则添加动作
  46. def t_FLOAT(t):
  47. r"""\d+\.\d+"""
  48. t.value = float(t.value)
  49. return t
  50. def t_NUM(t):
  51. r"""\d+"""
  52. t.value = int(t.value)
  53. return t
  54. # 未定义规则字符的错误处理
  55. def t_error(t):
  56. # 此处的 t.value 包含未标记的其余输入
  57. print(f"keyword not found: {t.value[0]}\nline {t.lineno}")
  58. t.lexer.skip(1)
  59. # 如果看到 \n 则将其设为新的一行
  60. def t_newline(t):
  61. r"""\n+"""
  62. t.lexer.lineno += t.value.count("\n")
  63. #####################################
  64. # 设置符号优先级 #
  65. #####################################
  66. precedence = (
  67. ("left", "PLUS", "MINUS"),
  68. ("left", "MUL", "DIV"),
  69. ("left", "POW"),
  70. ("right", "UPLUS", "UMINUS")
  71. )
  72. #####################################
  73. # 书写 BNF 规则 #
  74. #####################################
  75. def p_expression(p):
  76. """expression : expression PLUS expression
  77. | expression MINUS expression
  78. | expression DIV expression
  79. | expression MUL expression
  80. | expression POW expression"""
  81. if (p[2], p[3]) == ("/", 0):
  82. # 如果除以 0,则将“INF”(无限)作为值
  83. p[0] = float("INF")
  84. else:
  85. p[0] = ops[p[2]](p[1], p[3])
  86. def p_expression_uplus_or_expr(p):
  87. """expression : PLUS expression %prec UPLUS
  88. | LPAREN expression RPAREN"""
  89. p[0] = p[2]
  90. def p_expression_uminus(p):
  91. """expression : MINUS expression %prec UMINUS"""
  92. p[0] = -p[2]
  93. def p_expression_num(p):
  94. """expression : NUM
  95. | FLOAT"""
  96. p[0] = p[1]
  97. # 语法错误时的规则
  98. def p_error(p):
  99. print(f"Syntax error in {p.value}")
  100. #####################################
  101. # 主程式 #
  102. #####################################
  103. if __name__ == "__main__":
  104. basicConfig(level=INFO, filename="logs.txt")
  105. lexlexer = lex.lex()
  106. parser = yacc.yacc()
  107. while True:
  108. try:
  109. result = parser.parse(
  110. input(">>>"),
  111. debug=getLogger())
  112. print(result)
  113. except AttributeError:
  114. print("invalid syntax")

结论

由于这个话题的体积庞大,这篇文章并不能将事物完全的解释清楚,但我希望你能很好地理解文中涵盖的表层知识。

原文地址:https://mp.weixin.qq.com/s/5bx450vpFkrJ4Of7UQA0yQ