Question

我在TTY终端中使用python shell，并且所有文档都包含在如此窄的宽度中，这是非常恼人的。我的屏幕是1600 x 900像素，我的终端是200 x 56个字符，但shell中的python文档坚持以更窄的宽度包装。（我在提示符处输入的行不受限制;它允许它们运行整个屏幕宽度。）

我知道PEP-8 Maximum Line Length指定文档字符串每行限制为72个字符，但有没有办法让它使用整个终端呢？我知道javadoc从javadoc注释中删除了额外的换行;我追求的东西有点像那样。

最大的问题是模块列表：当它列出所有模块名称时，它不使用我的屏幕的整个宽度，而是仅使用窄的包裹宽度，仅在四列中显示模块，因此它可以实际上整个列表都适合我的屏幕（虽然它非常适合其他显示器）。我也不能通过less管道，就像我在bash中使用超大--help文本一样。

Answer 1

==编辑==更新

因此，您将遇到的问题是，对于基于CLI的帮助，文档字符串宽度实际上仅受原始文档中的换行限制。也就是说，当你运行'help（ future ）'时，它会打印出doc字符串并将其分页。没什么好看的，没有动态格式化。这就是为什么如果将文档呈现为HTML，您可以修改浏览器宽度，它将换行。

我发现修改此行为的唯一方法是实际修改docstring本身。

以下是如何修补doc字符串的快速示例。基本上在文档字符串中，新行被硬编码到行尾，例如

a = """
one
two

three
"""

编码到

'\none\ntwo\n\nthree\n'

如果您想自动“换行”，您只需要用捕获的字符替换\ n [^ \ n]（任何换行符+非换行符）。

re.sub('\n([^\n])', ' \g<1>', a)

然后变成

' one two\n three\n'

这是一种超级hacky的做事方式，但我能想到的唯一方法是重新格式化以便包装。

更好的例子是：

#!/usr/bin/python

import pydoc
import re

t = re.sub('\n([^\n])', ' \g<1>', pydoc.__doc__)
pydoc.__doc__ = t
help(pydoc)

==编辑==

这可能会或可能不适合您的需求，但我有一个类似的抱怨，我解决了一点不同。我写了一个'help'包装器，它在后台的浏览器中加载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文档的第二个解决方案是使用Sphinx的 sphinx-apidoc 来自动生成Python模块的API文档。标准的Python doc输出内容实际上是限制性的（正如您所经历的那样）。

然而，随着说 - 我打赌文档的宽度可以配置，但需要猴子修补...我会捅一下，看看我能找到什么。

在终端中设置python docs的包装宽度

1 个答案: