【Python】終了コードを設定してスクリプトを終了する

Pythonスクリプトにおいて、終了コードを設定する方法を紹介します。

サンプルコード

★印のように、sys.exit関数でスクリプトの終了コードを設定できます。

一般的に、終了コード0はプログラムがエラーなしで終了したことをOSや呼び出し元のスクリプトに示します。0以外の終了コードは、何らかのエラーが発生したことを示します。

#coding: UTF-8
import sys  # sysモジュールをインポート

# 引数の数を取得
arg_num = len(sys.argv) - 1

# コマンドライン引数が１つ以外の場合
if arg_num != 1:
    # コマンドの使用方法を表示
    print("引数は１つだけ指定してください")

    # 引数の数が正しくない場合は異常終了 ★
    sys.exit(1)

# コマンドライン引数を表示
print( "引数: " + sys.argv[1] )

# 正常終了の終了コード0を返して終了 ★
sys.exit(0)

実行結果

D:\Sample\Python>python sample.py
引数は１つだけ指定してください

D:\Sample\Python>python sample.py aaa
引数: aaa

D:\Sample\Python>python sample.py aaa bbb
引数は１つだけ指定してください

まとめ

本記事では、Pythonスクリプトにおいて、終了コードを設定する方法を紹介しました。