Python以及Bash处理命令行参数的模板

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

Shebang

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

在计算机科学中,Shebang(也称为 Hashbang )是一个由井号和叹号构成的字符序列 #! ,其出现在文本文件的第一行的前两个字符。 在文件中存在 Shebang 的情况下,类 Unix 操作系统的程序载入器会分析 Shebang 后的内容,将这些内容作为解释器指令,并调用该指令,并将载有 Shebang 的文件路径作为该解释器的参数。
简而言之,处于文件头的Shebang指定了运行脚本需要使用的程序,一般情况下,Shell脚本我们会设置成

#!/bin/bash

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

$ which python
/usr/bin/python

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

#!/usr/bin/python

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

$ chmod u+x you_script

命令行参数的处理

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

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

Bash

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

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

Python

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

Setup

基本机构如下所示

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
    # ...

Positional Param

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

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

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

Optional Param

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

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

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

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

DRY - DONT REPEAT YOUSELF

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353

推荐阅读更多精彩内容