linux - 在终端中设置 python 文档的换行宽度

Question

我在 TTY 终端中使用 python shell，所有文档都以如此窄的宽度换行，这非常令人恼火。我的屏幕为 1600 x 900 像素，终端为 200 x 56 个字符，但 shell 中的 python 文档坚持以更窄的宽度换行。 (我在提示符下输入的行不受限制；它允许它们运行全屏宽度。)

我知道PEP-8 Maximum Line Length指定文档字符串每行限制为 72 个字符，但是有没有办法让它使用整个终端？我知道 javadoc 从 javadoc 注释中删除了额外的换行；我正在寻找类似的东西。

最大的问题是模块列表:它在列出所有模块名称时没有使用屏幕的整个宽度，而是仅使用窄换行宽度，仅以四列显示模块，因此它实际上无法适合我的屏幕上的整个列表(尽管它在其他显示器上完美适合)。我也不能像在 bash 中使用超大的 --help 文本那样通过 less 进行管道传输。

Answer 1

==编辑==更新

因此，您将遇到的问题是，对于基于 CLI 的帮助，文档字符串宽度实际上仅受原始文档中的换行符限制。也就是说，当您运行“help(future)”时，它只是打印出文档字符串并对其进行分页。没什么花哨的，没有即时完成格式化。这就是为什么如果将文档呈现为 HTML，您可以修改浏览器宽度，并且它会以不同的方式换行。

我发现修改此行为的唯一方法是实际修改文档字符串本身。

以下是如何对文档字符串进行猴子修补的快速示例。本质上在文档字符串中，换行符被硬编码到行尾，这样

a = """
one
two

three
"""

编码为

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

如果您想自动换行，只需将\n[^\n] (任何换行符 + 不是换行符的字符)替换为捕获的字符即可。

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

a 然后变成

' one two\n three\n'

这是一种 super 古怪的做事方式，但这是我能想到的重新格式化内容以便它们换行的唯一方法。

一个更好的例子是:

#!/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 文档的第二个解决方案是使用 Sphinx 的 sphinx-apidoc 自动生成 Python 模块的 API 文档。标准 Python 文档输出内容确实有限制(正如您所经历的)。

但是，话虽如此 - 我打赌文档的宽度可以以某种方式配置，但需要猴子修补......我会四处看看，看看我能找到什么。