os 模块的文档 URL

Question

我正在尝试破解 Python 的 os 模块的 URL 格式，以便在 PyCharm 的文档 window 中使用。

我目前的尝试：

https://docs.python.org/3/library/os.html#{element.qname}

但我无法显示以下文档：

https://docs.python.org/3/library/os.path.html#module-os.path

什么是正确的格式？

Answer 1

在解决 URL 黑客攻击之前，应该提到 文档显示方式的决定性设置 是 "Render external documentation for stdlib" 设置。您可以通过 File > Settings > Python Integrated Tools > Docstrings > [=21 来配置它=]如截图所示：

如果您启用“为stdlib呈现外部文档”设置（并且可以访问互联网），IDE 将自动从 https://docs.python.org/{python.version}/library/{module.name}.html#{element.qname} 检索标准库文档。 Python 版本是根据 Python interpreter configured for the Project 自动确定的，因此这是为您在编辑器中打开的文件显示的文档版本。

看看这与在线文档的对应关系：

如果您禁用“为stdlib呈现外部文档”设置（或者没有互联网访问权限） , IDE 将显示其集成存根文件的文档字符串。

话虽如此，documentation tool window does not require configuring the URL for standard library modules (e.g. for the os, sys, etc...) contrary to how it's necessary for other libraries' External Documentation。事实上，IDE 设置中没有更改标准库模块地址的选项。

What's the right format?

完整格式为：

https://docs.python.org/{python.version}/library/{module.name}.html#{element.qname}

crack the URL format for Python's os module for use in PyCharm's documentation window.

可以做到，但仅限于特定模块。它不能对整个标准库完成，因为基础 Module Name 字段必须留空，在这种情况下 IDE 将忽略该设置。

如果您对特定模块使用 hack，IDE 将在文档工具 window 中显示文档字符串（如示例 2）但是，如果您单击外部 link，它将在外部文档中配置的地址中打开浏览器。见截图：

所以黑客的用处有限。

如果您 download the Python HTML documentation 可以将 hack 与离线文档一起使用（但它仍然仅限于仅显示示例 2 中的文档）。在该用例中，编写 URL 的正确方法取决于 OS/Shell/Browser，对于 Windows/CMD/Firefox，您可以使用下面的 URL，但无法转义散列 # 签名，这样锚点将不起作用，但您将被带到文档页面。

file:///C:/directory_name/library/{module.name}.html#{element.qname}

os 模块的文档 URL

Documentation URL of os module

python

pycharm

documentation

python-os