うっかり無限ループを書いてしまい、あわててCtrl+Cを押した。すると画面に長いエラーが出て、最後にKeyboardInterruptと表示された。Pythonを学び始めたころ、こんな経験をした方は多いのではないでしょうか。
止めたかったのは自分なのに、エラーのような表示が出るので少しドキッとしますよね。
安心してください。この表示は、Pythonがきちんと止まったという合図です。この記事では、Ctrl+Cを押したときにPythonの中で何が起きているのかから、止められたときに後片付けをする書き方までを順番に解説します。
サンプルの実行結果は、手元のLinux環境のPython 3.11で確認したものです。
KeyboardInterruptとはどんな例外なのか¶
まずは、この例外の正体を押さえておきましょう。KeyboardInterruptは、実行中のプログラムを利用者がキーボードから中断したときに発生する例外です。
ふだん私たちが目にするTypeErrorやValueErrorは、コードの書き方やデータに問題があるときに出ます。それに対してKeyboardInterruptは、コードの誤りではなく、人が止めたことを知らせる例外です。
ではなぜ、止まるだけでなく例外という形をとるのでしょうか。それは、止められる直前にプログラムが後片付けをするチャンスを作るためです。この点はあとでくわしく見ていきます。
Ctrl+Cを押してから止まるまでの流れ¶
次に、キーを押してからプログラムが止まるまでに何が起きているのかを見てみます。少しだけOSの話が出てきますが、流れがわかると挙動の理由がすっきり理解できます。
Ctrl+Cを押すと、OSは実行中のプログラムにSIGINTという合図を送ります。この合図はシグナルと呼ばれ、OSがプログラムに急ぎの知らせを届けるための仕組みです。
Pythonは起動したときに、このSIGINTを受け取るための係を自動で用意しています。係の正体は、signalモジュールにあるdefault_int_handlerという関数です。
手元で確かめると、たしかにこの関数が登録されていました。
import signal
print(signal.getsignal(signal.SIGINT))
# <built-in function default_int_handler>
この係がSIGINTを受け取ると、実行中のコードの場所でKeyboardInterruptを発生させます。つまり、Ctrl+Cという操作が、Pythonの中ではふつうの例外に変換されているわけです。
流れを表にまとめると、次のようになります。
| 段階 | 起きていること |
|---|---|
| 1 | 利用者がターミナルでCtrl+Cを押す |
| 2 | OSがプログラムにSIGINTを送る |
| 3 | Pythonの係がSIGINTを受け取る |
| 4 | 実行中の場所でKeyboardInterruptが発生する |
| 5 | 誰も捕まえなければ、tracebackを表示して終了する |
例外になるので、tracebackも表示されます。止めた瞬間に実行していた行がわかるので、無限ループの場所を探す手がかりにもなります。
tracebackの読み方をおさらいしたい方は、こちらの記事が参考になります。 【関連記事】Pythonのエラー文はどこを読めばいい?初心者向けtracebackの見方
except Exceptionで捕まらない理由¶
ここからは、例外処理と組み合わせたときの話です。初心者がいちばん驚くのが、except Exceptionと書いてもKeyboardInterruptは捕まらないという点ではないでしょうか。
例外の家系図を確かめてみる¶
理由は、例外のクラスの親子関係にあります。KeyboardInterruptの先祖をたどってみましょう。
print(KeyboardInterrupt.__mro__)
# (<class 'KeyboardInterrupt'>, <class 'BaseException'>, <class 'object'>)
print(issubclass(KeyboardInterrupt, Exception))
# False
KeyboardInterruptの親はBaseExceptionで、Exceptionの子どもではありません。except Exceptionは、Exceptionの子どもたちだけを受け止める書き方なので、KeyboardInterruptは素通りします。
Python公式ドキュメントにも、Exceptionを捕まえるコードにうっかり捕まらないよう、BaseExceptionを継承していると書かれています。もし捕まってしまうと、ループの中のexcept Exceptionが中断の合図を握りつぶし、Ctrl+Cで止められないプログラムができあがってしまいます。
同じようにBaseExceptionの直接の子どもになっている例外を、表で比べてみましょう。
| 例外 | 発生する場面 | except Exceptionで捕まるか |
|---|---|---|
| ValueErrorなど | コードやデータの問題 | 捕まる |
| KeyboardInterrupt | Ctrl+Cで中断した | 捕まらない |
| SystemExit | sys.exit()を呼んだ | 捕まらない |
| GeneratorExit | ジェネレーターが閉じられた | 捕まらない |
どれも、プログラムを止めたり閉じたりするための例外です。止める合図は、ふつうのエラー処理とは別扱いにするという考え方が見えてきますね。
SystemExitとsys.exit()の関係は、こちらの記事でくわしく解説しています。 【関連記事】Pythonのexit()とsys.exit()の違いとは?プログラムを終了させる方法
exceptだけの書き方には注意¶
一方で、except:のように例外の種類を書かない書き方をすると、KeyboardInterruptまで捕まえてしまいます。except BaseException:と書いた場合も同じです。
ループの中でこう書くと、何度Ctrl+Cを押しても止まらないプログラムになります。例外の種類を省略するのは、思わぬ落とし穴になるので避けましょう。
私は10年ほどエンジニアとして開発に関わってきましたが、まさにこの書き方のせいでCtrl+Cが効かないバッチに出会ったことがあります。結局ターミナルを閉じて止めるしかなく、途中まで書いたファイルが壊れたまま残ってしまいました。
止められたときに後片付けをする書き方¶
KeyboardInterruptが例外として届くおかげで、止められる直前に後片付けができます。ここでは、実務でよく使う書き方を紹介します。
finallyで必ず実行したい処理を書く¶
いちばん基本になるのが、finallyです。tryの中で何が起きても、finallyに書いた処理は必ず実行されます。
次のコードは、1秒ごとに処理を進めるプログラムです。わざとexcept Exceptionも書いて、KeyboardInterruptが捕まらないことも一緒に確かめます。
import time
try:
for i in range(1, 100):
print(f"{i}件目を処理中...")
time.sleep(1)
except Exception:
print("Exceptionで捕まえた")
finally:
print("finallyは実行された")
実行して3件目の途中でCtrl+Cを押すと、手元では次のように表示されました。
1件目を処理中...
2件目を処理中...
3件目を処理中...
finallyは実行された
Traceback (most recent call last):
File "t1.py", line 5, in <module>
time.sleep(1)
KeyboardInterrupt
Exceptionで捕まえた、という表示は出ていません。それでもfinallyはきちんと実行され、そのあとでtracebackが表示されています。
ファイルを開くときに使うwith文も、同じように後片付けをしてくれます。with open()で開いたファイルは、途中でCtrl+Cを押されてもきちんと閉じられます。
自分で後片付けの仕組みを作りたい方は、こちらの記事が役に立ちます。 【関連記事】Pythonのcontextmanagerとは?with文で後片付けを自動化する方法
KeyboardInterruptを受け止めて静かに終わる¶
利用者向けのツールでは、長いtracebackを見せずに終わりたい場面もあります。その場合は、except KeyboardInterruptと名前をはっきり書いて受け止めます。
次の例は、集計の途中で止められたら、そこまでの件数を表示して終わるプログラムです。
import sys
import time
def main():
done = 0
try:
for item in range(1, 1001):
time.sleep(0.5) # 重い処理のかわり
done += 1
except KeyboardInterrupt:
print(f"\n中断しました。{done}件まで処理済みです。")
sys.exit(130)
print(f"{done}件すべて処理しました。")
if __name__ == "__main__":
main()
ポイントは、受け止めたあとにsys.exit(130)で終わっている点です。130という数字の意味は、次の章で説明します。
try-exceptの基本の流れや、elseとfinallyの使い分けは、こちらの記事でまとめています。 【関連記事】Pythonのtry・except・else・finallyとは?例外処理の基本の流れ
終了コード130の意味¶
プログラムが終わるとき、OSには終了コードという番号が渡されます。0なら成功、それ以外なら何かあったという約束です。
LinuxやmacOSのシェルでは、シグナルで止められたプログラムの終了コードは128にシグナルの番号を足した値になります。SIGINTの番号は2なので、Ctrl+Cで止まったときは130になります。
手元で、さきほどのfinallyのプログラムを止めたあとにecho $?で確かめると、130と表示されました。Python 3.8からは、KeyboardInterruptを誰も捕まえずに終わった場合、呼び出し元にCtrl+Cで止まったことが伝わる終わり方をするようになっています。
これが役に立つのは、シェルスクリプトなどからPythonを呼び出すときです。呼び出し元は終了コードを見て、人が止めたのかどうかを区別できます。
だからこそ、さきほどの例では自分でKeyboardInterruptを受け止めたあとも、sys.exit(130)を選びました。sys.exit(0)にしてしまうと、途中で止めたのに成功したと伝わってしまいます。止めたときは止めたと正直に伝えるのが、ほかの仕組みと仲良くするコツです。
signalモジュールで止まり方を変える¶
ここまでは、Pythonが用意した係にまかせる方法でした。signalモジュールを使うと、SIGINTを受け取ったときの動きを自分で決めることもできます。
1回目は予約、2回目で強制終了にする¶
長い処理の途中で止めると、データが中途半端な状態で残ることがあります。そこで、1回目のCtrl+Cでは今の1件を終えてから止まり、2回目で即座に止まる、という作りがよく使われます。
import signal
import time
stop_requested = False
def handle_sigint(signum, frame):
global stop_requested
if stop_requested:
raise KeyboardInterrupt
stop_requested = True
print("\n今の1件が終わったら止まります。すぐ止めるにはもう一度Ctrl+C")
signal.signal(signal.SIGINT, handle_sigint)
for i in range(1, 100):
if stop_requested:
print(f"{i - 1}件で区切りよく終了しました。")
break
print(f"{i}件目を処理中...")
time.sleep(1)
signal.signal()には、シグナルの種類と、受け取ったときに呼び出してほしい関数を渡します。
注意したいのは、シグナルを受け取る関数はメインスレッドでしか実行されないという点です。signal.signal()の登録も、メインスレッドから行う必要があります。
もうひとつ、signal.SIG_DFLを登録すると元の係に戻ると思いがちですが、そうではありません。SIG_DFLはOS本来の動きを意味するので、KeyboardInterruptを出さずにいきなり終了します。Pythonの係に戻したいときは、signal.default_int_handlerを登録し直しましょう。
環境ごとの違いと止まらないとき¶
最後に、実行する環境による違いと、Ctrl+Cが効かないときの考え方を見ておきます。ここは、学習中につまずきやすいポイントです。
Jupyter NotebookやGoogle Colabでは、Ctrl+Cではなく画面の停止ボタンやカーネルの中断を使います。それでも、裏側ではKeyboardInterruptが発生するので、セルの出力にKeyboardInterruptと表示されます。
WindowsのコマンドプロンプトやPowerShellでも、Ctrl+CでKeyboardInterruptが発生します。ただしシグナルの仕組みがLinuxとは異なるため、終了コードの130はLinuxやmacOSの話だと考えてください。
Ctrl+Cを押してもなかなか止まらないときは、次のような原因が考えられます。
| 状況 | 考えられる原因 |
|---|---|
| 何度押しても止まらない | except:やexcept BaseException:で握りつぶしている |
| しばらくしてから止まる | 時間のかかる処理が終わるまで例外が届かない |
| 別スレッドの処理が続く | KeyboardInterruptはメインスレッドで発生する |
2つ目は少しわかりにくいかもしれません。Pythonの係が例外を出すのは、Pythonのコードに戻ってきたタイミングです。そのため、ライブラリの中で重い計算をしている間は、止まるまで待たされることがあります。
私のチームでは、夜間に動かすデータ移行のスクリプトに、さきほどの1回目は予約という作りを入れるようにしています。作業中に止めたくなっても、1件の書き込みが半分だけ終わった状態にならないので、やり直しがぐっと楽になりました。
まとめ¶
KeyboardInterruptは、Ctrl+Cでプログラムを中断したときに発生する例外です。Ctrl+CでOSがSIGINTを送り、Pythonの係がそれを例外に変換しています。
KeyboardInterruptはBaseExceptionの子どもなので、except Exceptionでは捕まりません。逆に、例外の種類を書かないexcept:は中断まで握りつぶしてしまうので、使わないようにしましょう。
止められたときの後片付けは、finallyやwith文にまかせるのが基本です。利用者向けのツールでは、except KeyboardInterruptで受け止めて、終了コード130で終わる書き方も覚えておくと便利です。
Ctrl+Cを押したあとの表示は、もう怖いものではありません。中断されても困らないプログラムを意識できるようになれば、一歩上の書き手に近づけます。
ここまでお読みいただきありがとうございました。