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

目次

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

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

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

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

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

2. Python 3.12 のインストール

本章では、Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

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

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

インストールコマンドの実行方法

管理者権限コマンドプロンプトを起動する(手順:Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」)。そして、コマンド全体をコマンドプロンプトにコピー&ペーストする。

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

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; $c=[Environment]::GetEnvironmentVariable('Path','Machine'); if((Test-Path $p) -and (';'+$c+';' -notlike \"*;$p;*\") -and (';'+$c+';' -notlike \"*;$s;*\")){[Environment]::SetEnvironmentVariable('Path',\"$p;$s;$c\",'Machine')}"

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

以降の章では、必要に応じて題材に応じたソフトウェアを追加する。

3. Python の開発環境 Visual Studio Code のインストールと Python 用の設定

本章では、Python の開発環境Visual Studio Code(プログラムを編集するソフトウェア。以下、VS Code)を整える。

[Windows での Visual Studio Code のインストールと Python 用の設定手順を見るには、ここをクリック]

Windows での Visual Studio Code のインストールと Python 用の設定手順

1. VS Code と拡張機能のインストール

以下のコマンドにより,既存の VS Code を削除し,全ユーザー共有の設定で再インストールしたうえで,拡張機能(VS Code に機能を追加するソフトウェア)をまとめて導入する.

インストールコマンドの実行方法

管理者権限コマンドプロンプトを起動する(手順:Windows キーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」)。そして,コマンド全体をコマンドプロンプトにコピー&ペーストする。

インストールコマンド


REM ============================================================
REM Microsoft Visual Studio Code
REM ============================================================
winget uninstall -e --id Microsoft.VisualStudioCode --silent --disable-interactivity --accept-source-agreements
rmdir /s /q C:\ProgramData\vscode-extensions 2>nul
rmdir /s /q "%APPDATA%\Code" 2>nul
rmdir /s /q "%USERPROFILE%\.vscode" 2>nul
rmdir /s /q "%LOCALAPPDATA%\Microsoft\vscode-update" 2>nul

REM VS Code をシステム領域に新規インストール
winget install --scope machine --id Microsoft.VisualStudioCode -e --silent --accept-source-agreements --accept-package-agreements

REM 全ユーザー共有の拡張機能フォルダ
mkdir C:\ProgramData\vscode-extensions 2>nul
icacls "C:\ProgramData\vscode-extensions" /grant "Everyone:(OI)(CI)M" /T

REM スタートメニューのショートカットを --extensions-dir 付きで再作成
rmdir /s /q "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code" 2>nul
del "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk" 2>nul
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); $lnk.TargetPath='C:\Program Files\Microsoft VS Code\Code.exe'; $lnk.Arguments='--extensions-dir \"C:\ProgramData\vscode-extensions\"'; $lnk.Save()"
REM ショートカットの検証
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); Write-Host 'TargetPath:' $lnk.TargetPath; Write-Host 'Arguments:' $lnk.Arguments"

REM ファイル / フォルダ右クリックの「Code で開く」を登録
reg add "HKLM\SOFTWARE\Classes\*\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\Background\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%V\"" /f

REM --extensions-dir 付きで起動する code.cmd ラッパを作成
REM (%* を echo で書くと対話的 cmd で失われるため、PowerShell で [char]37+'*' を書き出す)
powershell -NoProfile -Command "$pct=[char]37; $q=[char]34; $c='@echo off'+[char]13+[char]10+$q+'C:\Program Files\Microsoft VS Code\bin\code.cmd'+$q+' --extensions-dir '+$q+'C:\ProgramData\vscode-extensions'+$q+' '+$pct+'*'+[char]13+[char]10; [IO.File]::WriteAllText('C:\ProgramData\vscode-extensions\vscode.cmd',$c,[Text.Encoding]::ASCII)"

REM 拡張機能のインストール
set "CODE=C:\Program Files\Microsoft VS Code\bin\code.cmd"
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot-chat
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.python
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.vscode-pylance
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.debugpy
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension MS-CEINTL.vscode-language-pack-ja
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension saoudrizwan.claude-dev
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension rust-lang.rust-analyzer
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension tamasfe.even-better-toml
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension anthropic.claude-code
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension almenon.arepl
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --list-extensions --show-versions
echo === セットアップ完了 ===

2. Python インタプリタの選択

同一マシンに複数の Python がインストールされている場合,VS Code で使用する Python 本体(インタプリタ:Python プログラムを解釈・実行するソフトウェア)を選択する必要がある.

  1. コマンドパレット(コマンド名で機能を呼び出す VS Code の入力欄)を開く(Ctrl+Shift+P
  2. Python: Select Interpreter と入力する
  3. 表示される一覧から,使用する Python(例:C:\Program Files\Python312\python.exe)を選択する.

以降の章では、必要に応じて題材に応じた必要なソフトウェアを追加する。

4. Python プログラム実行手順

[Windows での Python プログラム実行手順を見るには、ここをクリック]

Windows での Python 実行手順(Visual Studio Codeを使用)

プログラムファイルの作成と保存

  1. 左サイドバーの「エクスプローラー」アイコン(Ctrl+Shift+E)をクリックする
  2. 「NO FOLDER OPENED」(作業対象フォルダが未選択の状態)と表示される場合は,「Open Folder」をクリックし,プログラムを保存するフォルダを選択する

    続いて「フォルダを信用するか」を確認する画面(フォルダ内のコードを実行してよいか確認する VS Code の仕組み)が表示されるので,チェックして Yes を選択する

  3. フォルダ名の右側に表示される「新しいファイル」アイコンをクリックする
  4. ファイル名(例:aitask.py.ファイル名は何でも良い)を入力し Enter を押す.拡張子は .py(Python ファイルを示す拡張子)とする
  5. 実行したいコードを選択し,Ctrl+C でコピーする.VS Code のエディタ領域に Ctrl+V で貼り付ける
  6. Ctrl+S で保存する

プログラムの実行

  1. エディタ右上の三角形「▷」アイコン(Run Python File:現在開いている Python ファイルを実行するボタン)をクリックする.または,エディタ上で右クリックし「ターミナルで Python ファイルを実行」を選択する
  2. VS Code 下部のターミナル(コマンドの入出力を表示する画面)に,実行結果(print 関数の出力等)が表示される
  3. tkinter(Python 標準の GUI ライブラリ)のファイル選択ダイアログを使うプログラムを実行した場合は,ダイアログが開くので対象画像を選択する
  4. VS Code 下部のターミナルで実行結果を確認する.OpenCV ウィンドウ(OpenCV が画像を表示するために開く専用ウィンドウ)が開いた場合はそちらも確認する.OpenCV ウィンドウは,マウスクリックでウィンドウをアクティブ(操作対象の状態)にしてからキーを押すと終了する

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

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

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

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

5.2 実行コマンド

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

python hoge.py

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

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

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

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

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

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

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

Python プログラムの実行

7. ソースコード

7.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)

7.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)

7.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():
    """定期的に繰り返すスレッド"""
    global c2
    c2 += 1
    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()

8. まとめ

一定間隔での定期実行

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)で表示している.