Python 和 Bash 是很方便的便携命令行工具的语言。在实现命令行工具时，为了保障工具的灵活性，我们希望很多参数可以通过命令行来设置。这篇文章我们整理一下 Python 和 Bash 脚本编写过程中命令行参数的处理方法。

1 Shebang

首先离题一下，讨论一下Shebang的问题:

在计算机科学中，Shebang（也称为 Hashbang ）是一个由井号和叹号构成的字符序列 #! ，其出现在文本文件的第一行的前两个字符。 在文件中存在 Shebang 的情况下，类 Unix 操作系统的程序载入器会分析 Shebang 后的内容，将这些内容作为解释器指令，并调用该指令，并将载有 Shebang 的文件路径作为该解释器的参数。

简而言之，处于文件头的 Shebang 指定了运行脚本需要使用的程序，一般情况下，Shell 脚本我们会设置成

1
#!/bin/bash

而 Python 则要根据情况来指定了。你可以通过which命令来找到你要使用的python可执行程序的位置

1
2
$ which python
/usr/bin/python

然后将该路径以 Shebang 的格式加入脚本开头

1
#!/usr/bin/python

准确的设置 Shebang 是保证脚本正确运行的必要条件。除此之外记得给你的脚本添加可执行权限

1
chmod u+x you_script

2 命令行参数的处理

按照通行的做法，命令行参数有一下两种类型：

  • Positional Arguments: 放置在命令之后顺序排列的参数，如command param形式，这种参数一般都是必须的
  • Optional Arguments: 这种参数由两部分组成，分别是在前方加都短杠的提示符和紧跟其后的参数内容，形如command -r param。有时候参数内容可以为空。

2.1 Bash

Bash 中我们主要靠while和case的结合来处理 Optional Arguments，而 Positional Arguments 可以通过$n形式的参数获取。下面是处理 Optional Arguments 的模板

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
while [ $# -gt 0 ]
do
  key="$1"
  case $key in
    -h|--help)
    show_help_info # bash function
    shift
    exit
    ;;

    -p|--param)
    PARAM_VARIABLE="$2"
    shift
    shift
    ;;

    -f|--flag)
    FLAG_SET=y
    shift
    ;;

    *)
    # other situation
    exit
    # Or if there are positional params after optional params
    # break
    esac
done

2.2 Python

Python 中我们使用argparse这个官方库可以很方便的处理命令行参数

2.2.1 Setup

基本结构如下所示

1
2
3
4
5
6
7
8
9
10
import argparse

parser = argparse.ArgumentParser(description="Description of command")
# add argumetns, we will talk later
# ...

if __name__ == "__main__":
    args = parser.parse_args()
    # get arguments, we will talk abouth this later
    # ...

2.2.2 Positional Param

argparse中我们通过add_argument函数来添加脚本支持的命令行参数。其中添加 Positional Param 的方式如下：

1
parser.add_argument("param", type=str, help="description of param")

在获取该参数时直接访问parser.param即可

2.2.3 Optional Param

1
parser.add_argument("-p", "--param", action="store_true", helper="description of param")

上面这种方法是添加没有后续参数的 flag 的方法，在执行命令时，只需要添加-p就可以了。如果指定了-p，那么parser.param为True，否则为False。如果需要在 flag 后面进一步输入参数，可以按照如下方式添加参数

1
2
parser.add_argument("-p", "--param", dest="param_variable",
  default="some_value", type=str, help="description of param")

这时在 flag 后面的参数就会被绑定到parser.param_variable。

3 DRY - DONT REPEAT YOUSELF

最后简要说一下 DRY 原则。DRY 是在软件工程中一个很基本的原则：即一些重复性的工作，与其每次重复自己的操作，不如先花点精力实现对应的自动化工具，这样可以在将来大大节省自己的重复操作成本。Bash 和 Python 脚本是实现 DRY 原则的重要工具。所谓磨刀不误砍柴工，好好磨练自己的脚本技能还是非常有价值的。