サイトマップ サイト内検索 まとめ

Python の fire を使ってみる（コマンドインタフェースの自動生成）

【概要】

fire は，コマンドインタフェース（コマンドラインから操作するための入口）を自動生成するライブラリである．Python の関数やクラスに対して fire.Fire() を呼び出すだけで，コマンドライン引数の解析やサブコマンド（コマンドに続けて指定する下位コマンド）の生成が自動的に行われる．

fire のインストールから基本的な使い方までを扱う．関数を fire に登録して引数付きで呼び出す方法，複数の関数をサブコマンドとして登録する方法，デフォルト引数付き関数を利用する方法，クラスのコンストラクタとメソッドを fire で公開する方法を順に説明する．

【目次】

【関連する外部ページ】

fire の使用法の詳細: https://github.com/google/python-fire/blob/master/docs/using-cli.md

【サイト内の関連情報】

1. 前準備

Python 3.12 のインストール

Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

以下のいずれかの方法でPython 3.12をインストールする。Pythonがインストール済みの場合、この手順は不要である。

方法 1：winget によるインストール

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして、コマンド全体をコマンドプロンプトにコピー＆ペーストする。

--scope machine を指定することで、システム全体（全ユーザー向け）にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動するとPATHが反映される。

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; $c=[Environment]::GetEnvironmentVariable('Path','Machine'); if((Test-Path $p) -and (';'+$c+';' -notlike \"*;$p;*\") -and (';'+$c+';' -notlike \"*;$s;*\")){[Environment]::SetEnvironmentVariable('Path',\"$p;$s;$c\",'Machine')}"

方法 2：インストーラーによるインストール

  1. Python公式サイト（https://www.python.org/downloads/）にアクセスし、「Download Python 3.x.x」ボタンからWindows用インストーラーをダウンロードする。
  2. ダウンロードしたインストーラーを実行する。
  3. 初期画面の下部に表示される「Add python.exe to PATH」にチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
  4. 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号（例：Python 3.12.x）が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

Python の開発環境 Visual Studio Code のインストールと Python 用の設定

Python の開発環境Visual Studio Code（プログラムを編集するソフトウェア。以下、VS Code）を整える。

[Windows での Visual Studio Code のインストールと Python 用の設定手順を見るには、ここをクリック]

Windows での Visual Studio Code のインストールと Python 用の設定手順

1. VS Code と拡張機能のインストール

以下のコマンドにより，既存の VS Code を削除し，全ユーザー共有の設定で再インストールしたうえで，拡張機能（VS Code に機能を追加するソフトウェア）をまとめて導入する．

【インストールコマンドの実行方法】

管理者権限でコマンドプロンプトを起動する（手順：Windows キーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。そして，コマンド全体をコマンドプロンプトにコピー＆ペーストする。

インストールコマンド


REM ============================================================
REM Microsoft Visual Studio Code
REM ============================================================
winget uninstall -e --id Microsoft.VisualStudioCode --silent --disable-interactivity --accept-source-agreements
rmdir /s /q C:\ProgramData\vscode-extensions 2>nul
rmdir /s /q "%APPDATA%\Code" 2>nul
rmdir /s /q "%USERPROFILE%\.vscode" 2>nul
rmdir /s /q "%LOCALAPPDATA%\Microsoft\vscode-update" 2>nul

REM VS Code をシステム領域に新規インストール
winget install --scope machine --id Microsoft.VisualStudioCode -e --silent --accept-source-agreements --accept-package-agreements

REM 全ユーザー共有の拡張機能フォルダ
mkdir C:\ProgramData\vscode-extensions 2>nul
icacls "C:\ProgramData\vscode-extensions" /grant "Everyone:(OI)(CI)M" /T

REM スタートメニューのショートカットを --extensions-dir 付きで再作成
rmdir /s /q "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code" 2>nul
del "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk" 2>nul
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); $lnk.TargetPath='C:\Program Files\Microsoft VS Code\Code.exe'; $lnk.Arguments='--extensions-dir \"C:\ProgramData\vscode-extensions\"'; $lnk.Save()"
REM ショートカットの検証
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); Write-Host 'TargetPath:' $lnk.TargetPath; Write-Host 'Arguments:' $lnk.Arguments"

REM ファイル / フォルダ右クリックの「Code で開く」を登録
reg add "HKLM\SOFTWARE\Classes\*\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\Background\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%V\"" /f

REM --extensions-dir 付きで起動する code.cmd ラッパを作成
REM （%* を echo で書くと対話的 cmd で失われるため、PowerShell で [char]37+'*' を書き出す）
powershell -NoProfile -Command "$pct=[char]37; $q=[char]34; $c='@echo off'+[char]13+[char]10+$q+'C:\Program Files\Microsoft VS Code\bin\code.cmd'+$q+' --extensions-dir '+$q+'C:\ProgramData\vscode-extensions'+$q+' '+$pct+'*'+[char]13+[char]10; [IO.File]::WriteAllText('C:\ProgramData\vscode-extensions\vscode.cmd',$c,[Text.Encoding]::ASCII)"

REM 拡張機能のインストール
set "CODE=C:\Program Files\Microsoft VS Code\bin\code.cmd"
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot-chat
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.python
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.vscode-pylance
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.debugpy
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension MS-CEINTL.vscode-language-pack-ja
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension saoudrizwan.claude-dev
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension rust-lang.rust-analyzer
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension tamasfe.even-better-toml
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension anthropic.claude-code
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension almenon.arepl
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --list-extensions --show-versions
echo === セットアップ完了 ===

2. Python インタプリタの選択

同一マシンに複数の Python がインストールされている場合，VS Code で使用する Python 本体（インタプリタ：Python プログラムを解釈・実行するソフトウェア）を選択する必要がある．

  1. コマンドパレット（コマンド名で機能を呼び出す VS Code の入力欄）を開く（Ctrl+Shift+P）
  2. Python: Select Interpreter と入力する
  3. 表示される一覧から，使用する Python（例：C:\Program Files\Python312\python.exe）を選択する．

Python プログラム実行手順

[Windows での Python プログラム実行手順を見るには、ここをクリック]

Windows での Python 実行手順（Visual Studio Codeを使用）

プログラムファイルの作成と保存

  1. 左サイドバーの「エクスプローラー」アイコン（Ctrl+Shift+E）をクリックする
  2. 「NO FOLDER OPENED」（作業対象フォルダが未選択の状態）と表示される場合は，「Open Folder」をクリックし，プログラムを保存するフォルダを選択する

    続いて「フォルダを信用するか」を確認する画面（フォルダ内のコードを実行してよいか確認する VS Code の仕組み）が表示されるので，チェックして Yes を選択する

  3. フォルダ名の右側に表示される「新しいファイル」アイコンをクリックする
  4. ファイル名（例：aitask.py．ファイル名は何でも良い）を入力し Enter を押す．拡張子は .py（Python ファイルを示す拡張子）とする
  5. 実行したいコードを選択し，Ctrl+C でコピーする．VS Code のエディタ領域に Ctrl+V で貼り付ける
  6. Ctrl+S で保存する

プログラムの実行

  1. エディタ右上の三角形「▷」アイコン（Run Python File：現在開いている Python ファイルを実行するボタン）をクリックする．または，エディタ上で右クリックし「ターミナルで Python ファイルを実行」を選択する
  2. VS Code 下部のターミナル（コマンドの入出力を表示する画面）に，実行結果（print 関数の出力等）が表示される
  3. tkinter（Python 標準の GUI ライブラリ）のファイル選択ダイアログを使うプログラムを実行した場合は，ダイアログが開くので対象画像を選択する
  4. VS Code 下部のターミナルで実行結果を確認する．OpenCV ウィンドウ（OpenCV が画像を表示するために開く専用ウィンドウ）が開いた場合はそちらも確認する．OpenCV ウィンドウは，マウスクリックでウィンドウをアクティブ（操作対象の状態）にしてからキーを押すと終了する

fire のインストール [クリックして展開]

管理者権限でコマンドプロンプトを起動する （手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。

起動したコマンドプロンプトで以下を実行する。

python -m pip install -U --no-user fire

2. 実行のための準備とその確認手順（Windows 前提）

2.1 プログラムファイルの準備

各演習に掲載するソースコードをテキストエディタ（Visual Studio Code やメモ帳など）に貼り付け，UTF-8 で保存する．演習ごとに，その演習のコードを保存して実行する．

2.2 実行コマンド

コマンドプロンプトでファイルの保存先ディレクトリに移動し，以下のように実行する（保存したファイル名が a.py の場合）．

python a.py 100

クラスの例では，コマンドライン引数としてオプション名（--名前 の形式）と値を指定する．

python a.py --qty 5 --weight 170.51 --name 'apple' total

2.3 動作確認チェックリスト

確認項目期待される結果
関数の例：python a.py 100 を実行108.0（引数 100 に 1.08 を掛けた値）が出力される
複数関数の例：python a.py add 3 5 を実行8（3 + 5 の結果）が出力される
デフォルト引数の例：python a.py Alice を実行Hello, Alice（デフォルト値が使用される）が出力される
クラスの例：python a.py --qty 5 --weight 170.51 --name 'apple' total を実行852.55（5 * 170.51 の結果）が出力される

3. 概要・使い方・実行上の注意

fire を用いた4つの使用パターンを説明する．各パターンの実行手順とソースコードは，続く演習の章にまとめている．

3.1 関数を fire に登録する

関数 foo を fire.Fire(foo) に渡すことで，コマンドラインから引数を指定して呼び出せるようになる．引数は位置引数として（順番どおりに）指定できる．

3.2 複数関数の登録

fire では，複数の関数をまとめて登録できる．fire.Fire() を引数なしで呼び出すと，呼び出した場所のローカル変数・グローバル変数（定義した関数やクラスなど）をまとめた辞書が対象となり，これらがコマンドとして登録される．これにより，定義した各関数をサブコマンドとして使える．

3.3 デフォルト引数付き関数

関数にデフォルト引数（呼び出し時に省略すると既定値が使われる引数）を設定すると，コマンドライン実行時にその引数を省略できる．--greeting を省略した場合はデフォルト値 'Hello' が使用される．

3.4 クラスのコンストラクタとメソッド

クラス C を fire.Fire(C) に渡すことで，コンストラクタ（__init__）の引数をコマンドラインオプションとして指定し，属性やメソッドにサブコマンドとしてアクセスできる．コンストラクタの引数は，--名前 値 のフラグ形式で指定する．

4. 演習1：関数を fire に登録する

テーマ名：関数を fire.Fire(foo) に登録し，コマンドラインから引数を渡して呼び出す．

手順：

次のコードを実行（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）．

import fire

def foo(a):
    return a * 1.08

if __name__ == '__main__':
    fire.Fire(foo)

端末（Windows のコマンドプロンプトなど）を開き，保存先ディレクトリで次を実行する． 

python a.py 100
python a.py 150
python a.py 400

ヒント：引数は数値として解釈される．108.0 のように小数で出力される．

考察ポイント：入力した値と出力された値を比べ，1.08 倍されていることを確認する．

5. 演習2：複数関数をサブコマンドとして登録する

テーマ名：複数の関数を fire.Fire() で登録し，関数名をサブコマンドとして呼び出す．

手順：

次のコードを実行（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）．

import fire

def add(a, b):
    return a + b

def multiply(a, b):
    return a * b

if __name__ == '__main__':
    fire.Fire()

端末（Windows のコマンドプロンプトなど）を開き，保存先ディレクトリで次を実行する． 

python a.py add 3 5
python a.py multiply 4 6

ヒント：関数名（add や multiply）をコマンドの先頭に付け，続けて引数を並べる．

考察ポイント：同じファイルで複数の関数を呼び分けられることを，先頭に付けた関数名と出力結果の対応から確認する．

6. 演習3：デフォルト引数付き関数を利用する

テーマ名：デフォルト引数付き関数を fire.Fire(greet) に登録し，引数を省略した場合と指定した場合の違いを観察する．

手順：

次のコードを実行（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）．

import fire

def greet(name, greeting='Hello'):
    return f'{greeting}, {name}'

if __name__ == '__main__':
    fire.Fire(greet)

端末（Windows のコマンドプロンプトなど）を開き，保存先ディレクトリで次を実行する． 

python a.py Alice
python a.py Alice --greeting Hi

ヒント：--greeting を付けないと既定値 'Hello' が使われる．

考察ポイント：--greeting を指定したときと省略したときの出力を比べ，デフォルト値が使われる条件を確認する．

7. 演習4：クラスのコンストラクタとメソッドを公開する

テーマ名：クラスを fire.Fire(C) に渡し，コンストラクタ引数の指定と，属性・メソッドへのアクセスを観察する．

手順：

次のコードを実行（メモ帳を用いる場合は a.py のようなファイル名で保存して実行）．

import fire

class C:
    def __init__(self, qty, weight, name):
        self.qty = qty
        self.weight = weight
        self.name = name

    def total(self):
        return self.qty * self.weight

if __name__ == '__main__':
    fire.Fire(C)

端末（Windows のコマンドプロンプトなど）を開き，保存先ディレクトリで次を実行する． 

python a.py --qty 5 --weight 170.51 --name 'apple' qty
python a.py --qty 5 --weight 170.51 --name 'apple' weight
python a.py --qty 5 --weight 170.51 --name 'apple' name
python a.py --qty 5 --weight 170.51 --name 'apple' total

ヒント：コンストラクタの引数は --qty のようにフラグ形式で指定し，末尾に属性名やメソッド名（qty，total など）を付ける．

考察ポイント：末尾に付けた語（属性名かメソッド名か）によって出力がどう変わるかを確認し，total が qty * weight の計算結果になることを確かめる．

8. まとめ