首页手记 python设置执行选项参数

python设置执行选项参数

标签：

Python

1. sys

可以通过sys.argv得到参数列表，其中sys.argv[0]是文件名称，此后的列表值是每一个参数，这里的参数列表也支持常规的列表操作

    for data in sys.argv:
        print("第{}个参数是：{}".format(sys.argv.index(data), data))

--------------------------------------------------------------------------------------
python mark_test.py first second three four -u username
第0个参数是：mark_test.py
第1个参数是：first
第2个参数是：second
第3个参数是：three
第4个参数是：four
第5个参数是：-u
第6个参数是：username

2. Argparse

Argparse模块可以让人轻松编写用户友好的命令行接口,支持自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息

操作流程

I. 导入库import argparse
II. 初始化解析器parser = argparse.ArgumentParser()
III. 增加参数parser.add_argument()
IV. 解析参数args = parser.parse_args()

使用

参数分为位置参数和可选参数，通常会结合使用，分为以下三种情况

I. 布尔型可选参数

只要指明了--verbose关键字，则会将值设为True，并作出对应响应

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")
-------------------------------------------------------------------------------------------
python mark_test.py 4 --verbose
#verbosity turned on
--------------------------------------------------------------------------------------------
python mark_test.py --ajschahc 2
#usage: mark_test.py [-h] [--verbose]
#mark_test.py: error: unrecognized arguments: --ashjca 1

II. 指定值的可选参数

指定可选参数的几个响应值，只能从指定值从指定参数值并做处理

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity == 1:
    print("{}^2 == {}".format(args.square, answer))
else:
    print(answer)
-----------------------------------------------------------------------------------------------
python mark_test.py 4 -v 3
#usage: mark_test.py [-h] [-v {0,1,2}] square
#mark_test.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
-----------------------------------------------------------------------------------------------
python mark_test.py 4 -v 2
#the square of 4 equals 16

III. 指定可选参数长度(次数)

利用count来通过次数给定参数的响应操作，这里还给定了default值是因为默认情况下未指定可选参数则它将获取None值，无法进行数值比较

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count", default=0,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity >= 2:
    print("the square of {} equals {}".format(args.square, answer))
elif args.verbosity >= 1:
    print("{}^2 == {}".format(args.square, answer))
else:
    print(answer)
--------------------------------------------------------------------------------
python mark_test.py 4 -v
#the square of 4 equals 16
--------------------------------------------------------------------------------
python mark_test.py 4 -vv
#4^2 == 16

长格式和短格式是可以混合使用的，参考之前的例子，更多可参考Argparse

3. Fire

Python Fire是一个Python库，只需一次调用即可将任何Python组件转换为命令行界面 Fire

I. 安装

pip install fire

II. 使用

Fire解析过程较为简单，在cmd中直接调用py文件中的函数、变量、类、实例等等

import fire

def newprint(text):
    print('my '+text)

def newadd(a,b):
    return a + b

fire.Fire() # 只要这一条命令
----------------------------------------------------------------
python cmd.py newprint notebook
#my notebook
----------------------------------------------------------------
python cmd.py newadd 2 3  
#python cmd.py newadd --a 2 --b 3

在函数中将fire.Fire改为固定的方法或者类名，则仅执行该实例，如果是函数，调用时则不再需要指定函数名，类也只需要指明其内的函数名即可
添加多个函数而非全部调用可使用

fire.Fire({
  'newadd': newadd,
  'newprint': newprint,
})

使用类名或者构造对象用法大都类似

import fire

class Myclass:

    def __init__(self, name):
        self.name = name

    def nameprint(self, parm):
        print(parm+ ', I am  ' + self.name)

fire.Fire(Myclass)
-----------------------------------------------------------------
python cmd.py nameprint Yes --name June
#Yes, I am June

4. getopt

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

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

#!/usr/bin/python
# -*- coding: UTF-8 -*-

import sys, getopt

def main(argv):
   inputfile = ''
   outputfile = ''
   try:
      opts, args = getopt.getopt(argv,"hi:o:",["ifile=","ofile="])
   except getopt.GetoptError:
      print 'test.py -i <inputfile> -o <outputfile>'
      sys.exit(2)
   for opt, arg in opts:
      if opt == '-h':
         print 'test.py -i <inputfile> -o <outputfile>'
         sys.exit()
      elif opt in ("-i", "--ifile"):
         inputfile = arg
      elif opt in ("-o", "--ofile"):
         outputfile = arg
   print '输入的文件为：', inputfile
   print '输出的文件为：', outputfile

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

---------------------------------------------------------------------------
$ python test.py -h
#usage: test.py -i <inputfile> -o <outputfile>
---------------------------------------------------------------------------
$ python test.py -i inputfile -o outputfile
#输入的文件为： inputfile
#输出的文件为： outputfile