2. 程式人生 > >Argparse模組:python快捷實現命令列操作

Argparse模組:python快捷實現命令列操作

阿新 • • 發佈：2019-01-01

python中的argparse模組可以方便地實現命令列解釋操作，從而實現豐富的功能介面。

首先我們來看一段Shell程式碼：

$ ls
cpython  devguide  prog.py  pypy  rm-unused-function.patch
$ ls pypy
ctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x  4 wena wena 4096
 
 Feb  8 12:04 devguide
-rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb  7 00:59 pypy
-rw-r--r--  1 wena wena  741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if
 
 none of -cftuvSUX nor --sort is specified.
...

接觸過linux的人都知道，上面的一段程式碼中使用了‘ls’這個命令列引數，這個‘ls’命令對於linux使用者是經常使用的。
從中上面的使用中我們可以看到：
1、如果我們只使用‘ls’這個命令，則預設顯示當前目錄中的內容；
2、如果你想要執行這個命令列的其他功能，比如你要顯示另一個目錄pypy。這裡我們要注意的就是“位置引數”（positional argument）。正如第二個命令顯示，‘ls pypy’，‘pypy’是‘ls’命令的位置引數，用於告訴這個命令具體要做什麼；
3、現在我們想要顯示更多的資訊，而不是光光顯示內容的名字，於是我們在後面加了一個‘-l’，這個引數則稱為“可選引數”；
4、‘–help’則幫助你瞭解這個命令怎麼使用。

好了，回到python來吧，首先我們匯入模組。

基本操作

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

寫好上面的程式後，在終端中輸入：

$ python3 prog.py
$ python3 prog.py --help
usage: prog.py [-h]

optional arguments:
  -h, --help  show this help message and exit
$ python3 prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python3 prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo
Here is what is happening:

第一行，僅僅執行這個指令碼沒有什麼實質用處。
第二行就展示了argparse module的作用，我們得到了一個不錯的幫助資訊。
很容易知道“–help”和’-h’功能相同，這個可選引數在初始化後就存在，不用自個兒寫。
第三個和第四個命令顯然是錯的，因為啥也沒寫，故會報錯。

現在進行修改：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)            #執行該指令碼時前臺顯示程式碼

執行以下命令：

$ python3 prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python3 prog.py --help
usage: prog.py [-h] echo

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit
$ python3 prog.py foo
foo

上面程式中，加入了 add_argument() 方法，用來確認我們想使用什麼樣的命令列可選引數。上面程式中加入了“echo”引數，另外parse_args()方法一般用於從確定使用的“可選引數”功能中返回資料，在這個例子中是返回echo。

再次修改，

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print(args.echo)

然後得到：

$ python3 prog.py -h
usage: prog.py [-h] echo

positional arguments:
  echo        echo the string you use here

optional arguments:
  -h, --help  show this help message and exit

再加進一步：


import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)
Following is a result of running the code:

$ python3 prog.py 4
Traceback (most recent call last):
  File "prog.py", line 5, in <module>
    print(args.square**2)
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'

這樣直接進行操作會發生錯誤，因為模組預設將輸入的引數識別為string型別，我們只有明確表明為int型才可以進行**操作。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
                    type=int)
args = parser.parse_args()
print(args.square**2)

然後看結果：

$ python3 prog.py 4
16
$ python3 prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'

接下來介紹“可選”引數：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:     #當不使用--verbosity時，該引數為None
    print("verbosity turned on"）

輸出：

$ python3 prog.py --verbosity 1
verbosity turned on
$ python3 prog.py
$ python3 prog.py --help
usage: prog.py [-h] [--verbosity VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  --verbosity VERBOSITY
                        increase output verbosity
$ python3 prog.py --verbosity
usage: prog.py [-h] [--verbosity VERBOSITY]
prog.py: error: argument --verbosity: expected one argument

上面的一段程式用來展示一些東西，當–verbosity被確定時就會打印出資訊，如果沒有則什麼也不顯示，另外要有些需要修改的地方：1、程式的幫助資訊有些歧義，2、verbosity只需要兩個狀態就可以工作了：Ture和False。

進行修改：

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")

輸出：

$ python3 prog.py --verbose
verbosity turned on
$ python3 prog.py --verbose 1
usage: prog.py [-h] [--verbose]
prog.py: error: unrecognized arguments: 1
$ python3 prog.py --help
usage: prog.py [-h] [--verbose]

optional arguments:
  -h, --help  show this help message and exit
  --verbose   increase output verbosity

修改後，這個選項更像一個標誌而不是獲取一個值了。注意我們加了一個新的關鍵字：action，然後給了它一個引數”store_true”。這樣的話，當選項被確定的時候，args.verbose被確定為True。不使用選項則為False。

當然也可以使用短的選項引數：

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")

輸出：

$ python3 prog.py -v
verbosity turned on
$ python3 prog.py --help
usage: prog.py [-h] [-v]

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity

將位置引數和可選引數進行結合：

i

mport argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbose", action="store_true",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbose:
    print("the square of {} equals {}".format(args.square, answer))
else:
    print(answer)

輸出：

$ python3 prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square
$ python3 prog.py 4
16
$ python3 prog.py 4 --verbose
the square of 4 equals 16
$ python3 prog.py --verbose 4
the square of 4 equals 16

上面程式中重新加上了位置引數，如果使用時不明確使用位置引數則會出現錯誤。
下面則使用了多可選引數的設定。

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,
                    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)

輸出：

$ python3 prog.py 4
16
$ python3 prog.py 4 -v
usage: prog.py [-h] [-v VERBOSITY] square
prog.py: error: argument -v/--verbosity: expected one argument
$ python3 prog.py 4 -v 1
4^2 == 16
$ python3 prog.py 4 -v 2
the square of 4 equals 16
$ python3 prog.py 4 -v 3
16

上面輸出中最後一行有點小問題，修改一下：

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)

輸出：

$ python3 prog.py 4 -v 3
usage: prog.py [-h] [-v {0,1,2}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
$ python3 prog.py 4 -h
usage: prog.py [-h] [-v {0,1,2}] square

positional arguments:
  square                display a square of a given number

optional arguments:
  -h, --help            show this help message and exit
  -v {0,1,2}, --verbosity {0,1,2}
                        increase output verbosity

相關推薦

Argparse模組:python快捷實現命令列操作

python中的argparse模組可以方便地實現命令列解釋操作，從而實現豐富的功能介面。 首先我們來看一段Shell程式碼： $ ls cpython devguide prog.py pypy rm-unused-function.p

Python程式設計：使用sys、argparse、click、fire實現命令列解析

python實現指令碼命令列的庫有： 內建庫sys 內建庫argparse 第三方庫click 第三方庫fire 內建庫sys sys.argv 包含命令列引數列表，第一個引數是檔名 sys_demo.py import sys d

Python：關於命令列引數argparse寫入圖片路徑

什麼是命令列引數？ 命令列引數是在執行時給予程式/指令碼的標誌。它們包含我們程式的附加資訊，以便它可以執行。 並非所有程式都有命令列引數，因為並非所有程式都需要它們。 為什麼我們使用命令列引數？ 如上所述，命令列引數在執行時為程式提供附加資訊。 這允許我們在不改變程式碼的情況下動

[Python小筆記]命令列引數：sys.argv和getopt模組

一、sys.argv sys.argv 是命令列引數列表。 #test_sys_argv.py import sys print(sys.argv)#命令列引數列表 print(sys.argv[0]) print(len(sys.argv))#命令列引數列表個數 二、g

python中處理命令列引數的模組optpars

optpars是python中用來處理命令列引數的模組，可以自動生成程式的幫助資訊，功能強大，易於使用，可以方便的生成標準的，符合Unix/Posix 規範的命令列說明。使用 add_option() 來加入選項，使用 parse_args() 來解析命令列。add_opti

WDCP上配置SSL證書即https 2017-08-28 百度總結 操作環境：linux的WDCP操作面板（沒有操作面板就在命令列操作） wdcp 安裝ssl證書教程實現https訪問 1.申請

百度總結 操作環境：linux的WDCP操作面板（沒有操作面板就在命令列操作） wdcp 安裝ssl證書教程實現https訪問 1.申請免費或付費證書 2.新建站點並 按照提示上傳SSL證書，證書名稱為：域名.KEY/域名.PEM 3.修改對應站點的.CONF檔案（配置檔案） 1234567

linux下命令列操作快捷鍵及技巧

歷史相關命令 !!：執行上一條命令 !num：執行歷史命令中第num條命令 !-num：執行歷史命令中倒數第num條命令 !?string?：執行最近一條包含有string字串的命令 Ctrl+r：搜尋上一條匹配的命令 !$：代表上一個命令的最後一個字串 E

windows常用命令列操作及相關快捷方式

       下面是個人總結的windows命令列和常用命令，和大家一起交流下！ 本文從命令列基礎命令，編寫命令快捷鍵，檔案操作命令，service服務操作命令，      啟動系統應用命令，net

python 2.7 命令列列印、print、str()、repr()

**1.**Python列印值（命令列列印）：會保持該值在python程式碼中的狀態，不是使用者所希望看到的狀態 >>> "hello" 'hello' #python打印出的值是給python理解的。python理解為字串，所以帶引號 **2.**P

MYSQL命令列操作基本語句

首先進入MYSQL命令列控制介面：   1. 查詢所有資料庫： show databases;  (分號不能少) 2 進入某一資料庫 use + 資料庫名 + database;   Database changed表明已經

嵌入式命令列操作（可移植性）

本文件基於stm32f103並移植到F407， MSP430，以及s3c2440 最終效果如下： 以上多餘列印是除錯時解析bug用的，可以去除。 本文參考u-boot命令列，重點部分有三個：①資料定義 ②獲取串列埠資料（1個位元組） ③解析資料 資料定義 typedef v

Python程式設計：命令列python和python -m的區別

參考了很多，總結下 Python指令碼執行的方式 當模組匯入 直接執行（__name__ == "main"） $ python 執行當前目錄下py檔案 $ python -m 將已安裝庫中的模組當指令碼執行 主要

Git入門（安裝及基礎命令列操作）

一、安裝 1、Mac 　　在Mac中安裝Git的方法不止一種。最簡單的要數通過Xcode命令列工具。對於Mavericks（10.9）或更高版本的作業系統，當你第一次嘗試在終端執行git命令時，系統會自動檢查是否已安裝Git；如果未安裝，則會提示你安裝它。如果希望獲得更高的版本，也可以通過二進位制安裝程式

appium+python自動化62-命令列啟動和關閉appium服務

前言 做app自動化測試比較繁瑣的一點是每次都要去啟動appium服務，然後跑完之後關閉appium服務。雖然在cmd裡面可以使用命令列的appium服務版本，開啟cmd啟動還是不太方便 不能做到真正自動化開啟和關閉。為了解決這個問題，可以用python寫個指令碼去開啟和關閉appium服務 啟動appi

linux 作業系統下簡單的命令列操作

一: 　　配置linux 作業系統虛擬主機   　　首先安裝一個虛擬機器(百度上面有很多哦) , 我主要使用的是VMware workstation 然後 下載一個centos映象6..5到7都可以; 　　然後用VMware安裝下載好的centos 配置好語言 , 使用者名稱 , 密

2018年10月31日Java學習之常用的命令列操作

1.常用的命令列操作 win+r調出並輸入cmd. 進入D盤：D:回車進入D盤：D:回車 D盤下的目錄DIR回車 建立目錄md 2018年10月31日 那麼建立了一個2018年10月31日的目錄（目前還在d盤目錄） 進入2018年10月31日的目錄 cd

【看這一篇就夠了】kubernetes入門命令列操作（例項演示）

寫在前面：網上找了好久終於找到了期盼已久的、一個一眼就能理解的kubernetes“整體全過程”文章。 建議看這篇文章可以結合kubernetes官網（www.kubernetes.io）的Tutorial進行演練，效果很好。 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

hadoop系統 hdfs 命令列操作

轉自：https://blog.csdn.net/sjhuangx/article/details/79796388 Hadoop檔案系統shell命令列表: https://hadoop.apache.org/docs/current/hadoop-project-dist/hado

Go語言基礎（十一）—— 實現命令列引數對資料的簡單查詢小案例

案例要求： 結合命令列引數、複合型別、包管理、排序等知識，寫一個商品管理系統 商品屬性包括：整型商品ID（gid）、字串型名稱(name)、整型類別(cid)、浮點型價格(price) 自己造一些假資料，實現如下功能： shop.exe -cmd single -gi

Mac/Linux 配置多版本Java，並實現命令列快速切換

0. 目標 使用簡單快捷的命令列，快速的切換本機的Java環境 1. 下載JDK 1.8：官網下載； 1.7：https://pan.baidu.com/s/1iCWtZhK_E-KYwZJcMqQ-mQ 2. 安裝JDK 一路next 安裝完成的路徑：