Python的argparse庫怎么使用

# Python的argparse庫怎么使用

## 1. 簡介

`argparse` 是 Python 標準庫中用于解析命令行參數的模塊，它能夠輕松地編寫用戶友好的命令行界面。相比于手動解析 `sys.argv`，`argparse` 提供了更強大、更靈活的功能，包括：

- 自動生成幫助和使用信息
- 支持位置參數和可選參數
- 參數類型檢查和自動轉換
- 子命令支持

## 2. 基本用法

### 2.1 創建解析器

首先需要創建一個 `ArgumentParser` 對象：

```python
import argparse

parser = argparse.ArgumentParser(description='這是一個示例程序')

description 參數用于簡要描述程序的用途，會顯示在幫助信息中。

2.2 添加參數

使用 add_argument() 方法添加參數：

parser.add_argument('filename', help='輸入文件名')
parser.add_argument('-v', '--verbose', help='顯示詳細信息', action='store_true')

• 不帶 - 的參數是位置參數（必須提供）
• 帶 - 或 -- 的是可選參數
• help 參數用于描述參數的用途
• action='store_true' 表示當指定該選項時，參數值為 True

2.3 解析參數

使用 parse_args() 方法解析參數：

args = parser.parse_args()
print(args.filename)
if args.verbose:
    print("詳細模式已開啟")

3. 參數類型詳解

3.1 位置參數

parser.add_argument('input', help='輸入文件')

3.2 可選參數

parser.add_argument('-o', '--output', help='輸出文件')

3.3 參數類型

可以指定參數類型：

parser.add_argument('--count', type=int, help='重復次數')

3.4 默認值

parser.add_argument('--level', type=int, default=1, help='處理級別')

3.5 多值參數

parser.add_argument('--numbers', nargs='+', type=int, help='一組數字')

nargs 可以是： - ? - 0或1個值 - * - 0或多個值 - + - 1或多個值 - 數字 - 確切數量的值

3.6 互斥參數

group = parser.add_mutually_exclusive_group()
group.add_argument('--fast', action='store_true', help='快速模式')
group.add_argument('--slow', action='store_true', help='慢速模式')

4. 高級功能

4.1 子命令

subparsers = parser.add_subparsers(dest='command', help='子命令')

# 創建子命令 'init'
parser_init = subparsers.add_parser('init', help='初始化項目')
parser_init.add_argument('--name', required=True, help='項目名稱')

# 創建子命令 'build'
parser_build = subparsers.add_parser('build', help='構建項目')
parser_build.add_argument('--debug', action='store_true', help='調試模式')

4.2 自定義動作

class CustomAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
        print(f"處理參數: {self.dest}={values}")
        setattr(namespace, self.dest, values.upper())

parser.add_argument('--custom', action=CustomAction)

4.3 參數組

group = parser.add_argument_group('輸出選項')
group.add_argument('--output', help='輸出文件')
group.add_argument('--format', choices=['json', 'xml'], default='json')

5. 實用示例

5.1 文件處理工具

import argparse

parser = argparse.ArgumentParser(description='文件處理工具')

parser.add_argument('input', help='輸入文件路徑')
parser.add_argument('-o', '--output', help='輸出文件路徑')
parser.add_argument('-v', '--verbose', action='store_true', help='詳細輸出')
parser.add_argument('--encoding', default='utf-8', help='文件編碼')
parser.add_argument('--lines', type=int, help='處理的行數')

args = parser.parse_args()

if args.verbose:
    print(f"正在處理文件: {args.input}")
    if args.output:
        print(f"輸出到: {args.output}")

5.2 計算器

parser = argparse.ArgumentParser(description='簡單計算器')

subparsers = parser.add_subparsers(dest='operation', required=True)

# 加法
add_parser = subparsers.add_parser('add', help='加法運算')
add_parser.add_argument('numbers', nargs='+', type=float, help='要相加的數字')

# 乘法
mul_parser = subparsers.add_parser('mul', help='乘法運算')
mul_parser.add_argument('numbers', nargs='+', type=float, help='要相乘的數字')

args = parser.parse_args()

if args.operation == 'add':
    result = sum(args.numbers)
    print(f"結果: {result}")
elif args.operation == 'mul':
    result = 1
    for num in args.numbers:
        result *= num
    print(f"結果: {result}")

6. 總結

argparse 是 Python 中處理命令行參數的標準方法，它提供了：

1. 簡潔的 API 來定義參數
2. 自動生成幫助信息
3. 強大的參數驗證功能
4. 支持復雜的命令行界面設計

掌握 argparse 可以讓你輕松創建專業級的命令行工具，提高腳本的可用性和用戶體驗。 “`