Python的argparse模块的使用

Python的argparse模块的使用

最近看到一份Pytorch代码有以下内容：

# Training settings
    parser = argparse.ArgumentParser(description='PyTorch MNIST Example')
    parser.add_argument('--batch-size', type=int, default=64, metavar='N',
                        help='input batch size for training (default: 64)')
    parser.add_argument('--test-batch-size', type=int, default=1000, metavar='N',
                        help='input batch size for testing (default: 1000)')
    parser.add_argument('--epochs', type=int, default=14, metavar='N',
                        help='number of epochs to train (default: 14)')
    parser.add_argument('--lr', type=float, default=1.0, metavar='LR',
                        help='learning rate (default: 1.0)')
    parser.add_argument('--gamma', type=float, default=0.7, metavar='M',
                        help='Learning rate step gamma (default: 0.7)')
    parser.add_argument('--no-cuda', action='store_true', default=False,
                        help='disables CUDA training')
    parser.add_argument('--seed', type=int, default=1, metavar='S',
                        help='random seed (default: 1)')
    parser.add_argument('--log-interval', type=int, default=10, metavar='N',
                        help='how many batches to wait before logging training status')

    parser.add_argument('--save-model', action='store_true', default=False,
                        help='For Saving the current Model')
    args = parser.parse_args()
    use_cuda = not args.no_cuda and torch.cuda.is_available()

    torch.manual_seed(args.seed)

    device = torch.device("cuda" if use_cuda else "cpu")

上网查了一下，这个argparse是是Python标准库中推荐使用的编写命令行程序的工具，是一个用来解析命令行程序的参数的模块。其实就是我们编写在linux中常见的命令行程序中带的参数的处理程序。这些参数理论上可以分为定位参数(positional arguments)和可选参数(optional argument),但其实这两种在定义上没有任何区别，这里摘取博客https://www.cnblogs.com/lindaxin/p/7975697.html中的例子来说明：

一个定位参数的例子：

# -*- 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)

一个可选参数的例子：

# -*- 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()
 
if args.square:
    print(args.square**2)

其实你看，定义的过程都是一样的。只是说，如果

1）参数设置了默认值

2）参数没有设置默认值，但是像上面可选参数的例子一样，只有判断了该参数存在的时候才调用

就算是可选参数了。像那种不赋值程序不能正常运行的就是定位参数。

但是约定俗成的是，定位参数就直接写参数名，而可选参数要写成类似“--help”(两个短横线+全单词）或者“-h"（一个短横线+首字母）的形式，这两个能不能写在一条我还没有试。

每一个程序使用argparse之后都会默认有两个可选参数:-h和--help。用它可以看所有的定位和可选参数的描述，这也和linux用的一样。注意如果输入的参数是--help,是不会执行原程序的内容的。

参数解释

type:输入值的类型

help:该参数的描述，用在--help中

metavar:在--help中的参数名称

default:默认值

这些是常用的，完整的看这里（来源：https://www.cnblogs.com/lindaxin/p/7975697.html）

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 - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

运行

在命令行中cd到py文件所在的位置，然后输入python xxx.py，后面加要输入的参数，不知道需要哪些的时候可以--help