==编辑==更新
因此,您将遇到的问题是,对于基于CLI的帮助,DOC字符串宽度确实仅受原始文档中的新线的限制。也就是说,当您运行'帮助时(未来)',它只是打印出DOC字符串并打印它。没有花哨的,没有格式化。这就是为什么如果将文档渲染到HTML,则可以修改浏览器宽度,并且它将以不同的方式包装。
我发现修改此行为的唯一方法是,如果您实际修改了Docstring本身。
这是一个如何进行猴子绘制文档字符串的快速示例。从本质上讲,在docstring中,新线对线的结尾进行了硬编码,以便
a = """
one
two
three
"""
编码
'\none\ntwo\n\nthree\n'
如果您想自动自动“包裹”行,则只需替换带有捕获的字符的 n [^ n](任何不是newline的newline +字符)即可。
re.sub('\n([^\n])', ' \g<1>', a)
然后变成
' one two\n three\n'
这是一种超级骇人听闻的做事方式,但是我能想到的唯一方法可以重新格式化事物,以便它们包裹起来。
一个更好的例子是:
#!/usr/bin/python
import pydoc
import re
t = re.sub('\n([^\n])', ' \g<1>', pydoc.__doc__)
pydoc.__doc__ = t
help(pydoc)
==编辑==
这可能不适合您的需求,但是我的解决方案类似,我对解决方案有所不同。我写了一个“帮助”包装器,该包装器将stdlib文档加载到后台的浏览器中。它可能会或可能不会帮助您 - 一件好事是,PYDOC东西的HTML输出允许在段落上宽度可变。
您可以获取附件的脚本,从site.py导入它,然后在任何stdlib东西上从CLI运行help()时,它将自动打开相应的网页。这对您自己本地的东西没有任何作用(我认为没有一段时间),但可以修改以进行修改。
如果您是硬核CLI家伙,请深表歉意。但是,当面对类似的东西时,关于东西的输出,这就是我最初尝试的。
#!/usr/bin/python
import inspect
import os
import sys
import webbrowser
from pydoc import Helper
__all__ = ['MyHelper', 'old_help', 'help']
class MyHelper(Helper):
def __init__(self):
Helper.__init__(self)
def getdocloc(self, object):
global old_help
"""Return the location of module docs or None"""
try:
file = inspect.getabsfile(object)
except TypeError:
file = '(built-in)'
docloc = os.environ.get("PYTHONDOCS", "http://docs.python.org/library")
basedir = os.path.join(sys.exec_prefix, "lib", "python"+sys.version[0:3])
BUILTINS_LIST = ( 'errno', 'exceptions', 'gc', 'imp', 'marshal', 'posix', 'signal', 'sys', 'thread', 'zipimport')
if (isinstance(object, type(os)) and (object.__name__ in BUILTINS_LIST or file.startswith(basedir)) and object.__name__ not in ('xml.etree', 'test.pydoc_mod')):
if docloc.startswith("http://"):
docloc = "%s/%s" % (docloc.rstrip("/"), object.__name__)
else:
docloc = os.path.join(docloc, object.__name__ + ".html")
else:
docloc = None
return docloc
def __repr__(self):
global old_help
if inspect.stack()[1][3] == '?':
return self()
return ''
else:
return '<HHhelp instance>'
def help(self, *args):
print args
global old_help
if isinstance(args[0], object):
docloc = self.getdocloc(args[0])
print '********',docloc,type(docloc)
if isinstance(docloc, str):
if docloc.find('http://') == 0:
webbrowser.open(docloc)
else:
old_help(args)
global old_help, help
old_help = help
help = MyHelper()
我使用的第二个解决方案用于获取漂亮的python文档是使用phinx的 狮身人面像 自动生成Python模块的API文档。标准的Python Doc输出内容确实是限制的(您正在经历)。
但是,话虽如此 - 我敢打赌,文档的宽度是可以以某种方式配置的,但需要猴子补丁...我会戳一点点,看看我能找到什么。