29.2. codeop — 编译Python代码

codeop 模块提供了可以模拟Python读取-执行-打印循环的实用程序,就像在 code 模块中一样。因此,您可能不希望直接使用该模块;如果你想在程序中包含这样一个循环,你可能需要使用 code 模块。

这个任务有两个部分:

  1. 能够判断一行输入是否完成了一个Python语句:简而言之,告诉我们是否要打印 ‘>>>’ 或 ‘...’。

  2. 记住用户已输入了哪些 future 语句,这样后续的输入可以在这些语句被启用的状态下被编译。

codeop 模块提供了分别以及同时执行这两个部分的方式。

只执行前一部分:

codeop.compile_command(source[, filename[, symbol]])

尝试编译 source,这应当是一个 Python 代码字符串,并且在 source 是有效的 Python 代码时返回一个代码对象。 在此情况下,代码对象的 filename 属性将为 filename,其默认值为 '<input>'。 如果 source 不是 有效的 Python 代码而是有效的 Python 代码的一个前缀时将返回 None

如果 source 存在问题,将引发异常。 如果存在无效的 Python 语法将引发 SyntaxError,而如果存在无效的字面值则将引发 OverflowErrorValueError

The symbol argument determines whether source is compiled as a statement ('single', the default) or as an expression ('eval'). Any other value will cause ValueError to be raised.

注解

解析器有可能(但很不常见)会在到达源码结尾之前停止解析并成功输出结果;在这种情况下,末尾的符号可能会被忽略而不是引发错误。 例如,一个反斜杠加两个换行符之后可以跟随任何无意义的符号。 一旦解析器 API 得到改进将修正这个问题。

class codeop.Compile

这个类的实例具有 __call__() 方法,其签名与内置函数 compile() 相似,区别在于如果该实例编译了包含 __future__ 语句的程序文本,则实例会‘记住’并使用已生效的语句编译所有后续程序文本。

class codeop.CommandCompiler

这个类的实例具有 __call__() 方法,其签名与 compile_command() 相似;区别在于如果该实例编译了包含 __future__ 语句的程序文本,则实例会‘记住’并使用已生效的语句编译编译所有后续程序文本。

A note on version compatibility: the Compile and CommandCompiler are new in Python 2.2. If you want to enable the future-tracking features of 2.2 but also retain compatibility with 2.1 and earlier versions of Python you can either write

try:
    from codeop import CommandCompiler
    compile_command = CommandCompiler()
    del CommandCompiler
except ImportError:
    from codeop import compile_command

which is a low-impact change, but introduces possibly unwanted global state into your program, or you can write:

try:
    from codeop import CommandCompiler
except ImportError:
    def CommandCompiler():
        from codeop import compile_command
        return compile_command

and then call CommandCompiler every time you need a fresh compiler object.