关于python argparse帮助格式化程序类的文档在哪里？ [英] where is the documentation for the python argparse helpformatter class?

问题描述

我找到了python argparse模块的文档，其中提到了Formatter_CLASS。我在该页面上看不到任何内容，比如Width参数或max_Help_Position。这些文档记录在哪里？

https://docs.python.org/3/library/argparse.html

argparse

推荐答案使用帮助器类argparse.helpFormatter()，该类使用max_help_position和width参数(以及其他参数)。请参阅解释如何使用它的出色答案Explain lambda argparse.HelpFormatter(prog, width)。

查找文档时遇到的问题是，HelpForMatter只是从其名称的意义上来说是公共的。它的所有方法都是私有的。

这取自您提供的文档中链接的来源https://github.com/python/cpython/blob/2.7/Lib/argparse.py：

类HelpForMatter(Object)：

用于生成用法消息和参数帮助字符串的格式化程序。

只有此类的名称才被视为公共API。所有的方法 类提供的数据被视为实现详细信息。

因此，argparse文档本身就是How-to和正式API描述的混合体。主要描述如何执行常见的解析任务。尽管argparse由类组成，但文档并没有正式描述这些类、它们的子类化和所有方法。这不是参考API。

一个解决办法是找到另一个使用HelpForMatter类的服务，以便更好地记录其变量，如Discordehttps://discordpy.readthedocs.io/en/rewrite/ext/commands/api.html#discord.ext.commands.HelpFormatter中的变量。

希望这能有所帮助。

更新

Discorde已更新其链接，因此上述链接现在已断开。改为在WayBackMachine中查找：https://web.archive.org/web/20180306073319/https://discordpy.readthedocs.io/en/rewrite/ext/commands/api.html#discord.ext.commands.HelpFormatter

这篇关于关于python argparse帮助格式化程序类的文档在哪里？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！