问题标签 [docstring]

加载模块时，Python 文档字符串和注释是否存储在内存中？

我想知道这是不是真的，因为我通常会很好地记录我的代码；这会影响内存使用吗？

通常每个 Python 对象都有一个__doc__方法。这些文档字符串是从文件中读取的，还是以其他方式处理的？

我在论坛、谷歌和邮件列表中进行了搜索，但没有找到任何相关信息。

你更了解吗？

doctest 中的这段代码在单独运行时有效，但在这个 doctest 中它在 10 个地方失败。我不知道为什么会这样。以下是整个模块：

我正在使用python 3.1。

是否可以为单个模块或函数创建超过 1 个文档字符串？我正在创建一个程序，并且我打算有多个文档字符串，每个文档字符串都有一个类别。我打算将程序提供给其他人，以便他们可以使用它，并且为了让程序员和非程序员都可以轻松使用，我在程序本身中引用了文档字符串以供文档使用。

更具体地说，我在程序/模块中有一个菜单作为界面，其中一个选项将允许访问模块文档字符串以获取程序文档。因此，如果可能的话，我想制作多个文档字符串来对不同类型的文档进行分类。因此，如果用户想查看文档的某些部分，他们会更容易。

例如。第一个文档字符串包含有关如何使用该程序的说明。第二个文档字符串包含有关程序的一部分如何工作的信息。第三个文档字符串包含有关另一部分如何工作的信息。等等

这可能吗？如果是这样，你如何引用它们？

更新：添加了评论。

我最初的想法是实际上有多个文档字符串：

然后会有一些代码可以让我引用这些文档字符串中的每一个。所以，我猜这不可能吗？

如果可能的话，我想在我的 Python 代码的文档字符串上运行拼写检查器，如果可能的话，可以在 emacs 中运行。

我发现 ispell-check-comments 设置可用于仅对代码中的注释进行拼写检查，但我无法仅针对特定于 python 的文档字符串。

我已经编写了一个epytext到reST标记转换器，现在我想将整个库中的所有文档字符串从 epytext 转换为 reST 格式。

有没有一种聪明的方法来读取模块中的所有文档字符串并写回替换内容？

ps：也许是ast模块？

处理文档字符串中重复内容的好方法是什么？我有许多采用“标准”参数的函数，这些参数必须在文档字符串中进行解释，但最好只编写一次文档字符串的相关部分，因为这样更容易维护和更新。我天真地尝试了以下方法：

但这不起作用，因为当我这样做时，我help(test)看不到文档字符串。有没有好的方法来做到这一点？

我知道在 Python 中，字符串只是一个表达式，而字符串本身会在将控制权返回给代码调用者后立即被垃圾收集，但是......

1. 代码中的大型类/方法文档字符串：它们是否通过构建字符串对象来浪费内存？
2. 模块级文档字符串：它们是否被解释器无限存储？

这还重要吗？我唯一担心的想法是，如果我使用像 Django 这样的大型框架或多个大型开源库，它们往往有很好的文档记录，可能有数兆字节的文本。在这些情况下，文档字符串是否会加载到内存中以供沿途使用的代码使用，然后保存在那里，还是像普通字符串一样立即收集？

我正在编写一个轻量级类，其属性旨在公开访问，并且仅有时在特定实例中被覆盖。就此而言，Python 语言中没有为类属性或任何类型的属性创建文档字符串的规定。记录这些属性的预期和支持方式是什么？目前我正在做这样的事情：

这将导致类的文档字符串包含初始标准文档字符串部分，以及通过对__doc__.

尽管在docstring style Guidelines中似乎没有明确禁止这种风格，但也没有提到它作为一个选项。这里的优点是它提供了一种在属性定义旁边记录属性的方法，同时仍然创建一个可呈现的类文档字符串，并且避免编写重复来自文档字符串的信息的注释。我仍然有点恼火，我实际上必须写两次属性；我正在考虑使用文档字符串中值的字符串表示形式至少避免默认值的重复。

这是对特设社区公约的严重违反吗？没事吧？有没有更好的办法？例如，可以创建一个包含属性值和文档字符串的字典，然后将内容添加到类__dict__中，并在类声明的末尾添加文档字符串；这将减少两次键入属性名称和值的需要。 编辑：我认为最后一个想法实际上是不可能的，至少在没有从数据动态构建整个类的情况下是不可能的，除非有其他原因，否则这似乎是一个非常糟糕的主意。

我对 python 还很陌生，仍在研究编码风格的细节，所以也欢迎不相关的批评。

是否可以在 Java 的文档字符串中显示text变量cls而无需复制粘贴内容？

我想显示我的函数的文档字符串，但如果我这样使用

它不会显示文档字符串，只是因为我使用了一些棘手的元编程，如何解决这个问题？