os模块的文档URL

Question

我正试图破解PyCharm的os模块的URL格式，以便在PyCharm的文档窗口中使用。

我到目前为止的尝试：

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之前，应该提到--文档显示方式的决定设置--是设置。您可以通过转到File > Settings > Python Integrated Tools > Docstrings > Render external documentation for stdlib来配置它，如屏幕快照所示：

​

​

1. 如果您启用了“为提供外部文档”设置(并具有internet访问权限)，则将自动从https://docs.python.org/{python.version}/library/{module.name}.html#{element.qname}检索标准库文档。Python版本是从为项目配置Python解释器自动确定的，因此这是您在编辑器中打开的文件的文档版本。

​

​

请参见这如何与在线文档相对应：

​

​

1. 如果禁用的“为stdlib呈现外部文档”设置(或没有internet访问权限)，则IDE将显示其集成存根文件的文档字符串。

​

​

话虽如此，文档工具窗口 不需要为标准库模块配置URL (例如os、sys等.)与其他库的外部文件的必要性相反。实际上，IDE设置中没有更改标准库模块地址的选项。

什么是正确的格式？

完整的格式如下：

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

破解Python的os模块的URL格式，以便在PyCharm的文档窗口中使用。

这是可以做到的，但它仅限于特定的模块。不能对整个标准库执行此操作，因为基本的Module Name字段必须保持为空，在这种情况下，IDE将忽略设置。

​

​

如果您对特定模块使用hack，则将在文档工具窗口(如示例2)中显示文档字符串，但如果单击外部链接，它将打开外部文档中配置的地址中的浏览器。见截图：

​

​

因此，这次黑客攻击的用处有限。

如果您使用下载Python文档，则可以在脱机文档中使用该黑客(但它仍然仅限于显示文档，如示例2)。在这种情况下，编写URL的正确方式将取决于OS/Shell/Browser，对于Windows/CMD/Firefox，您可以使用下面的URL，但是没有办法转义散列#标记，因此锚点不能工作，但您将被带到文档页面。

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