【问题标题】:Set the wrap width for python docs in a terminal在终端中设置 python 文档的换行宽度
【发布时间】:2013-11-06 21:47:59
【问题描述】:

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

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

这个最大的问题是模块列表:当它列出所有模块名称时,它没有使用我的屏幕的整个宽度,它只使用窄的换行宽度,只在四列中显示模块,所以它可以'实际上并不适合我的屏幕上的整个列表(尽管它完全适合其他显示器)。我也不能只通过less 传递它,就像我在 bash 中处理超大的--help 文本一样。

【问题讨论】:

  • 这是关于“帮助”中打印文档的宽度还是文档字符串中嵌入代码之类的内容?
  • @synthesizerpatel 这是关于调用类似help('modules')help('__future__') 的输出。
  • 啊,在 help('modules') 的情况下,它使用 pydoc.Helper.list(items,columns=4,width=80) 作为默认值。您可以修改该函数以覆盖这些默认值。我想到了另一个想法 - 这可能在 ipython 中很容易配置,它的命令完成(模块名。)支持开箱即用的 80 多个列。

标签: linux word-wrap tty python


【解决方案1】:

== 编辑 == 更新

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

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

下面是一个如何对文档字符串进行猴子补丁的快速示例。基本上在一个文档字符串中, 换行符被硬编码到行尾,这样

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)

== 编辑 ==

这可能符合您的需求,也可能不符合您的需求,但我也有类似的抱怨,但我的解决方法略有不同。我写了一个“帮助”包装器,它在后台的浏览器中加载标准库文档。它可能对您有所帮助,也可能无济于事 - 一件好事是 pydoc 内容的 HTML 输出允许段落的可变宽度。

您可以获取附加的脚本,从 site.py 导入它,然后当您从 CLI 对任何 stdlib 内容运行 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 文档输出内容确实是有限的(正如您所经历的那样)。

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

【讨论】:

  • 嗯,似乎应该有一种方法可以自动化这样的解决方案,这样当我启动 python shell 时,它会自动重新定义帮助命令以输出重新格式化的内容。
  • 是的,你会在你的站点包目录中拥有那个脚本,在你的系统范围的 site.py 中,导入它。使猴子补丁成为启动任何 Python 解释器的标准步骤
猜你喜欢
  • 1970-01-01
  • 2017-09-16
  • 1970-01-01
  • 2021-08-24
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2015-07-31
  • 2011-11-15
相关资源
最近更新 更多