Python中 模块click自我使用总结:
之前不知道有click这个模块,一次偶然的机会,对这个模块有了认识。
网络上查看了一些知识,自己研究了一下,和大家分享一下。
import click
@click.command()#这个是固定格式 #这里的option是click的一个方法:下面是它的一些参数
@click.option('--gender', '--g', default='man', type=str, prompt="please input the name", nargs=1, required=True, \
help='Please input the name that "man" or "woman"' )
def choose(gender):
'''This is log message.''' #这段字符串看起来很普通,但是它代表当你输入--help时显示的字符串。
click.echo('gender: %s' % gender) #这个是click的一个方法,类似于print
input() #当时自己在研究时添加的代码,目的在于让代码停住,查看现象。
if __name__ == '__main__':
choose() #这里函数没有输入参数,这个参数需要从命令行获取。一般编译器会报错,不用管,能够执行成功。
#首先使用这个模块需要进行库的安装,在windows的cmd下执行pip install click即可。
'--gender', '--g':#使用单引号括起来的,表示在执行命令是需要敲击的命令,两个单引号表示,输入这两种形式哪种都可以。
例如输入格式为:python .\second02.py --gender man 或者python .\second02.py --g man
default='man':如果没有输入参数,即没有输入--gender man or --g man 那么会默认为输入的是'man'
type=str:表示输入参数的类型,可以是str,int,float等,限定输入参数的类型
prompt='please...':当你忘记输入参数时,会提醒你输入参数。
nargs=1:代表指定命令行参数输入个数。1代表参数--gender 之接受一个参数。
required=True:代表是否为必填参数,True表示必须要填写。
help='Please...':当使用--help时,用来显示参数的提示信息。
#option里有时也会添加这个参数:type=click.Choice(['start','stop']),表示参数值只能填写列表中的参数。
这个是我自己对click的一个总结,使用简介的话来描述,希望能给大家带来更好的理解。
刚刚在写这篇文档是突然发现一个小技巧和大家分享下,当我们在这里书写文档时,使用回车键时,行间距会很大,那么使用shift+回车就会出现小行间距的换行,希望能对你有所帮助。