56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
一個範例：
|
||
```python
|
||
import argparse
|
||
|
||
parser = argparse.ArgumentParser()
|
||
parser.add_argument("-u", "--update_tool", default=WIN_FW_UPDATER_PATH, help="The path of win_fw_updater.exe.")
|
||
parser.add_argument("-f", "--firmware", required=True, help="The path of ITB file.")
|
||
parser.add_argument("-w", "--waittime_update_firmware", default=600, type=int, help="Wait time for update the firmware.")
|
||
parser.add_argument("-g", "--ignore_check_file_path", action='store_true', help="Skip check the existence of file.")
|
||
args = parser.parse_args()
|
||
```
|
||
|
||
#### 要求user一定要設定的參數
|
||
使用`required=True`
|
||
例如：
|
||
```python
|
||
parser.add_argument("-f", "--firmware", required=True, help="The path of ITB file.")
|
||
```
|
||
如果使用者沒有下`-f`（或者`--firmware=XXX`）就會報錯，如下：
|
||
```bash
|
||
FwUpdateCheck.py: error: the following arguments are required: -f/--firmware
|
||
```
|
||
|
||
|
||
#### 有設定才會產生的參數
|
||
使用`action='store_true'`或`action='store_false'`
|
||
例如：
|
||
```python
|
||
parser.add_argument("-g", "--ignore_check_file_path", action='store_true', help="Skip check the existence of file.")
|
||
```
|
||
當使用者沒有設置`-g`時，`args.ignore_check_file_path`為`False`，當設置時，`args.ignore_check_file_path`為`True`。
|
||
|
||
#### 使用預設值
|
||
例如：
|
||
```python
|
||
parser.add_argument("-u", "--update_tool", default="C:\\tool.exe", help="The path of win_fw_updater.exe.")
|
||
```
|
||
用`default=<Something>`來設定參數的預設值，上面的例子中，`args.update_tool`的預設值為`C:\tool.exe`。
|
||
另外可以用`type=<Object type>`來指定預設值的型別。例如：
|
||
```python
|
||
parser.add_argument("-n", "--number", default=50, type=int, help="Assign a number")
|
||
```
|
||
上例中，`args.number`的預設值是50，型別是`int`，所以可以直接運算，不需要再經過`int(args.number)`這樣的轉換。
|
||
|
||
#### 限制使用者的選擇
|
||
Example:
|
||
```python
|
||
parser.add_argument('move', choices=['rock', 'paper', 'scissors'])
|
||
```
|
||
使用`choices=<list>`來限定輸入的選項，上例中，使用者只能輸入'rock'、'paper'、'scissors'這三個字串中的其中一個，否則會報錯：
|
||
```bash
|
||
error: argument move: invalid choice: 'fire' (choose from 'rock', 'paper', 'scissors')
|
||
```
|
||
|
||
-----
|
||
- https://docs.python.org/zh-tw/3/library/argparse.html |