Pythonのsleep関数とは？実行方ほについてご紹介

システム
エンジニア

Pythonのsleep関数を使うと何ができるのですか。

プロジェクト
マネージャー

Pythonのsleep関数を使うと、指定した秒数のあいだ処理を停止したり、一定の間隔で処理を繰り返したり、指定した時間に処理を実行することができます。

sleep関数とは？

Pythonのsleep関数は、実行中の処理を一時的に停止することができる、timeモジュールの関数です。

timeモジュールとは、時間に関係した処理をまとめたモジュールです。Pythonでは、sleep関数を使用することで、処理の負荷を軽くしたり、後続処理の実行時間を予約したりすることができます。

Pythonのsleep関数の使い方

Pythonのsleep関数は、timeモジュールをインポートしたあとに、引数をわたして実行します。

引数として、int型もしくはfloat型の数字をわたすことができます。sleep関数は実行した際に、引数の秒数だけ処理を停止します。例えば、引数に5.12をわたした場合は、5.12秒間停止します。

繰り返し処理のなかでsleep関数を実行すれば、連続実行される処理のあいだに、バッファを設けることができます。これによりCPUへの負荷を減らすことが期待できます。

規定の時間に処理を実行したい場合は、sleep関数を使えば実現することができます。実行予定時刻と現在時刻の差を、sleep関数の引数として使用すれば、実行予定時刻まで後続の処理を待機させることができます。

指定した秒数のあいだ、処理を停止する方法

Pythonのsleep関数を使うことで、指定した秒数のあいだ、処理を停止することができます。

さっそく、実際にソースコードをかいていきましょう。

上記の例では、まずtimeモジュールとdatetimeモジュールをインポートしています。datetimeモジュールは、次の行のprint文で現在時刻を取得するために、インポートしています。

それからsleep関数を使って、処理を10秒間停止したあとに、もう一度現在時刻を取得します。

出力結果を確認すると、2度の表示時間に10秒ほどの間隔があいていることがわかります。

もしかすると、print('10秒間、停止します。')のprint文で、処理に10秒ほどかかってしまったのかもしれません。それでは、sleep関数を使用しなければ、出力結果はどうなるでしょうか。実際にためしてみましょう。

上記の例では、#time.sleep(10)で、sleep関数をコメントアウトしています。そのほかは、前出の例と同じプログラムを実行しています。

出力結果を確認してみると、2度の表示時間が同じになっています。これはdatetimeモジュールで取得した有効数字では、差が表れないほど、一瞬で処理が終了しているということです。前出の例と比較すると、Pythonのsleep関数の効果が確認できます。

一定の間隔で処理を繰り返し実行する方法

Pythonのsleep関数を使うことで、繰り返し処理を、一定の間隔で実行することができます。

さっそく、実際にソースコードをかいていきましょう。

上記の例では、まずモジュールをインポートしたあと、for文を使って、処理を5回、繰り返しています。繰り返し処理のなかでは、実行回数と現在時刻を表示するprint文と、sleep関数が実行されています。

実行結果を確認すると、それぞれのprint文が、10秒ごとに実行されていることがわかります。このようにバッファを設けることで、CPUにかかる負荷を軽くすることが期待できます。

指定した時間に処理を実行する方法

Pythonのsleep関数を使うことで、現在時刻と実行時間の差から、指定した時間に処理を実行することができます。

さっそく、実際にソースコードをかいていきましょう。

上記の例では、これまでと同様のモジュールをインポートしたあと、変数now_timeに現在時刻を、変数exec_time に実行時間を設定しています。ここでは、datetimeオブジェクトのコンストラクタとして、(year, month, day, hour, minute, second, microsecond)の順で実行時間を設定しています。

次に、now_timeとexec_time の差を計算し、変数sleep_timeに停止時間として設定しています。

ここで注意しなければならないことがあります。now_timeとexec_time はdatetimeオブジェクトとして作成されましたが、sleep_timeには、timedeltaオブジェクトとして結果が格納されていることです。

timedeltaオブジェクトは、経過時間を保持するオブジェクトです。そのため、timedeltaオブジェクトのメソッドtotal_seconds()が使用できます。total_seconds()で処理を停止する秒数を取得し、sleep関数を実行しています。

実行結果を確認すると、実行予定時間の2021-02-20 15:30:00に、実行時間になりました！と出力されていることがわかります。このようにsleep関数を使えば、指定した時間になるまで処理を停止することができます。

システム
エンジニア

Pythonのsleep関数を使ってできることがよく分かりました。

プロジェクト
マネージャー

ご紹介したソースコードを参考に、ご自身でもソースコードを書いてみてください。

まとめ

いかがでしたでしょうか。Pythonのsleep関数の使い方として、指定した秒数のあいだ処理を停止する方法、一定の間隔で処理を繰り返し実行する方法、指定した時間に処理を実行する方法を紹介しました。

Pythonのsleep関数を使えば、CPUへの負荷を軽減したり、指定した時間まで処理を停止することができます。ぜひご自身でソースコードを書いて、動作を確認してみてください。