python命令行工具Click快速掌握

更新時間：2019年07月04日 09:33:50 作者：FOOFISH-PYTHON之禪

這篇文章主要介紹了python命令行工具Click快速掌握，寫 Python 的經(jīng)常要寫一些命令行工具，雖然標準庫提供有命令行解析工具 Argparse，但是寫起來非常麻煩，我很少會使用它。命令行工具中用起來最爽的就是 Click，,需要的朋友可以參考下

前言

寫 Python 的經(jīng)常要寫一些命令行工具，雖然標準庫提供有命令行解析工具 Argparse，但是寫起來非常麻煩，我很少會使用它。命令行工具中用起來最爽的就是 Click，它是 Flask 的團隊 pallets 的開源項目。Click 只要很少的代碼就可以優(yōu)雅地創(chuàng)造一個命令行工具，它致力于將創(chuàng)建命令行工具的過程變的快速而有趣。

百聞不如一試

安裝

pip install Click

使用

創(chuàng)建 click_demo.py ，寫一個最簡單的函數(shù)

import click
@click.command()
def hello():
  click.echo('Hello World!')
if __name__ == '__main__':
  hello()

運行：

python click_demo.py
Hello World!

裝飾器 click.command() 使函數(shù)秒變命令行工具，echo 函數(shù)的作用等同于 print 函數(shù)。

參數(shù)

裝飾器 click.option()可以給命令行函數(shù)指定參數(shù)

import click

@click.command()
@click.option("--count", default=1, help="打印次數(shù)", type=int)
def hello(count):
  """
  這是一個簡單示例
  """
  for i in range(count):
    click.echo('Hello World!')

if __name__ == '__main__':
  hello()

--count：count是參數(shù)的名字
default ：參數(shù)的默認值
type：給參數(shù)指定類型
help：說明文檔

執(zhí)行腳本的時候后面加上參數(shù) --help 就可以查看說明文檔。

$ python click_demo.py --help

Usage: click_demo.py [OPTIONS]

 這是一個簡單示例

Options:
 --count INTEGER 打印次數(shù)
 --help    Show this message and exit.

指定參數(shù)：

>python click_demo.py --count 3

Hello World!
Hello World!
Hello World!

prompt

有些命令行工具在運行的時候要求用戶輸入信息，可以給 option 裝飾器指定 prompt 參數(shù)

import click

@click.command()
@click.option("--count", default=1, help="打印次數(shù)", type=int)
@click.option("--name", prompt="請輸入名字", help="姓名")
def hello(count, name):
  """
  這是一個簡單示例
  """
  for i in range(count):
    click.echo(f'Hello {name}!')

if __name__ == '__main__':
  hello()

$ python click_demo.py

請輸入名字: lzjun
Hello lzjun!

Group

Click 很重要的一個特性就是它的分組功能，當一個命令行工具的邏輯已經(jīng)非常復雜的時候，為了解耦，我們需要將不同的邏輯放在不同的命令中，這樣既可以避免單個命令行工具函數(shù)臃腫。來看個例子：

# db.py
import click

@click.group()
def db():
  pass

@click.command()
@click.option("--name", help="用戶名")
def add(name):
  """
  添加用戶
  :param name:
  :return:
  """
  click.echo(f'add user {name}')

@click.command()
@click.option("--id", help="用戶名")
def delete(id):
  """
  刪除用戶
  :param id:
  :return:
  """
  click.echo(f'delete user {id}')

db.add_command(delete)
db.add_command(add)

if __name__ == '__main__':
  db()

這是一個操作數(shù)據(jù)庫DB的命令行工具，提供了添加用戶和刪除用戶的命令行等其它操作，如果所有的業(yè)務邏輯全部寫在一個函數(shù)，維護變得異常困難。

@click.group 裝飾器把函數(shù)裝飾成為一個Group對象，通過 Group 可以添加很多子命令。

python db.py --help
Usage: db.py [OPTIONS] COMMAND [ARGS]...

Options:
 --help Show this message and exit.

Commands:
 add   添加用戶 :param name: :return:
 delete 刪除用戶 :param id: :return:

從幫助文檔中我們看到 add 和 delete 就是兩個子命令。 Flask 框架的 flask 命令也是一個 Group 命令。

$ flask
Usage: flask [OPTIONS] COMMAND [ARGS]...

 A general utility script for Flask applications.

 Provides commands from Flask, extensions, and the application. Loads the
 application defined in the FLASK_APP environment variable, or from a
 wsgi.py file. Setting the FLASK_ENV environment variable to 'development'
 will enable debug mode.

  $ export FLASK_APP=hello.py
  $ export FLASK_ENV=development
  $ flask run

Options:
 --version Show the flask version
 --help   Show this message and exit.

Commands:
 add_user      添加賬號 :param name: :param username: :param password:...
 init_invite_code  添加邀請碼
 recommend_account 更新推薦賬號
 routes       Show the routes for the app.
 run        Runs a development server.
 shell       Runs a shell in the app context.

提供了幾個預定義的子命令和自定義的命令。

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: