自定义命令
argparse

自定义命令示例

在mac或者linux中自定义命令可以这么弄
如下我定义了一个python脚本实现了加法add，在终端想实现的效果如add 1 2.1 3输入结果为6.1

# add.py文件
# ast.literal_eval：This can be used for safely evaluating strings containing Python expressions from untrusted sources without the need to parse the values oneself.
import sys
import ast

def add(*x):
    result = 0
    try:
        for i in x:
            result += ast.literal_eval(i)
    except ValueError:
        print('输入参数有误,请重新输入')
    else:
        return result

my_result = add(*sys.argv[1:])
if my_result:
    print("数值求和为: ", my_result)

直接用sys.argv来接收参数

在命令行执行

$ python add.py 1 2 3
数值求和为: 6

再次伪装一下
如我的add.py文件放在~/Documents/pyscripts下
然后我就可以在.zshrc中添加如下别名并source一下

alias add="python ~/Documents/pyscripts/add.py"

命令行执行

$ add 1 2.1 3
数值求和为: 6.1

argparse

概述

上面的例子是从sys.argv中直接来传递变量的，如果还要实现如帮助 add -h等使用信息，还要写很多冗余的代码，这里介绍的argparse将大大简化这一流程，使我们自定义命令更方便

argparse 是一个用来解析命令行参数的 Python 库，它是 Python 标准库的一部分。argparse 模块使编写用户友好的命令行界面变得容易。程序定义了所需的参数，而 argparse 将找出如何从 sys.argv 中解析这些参数。argparse 模块还会自动生成帮助和使用消息，并在用户为程序提供无效参数时发出错误。

官方文档

argparse doc

官方示例

# prog.py文件
import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

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

在命令行中执行

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
  N           an integer for the accumulator

optional arguments:
  -h, --help  show this help message and exit
  --sum       sum the integers (default: find the max)

$ python prog.py 1 2 3 4
4

$ python prog.py 1 2 3 4 --sum
10

$ python prog.py a b c
usage: prog.py [-h] [--sum] N [N ...]
prog.py: error: argument N: invalid int value: 'a'

ArgumentParser 对象(解析器)

第一步是创建一个 ArgumentParser 对象，ArgumentParser 对象包含将命令行解析成 Python 数据类型所需的全部信息

class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)

prog：程序的名称（默认：sys.argv[0]）
description：在参数帮助文档之前显示的文本（默认值：无）

其他参数参考官方文档

add_argument() 方法

第二步，通过add_argument定义单个的命令行参数应当如何解析

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

name or flags：一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo，当 parse_args() 被调用，选项会以 - 前缀识别，剩下的参数则会被认为是位置参数
- 如添加flag参数parser.add_argument('-f', '--foo')，代表-f短选项和--foo长选项，且等效
- 如添加位置参数parser.add_argument('bar')
action：当参数在命令行中出现时使用的动作基本类型，将命令行参数与动作相关联
nargs：命令行参数应当消耗的数目
const：被一些 action 和 nargs 选择所需求的常数
default：当参数未在命令行中出现并且也不存在于命名空间对象时所产生的值
type：命令行参数应当被转换成的类型
- add_argument() 的 type 关键字允许执行任何必要的类型检查和类型转换
- 如果 type 关键字使用了 default 关键字，则类型转换器仅会在默认值为字符串时被应用
help - 一个此选项作用的简单描述
dest：被添加到 parse_args() 所返回对象上的属性名

其他参数参考官方文档

parse_args() 方法

ArgumentParser.parse_args(args=None, namespace=None)
将参数字符串转换为对象并将其设为命名空间的属性。返回带有成员的命名空间

args：要解析的字符串列表。默认值是从 sys.argv 获取
namespace：用于获取属性的对象。默认值是一个新的空 Namespace 对象

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-f', '--foo')
>>> parser.add_argument('bar')
>>> parser.parse_args(['BAR'])
Namespace(bar='BAR', foo=None)
>>> parser.parse_args(['BAR', '--foo', 'FOO'])
Namespace(bar='BAR', foo='FOO')
>>> parser.parse_args(['--foo', 'FOO'])
usage: PROG [-h] [-f FOO] bar
PROG: error: the following arguments are required: bar

add_subparsers() 子命令

许多程序都会将其功能拆分为一系列子命令，例如，svn 程序包含的子命令有 svn checkout, svn update 和 svn commit。当一个程序能执行需要多组不同种类命令行参数时这种拆分功能的方式是一个非常好的主意。 ArgumentParser 通过 add_subparsers() 方法支持创建这样的子命令

更多使用方式可参考官方文档

扩展阅读

Python 命令行之旅

小猴子jerry

自定义命令和Python的argparse