[[435093]]

使用 argparse 模塊為應用程序設置命令行選項。

有一些第三方庫用于命令行解析，但標準庫 argparse 與之相比也毫不遜色。

無需添加很多依賴，你就可以編寫帶有實用參數解析功能的漂亮命令行工具。

Python 中的參數解析

使用 argparse 解析命令行參數時，第一步是配置一個 ArgumentParser 對象。這通常在全局模塊內完成，因為單單_配置_一個解析器沒有副作用。

import argparse
 
PARSER = argparse.ArgumentParser()

ArgumentParser 中最重要的方法是 .add_argument()，它有幾個變體。默認情況下，它會添加一個參數，并期望一個值。

PARSER.add_argument("--value")

查看實際效果，調用 .parse_args()：

PARSER.parse_args(["--value", "some-value"])

Namespace(value='some-value')

也可以使用 = 語法：

PARSER.parse_args(["--value=some-value"])

Namespace(value='some-value')

為了縮短在命令行輸入的命令，你還可以為選項指定一個短“別名”：

PARSER.add_argument("--thing", "-t")

可以傳入短選項：

PARSER.parse_args("-t some-thing".split())

Namespace(value=None, thing='some-thing')

或者長選項：

PARSER.parse_args("--thing some-thing".split())

Namespace(value=None, thing='some-thing')

類型

有很多類型的參數可供你使用。除了默認類型，最流行的兩個是布爾類型和計數器。布爾類型有一個默認為 True 的變體和一個默認為 False 的變體。

PARSER.add_argument("--active", action="store_true")
PARSER.add_argument("--no-dry-run", action="store_false", dest="dry_run")
PARSER.add_argument("--verbose", "-v", action="count")

除非顯式傳入 --active，否則 active 就是 False。dry-run 默認是 True，除非傳入 --no-dry-run。無值的短選項可以并列。

傳遞所有參數會導致非默認狀態：

PARSER.parse_args("--active --no-dry-run -vvvv".split())

Namespace(value=None, thing=None, active=True, dry_run=False, verbose=4)

默認值則比較單一：

PARSER.parse_args("".split())

Namespace(value=None, thing=None, active=False, dry_run=True, verbose=None)

子命令

經典的 Unix 命令秉承了“一次只做一件事，并做到極致”，但現代的趨勢把“幾個密切相關的操作”放在一起。

git、podman 和 kubectl 充分說明了這種范式的流行。argparse 庫也可以做到：

MULTI_PARSER = argparse.ArgumentParser()
subparsers = MULTI_PARSER.add_subparsers()
get = subparsers.add_parser("get")
get.add_argument("--name")
get.set_defaults(command="get")
search = subparsers.add_parser("search")
search.add_argument("--query")
search.set_defaults(command="search")

MULTI_PARSER.parse_args("get --name awesome-name".split())

Namespace(name='awesome-name', command='get')

MULTI_PARSER.parse_args("search --query name~awesome".split())

Namespace(query='name~awesome', command='search')`

程序架構

使用 argparse 的一種方法是使用下面的結構：

## my_package/__main__.py
import argparse
import sys
 
from my_package import toplevel
 
parsed_arguments = toplevel.PARSER.parse_args(sys.argv[1:])
toplevel.main(parsed_arguments)

## my_package/toplevel.py
 
PARSER = argparse.ArgumentParser()
## .add_argument, etc.
 
def main(parsed_args):
 
    ...
 
    # do stuff with parsed_args

在這種情況下，使用 python -m my_package 運行。或者，你可以在包安裝時使用 console_scprits 入口點。

總結

argparse 模塊是一個強大的命令行參數解析器，還有很多功能沒能在這里介紹。它能實現你想象的一切。