Python 命令行传参

说到 python 命令行传参，可能大部分人的第一反应就是用 argparse。的确，argparse 在我们需要指定多个预设的参数（如深度学习中指定模型的超参数等）时，是非常有用的。但是如果有时我们只需要一个参数，那么再解析一整套 argparse 稍显笨重。本文除了介绍 argparse 之外，也会介绍一些简单轻便的命令行传参方法。

sys

我们在学习 C/C++ 时知道主函数 main 需要传入三个参数：

int main(int argc, char* argv[], char* env[]) {}

其中第三个参数是环境变量，大部分时候我们不写在程序里，即一般有：

int main(int argc, char* argv[]) {}

关于这几个参数包括环境变量参数更深入的解释可参考：Linux中 C++ main函数参数argc和argv含义及用法、12 [虚拟化] 进程抽象；fork，execve，exit

简单来说，这里的 argc 和 argv 分别是传入参数的个数，和传入的参数列表。这里传入的参数，就是可以在命令行中传递的。

在 python 中，我们当然同样可以用这种方式来传递命令行参数，这里我们需要借助内置的 sys 库。

直接上代码：

import sys

print(f'参数个数：{len(sys.argv)}')
print(f'参数列表：{str(sys.argv)}')

然后我们在命令行运行，并传入几个参数：

python test.py arg1 arg2

输出为：

参数个数：3
参数列表：['test.py', 'arg1', 'arg2']

注意这里没有所谓的 sys.argc，而是通过取参数列表的长度来获得参数的个数 len(sys.argv)。

这种方式获取几个命令行参数有时是非常方便的。比如有时我们写了一个脚本，要将目标检测数据集中某一张图像的检测框画出来查看，但是想要每次查看不同的图像。就可以通过这种方式在运行脚本时通过命令行传参。

# draw_box.py
import sys

def draw_box(image_name):
  # ...
  pass

if __name__ == "__main__":
  draw_box(sys.argv[1])

这样在运行时直接在命令行中：

python draw_box.py 12345.jpg

getopt 模块

getopt模块是专门处理命令行参数的模块，用于获取命令行选项和参数，也就是sys.argv。命令行选项使得程序的参数更加灵活。支持短选项模式 - 和长选项模式 –。

该模块提供了两个方法及一个异常处理来解析命令行参数。

getopt.getopt 方法

getopt.getopt 方法用于解析命令行参数列表，语法格式如下：

getopt.getopt(args, options[, long_options])

方法参数说明：

• args: 要解析的命令行参数列表。
• options : 以字符串的格式定义，options 后的冒号 : 表示如果设置该选项，必须有附加的参数，否则就不附加参数。
• long_options : 以列表的格式定义，long_options 后的等号 = 表示该选项必须有附加的参数，不带等号表示该选项不附加参数。
• 该方法返回值由两个元素组成: 第一个是 (option, value) 元组的列表。 第二个是参数列表，包含那些没有 - 或 – 的参数。

另外一个方法是 getopt.gnu_getopt，这里不多做介绍。

Exception getopt.GetoptError

在没有找到参数列表，或选项的需要的参数为空时会触发该异常。

异常的参数是一个字符串，表示错误的原因。属性 msg 和 opt 为相关选项的错误信息。

argparse

最后是大家最熟悉的 argparse，由于它功能强大且复杂，这里就介绍几个最常用的方式。

# test_argparse.py
import argparse

parser.add_argument('--representation_size', type=int, default=768)
parser.add_argument('--batchSize', type=int, default=32, help='batch size')
parser.add_argument('--epochs', type=int, default=100, help='epochs')
parser.add_argument('--num_workers', type=int, default=20, help='num workers')
parser.add_argument('--tbx', default='debug', help='the name of dir to store data for tensorboard')
parser.add_argument('--gpu_id', default='0', help='gpu id')
parser.add_argument('--load_path', type=str, default='')
parser.add_argument('--lr', type=float, default=5e-3, help='learning rate')
parser.add_argument('--lr_decay', type=float, default=1., help='gamma of learning rate decay')
parser.add_argument('--p', type=float, default=0.75, help='p of drop out')

parser.add_argument('--freeze-features', action="store_true")


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

在导入 argparse 之后分以下几步：

1. 先建立一个 parser 对象
2. 然后通过 add_argument 加入所需要的参数
3. 最后通过调用 parser 对象的 parse_args 方法来将参数解析，并赋值给 args

之后就可使用添加的参数（如 args.integer）了。

在命令行传参时需：

python test_argparse.py --batchSize 64 --num_workers 12 --freeze-features

若未传参，则按照设置的 default 赋值。

Ref：

https://www.runoob.com/python/python-command-line-arguments.html

https://docs.python.org/zh-cn/3/library/argparse.html