restructuredText,docstring和python交互式shell

Question

我使用reStructuredText来记录我的代码,以便通过epydoc获得不错的离线HTML页面.

结果很棒.唯一的缺点是当我使用Python交互式shell时,help()函数不解析文档字符串中的reST元数据,而是显示整个事物.

有没有办法让help()对文档字符串进行一些最小的解析？

我不希望渲染斜体字体或超链接,但至少进行一些最小的清理以提高可读性.

Answer 1

该help()函数由模块添加到内置命名空间中site，您可以通过sitecustomize.py在路径上的某个位置创建模块来自定义该模块（显然它通常保存在站点包中）。

然后在sitecustomize.py文件中添加您想要的任何自定义内容。

您可以通过几种方式处理这个问题：

如果您想更改help()函数本身的（明显）行为，请将帮助函数包装在装饰器中，例如：

def help_wrapper(func):
    def inner(*args):
        results = func(*args)
        return your_cleanup_function_here(results)
help = help_wrapper(help)

我个人更喜欢稍微不同的解决方案，因为不知道你的清理函数将做什么来帮助未在RestructedText 中编写的输出。

所以我只是创建一个包装函数：

def my_help(*args):
    return your_cleanup_function_here(help(*args))

help()这样，如果需要，您仍然可以访问原始功能。

注意：在 sitecustomize.py 中执行操作时要小心，因为您在这里所做的任何操作都可能会影响整个解释器会话（以及每个解释器会话），这有时会导致意想不到的后果。