问题标签 [docstring]

我在 Sphinx 中记录类似于这样的代码：

我:inherited-members将ChildClass.

有没有办法我可以在像 <class_name> 这样的文档字符串中放入 Sphinx 将替换为它正在记录的实际类的东西？

我想让代码看起来像：

因此，在 ChildClass 部分，Sphinx 文档将显示“(...) using /run/ChildClass/generic_fun()(...)”，而 ParentClass 部分将显示“(...) using /run/ParentClass/ generic_fun()(...)”？

理想情况下，我希望将文档放在同一页面上，因此不同部分的替换字符串会有所不同。

也许是一个愚蠢的问题：如何为特殊函数指定文档字符串，例如__init__在编写 C 扩展时？对于普通方法，方法表提供了文档字符串。当我尝试 help(myclass) 时，会显示以下自动生成的文档：

但这是我想要覆盖的。

__doc__我喜欢在我的使用字符串中给我的用户一个例子。以下是与我的问题相关的代码的重要部分。

我期望这种行为：

但是，当我将示例复制到命令行时，我希望程序能够运行。相反，我得到：

注意上面的第二行。这是由print args里面的命令产生的main()。它是说 args 列表只有 1 个元素，['\\\\Hal\\hal free agent 1\\backups\\videos" out.txt']而不是 2。这对我来说没有意义。

我通过编写一个 Windows .cmd 文件进行了更多调查。这是 show_args.cmd：

这是运行的结果：

Windows 似乎将这些项目分开。我难住了。有谁知道这里发生了什么？

我希望有人有一些见解可以分享。提前致谢。

我想func_doc在. def

这可能吗？

（我可以考虑这样做的两个原因：从模块导入函数（并且您也想导入文档字符串）和使用lexer。）

我想在 Sublime Text 2 中区分 Python 文档字符串和单行字符串。查看 Python 语言定义，我可以看到这一点，以及使用相同 comment.block.python 名称的撇号字符串的匹配定义.

但是当我像这样创建一个新的颜色规则时：

什么都没发生; 它们保持与单行字符串相同的颜色。

是否有可能做到这一点？如果是这样，我做错了什么？

我有一个 Python 包，其中实现被分成（为了可维护性）两个内部子模块。但是，从用户的角度来看，包应该作为一个单元出现，因此在包的__init__.py两个子模块中都使用 导入import *，如下所示：

和

从包功能的角度来看，这可以按预期工作：

如果直接查找这些类的内联帮助，一切都很好：

问题是，如果我只是查找顶级包的帮助，请参阅。

那么子模块中的类和函数根本不会“自愿”出现（尽管它们中的变量确实出现在该DATA部分中）。这是预期/正确的行为吗，有没有办法绕过它，以便用户不必知道仅为实现/维护方便而存在的子模块？

我需要将文档字符串转换为 XML 数据，并将此 XML 数据附加到现有 XML 文件的开头。

要转换为 XML 的数据如下所示：

string = __doc__给了我 doc 字符串，但是如何进一步进行，转换为 XML 并附加到已经存在的 XML 文件的开头？

XML 文件应如下所示：

我只是想知道编写 Python Docstrings ( ) 的两种方式有什么区别__doc__：

1. 三个单引号：

   /li>

2. 三个双引号：

   /li>

在生成文档时，文档字符串的格式化方式是否有任何细微差别？

你怎么能在函数文档字符串前面加上一个装饰器？

结果：

所有的帮助将不胜感激。

我几乎有我想要的...

这个动态对象封装了一个带有动态文档字符串生成的通用函数调用：

它按预期工作：

唯一的两个问题是帮助显示mutable_f签名

并且没有自动完成（我可以即时获取有效函数的列表，并缓存它，因为该操作很昂贵）

我认为第一个是无法解决的，但我不太确定第二个。想法？