Click 創造奇蹟:簡化您的 CLI 體驗

Mary-Kate Olsen
發布: 2024-10-25 09:28:28
原創
213 人瀏覽過

介紹

在這篇部落格中,我們將深入探討Click 的迷人維度,這是一個Python 庫,可以簡化您的CLI 性能和覆蓋範圍。我們將討論創建基本且緊湊的 CLI 所需的概念。這個部落格將幫助您製作組織?為您的客戶提供更好的 CLI? .

Wonders with Click: Streamline your CLI Experience

Click到底是什麼?

點擊是一個Python套件?這有助於加快 CLI 實用程式的開發。與其他 Python 套件相比,此套件是開發命令列介面的更簡單的選擇。這是一個更好的選擇,因為它需要最少的編碼,並附帶許多內建功能,簡化開發功能。

掌握 Click 的基礎知識

安裝:

要安裝,請按一下執行以下命令。

pip install click
登入後複製

編碼:

先建立一個名為 main.py 的文件,然後使用您喜歡的程式碼編輯器/ide 開啟該文件。現在引入以下程式碼片段來建立一個基本的 cli 工具?在 main.py

import click

@click.command()
def say_hello():
  click.echo("Hello Bob")

# runs when the file is run directly and not imported
if __name__ == "__main__": 
  say_hello()
登入後複製

這裡我們使用 @click.command 裝飾器為函數提供更多功能,使其適合 cli 指令(例如:Git 中的 commit、merge、init 等)。而click.echo是python列印函數的定製版本,適合click的需要。

有多個指令

import click

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

@click.command()
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def say_hello(name):
  click.echo(f'Hello {name}!')

@click.command()
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def say_bye(name):
  click.echo(f'Goodbye {name}!')

@click.command()
@click.option('--num', prompt='Enter a number',type=int ,
              help='The person to greet.')
def give_square(num):
  click.echo(num*num)


# Registering the commands with the CLI
cli.add_command(say_hello)
cli.add_command(say_bye)
cli.add_command(give_square)


if __name__ == "__main__": 
  cli()
登入後複製

@click.option 裝飾器將函數轉換為能夠取得可選值的命令。

要使用此片段在終端機中執行以下命令,

python main.py say_hello --name=Kris

使用參數

import click

@click.command()
@click.argument('name')
def say_hello(name):
  click.echo(f"Hello {name}")

# runs when the file is run directly and not imported
if __name__ == "__main__": 
  say_hello()
登入後複製

@click.argument 裝飾器將函數轉換為一個指令,能夠接受 cli 所需提供的參數。

要使用此程式碼片段在終端機中執行以下命令,

python main.py bob

結論

Click 使得在 Python 中建立 命令列介面變得簡單直觀。它支援多個命令、選項和參數,它是一個功能強大的工具,可以從簡單的用例擴展到複雜的用例。

簡而言之:

  • 命令群組允許您組織多個命令。
  • 指令定義您的 CLI 將要執行的動作。
  • 選項和參數允許使用者輸入來自訂命令行為。

開始嘗試使用 Click 來建立你的下一個 Python
專案並看看建立用戶友好的 CLI 工具是多麼容易!

以上是Click 創造奇蹟:簡化您的 CLI 體驗的詳細內容。更多資訊請關注PHP中文網其他相關文章!

來源:dev.to
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
作者最新文章
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板
關於我們 免責聲明 Sitemap
PHP中文網:公益線上PHP培訓,幫助PHP學習者快速成長!