nhelp2

nhelp2 是一种与 help() 功能相似但更强大的 Python 命令行工具，它提供了更好的搜索和筛选功能，并可以将结果以 Markdown 的形式返回。

安装

您可以使用 pip 安装 nhelp2 ：

pip install nhelp2

使用

在 Python 控制台或 Jupyter Notebook 中，输入以下命令启用 nhelp2：

from nhelp2 import nhelp2
nhelp2()

运行后，您将看到一个提示符：

Enter search term(s): 

在此处您可以输入想要搜索的 Python 对象，例如 list 或 os.path.join。按下回车键后，将出现一个带有搜索结果的窗口。

要退出 nhelp2，请输入 quit 或使用 Ctrl+C。

参数

• --color/--no-color: 显示颜色的输出（默认为启用）

nhelp2('--color')
nhelp2('--no-color')

例子

以下示例将向您展示如何在使用 nhelp2 时搜索特定的 Python 对象：

搜索列表（list）

from nhelp2 import nhelp2

# 搜索列表的相关信息
nhelp2('list')

# 搜索列表中包含的方法
nhelp2('list.append')

查询操作系统路径的相关信息（os.path）

from nhelp2 import nhelp2

# 搜索 os.path 的相关信息
nhelp2('os.path')

# 搜索 os.path.join 的信息
nhelp2('os.path.join')

返回值

nhelp2() 函数将返回包含相关信息的字符串，可以将其转换为 Markdown 格式：

import markdown

markdown_text = markdown.markdown(nhelp2('os.path.join'))
print(markdown_text)

该代码片段将返回以下类型的 Markdown：

<h3 id="os.path.join"><a class="header-link" href="#os.path.join"></a>os.path.join()</h3>
<p>Join one or more path components intelligently. The return value is the concatenation of path and any members of *paths with exactly one directory separator (os.sep) following each non-empty part except the last, meaning that the result will only end in a separator if the last part is empty. If a component is an absolute path, all previous components are thrown away and joining continues from the absolute path component.</p>
<p>On Windows, the drive letter is not reset when an absolute path component (e.g., r'\foo') is encountered. If a component contains a drive letter, all previous components are thrown away and the drive letter is reset. Note that since there is a current directory for each drive, os.path.join("c:", "foo") represents a path relative to the current directory on drive C: (c:\foo), not c:\foo.</p>