python invoke

pythonのinvokeの使い方

タグ invoke


pythonのinvokeの使い方

概要

  • CLIコマンドをラップするライブラリ
  • /python-fire/に似た機能を持つ
    • fireはコマンドを実行する目的ではない
  • tasks.pyというファイル名でinvoke用のスクリプトを作成する必要がある
  • 関数名を引数に呼び出せるが、コマンドではアンダーバー(_)がハイフン(-)に置き換えられる

インストール

ダウンロード

$ pythno3 -m pip install invoke

具体例

  • gitで指定したブランチにチェックアウトする機能

tasks.py

from invoke import task

@task
def git_checkout(c, branch):
    c.run(f"git checkout {branch}")

実行

$ invoke git-checkout --branch=main # mainブランチをチェックアウトする例

参考