一定間隔で処理の繰り返し

1. エグゼクティブサマリー

本記事では,Python の標準ライブラリ(timethreading)を用いて,一定間隔で処理を繰り返す方法を解説する.

単一スレッドでの定期実行の基本例と,別スレッドと組み合わせた応用例を2種類示す.

謝辞: 次のWebページに記載のソースコードを変更の上,掲載している.

https://qiita.com/miminashi/items/50a4f0906ab8f18b105d

2. 前準備(必要ソフトウェアの入手)

ここでは、最低限の事前準備について説明する。機械学習や深層学習を行う場合は、NVIDIA CUDA、Visual Studio、Cursorなどを追加でインストールすると便利である。これらについては別ページ https://www.kkaneko.jp/cc/dev/aiassist.htmlで詳しく解説しているので、必要に応じて参照してください。

Python 3.12 のインストール(Windows 上) [クリックして展開]

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

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

管理者権限コマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。

winget install --scope machine --id Python.Python.3.12 -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_pip=1 Include_test=0 Include_launcher=1 InstallLauncherAllUsers=1"

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

方法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' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

AIエディタ Windsurf のインストール(Windows 上) [クリックして展開]

Pythonプログラムの編集・実行には、AIエディタの利用を推奨する。ここでは、Windsurfのインストールを説明する。Windsurf がインストール済みの場合、この手順は不要である。

管理者権限コマンドプロンプトで以下を実行する。管理者権限のコマンドプロンプトを起動するには、Windows キーまたはスタートメニューから「cmd」と入力し、表示された「コマンドプロンプト」を右クリックして「管理者として実行」を選択する。

winget install --scope machine --id Codeium.Windsurf -e --silent --disable-interactivity --force --accept-source-agreements --accept-package-agreements --custom "/SP- /SUPPRESSMSGBOXES /NORESTART /CLOSEAPPLICATIONS /DIR=""C:\Program Files\Windsurf"" /MERGETASKS=!runcode,addtopath,associatewithfiles,!desktopicon"
powershell -Command "$env:Path=[System.Environment]::GetEnvironmentVariable('Path','Machine')+';'+[System.Environment]::GetEnvironmentVariable('Path','User'); windsurf --install-extension MS-CEINTL.vscode-language-pack-ja --force; windsurf --install-extension ms-python.python --force; windsurf --install-extension Codeium.windsurfPyright --force"

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

関連する外部ページ

Windsurf の公式ページ: https://windsurf.com/

本プログラムは Python 標準ライブラリ(timethreading)のみで動作するため,追加ライブラリのインストールは不要である.

3. 実行のための準備とその確認手順(Windows 前提)

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

第5章のソースコードをテキストエディタ(メモ帳,Windsurf 等)に貼り付け,hoge.py として保存する(文字コード:UTF-8).

3.2 実行コマンド

コマンドプロンプトでファイルの保存先ディレクトリに移動し,以下を実行する.

python hoge.py

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

確認項目期待される結果
プログラム起動後,5秒ごとの定期実行約5秒間隔で現在時刻(UTC)が繰り返し表示される
処理時間が5秒を超える場合(sleep(8)による模擬)処理完了後,次の5秒境界まで待ってから次の処理が開始される
別スレッドとの並行動作(第2・第3コード)1秒ごとに「hello, カウンタ値, カウンタ値」が表示され,5秒ごとに時刻が表示される
プログラムの停止Ctrl+C で終了できる

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

本プログラムは,指定した秒数(既定値:5秒)ごとに処理を繰り返す仕組みを,Python の threading モジュールで実装したものである.

第5章には3つのソースコードを掲載している.

いずれのコードも,worker 関数内の time.sleep(8) により処理に8秒かかる状況を模擬している.実際の用途では,この部分を定期的に実行したい処理に置き換える.

定期実行の間隔を変更するには,mainloop の呼び出し時に渡す引数(既定値:5)を変更する.

Python プログラムの実行

5. ソースコード

5.1 基本例:一定間隔での定期実行

import time
import threading

def worker():
    print(time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime()))
    time.sleep(8)

def mainloop(interval, f):
    base = time.time()
    while True:
        t = threading.Thread(target=f, daemon=True)
        t.start()
        t.join()
        time.sleep(interval - (time.time() - base) % interval)

mainloop(5, worker)

5.2 応用例1:定期実行と別スレッドの並行動作

次の動作は,基本例と同じである.

import time
import threading

c = 0
c2 = 0

def another():
    """ずっと動き続けるスレッド"""
    global c, c2
    while True:
        c += 1
        print(f"hello, {c}, {c2}")
        time.sleep(1)

def worker():
    """定期的に繰り返すスレッド"""
    global c2
    c2 += 1
    print(time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime()))
    time.sleep(8)

def mainloop(interval, f, bg):
    base = time.time()
    threading.Thread(target=bg, daemon=True).start()
    while True:
        t = threading.Thread(target=f, daemon=True)
        t.start()
        t.join()
        time.sleep(interval - (time.time() - base) % interval)

if __name__ == '__main__':
    mainloop(5, worker, another)

5.3 応用例2:別の書き方による同一機能の実装

応用例1と同じ機能を,別の書き方で実装した例である.

import time
import threading

c = 0
c2 = 0

def another():
    """ずっと動き続ける処理"""
    global c, c2
    while True:
        c += 1
        print(f"hello, {c}, {c2}")
        time.sleep(1)

def worker():
    """定期的に繰り返すスレッド"""
    print(time.strftime("%Y-%m-%d %H:%M:%S", time.gmtime()))
    time.sleep(8)

def mainloop():
    interval = 5
    base = time.time()
    while True:
        t = threading.Thread(target=worker, daemon=True)
        t.start()
        t.join()
        time.sleep(interval - (time.time() - base) % interval)

if __name__ == '__main__':
    threading.Thread(target=mainloop, daemon=True).start()
    another()

6. まとめ

一定間隔での定期実行

time.time() で基準時刻を記録し,処理完了後に次の実行タイミングまでの待機時間を計算することで,処理の所要時間に関わらず一定間隔での繰り返しを実現している.

スレッドによる並行処理

threading.Thread を用いて,定期的に繰り返す処理と常駐する処理を並行して動作させることができる.スレッドは daemon=True を指定してデーモンスレッドとする.

処理時間超過時の挙動

処理が指定間隔(5秒)以内に終わらなかったときは,さらに5秒待つ.t.join() により処理の完了を待ってから次の待機時間を計算するためである.

2つの実装パターン

応用例1では mainloop 関数の引数として常駐関数を渡し,応用例2では mainloop 自体をスレッドとして起動しメインスレッドで常駐関数を直接実行する.いずれも同じ機能を実現する.

時刻表示のフォーマット

time.strftimetime.gmtime() を組み合わせ,現在時刻を UTC で読みやすい形式(%Y-%m-%d %H:%M:%S)で表示している.