关于python:最全总结-聊聊-Python-命令行参数化的几种方式

1. 前言

在日常编写 Python 脚本的过程中，咱们常常须要联合命令行参数传入一些变量参数，使我的项目应用更加的灵便不便

本篇文章我将列举出构建 Python 命令行参数的 4 种常见形式

它们别离是：

• 内置 sys.argv 模块
• 内置 argparse 模块
• 内置 getopt 模块
• 第三方依赖库 click

2. sys.argv

构建命令行参数最简略、常见的形式是利用内置的「sys.argv」模块

它是将参数以一个有序的列表传入，所以在应用时传参程序必须固定

因而，这种形式实用于参数个数少且场景固定的我的项目中

import sys

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」获取的参数列表中，第一个参数代表脚本主文件名称

3. argparse

内置的 argparse 模块能够十分轻松地编写出敌对的命令行参数脚本，并且它能主动生成帮忙使用手册，在用户给程序传入有效参数时能抛出清晰的错误信息

应用它构建命令行参数蕴含 3 个步骤：

 构建参数解析对象增加参数

增加参数

解析参数 

3-1  构建命令行参数解析对象 

import argparse

...
# 构建一个命令行参数解析对象
parser = argparse.ArgumentParser(description='命令行参数')
...

3-2  增加命令行参数 

 须要指出的是，--arg1 用于指定参数名称，-a1 代表 dest 指标变量值（简写）

...
# 设置 3 个参数
# 参数 1：arg1，整型，非必须传入参数
# 参数 2：arg2，字符串，非必须传入参数，蕴含默认值「xag」# 参数 3：arg3，字符串类型，必须传入的参数
parser.add_argument('--arg1', '-a1', type=int, help='参数 1，非必须参数')
parser.add_argument('--arg2', '-a2', type=str, help='参数 2，非必须参数, 蕴含默认值', default='xag')
parser.add_argument('--arg3', '-a3', type=str, help='参数 3，必须参数', required=True)
...

3-3  解析出参数值 

...
# 解析参数, 获取所有的命令行参数（Namespace），而后转为字典
args = vars(parser.parse_args())

# 获取所有参数
print("所有命令行参数为:")
for key in args:
    print(f"命令行参数名:{key}，参数值:{args[key]}")
...

 应用的时候，咱们就能够通过「-h / --help」命令参数查看帮忙文档 

# 查看命令行参数帮忙文档
python3 2_argparse.py --help
# 或
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

4. getopt

getopt 是 Python 中一个内置规范模块，能够联合 sys.argv 模块，间接解析脚本运行时参数

应用格局：getopt(args,shortopts,longopts = [])

其中

• args

  参数列表，能够通过 sys.argv 获取，能够参考下面

• shortopts 短参数组成的字符串

  定义短参数，如果参数有值，须要在短参数后追加一个「:」符号

  传参应用形式：-n 23

• longopts 长参数列表

  定义长参数列表时，如果某个参数有值，须要在短参数后追加一个「=」符号

  传参应用形式：–port 8080

这里以传入数据库连贯参数为例（参数蕴含 ip、用户名、明码、数据库名称）进行解说

from getopt import getopt
import 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

5. 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

6. 最初

下面通过实例解说了实现 Python 命令行参数常见的 4 种形式

对于一些简略自用且不那么正规的场景，集体感觉能够思考用 sys.argv 模块疾速构建命令行参数；而对一些参数多、面向用户的正式生产环境，倡议利用 argparse 模块或 click 依赖来创立命令行参数

以上就是本次分享的所有内容，如果你感觉文章还不错，欢送关注公众号：Python 编程学习圈 ，每日干货分享，发送“J”还可支付大量学习材料，内容笼罩 Python 电子书、教程、数据库编程、Django，爬虫，云计算等等。或是返回编程学习网，理解更多编程技术常识。