[[271723]]

使用 argparse 模塊像專業(yè)人士一樣解析參數(shù)。

如果你在使用 Python 進(jìn)行開發(fā)，你可能會(huì)在終端中使用命令，即使只是為了啟動(dòng) Python 腳本或使用 pip 安裝 Python 模塊。命令可能簡(jiǎn)單而單一：

$ ls

命令也可能需要參數(shù)：

$ ls example

命令也可以有選項(xiàng)或標(biāo)志：

$ ls --color example

有時(shí)選項(xiàng)也有參數(shù)：

$ sudo firewall-cmd  --list-all --zone home

參數(shù)

POSIX shell 會(huì)自動(dòng)將你輸入的內(nèi)容作為命令分成數(shù)組。例如，這是一個(gè)簡(jiǎn)單的命令：

$ ls example

命令 ls 的位置是 $0，參數(shù) example 位置是 $1。

你可以寫一個(gè)循環(huán)迭代每項(xiàng)。確定它是否是命令、選項(xiàng)還是參數(shù)。并據(jù)此采取行動(dòng)。幸運(yùn)的是，已經(jīng)有一個(gè)名為 argparse 的模塊。

argparse

argparse 模塊很容易集成到 Python 程序中，并有多種便利功能。例如，如果你的用戶更改選項(xiàng)的順序或使用一個(gè)不帶參數(shù)的選項(xiàng)（稱為布爾，意味著選項(xiàng)可以打開或關(guān)閉設(shè)置），然后另一個(gè)需要參數(shù)（例如 --color red），argparse 可以處理多種情況。如果你的用戶忘記了所需的選項(xiàng)，那么 argparse 模塊可以提供友好的錯(cuò)誤消息。

要在應(yīng)用中使用 argparse，首先要定義為用戶提供的選項(xiàng)。你可以接受幾種不同的參數(shù)，而語法一致又簡(jiǎn)單。

這是一個(gè)簡(jiǎn)單的例子：

#!/usr/bin/env python
import argparse
import sys
 
def getOptions(args=sys.argv[1:]):
    parser = argparse.ArgumentParser(description="Parses command.")
    parser.add_argument("-i", "--input", help="Your input file.")
    parser.add_argument("-o", "--output", help="Your destination output file.")
    parser.add_argument("-n", "--number", type=int, help="A number.")
    parser.add_argument("-v", "--verbose",dest='verbose',action='store_true', help="Verbose mode.")
    options = parser.parse_args(args)
    return options

此示例代碼創(chuàng)建一個(gè)名為 getOptions 的函數(shù)，并告訴 Python 查看每個(gè)可能的參數(shù)，前面有一些可識(shí)別的字符串（例如 --input 或者 -i）。 Python 找到的任何選項(xiàng)都將作為 options 對(duì)象從函數(shù)中返回（options 是一個(gè)任意名稱，且沒有特殊含義。它只是一個(gè)包含函數(shù)已解析的所有參數(shù)的摘要的數(shù)據(jù)對(duì)象）。

默認(rèn)情況下，Python 將用戶給出的任何參數(shù)視為字符串。如果需要提取整數(shù)（數(shù)字），則必須指定選項(xiàng) type=int，如示例代碼中的 --number 選項(xiàng)。

如果你有一個(gè)只是關(guān)閉和打開功能的參數(shù)，那么你必須使用 boolean 類型，就像示例代碼中的 --verbose 標(biāo)志一樣。這種選項(xiàng)只保存 True 或 False，用戶用來指定是否使用標(biāo)志。如果使用該選項(xiàng)，那么會(huì)激活 stored_true。

當(dāng) getOptions 函數(shù)運(yùn)行時(shí)，你就可以使用 options 對(duì)象的內(nèi)容，并讓程序根據(jù)用戶調(diào)用命令的方式做出決定。你可以使用測(cè)試打印語句查看 options 的內(nèi)容。將其添加到示例文件的底部：

print(getOptions())

然后帶上參數(shù)運(yùn)行代碼：

$ python3 ./example.py -i foo -n 4
Namespace(input='foo', number=4, output=None, verbose=False)

檢索值

示例代碼中的 options 對(duì)象包含了用戶提供的選項(xiàng)后面的值（或派生的布爾值）。例如，在示例代碼中，可以通過 options.number 來檢索 --number。

options = getOptions(sys.argv[1:])
 
if options.verbose:
    print("Verbose mode on")
else:
    print("Verbose mode off")
 
print(options.input)
print(options.output)
print(options.number)
 
# 這里插入你的 Python 代碼

示例中的布爾選項(xiàng) --verbose 是通過測(cè)試 options.verbose 是否為 True（意味著用戶使用了 --verbose 標(biāo)志）或 False（用戶沒有使用 --verbose 標(biāo)志），并采取相應(yīng)的措施。

幫助和反饋

argparse 還包含一個(gè)內(nèi)置的 --help（簡(jiǎn)寫 -h）選項(xiàng)，它提供了有關(guān)如何使用命令的提示。這是從你的代碼派生的，因此生成此幫助系統(tǒng)不需要額外的工作：

$ ./example.py --help
usage: example.py [-h] [-i INPUT] [-o OUTPUT] [-n NUMBER] [-v]
 
Parses command.
 
optional arguments:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        Your input file.
  -o OUTPUT, --output OUTPUT
                        Your destination output file.
  -n NUMBER, --number NUMBER
                        A number.
  -v, --verbose         Verbose mode.

像專業(yè)人士一樣用 Python 解析

這是一個(gè)簡(jiǎn)單的示例，來演示如何在 Python 應(yīng)用中的解析參數(shù)以及如何快速有效地記錄它的語法。下次編寫 Python 腳本時(shí)，請(qǐng)使用 argparse 為其提供一些選項(xiàng)。你以后會(huì)感到自得，你的命令不會(huì)像一個(gè)快速的臨時(shí)腳本，更像是一個(gè)“真正的” Unix 命令！

以下是可用于測(cè)試的示例代碼：

#!/usr/bin/env python3
# GNU All-Permissive License
# Copying and distribution of this file, with or without modification,
# are permitted in any medium without royalty provided the copyright
# notice and this notice are preserved.  This file is offered as-is,
# without any warranty.
 
import argparse
import sys
 
def getOptions(args=sys.argv[1:]):
    parser = argparse.ArgumentParser(description="Parses command.")
    parser.add_argument("-i", "--input", help="Your input file.")
    parser.add_argument("-o", "--output", help="Your destination output file.")
    parser.add_argument("-n", "--number", type=int, help="A number.")
    parser.add_argument("-v", "--verbose",dest='verbose',action='store_true', help="Verbose mode.")
    options = parser.parse_args(args)
    return options
 
options = getOptions(sys.argv[1:])
 
if options.verbose:
    print("Verbose mode on")
else:
    print("Verbose mode off")
 
print(options.input)
print(options.output)
print(options.number)