python 命令行参数——argparse模块的使用

以下内容主要来自:http://wiki.jikexueyuan.com/project/explore-python/Standard-Modules/argparse.html

argparse 使用

简单示例

我们先来看一个简单示例。主要有三个步骤:

  • 创建 ArgumentParser() 对象
  • 调用 add_argument() 方法添加参数
  • 使用 parse_args() 解析添加的参数

示例:

# -*- coding: utf-8 -*-

import argparse

parser = argparse.ArgumentParser()
parser.add_argument(‘integer‘, type=int, help=‘display an integer‘)
args = parser.parse_args()

print(args.integer)

将上面的代码保存为文件 argparse_usage.py,在终端运行,结果如下:

$ python argparse_usage.py
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: too few arguments

$ python argparse_usage.py abcd
usage: argparse_usage.py [-h] integer
argparse_usage.py: error: argument integer: invalid int value: ‘abcd‘

$ python argparse_usage.py -h
usage: argparse_usage.py [-h] integer

positional arguments:
  integer     display an integer

optional arguments:
  -h, --help  show this help message and exit

$ python argparse_usage.py 10
10

定位参数

上面的示例,其实就展示了定位参数的使用,我们再来看一个例子 - 计算一个数的平方:

# -*- coding: utf-8 -*-

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number", type=int)
args = parser.parse_args()
print(rgs.square**2)

将上面的代码保存为文件 argparse_usage.py,在终端运行,结果如下:

$ python argparse_usage.py 9
81

可选参数

现在看下可选参数的用法,所谓可选参数,也就是命令行参数是可选的,废话少说,看下面例子:

# -*- coding: utf-8 -*-

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("--square", help="display a square of a given number", type=int)
parser.add_argument("--cubic", help="display a cubic of a given number", type=int)

args = parser.parse_args()

if args.square:
    print(args.square**2)

if args.cubic:
    print(args.cubic**3)

将上面的代码保存为文件 argparse_usage.py,在终端运行,结果如下:

$ python argparse_usage.py --h
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]

optional arguments:
  -h, --help       show this help message and exit
  --square SQUARE  display a square of a given number
  --cubic CUBIC    display a cubic of a given number

$ python argparse_usage.py --square 8
64

$ python argparse_usage.py --cubic 8
512

$ python argparse_usage.py 8
usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]
argparse_usage.py: error: unrecognized arguments: 8

$ python argparse_usage.py  # 没有输出

混合使用

定位参数和选项参数可以混合使用,看下面一个例子,给一个整数序列,输出它们的和或最大值(默认):

import argparse

parser = argparse.ArgumentParser(description=‘Process some integers.‘)
parser.add_argument(‘integers‘, metavar=‘N‘, type=int, nargs=‘+‘,
                   help=‘an integer for the accumulator‘)
parser.add_argument(‘--sum‘, dest=‘accumulate‘, action=‘store_const‘,
                   const=sum, default=max,
                   help=‘sum the integers (default: find the max)‘)

args = parser.parse_args()
print(args.accumulate(args.integers))

结果:

$ python argparse_usage.py
usage: argparse_usage.py [-h] [--sum] N [N ...]
argparse_usage.py: error: too few arguments
$ python argparse_usage.py 1 2 3 4
4
$ python argparse_usage.py 1 2 3 4 --sum
10

add_argument() 方法

add_argument() 方法定义如何解析命令行参数:

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

每个参数解释如下:

    • name or flags - 选项字符串的名字或者列表,例如 foo 或者 -f, --foo。
    • action - 命令行遇到参数时的动作,默认值是 store。
      • store_const,表示赋值为const;
      • append,将遇到的值存储成列表,也就是如果参数重复则会保存多个值;
      • append_const,将参数规范中定义的一个值保存到一个列表;
      • count,存储遇到的次数;此外,也可以继承 argparse.Action 自定义参数解析;
    • nargs - 应该读取的命令行参数个数,可以是具体的数字,或者是?号,当不指定值时对于 Positional argument 使用 default,对于 Optional argument 使用 const;或者是 * 号,表示 0 或多个参数;或者是 + 号表示 1 或多个参数。
    • const - action 和 nargs 所需要的常量值。
    • default - 不指定参数时的默认值。
    • type - 命令行参数应该被转换成的类型。
    • choices - 参数可允许的值的一个容器。
    • required - 可选参数是否可以省略 (仅针对可选参数)。
    • help - 参数的帮助信息,当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
    • metavar - 在 usage 说明中的参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写的参数名称.
    • dest - 解析后的参数名称,默认情况下,对于可选参数选取最长的名称,中划线转换为下划线.

原文地址:https://www.cnblogs.com/chaofn/p/10215905.html

时间: 2024-11-02 21:59:27

python 命令行参数——argparse模块的使用的相关文章

python命令行参数处理模块 optparse 使用参考

from optparse import OptionParser parser = OptionParser() parser.add_option( '-f', '--file', dest='filename', help='write report to FILE', metavar='FILE' ) parser.add_option( '-q', '--quiet', action='store_false', dest='verbose', default=True, help='

Python 命令行工具 argparse 模块使用详解

先来介绍一把最基本的用法 import argparse parser = argparse.ArgumentParser() parser.parse_args() 在执行 parse_args() 之前,所有追加到命令行的参数都不会生效,生效了之后的默认情况类似于这样: Reference: https://www.jianshu.com/p/fef2d215b91d  python argparse用法总结 原文地址:https://www.cnblogs.com/piperck/p/84

Python命令行参数

Python命令行参数: -d 在解析时显示调试信息 -O 生成优化代码 ( .pyo 文件 ) -S 启动时不引入查找Python路径的位置 -v 输出Python版本号 -X 从 1.6版本之后基于内建的异常(仅仅用于字符串)已过时. -c cmd 执行 Python 脚本,并将运行结果作为 cmd 字符串. file 在给定的python文件执行python脚本.

Python命令行参数处理之argparse模块

介绍 平时我们想要了解一个命令的用法时,会使用『 --help 』或是『 --version 』参数,Python中也可以自定义命令行参数. 用法实例 先创建一个Python脚本test.py import argparse # 创建解析 parser = argparse.ArgumentParser(prog="This is a description.") # 添加位置参数(必须参数) parser.add_argument("name", type = s

python 命令行参数解析 argparse简单分析

在python 2.7 后,不推荐使用 optparse, 而推荐使用 argparse. 其它的不多说,简单的分析下我遇到的问题:我是想用 argparse 来解析不定长的命令行参数 例如: import argparse import sys parser = argparse.ArgumentParser(description='test parsing arguments') parser.add_argument('pos1', nargs='*') parser.add_argum

Python 命令行参数和getopt模块详解

1.需求来源 有时候我们需要写一些脚本处理一些任务,可能根据不同的条件输入不同的命令,来完成不同的任务.能不能做到跟linux操作系统一样,看着更高大上一点呢? 答案当然是可以的啦!getopt能满足你的需求 先看个linux 中的系统命令吧:最终目的就是写出类似的脚本. 2.getopt介绍 getopt这个函数 就是用来抽取 sys.argv 获得的用户输入来确定执行步骤. getopt是个模块,而这个模块里面又有getopt 函数,所以getopt需要这样这样用. getopt.getop

【Python 命令行参数解析: optparse 模块】

大家在使用Python进行脚本开发时,经常需要通过终端交互的方式对Python的脚本模块进行调用.这时在 Python模块中提供基础的命令行参数支持是必不可少的.那么,在Python中我们如何实现命令行参数的传入和解析呢,如下内容将对此进行简要的介绍. Python对命令行参数解析的支持 Python中通过两个内建模块对命令行参数解析进行支持:getopt 和 optparse 两种内置支持 模块名 功能说明 getopt 对命令行参数进行简单的处理 optparse 能够对命令行参数进行复杂的

python 命令行参数解析

本文是从我另一个博客转载过来的,欢迎大家点击进去看一下,帮我增加点人气^_^ ImPyy 选择模块 根据python参考手册的提示,optparse 已经废弃,应使用 argparse 教程 概念 argparse 模块使用 add_argument 来添加可选的命令行参数,原型如下: ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, r

python命令行解释器 argparse

一: argparse介绍 1.  argparse argparse,它是Python标准库中推荐使用的编写命令行程序的工具 parser = argparse.ArgumentParser()  创建一个实例,#parser.parse_args()    parse_args方法是从命令行的参数中返回了一些默认或指定的参数信息.#print dir(parser)parser.add_argument('square',help=' **2 ',type = int)  添加一个posit