【知らないとやばい!?】Pythonの「if __name__ == ‘__main__’:」の使い方 #クラス

こんにちは！タランチュラです。
突然ですが、Pythonでスクリプトを書いていると頻繁に目にするif __name__ == '__main__':という構文、ご存じでしょうか？
この記事では、このおなじみの構文がいったい何を意味し、なぜ使われるのかをサクッと解説していきます。

プログラミング経験が浅い方や、Pythonを使い始めたばかりで「とにかく動くから何となく使っている」という方を主な対象読者としています。逆に、Python歴の長い方にとっては復習・再確認の内容になるかもしれません。

僕はXで統計やデータサイエンスに関する情報発信を行う傍ら、データ系職種専門の求人広告サイト「DSの森」を運営しています。興味があればぜひチェックしてみてください。

本記事が少しでもお役に立ちましたら、「いいね」や「ストック」をしていただけると励みになります。最後までお付き合いいただけると嬉しいです。

Pythonでは、モジュール・関数・クラスなど“プログラム要素”として定義されたオブジェクトが持つ特別な属性の一つに、__name__があります。ただし、文字列や数値のような一般的なオブジェクトはこの属性を持たないため、「すべてのオブジェクトが持っているわけではない」という点に注意が必要です。

例えば、以下のような関数とクラスを定義します。

def func():
    print(func.__name__)  # "func"

class MyClass:
    pass

print(MyClass.__name__)   # "MyClass"

これを実行すると、それぞれ定義名がそのまま表示されます。

一方、モジュールの場合は、やや挙動が異なります。
モジュールが直接実行されるか、あるいは別のファイルからimportされるかで、__name__の値が変わる点が特徴的です。
具体的には、ターミナルから直接実行した際には"__main__"、インポートされた場合にはモジュール名が入ります。

たとえば、以下のコードをmy_module.pyとして用意します。

# my_module.py

print("Module name:", __name__)

def func():
    print("Function name:", func.__name__)

class MyClass:
    pass

func()
print("Class name:", MyClass.__name__)

ターミナルなどのスクリプトで直接python my_module.pyを実行すると、出力はだいたい以下のようになります。

Module name: __main__
Function name: func
Class name: MyClass

一方、別のファイルでimport my_module.pyを呼び出してみると、

Module name: my_module
Function name: func
Class name: MyClass

のように出力されます。

このように、モジュールの__name__だけは「直接実行時」と「import時」で異なる値を取るわけです。ここで活用されるのが、次に解説するif __name__ == '__main__':構文です。

「モジュールとして実行されているのか、それともスクリプトとして直接呼ばれているのか」を判定し、処理を切り分けるために利用されます。

Pythonファイルをモジュールとしてインポートせずに、直接スクリプトとして実行した場合には、ファイルの先頭から順番にコードがすべて読み込まれて実行されます。

しかし、他のファイルからインポートされる場合には「モジュールが読み込まれる」という処理だけ行われ、いわゆる“メインの処理”を動かしたくないケースがあります。

こうした「直接実行のときだけ動かしたい処理」を切り分けるために使用されるのが、if __name__ == '__main__':構文です。以下の例を見てください。

# sample.py
def greet():
    print("Hello from greet()!")

def main():
    """メインとなる処理"""
    greet()
    print("This script is executed directly!")

# ここがポイント
if __name__ == '__main__':
    main()

スクリプトで直接モジュールをpython sample.pyで実行する場合は、__name__には"__main__"がセットされているため、if __name__ == '__main__':以下のmain()関数が呼び出され、処理が行われます。

Hello from greet()!
This script is executed directly!

続いて、以下のように他のファイルからimportするケースを想定します。

# another_script.py
import sample

sample.greet()

こちらの実行結果は、

この場合は、sample.pyがモジュールとして読み込まれただけなので、__name__は"sample"になり、if __name__ == '__main__':以下の処理は実行されません。

このように、「スクリプトとして実行したときだけ動かしたい処理」と「モジュールとして読み込まれたときにはスキップしたい処理」を分ける役割を果たすのがif __name__ == '__main__':構文です。

大規模プロジェクトやライブラリの中にデモやテストを組み込む場合にも、便利に使われる仕組みです。

if __name__ == '__main__': のメリット