依赖文档字符串的脚本？

Question

来自 2.7.2 文档第 6 节，模块：

将两个 -O 标志传递给 Python 解释器 (-OO) 将导致字节码编译器执行优化，在极少数情况下可能会导致在出现故障的程序中。目前，只有 __doc__ 字符串从字节码中删除，从而产生更紧凑的 .pyo 文件。

这引起了我的注意：

由于某些程序可能依赖于这些可用，因此只有在您知道什么时才应该使用此选项

是否有任何情况下，删除脚本的文档字符串可能会在逻辑上破坏代码功能的某些依赖项或其他方面，而忽略任何语法错误？

编辑

为什么删除注释会破坏帮助声明？在解释器中似乎没有这样做。

>>> help('import_pi')

Help on module import_pi:

NAME
    import_pi

FILE
    /home/droogans/py/import_pi.py

FUNCTIONS
    print_pi()

DATA
    pi = 3.1415926535897931


>>> import import_pi()
>>> import_pi.__doc__
>>>
>>> print import_pi.print_pi.__doc__
Convert a string or number to a floating point number, if possible.

Answer 1

例如 ply 是一个进行词法分析和解析的模块，它使用文档字符串来描述语法。剥离文档字符串会破坏代码。

Answer 2

-OO 选项仅影响是否存储文档字符串——它不影响解析。例如，以下代码在启用和不启用优化的情况下都可以工作：

def f():
    'Empty docstring'

assert f() is None

启用文档字符串优化后将中断的程序是依赖于文档字符串的内容的程序。 Paul Hankin 提到了 Ply，它是一个使用文档字符串作为调度逻辑的工具。另一个例子是 doctest 模块，它使用文档字符串的内容进行测试。

下面是一个简单的代码示例，该代码在启用 -OO 优化的情况下不起作用：

def f():
    '30 + 40'
    return eval(f.__doc__)

print f()

注意 help() 仍可与 -OO 一起使用启用优化，但它只会找到函数名称、参数和模块，但不会找到文档字符串：

>>> help(f)
Help on function f in module __main__:

f()