当前位置: 首页 > 科技观察

在Python中使用argparse解析命令行参数

时间:2023-03-20 21:09:19 科技观察

使用argparse模块为您的应用程序设置命令行选项。有用于命令行解析的第三方库,但标准库argparse也毫不逊色。无需添加许多依赖项,您就可以编写具有有用参数解析功能的漂亮命令行工具。Python中的参数解析当使用argparse解析命令行参数时,第一步是配置一个ArgumentParser对象。这通常在全局模块中完成,因为仅仅_配置_解析器没有副作用。importargparsePARSER=argparse.ArgumentParser()ArgumentParser中最重要的方法是.add_argument(),它有几个变体。默认情况下,它会添加一个参数并需要一个值。PARSER.add_argument("--value")查看实际效果,调用.parse_args():PARSER.parse_args(["--value","some-value"])Namespace(value='some-value')也可以使用=语法:PARSER.parse_args(["--value=some-value"])Namespace(value='some-value')来缩短在命令行输入的命令,也可以指定一个简短的“选项的别名":PARSER.add_argument("--thing","-t")可以传入短选项:PARSER.parse_args("-tsome-thing".split())Namespace(value=None,thing='some-thing')或长选项:PARSER.parse_args("--thingsome-thing".split())Namespace(value=None,thing='some-thing')您可以使用多种类型的参数使用。除了默认类型外,最流行的两种是Boolean和Counter。Boolean类型有一个默认为True的变体和一个默认为False的变体。PARSER.add_argument("--active",action="store_true")PARSER.add_argument("--no-dry-run",action="store_false",dest="dry_run")PARSER.add_argument("--verbose","-v",action="count")ActiveisFalseunless--activeisexplicitlypassedin.dry-rundefaultstoTrueunless--no-dry-runispassed.可以绑定没有价值的空头期权。传递所有参数会导致非默认状态:PARSER.parse_args("--active--no-dry-run-vvvv".split())Namespace(value=None,thing=None,active=True,dry_run=False,verbose=4)默认值比较简单:PARSER.parse_args("".split())Namespace(value=None,thing=None,active=False,dry_run=True,verbose=None)子命令继承了经典的Unix命令“一次只做一件事,把它做到极致”,而现代趋势却把“几个密切相关的操作”放在一起。git、podman和kubectl充分说明了这种范式的流行。argparse库也可以做到:MULTI_PARSER=argparse.ArgumentParser()subparsers=MULTI_PARSER.add_subparsers()get=subparsers.add_parser("get")get.add_argument("--name")get.set_defaults(command="get")search=subparsers.add_parser("search")search.add_argument("--query")search.set_defaults(command="search")MULTI_PARSER.parse_args("get--nameawesome-name".split())命名空间(name='awesome-name',command='get')MULTI_PARSER.parse_args("search--queryname~awesome".split())Namespace(query='name~awesome',command='search')`使用argparse的一种方法是使用以下结构:##my_package/__main__.pyimportargparseimportsysfrommy_packageimporttoplevelparsed_arguments=toplevel.PARSER.parse_args(sys.argv[1:])toplevel.main(parsed_arguments)##my_package/toplevel.pyPARSER=argparse.ArgumentParser()##.add_argument,etc.defmain(parsed_args):...#在这种情况下用parsed_args做一些事情,用python-mmy_package运行或者,您可以在包安装期间使用console_scprits入口点。总结argparse模块是一个强大的命令行参数解析器,还有很多功能这里没有介绍。它可以实现你能想象到的一切。