[英]restructuredText, docstring and python interactive shell
我使用reStructuredText来记录我的代码,以便通过epydoc获得不错的离线HTML页面。
结果很棒。 唯一的缺点是当我使用Python交互式shell时,help()函数不解析文档字符串中的reST元数据,而是显示整个事物。
有没有办法让help()对文档字符串进行一些最小的解析?
我不希望渲染斜体字体或超链接,但至少进行一些最小的清理以提高可读性。
help()
函数由site
模块添加到内置命名空间,您可以通过在路径上的某个位置创建sitecustomize.py
模块来自定义(显然它通常保存在site-packages中)。
然后在sitecustomize.py
文件中添加所需的任何自定义项。
您可以通过以下两种方式处理:
如果要更改help()
函数本身的(明显)行为,请将help()
函数包装在装饰器中,如:
def help_wrapper(func):
def inner(*args):
results = func(*args)
return your_cleanup_function_here(results)
help = help_wrapper(help)
我个人更喜欢稍微不同的解决方案,因为没有人知道你的清理功能将如何帮助输出不是用RestructuredText编写的。
所以我只想创建一个包装函数:
def my_help(*args):
return your_cleanup_function_here(help(*args))
这样,如果需要,您仍然可以访问原始的help()
函数。
CAVEAT:在sitecustomize.py中执行操作时要小心,因为无论你在这里做什么都可能会影响整个解释器会话(以及每个解释器会话),这有时会导致意想不到的后果。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.