Python命令行解析工具argparse模块

 更新时间:2023年05月18日 09:46:27   作者:FLy_鹏程万里  
这篇文章主要介绍了Python命令行解析工具argparse模块,argparse模块是一个python标准库,它主要用于对用户从客户端输入的命令进行解析,这使得编写用户友好的命令行接口变得非常容易,需要的朋友可以参考下

argparse模块简介

argparse模块是一个python标准库,它主要用于对用户从客户端输入的命令进行解析,这使得编写用户友好的命令行接口变得非常容易。

程序只需要定义好用户可以从终端可以输入哪些参数,以及参数对应的含义、数据类型即可,然后argparse将负责从sys.argv中解析出这些参数。argparse模块还会自动生成帮助信息和使用信息并且当用户赋给程序非法的参数的时候会出现友好的错误提示信息。

使用方法

(1)导入argparse模块

(2)创建一个解析器对象

(3)使用对象内置的add_argument()方法添加需要关注的命令参数和选项

(4)之后调用parse_args()方法解析命令即可

示例:

import argparse                     #导入argparse该模块;
parser = argparse.ArgumentParser()  #创建一个解析器对象
parser.add_argument()               #添加令行参数和选项,每一个add_argument方法对应一个参数或选项;
args=parser.parse_args()            #调用parse_args()方法进行解析,解析成功之后即可使用    

ArgumentParser对象介绍

class argparse.ArgumentParser(
                prog=None, 
                usage=None, 
                description=None, 
                epilog=None, 
                parents=[], 
                formatter_class=argparse.
                HelpFormatter, 
                prefix_chars='-',
                fromfile_prefix_chars=None, 
                argument_default=None, 
                conflict_handler='error', 
                add_help=True)

参数说明:

参数描述
prog程序的名字(默认:sys.argv[0])
usage描述程序用法的字符串(默认:从解析器的参数生成)
description参数帮助信息之前的文本(默认:空)
epilog参数帮助信息之后的文本(默认:空)
parentsArgumentParser 对象的一个列表,这些对象的参数应该包括进去
formatter_class定制化帮助信息的类
prefix_chars可选参数的前缀字符集(默认:‘-‘)
fromfile_prefix_chars额外的参数应该读取的文件的前缀字符集(默
argument_default参数的全局默认值(默认:None)
conflict_handler解决冲突的可选参数的策略(通常没有必要)
add_help给解析器添加-h/–help 选项(默认:True)

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在命令行遇到该参数时采取的基本动作类型。
nargs应该读取的命令行参数数目。
const某些action和nargs选项要求的常数值。
default如果命令行中没有出现该参数时的默认值。
type命令行参数应该被转换成的类型。
choices参数可允许的值的一个容器。
required - 该命令行选项是否可以省略(只针对可选参数)。
help参数的简短描述。
metavar参数在帮助信息中的名字。
dest给parse_args()返回的对象要添加的属性名称。

其中“type”、“help”、“action”、“default”、“name ”、“dest”使用最为频繁

实战演示

(1)可选参数

代码如下:

import argparse
parser=argparse.ArgumentParser()
parser.add_argument("-display",help="display the message!")
args=parser.parse_args()
if args.display:
    print "Display is trun on!"

运行结果:

注:可选参数可以在add_argment("这里如果加上“-”,则说明是可选的,否则是必须的")定义

(2)短选项

有时候写一个匹配项的时候还需要写全拼,实在是有些麻烦,在Linux中大多数的交互命令都有简写,那么我们也可以来进行设置短选项

代码如下:

import argparse
parser=argparse.ArgumentParser()
parser.add_argument("-d","--display",help="display the message!",action="store_true")
args=parser.parse_args()
if args.display:
    print "Display is trun on!"

(3)结合位置参数与可选参数

代码如下:

import argparse  
parser = argparse.ArgumentParser()  
parser.add_argument("square", type=int,  
                    help="display a square of a given number")  
parser.add_argument("-v", "--verbose", action="store_true",  
                    help="increase output verbosity")  
args = parser.parse_args()  
answer = args.square**2  
if args.verbose:  
    print "the square of {} equals {}".format(args.square, answer)  
else:  
    print answer  

运行结果如下:

到此这篇关于Python命令行解析工具argparse模块的文章就介绍到这了,更多相关Python的argparse模块内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • ubuntu迁移anaconda到另外的目录(完美解决)

    ubuntu迁移anaconda到另外的目录(完美解决)

    本文主要介绍了ubuntu迁移anaconda到另外的目录,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-07-07
  • 解决springboot yml配置 logging.level 报错问题

    解决springboot yml配置 logging.level 报错问题

    今天小编就为大家分享一篇解决springboot yml配置 logging.level 报错问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-02-02
  • Python爬取数据并实现可视化代码解析

    Python爬取数据并实现可视化代码解析

    这篇文章主要介绍了Python爬取数据并实现可视化代码解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08
  • 如何使用Python JSON解析和转换数据

    如何使用Python JSON解析和转换数据

    JSON 是文本,使用 JavaScript 对象表示法编写,Python 有一个内置的 json 包,可用于处理 JSON 数据,本文给大家介绍使用Python JSON解析和转换数据的方法,感兴趣的朋友跟随小编一起看看吧
    2023-11-11
  • python字符串切割:str.split()与re.split()的对比分析

    python字符串切割:str.split()与re.split()的对比分析

    今天小编就为大家分享一篇python字符串切割:str.split()与re.split()的对比分析,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-07-07
  • 在Python中通过getattr获取对象引用的方法

    在Python中通过getattr获取对象引用的方法

    今天小编就为大家分享一篇在Python中通过getattr获取对象引用的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-01-01
  • Python自定义一个异常类的方法

    Python自定义一个异常类的方法

    在本篇文章里小编给大家分享了关于Python自定义一个异常类的详细步骤和实例代码,有兴趣的朋友们参考学习下。
    2019-06-06
  • Python+opencv+pyaudio实现带声音屏幕录制

    Python+opencv+pyaudio实现带声音屏幕录制

    今天小编就为大家分享一篇Python+opencv+pyaudio实现带声音屏幕录制,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-12-12
  • python Django模板的使用方法

    python Django模板的使用方法

    这篇文章主要为大家介绍了python Django模板的使用方法,代码很详细,感兴趣的小伙伴们可以参考一下
    2016-01-01
  • python使用str & repr转换字符串

    python使用str & repr转换字符串

    str() 是将 数值 转成字符串 repr() 是将一个对象 转成字符串 显示 看明白了么:str()是将一个对象转化成str对象 repr()是将一个对象可视化,使用字符串输出,使编程人员看到其的内部结构
    2016-10-10

最新评论