Python-如何不按字母顺序对pydoc输出进行排序

Question

pydoc的输出根据字母顺序对结果（方法及其文档字符串）进行排序。 很好，但是我想紧跟新事物。 当我在模块中添加新方法时，我将其添加为第一个方法，因此，每次添加新方法时，它将成为文件中的第一个方法。

我希望pydoc输出以与文件中方法相同的顺序显示。

这可能吗？

例：

这是我的模块pydoc_test.py：

#!/usr/bin/python
def test_my_code():
    """
    Docstring for test_my_code()
    :return:
    """
    pass


def add_my_code():
    """
    Docstring for add_my_code()
    :return:
    """
    pass

这是“ pydoc pydoc_test”的输出：

Help on module pydoc_test:

NAME
    pydoc_test

FILE
    /Users/myname/Documents/scripts/python_learning/pydoc_test.py

FUNCTIONS
    add_my_code()
        Docstring for add_my_code()
        :return:

    test_my_code()
        Docstring for test_my_code()
        :return:

pydoc首先显示“ add_my_code”，然后显示“ test_my_code”，但是我想要的顺序与文件中的顺序相同。

Answer 1

最近，我遇到了同样的问题，据我从文档中得知，pydoc本身并没有为您提供此选项。

我认为您唯一可以做的就是捕获pydoc的输出：

import pydoc
import pydoc_test
docstrings = pydoc.render_doc(pydoc_test)

并解析它以获得单独的文档字符串。

然后阅读pydoc_test.py，通过搜索'def'获得函数名称，并根据它们在pydoc_test.py中的出现顺序重新排列pydoc docstring。

我非常难看。 我猜想这是一种获取所需内容的round回方式，以至于您可能完全忘记了pydoc，而直接直接读取pydoc_test.py文件并对其进行解析以获取文档字符串。