python学习之argparse模块的使用

本是古典何须时尚 2022-03-17 02:26 206阅读 0赞

# 原文：[https://www.cnblogs.com/lindaxin/p/7975697.html][https_www.cnblogs.com_lindaxin_p_7975697.html] #

# argparse 使用 #

## 简单示例 ##

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

*  创建 ArgumentParser() 对象
 *  调用 add\_argument() 方法添加参数
 *  使用 parse\_args() 解析添加的参数

示例：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code># -*- coding: utf-8 -*-</code> &nbsp; <code>import argparse</code> &nbsp; <code>parser = argparse.ArgumentParser()</code> <code>parser.add_argument(</code><code>'integer'</code><code>, type=</code><code>int</code><code>, help=</code><code>'display an integer'</code><code>)</code> <code>args = parser.parse_args()</code> &nbsp; <code>print(args.integer)</code> </td> 
 </tr> 
 </tbody> 
</table>

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 </td> 
 <td> <code>$ python argparse_usage.py</code> <code>usage: argparse_usage.py [-h] integer</code> <code>argparse_usage.py: error: too few arguments</code> &nbsp; <code>$ python argparse_usage.py abcd</code> <code>usage: argparse_usage.py [-h] integer</code> <code>argparse_usage.py: error: argument integer: invalid </code><code>int</code> <code>value: </code><code>'abcd'</code> &nbsp; <code>$ python argparse_usage.py -h</code> <code>usage: argparse_usage.py [-h] integer</code> &nbsp; <code>positional arguments:</code> <code>&nbsp;&nbsp;</code><code>integer&nbsp;&nbsp;&nbsp;&nbsp; display an integer</code> &nbsp; <code>optional arguments:</code> <code>&nbsp;&nbsp;</code><code>-h, --help&nbsp; show </code><code>this</code> <code>help message and exit</code> &nbsp; <code>$ python argparse_usage.py 10</code> <code>10</code> </td> 
 </tr> 
 </tbody> 
</table>

## 定位参数 ##

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code># -*- coding: utf-8 -*-</code> &nbsp; <code>import argparse</code> &nbsp; <code>parser = argparse.ArgumentParser()</code> <code>parser.add_argument(</code><code>"square"</code><code>, help=</code><code>"display a square of a given number"</code><code>, type=</code><code>int</code><code>)</code> <code>args = parser.parse_args()</code> <code>print(rgs.square**2)</code> </td> 
 </tr> 
 </tbody> 
</table>

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>$ python argparse_usage.py 9</code> <code>81</code> </td> 
 </tr> 
 </tbody> 
</table>

## 可选参数 ##

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> <code># -*- coding: utf-8 -*-</code> &nbsp; <code>import argparse</code> &nbsp; <code>parser = argparse.ArgumentParser()</code> &nbsp; <code>parser.add_argument(</code><code>"--square"</code><code>, help=</code><code>"display a square of a given number"</code><code>, type=</code><code>int</code><code>)</code> <code>parser.add_argument(</code><code>"--cubic"</code><code>, help=</code><code>"display a cubic of a given number"</code><code>, type=</code><code>int</code><code>)</code> &nbsp; <code>args = parser.parse_args()</code> &nbsp; <code>if</code> <code>args.square:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print(args.square**2)</code> &nbsp; <code>if</code> <code>args.cubic:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print(args.cubic**3)</code> </td> 
 </tr> 
 </tbody> 
</table>

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 </td> 
 <td> <code>$ python argparse_usage.py --h</code> <code>usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]</code> &nbsp; <code>optional arguments:</code> <code>&nbsp;&nbsp;</code><code>-h, --help&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; show </code><code>this</code> <code>help message and exit</code> <code>&nbsp;&nbsp;</code><code>--square SQUARE&nbsp; display a square of a given number</code> <code>&nbsp;&nbsp;</code><code>--cubic CUBIC&nbsp;&nbsp;&nbsp; display a cubic of a given number</code> &nbsp; <code>$ python argparse_usage.py --square 8</code> <code>64</code> &nbsp; <code>$ python argparse_usage.py --cubic 8</code> <code>512</code> &nbsp; <code>$ python argparse_usage.py 8</code> <code>usage: argparse_usage.py [-h] [--square SQUARE] [--cubic CUBIC]</code> <code>argparse_usage.py: error: unrecognized arguments: 8</code> &nbsp; <code>$ python argparse_usage.py&nbsp; # 没有输出</code> </td> 
 </tr> 
 </tbody> 
</table>

## 混合使用 ##

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 </td> 
 <td> <code>import argparse</code> &nbsp; <code>parser = argparse.ArgumentParser(description=</code><code>'Process some integers.'</code><code>)</code> <code>parser.add_argument(</code><code>'integers'</code><code>, metavar=</code><code>'N'</code><code>, type=</code><code>int</code><code>, nargs=</code><code>'+'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>help=</code><code>'an integer for the accumulator'</code><code>)</code> <code>parser.add_argument(</code><code>'--sum'</code><code>, dest=</code><code>'accumulate'</code><code>, action=</code><code>'store_const'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>const</code><code>=sum, </code><code>default</code><code>=max,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>help=</code><code>'sum the integers (default: find the max)'</code><code>)</code> &nbsp; <code>args = parser.parse_args()</code> <code>print(args.accumulate(args.integers))</code> </td> 
 </tr> 
 </tbody> 
</table>

结果：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>$ python argparse_usage.py</code> <code>usage: argparse_usage.py [-h] [--sum] N [N ...]</code> <code>argparse_usage.py: error: too few arguments</code> <code>$ python argparse_usage.py 1 2 3 4</code> <code>4</code> <code>$ python argparse_usage.py 1 2 3 4 --sum</code> <code>10</code> </td> 
 </tr> 
 </tbody> 
</table>

## add\_argument() 方法 ##

add\_argument() 方法定义如何解析命令行参数：``

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>ArgumentParser.add_argument(name or flags...[, action][, nargs][, </code><code>const</code><code>][, </code><code>default</code><code>][, type][, choices][, required][, help][, metavar][, dest])</code> </td> 
 </tr> 
 </tbody> 
</table>

每个参数解释如下:

*  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_lindaxin_p_7975697.html]: https://www.cnblogs.com/lindaxin/p/7975697.html