python 命令行 参数,Python参数化
在日常编写Python脚本的过程中,我们经常需要结合命令行参数传入一些变量参数,使得项目使用起来更加灵活方便。本文列出了构建Python命令行参数的四种常用方法,如果需要可以参考。
00-10101.sys。argv2。argparse3。getopt4。最后点击,大家好。在日常编写Python脚本的过程中,我们经常需要结合命令行参数传入一些变量参数,使项目更加灵活方便使用。
在本文中,我将列出构建Python命令行参数的四种常用方法。
它们是:
内置sys.argv模块内置argparse模块内置getopt模块第三方依赖库点击
目录
构建命令行参数最简单也是最常见的方法是使用内置的“sys.argv”模块。
它在一个有序列表中传递参数,因此在使用它时传递参数的顺序必须是固定的。
因此,该方法适用于参数少、场景固定的项目。
导入系统
if __name__==__main__:
#获取参数列表
#注意:sys.argv[0]代表第一个参数,即:脚本名“1_sys.argv.py”
#其他参数列表
args=sys.argv[1:]
#参数数量
args _ length=len(sys . argv)if sys . argv else 0
Print(排除正在运行的主文件参数,其他参数列表为: ,args)
Print(参数总数:,args_length)
#使用
# python3 1_sys.argv.py arg1 arg2
#排除运行主文件参数,其他参数列表为: [arg1,arg1]
#参数总数:3
注意,在脚本中“sys.argv”获得的参数列表中,第一个参数代表脚本主文件的名称。
1. sys.argv
内置的argparse模块可以方便地编写友好的命令行参数脚本,它可以自动生成帮助手册,当用户向程序传递无效参数时,可以抛出明确的错误信息。
公文
使用它来构建命令行参数包括3个步骤:
构建参数解析对象添加参数添加参数解析参数
1.构建命令行参数分析对象。
导入argparse
.
#构建命令行参数解析对象
parser=arg parse . argument parser(description=命令行参数)
.
2.添加命令行参数
需要注意的是- arg1用于指定参数名,-a1表示dest目标变量的值(缩写)。
.
#设置3个参数
# Parameter 1: arg1,整数,可选参数。
# Parameter 2: arg2,string,可选参数,包括默认值“xag”
# Parameter 3: arg3,字符串类型,必须传入的参数
Parser.add _ argument (-arg1 ,-a1 ,type=int,help= parameter 1,可选参数)
Parser.add _ argument (-arg2 ,-a2 ,type=str,help= parameter 2,可选参数,包括默认值,default=xag )
Parser.add _ argument (-arg3 ,-a3 ,type=str,help= parameter 3,required parameter ,required=True)
.
3.解析参数值。
.
#解析参数,获取所有命令行参数(名称空间),然后将它们转换成字典。
args=vars(parser.parse_args())
#获取所有参数
打印(“所有命令行参数都是:”)
对于args:中的键
Print(f 命令行参数名:{key},参数值:{args[key]} )
.
使用时,我们可以通过“-h/-help”命令参数查看帮助文档。
#检查命令行参数的帮助文档
python3 2_argparse.py -帮助
#或者
python3 2_
argparse.py -h
上面添加的 3 个参数,参数 arg1、arg2 非必须传值,arg3 必须传值,另外参数 arg2 指定了默认值
# 参数arg3必须,参数arg1和参数arg2非必须,其中参数arg2设置了默认值# 传入参数arg3
# python3 2_argparse.py --arg3 123
# python3 2_argparse.py -a3 123
xingag@xingagdeMacBook-Pro args % python3 2_argparse.py -a3 123
所有命令行参数为:
命令行参数名:arg1,参数值:None
命令行参数名:arg2,参数值:xag
命令行参数名:arg3,参数值:123
# 传入参数arg1、arg3
xingag@xingagdeMacBook-Pro args % python3 2_argparse.py -a1 111 -a3 123
所有命令行参数为:
命令行参数名:arg1,参数值:111
命令行参数名:arg2,参数值:xag
命令行参数名:arg3,参数值:123
# 传入参数arg1、arg2、arg3
xingag@xingagdeMacBook-Pro args % python3 2_argparse.py -a1 111 -a2 222 -a3 123
所有命令行参数为:
命令行参数名:arg1,参数值:111
命令行参数名:arg2,参数值:222
命令行参数名:arg3,参数值:123
3. getopt
getopt 是 Python 中一个内置标准模块,可以结合 sys.argv 模块,直接解析脚本运行时参数
使用格式:getopt(args,shortopts,longopts = [])
其中
args
参数列表,可以通过 sys.argv 获取,可以参考上面
shortopts 短参数组成的字符串
定义短参数,如果参数有值,需要在短参数后追加一个「 : 」符号
传参使用方式:-n 23
longopts 长参数列表
定义长参数列表时,如果某个参数有值,需要在短参数后追加一个「 = 」符号
传参使用方式:–port 8080
这里以传入数据库连接参数为例(参数包含 ip、用户名、密码、数据库名称)进行讲解
from getopt import getoptimport sys
# 获取参数
# sys.argv[1:]:获取除脚本文件名外的所有命令行参数
# opts:存有所有选项及其输入值的元组列表
# args:去除有用的输入以后剩余的部分
opts, args = getopt(sys.argv[1:], i:u:p:d:, [ip=, user=, pwd=, db=])
# 获取参数值
# 短参数
# python3 4_getopt.py -i 127.0.0.1 -u root -p 123456 -d mysqldb
# 长参数
# python3 4_getopt.py --ip 127.0.0.1 -u root -p 123456 -d mysqldb
ip_pre = [item[1] for item in opts if item[0] in (-i, --ip)]
ip = ip_pre[0] if len(ip_pre) > 0 else None
print("参数ip:", ip)
user_pre = [item[1] for item in opts if item[0] in (-u, --user)]
user = user_pre[0] if len(user_pre) > 0 else None
print("参数user:", user)
pwd_pre = [item[1] for item in opts if item[0] in (-p, --pwd)]
pwd = pwd_pre[0] if len(pwd_pre) > 0 else None
print("参数pwd:", pwd)
db_pre = [item[1] for item in opts if item[0] in (-d, --db)]
db = db_pre[0] if len(db_pre) > 0 else None
print("参数db:", db)
在运行脚本时,我们可以利用「 短参数 」或「 长参数 」形式进行传递
# 测试# 短参数
python3 4_getopt.py -i 127.0.0.1 -u root -p 123456 -d mysqldb
# 长参数
python3 4_getopt.py --ip 127.0.0.1 --user root --pwd 123456 --db mysqldb
4. click
click 作为第三方依赖库,它为命令行工具封装了大量的方法,可以非常方便实现命令行参数
项目地址
首先,我们需要安装依赖库 click
import click# 安装依赖
# pip3 install -U click
@click.command()
@click.option(--arg1, default=111, help=参数arg1,默认值为「111」)
@click.option(--arg2, type=int, help=参数arg2)
@click.option(--arg3, type=str, help=参数arg3)
def start(arg1, arg2, arg3):
"""
基于参数arg1、参数arg2、参数arg3运行项目
:param arg1:
:param arg2:
:param arg3:
:return:
"""
print("参数arg1值为:", arg1)
print("参数arg2值为:", arg2)
print("参数arg3值为:", arg3)
if __name__ == __main__:
start()
然后,在主运行函数上通过装饰器配置参数即可
比如,上面就定义了 3 个命令行参数 arg1、arg2、arg3,并设置了参数的类型及默认值
最后,在运行脚本时只需要按参数设定传递对应的值即可
# 不包含参数xingag@xingagdeMacBook-Pro args % python3 3_click.py
参数arg1值为: 111
参数arg2值为: None
参数arg3值为: None
# 包含参数arg1
xingag@xingagdeMacBook-Pro args % python3 3_click.py --arg1 test1
参数arg1值为: test1
参数arg2值为: None
参数arg3值为: None
# 包含参数arg1、arg2
# 注意:arg2的参数类型为整形,传入的参数必须能转为整形,否则会报错
xingag@xingagdeMacBook-Pro args % python3 3_click.py --arg1 test1 --arg2 222
参数arg1值为: test1
参数arg2值为: 222
参数arg3值为: None
# 包含参数arg1、arg2、arg3
xingag@xingagdeMacBook-Pro args % python3 3_click.py --arg1 test1 --arg2 222 --arg3 test3
参数arg1值为: test1
参数arg2值为: 222
参数arg3值为: test3
最后
上面通过实例讲解了实现 Python 命令行参数常见的 4 种方式
对于一些简单自用且不那么正规的场景,个人觉得可以考虑用 sys.argv 模块快速构建命令行参数;而对一些参数多、面向用户的正式生产环境,建议利用 argparse 模块或 click 依赖来创建命令行参数
到此这篇关于Python命令行参数化的四种方式详解的文章就介绍到这了,更多相关Python命令行参数化内容请搜索盛行IT软件开发工作室以前的文章或继续浏览下面的相关文章希望大家以后多多支持盛行IT软件开发工作室!
郑重声明:本文由网友发布,不代表盛行IT的观点,版权归原作者所有,仅为传播更多信息之目的,如有侵权请联系,我们将第一时间修改或删除,多谢。