如何添加“我自己的”;“帮助”;python函数/类的信息?
我知道我可以使用“help()”查看包中的现有帮助信息。但在我编写了自己的函数/类之后,如何启用“帮助”来查看帮助文档?我知道“comment”的第一行是一个doc属性,但这不是我想要的 我希望编译自己的包,其他人可以从“help()”中看到。如何做到这一点?如何添加“我自己的”;“帮助”;python函数/类的信息?,python,documentation,Python,Documentation,我知道我可以使用“help()”查看包中的现有帮助信息。但在我编写了自己的函数/类之后,如何启用“帮助”来查看帮助文档?我知道“comment”的第一行是一个doc属性,但这不是我想要的 我希望编译自己的包,其他人可以从“help()”中看到。如何做到这一点?help()完全基于\uuuu doc\uuuu属性(以及函数参数的内省),因此请确保您的模块、类和函数都有一个docstring docstring不是注释,它是位于顶部的裸字符串文字: """This is a module docst
help()
完全基于\uuuu doc\uuuu
属性(以及函数参数的内省),因此请确保您的模块、类和函数都有一个docstring
docstring不是注释,它是位于顶部的裸字符串文字:
"""This is a module docstring, shown when you use help() on a module"""
class Foo:
"""Help for the class Foo"""
def bar(self):
"""Help for the bar method of Foo classes"""
def spam(f):
"""Help for the spam function"""
例如,流行的第三方请求
模块有一个docstring:
>>> import requests
>>> requests.__doc__
'\nRequests HTTP library\n~~~~~~~~~~~~~~~~~~~~~\n\nRequests is an HTTP library, written in Python, for human beings. Basic GET\nusage:\n\n >>> import requests\n >>> r = requests.get(\'https://www.python.org\')\n >>> r.status_code\n 200\n >>> \'Python is a programming language\' in r.content\n True\n\n... or POST:\n\n >>> payload = dict(key1=\'value1\', key2=\'value2\')\n >>> r = requests.post(\'http://httpbin.org/post\', data=payload)\n >>> print(r.text)\n {\n ...\n "form": {\n "key2": "value2",\n "key1": "value1"\n },\n ...\n }\n\nThe other HTTP methods are supported - see `requests.api`. Full documentation\nis at <http://python-requests.org>.\n\n:copyright: (c) 2016 by Kenneth Reitz.\n:license: Apache 2.0, see LICENSE for more details.\n'
您可以使用argparse:。它允许您创建一个--help
参数,您可以自定义该参数并添加参数描述
例如:
parser = argparse.ArgumentParser(description = "Write your help documentation here...")
parser.add_argument('config.txt', nargs='?', help='Write about your positional arguments here')
args = parser.parse_args()
因此,当有人使用--help
运行您的程序时,它将输出:
$python yourProgram.py --help
usage: yourProgram.py [-h] [config.txt]
Write your help documentation here...
positional arguments:
config.txt Write about your positional arguments here
optional arguments:
-h, --help show this help message and exit
$python yourProgram.py --help
usage: yourProgram.py [-h] [config.txt]
Write your help documentation here...
positional arguments:
config.txt Write about your positional arguments here
optional arguments:
-h, --help show this help message and exit