构建 Python 命令行参数的 4 种常见方式

目录
  • 前言
  • 1. sys.argv
  • 2. argparse
  • 3. getopt
  • 4. click
  • 总结

前言

大家好,在日常编写 Python 脚本的过程中,我们经常需要结合命令行参数传入一些变量参数,使项目使用更加的灵活方便

它们分别是:

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

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

2. argparse

内置的 argparse 模块可以非常轻松地编写出友好的命令行参数脚本,并且它能自动生成帮助使用手册,在用户给程序传入无效参数时能抛出清晰的错误信息

官方文档:

使用它构建命令行参数包含 3 个步骤

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

构建命令行参数解析对象

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

添加命令行参数:

需要指出的是,--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)
...

解析出参数值:

...
# 解析参数,获取所有的命令行参数(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

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

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 命令行参数的 4 种常见方式的文章就介绍到这了,更多相关Python命令行参数内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • Python命令行参数化的四种方式详解

    目录 1. sys.argv 2. argparse 3. getopt 4. click 最后 大家好,在日常编写 Python 脚本的过程中,我们经常需要结合命令行参数传入一些变量参数,使项目使用更加的灵活方便 本篇文章我将罗列出构建 Python 命令行参数的 4 种常见方式 它们分别是: 内置 sys.argv 模块 内置 argparse 模块 内置 getopt 模块 第三方依赖库 click 1. sys.argv 构建命令行参数最简单.常见的方式是利用内置的「 sys.argv

  • 命令行运行Python脚本时传入参数的三种方式详解

    如果在运行python脚本时需要传入一些参数,例如gpus与batch_size,可以使用如下三种方式. python script.py 0,1,2 10 python script.py -gpus=0,1,2 --batch-size=10 python script.py -gpus=0,1,2 --batch_size=10 这三种格式对应不同的参数解析方式,分别为sys.argv, argparse, tf.app.run, 前两者是python自带的功能,最后一个是tensorfl

  • python获得命令行输入的参数的两种方式

    外部直接执行python文件时,我们有时需要获得命令行的参数 获得命令行参数的两种方式 1.通过sys.argv sys.argv:获得一个参数列表,第一个值为文件名本身,通过sys.argv[1]获得第文件名后的第一个参数 ,多个参数使用空格隔开 测试代码: import sys print(sys.argv) print(len(sys.argv)) print(len(sys.argv[1])) 测试数据: python3 test.py 第一个参数 第二个参数 执行结果: ['test.

  • 构建 Python 命令行参数的 4 种常见方式

    目录 前言 1. sys.argv 2. argparse 3. getopt 4. click 总结 前言 大家好,在日常编写 Python 脚本的过程中,我们经常需要结合命令行参数传入一些变量参数,使项目使用更加的灵活方便 它们分别是: 内置 sys.argv 模块 内置 argparse 模块 内置 getopt 模块 第三方依赖库 click 1. sys.argv 构建命令行参数最简单.常见的方式是利用内置的「 sys.argv 」模块 它是将参数以一个有序的列表传入,所以在使用时传参

  • python解析命令行参数的三种方法详解

    这篇文章主要介绍了python解析命令行参数的三种方法详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 python解析命令行参数主要有三种方法:sys.argv.argparse解析.getopt解析 方法一:sys.argv -- 命令行执行:python test_命令行传参.py 1,2,3 1000 # test_命令行传参.py import sys def para_input(): print(len(sys.argv)) #

  • Python命令行参数argv和argparse该如何使用

    概述 运行python脚本时通过命令行方式传入运行参数通常有以下两种自建方式: sys.argv - 简洁 argparse - 丰富,可自定义 下面详细说一下具体时使用 argv # test_argv.py import sys args = sys.argv print(f'args = {args}') >>> output ➜ git:(master) python3 test_argv.py args = ['test_argv.py'] ➜ git:(master) ✗ p

  • python命令行参数argparse模块基本用法详解

    目录 一.传入一个参数 二.传入多个参数 三.改变数据类型 四.可选参数(关键字参数) 五.参数默认值 六.参数解析 补充:python中的argparse基本用法 argparse 是python自带的命令行参数解析包,可以用来方便地读取命令行参数. 一.传入一个参数 import argparse # 创建一个命令行参数解析器 parser = argparse.ArgumentParser(description='命令行中传入一个数字') # 往解析器里面添加参数 parser.add_

  • python命令行参数解析OptionParser类用法实例

    本文实例讲述了python命令行参数解析OptionParser类的用法,分享给大家供大家参考. 具体代码如下: from optparse import OptionParser parser = OptionParser(usage="usage:%prog [optinos] filepath") parser.add_option("-t", "--timeout", action = "store", type =

  • python命令行参数用法实例分析

    本文实例讲述了python命令行参数用法.分享给大家供大家参考,具体如下: 在命令行下执行某些命令的时候,通常会在一个命令后面带上一些参数,这些参数会传递到程序里,进行处理,然后返回结果,在linux 下很多命令其实也是用python来实现的.那么如果做到在命令行输入类似如下的命令并能得到正确的解析呢,比如 python commandline.py -l c:/temp -f c:/aaa.txt 这样的命令,并在程序中进行处理.下面详细介绍处理办法. python为我们提供了一个模块叫opt

  • 浅谈Python 命令行参数argparse写入图片路径操作

    什么是命令行参数? 命令行参数是在运行时给予程序/脚本的标志.它们包含我们程序的附加信息,以便它可以执行. 并非所有程序都有命令行参数,因为并非所有程序都需要它们. 为什么我们使用命令行参数? 如上所述,命令行参数在运行时为程序提供附加信息. 这允许我们在不改变代码的情况下动态地为我们的程序提供不同的输入 . 您可以绘制命令行参数类似于函数参数的类比.如果你知道如何在各种编程语言中声明和调用函数,那么当你发现如何使用命令行参数时,你会立刻感到宾至如归. 鉴于这是计算机视觉和图像处理博客,您在这里

  • Python命令行参数定义及需要注意的地方

    在命令行中运行python代码是很常见的,下面介绍如何定义命令后面跟的参数. 1  常规用法 Python代码中主要使用下面几行代码来定义并获取需要在命令行中赋值的参数: import argparse parser = argparse.ArgumentParser("Description.") # ----1---- parser.add_argument('--test1', type=str, default="1", help="Test1 h

  • Python命令行参数解析包argparse的使用详解

    目录 一.argparse简介 二.简单案例 三.ArgumentParser参数 四.add_argument指令参数解释 五.vars() 一.argparse简介 argparse 是 python 自带的命令行参数解析包,可以用来方便的服务命令行参数,使用之前需要先导入包 import argparse 二.简单案例 简单使用,创建一个名为test.py的文件 # 导入 argparse 模块 import argparse # 创建一个argparse 的对象 parser = arg

随机推荐