问题标签 [pydoc]

我正在从 LPTH 学习 python。

在学习练习的练习 15 中，我应该知道read()使用 pydoc 是做什么的；但是，当我尝试使用时python -m pydoc read()，我会收到这样的错误。

我不明白我做错了什么。

我对 : 使用了相同的方法raw_input,os,open，但显然我在 . 上做错了什么read()。

pydoc 的输出根据字母顺序对结果（方法及其文档字符串）进行排序。这很好，但我想了解最新情况。当我在我的模块中添加一个新方法时，我将它添加为第一个方法，所以每次我添加一个新方法时，它都会成为文件中的第一个方法。

我希望 pydoc 输出以与文件中方法相同的顺序显示。

这可能吗？

例子：

这是我的模块 pydoc_test.py：

这是“pydoc pydoc_test”的输出：

pydoc 首先显示“add_my_code”，然后显示“test_my_code”，但我想要与文件中相同的顺序。

有没有办法评论函数的参数以使它们被 pydoc 库识别？

即 pydoc 的文档字符串是什么？

我创建了自己的模块X。一开始，我从其他一些模块（例如）导入函数from math import func。我注意到，当我创建文档时：

结果文件还包含从模块中导入的函数函数math，这是不可取的（特别是如果我从多个模块导入许多函数，这就是我所做的）。

可以通过调用来避免：

但在这种情况下，我必须导入所有函数，然后使用math.func而不是调用它们func。

有没有另一种方法可以避免使用导入的函数填充我的文档，同时仍然能够导入函数from？

我正在尝试设置我的新笔记本电脑的开发环境。安装 zsh 后，我不断收到错误

deactivate:unset:1: no such hash table element: pydoc 请帮忙。我的 zshrc 中有以下简单别名：

对 python 来说还是很新的，所以如果这看起来很明显，请原谅我，但我发现 argparse 阻止我在我的脚本上运行 pydoc。

如果我取消注释最后一行并运行pydoc scriptname，那么 pydoc 似乎会尝试以某种方式运行脚本，而不仅仅是显示格式化的文档字符串？

我哪里错了？

pydoc.locate从代码块或基本交互式 shell 调用时不会抛出错误。只有当我从 pycharm 中启动 IPython 控制台时，locate如果提供不存在的模块作为参数，它会引发错误。

Python 代码：None作为输出打印

从 pycharm 运行 IPython

从终端运行 python

pycharm IDE 是否将某些东西设置为系统变量，以便能够locate意识到存在导入错误？

如果有人可以测试和解释这种行为，我将不胜感激。

谢谢！

我正在编写一个配置卷的存储自动化模块。我没有传递在存储控制器上实际创建卷所需的六个或更多参数，而是创建了一个参数类，使用__slots__它传递给 create 方法，如下所示：

上面的示例效果很好，但有一个小例外。如何将文档字符串添加到参数类中的描述符中并不明显。似乎元类应该是可能的，但是在实例化元类时没有定义描述符。

我敏锐地意识到有些人可能不同意我使用 的副作用__slots__，但我喜欢它有助于消除拼写错误。尝试设置一个不存在的参数并引发繁荣AttributeError。所有这些都没有任何样板代码。可以说让它在创建卷时失败更符合 Pythonic，但结果将是使用默认值而不是拼写错误的参数。这实际上是一个无声的失败。

我意识到可以简单地扩展参数类文档字符串，但是pydoc其他文档构建脚本的结果是类的大型自由格式文档字符串和每个描述符的空文档字符串。

当然必须有一种方法来为由__slots__?创建的描述符定义文档字符串。也许除了插槽之外还有另一种方法？一个可变的namedtuple或类似的？

我从 Mac Os 的官方网站下载并安装了 python 3。在设置中，文档有一个复选标记。

该软件包将 python 文档安装在可用于 pydoc 和 IDLE 的位置。

但是我找不到它。 如何打开文档或它们在哪里？

我正在尝试在init.py中记录一个 python 包，但我不清楚 pydoc 如何解析 """三方括号""" 注释以通过以下方式显示给用户：

或者

如何解析注释以在 pydoc 输出的 NAME 和 DESCRIPTION 部分提供内容？是否还有其他部分我也可以填充，例如示例？