ポモドーロテクニックとは？

コロナ禍初期の2020年に広まった時間管理手法です。正確には1980年後半にフランチェスコ・チリロさんによって開発された手法ですが、コロナが蔓延し学校や職場が閉鎖されリモート勤務になった2020年以降に一気にこの手法が注目され、YouTubeやTwitchなどのオンライン動画配信プラットフォームでポモドーロタイマーを用いたコンテンツが多く上がりました。「ポモドーロ」という言葉はイタリア語でトマトを意味するそうで、この手法は欧米のキッチンではよく見られるトマト型のタイマーに由来しているそうです。

🍅ポモドーロ手法の特徴は主に以下のように機能します：

1. タスクの選択：作業したいタスクを選択します。

2. タイマーの設定：基本は２５分です。ただ作業内容によって４５分や１時間に設定したり人それぞれ自由です。

3. タスクに集中：タイマーがなるまで選択したタスクに集中します。

4. 短い休憩：基本は５分です。

5. 繰り返す：以上のプロセスを繰り返します。基本は４セットのポモドーロを完了したら長い休憩（通常は１５分から３０分）を取ります。

🍅ポモドーロ手法の利点は：

• 時間管理：時間を効率的に管理する手助けをします。

• 集中と生産性：短い作業時間が高い集中力と生産性を維持する事を助けます。

• バーンアウト（燃え尽き）の防止：定期的な休憩はバーンアウトを防ぎ、持続可能な作業ペースを保ちます。

• モチベーションの向上：タイマーはモチベーションを高め、タスクを完了するためのある種の緊急感を生み出します。

ポモドーロの使用例

YouTubeではこのような動画を見たことある人もいるかと思います。これも２５分の作業時間と５分間の休憩を４セットをこなす動画です。

私自身も数年前はポモドーロ手法を用いたプログラミングセッションをライブ配信したりしていました。プログラミングの場合は２５分だとかなり短いので大体は４５分の作業時間と１０分の休憩を挟んで２，３セットをこなしていました。
その時に使っていたポモドーロタイマーは他のデベロパーが構築したものを使わせてもらっていたので、いつか自分でもシンプルなものでもいいから作ってみたいと思っていました。

先月、少し時間が空いたのでFlaskを使ったシンプルなポモドーロタイマーを作ってみました。

コードの構築

まず大きく分けて３つのファイルから成り立っています。
バックエンドはPython言語、フロントエンドはFlaskと呼ばれるPython のWebフレームワーク、そしてタイマーを秒ごとにアップデートさせるファイルにはJavaScriptを使っています。

このNote記事ではバックエンドのパイソン言語コードを紹介していきます。

幾つかのセクションに分けて役割などを解説していきます。

ライブラリーの呼び込み

from flask import Flask, render_template
import time
import threading
import winsound

app = Flask(__name__)

必要なライブラリーを呼び込み、Flaskウェブアプリケーションのインスタンスを作成します。

デコレーターの使用

# define decorator
def log_method_call(func) -> callable:
    """ 
     A decorator that logs the method call and arguments.
     Parameters:
       func (function): The function to decorate.
     Returns:
       function: The decorated function.
       
       """
    def wrapper(*args, **kwargs) -> any:
        """ 
         Wrapper function that logs the method call and arguments.
         Parameters:
           *args (tuple): The positional arguments.
           **kwargs (dict): The keyword arguments.
         Returns:
           The result of the decorated function.
           """
        print(f"Calling {func.__name__} with arguments {args} and keywork arguments {kwargs}")
        return func(*args, **kwargs)
    return wrapper

まず一番最初にデコレーターを定義しました。デコレーターとは、すでに定義されている関数に処理の変更や追加を行う為のパイソン特融の機能です。
ここではコードフローを分かりやすくしたりデバッグしやすくするログ機能を付け加えるデコレーターを定義しています。
この先のコードに@log_method_callが数か所に出てきますが、これがデコレーターの機能をしています。

Pythonクラス

class PomodoroTimer():
    def __init__(self):
        # Initialize timer-related variables
        self.timer_message = ""
        self.remaining_time = 0
        self.timer_lock = threading.Lock()  # Add a lock for thread safety
        self.cycles = 4
        self.current_session = 0

    @log_method_call
    def update_timer(self, message, time_remaining) -> None:
        """ 
         Update the timer message and remaining time.
         Parameters:
           message (str): The message to display in the timer.
           time_remaining (int): The remaining time in seconds.
         Returns:
           None.
           """
        with self.timer_lock:
            self.timer_message = message
            self.remaining_time = time_remaining
            # print(f"Timer Updated: {self.timer_message}, Remaining Time: {self.remaining_time} seconds") 
    
    @log_method_call
    def play_bell_sound(self) -> None:
        """ 
         Play bell sound
           """
        winsound.PlaySound("bell.wav", winsound.SND_ASYNC)

    @log_method_call
    def format_time(self, seconds) -> str:
        """ 
         Format time in seconds as MM:SS
         Parameters:
           seconds (int): The time in seconds.
         Returns:
           str: The formatted time as MM:SS.
           """
        minutes, seconds = divmod(seconds, 60) # python built-in
        formatted_time = f"{minutes:02d}:{seconds:02d}"
        # print(f"Formatted Time: {formatted_time}")
        return formatted_time
    
    @log_method_call
    def countdown(self, phase, duration) -> None:
        """ 
         Run the countdown timer for the specified phase and duration.
         Parameters:
           phase (str): The phase of the timer (e.g. "Work Time" or "Break Time").
           duration (int): The duration of the timer in seconds.
         This method updates the timer display with the current phase, session couint,
         and remaining time every second during the countdown. 
         Returns:
           None.
           
           """
        start_time = time.time()

        while time.time() - start_time < duration:
            elapsed_time = time.time() - start_time
            time_remaining = max(0, int(duration - elapsed_time))

            # Update the timer with the current phase and remaining time
            session_info = f"Session {self.current_session} of {self.cycles}"
            self.update_timer(f"{phase} : {session_info} - {self.format_time(time_remaining)}", time_remaining)
            time.sleep(1)  # Update every second
            # print(f"Phase: {phase}, Elapsed Time: {elapsed_time}, Remaining Time: {time_remaining}")
    
    @log_method_call
    def pomodoro_timer(self) -> None:
        """ 
         Run the entire Pomo timer logic, including work and break phases alternating.
         Returns:
           None.
         It iterates through the specified numbe of cycles, executing the work and break phases, 
         along with brief pauses and bell sounds between each cycle.
           """
        # Display Welcome Message
        self.update_timer("Welcome to Pomo Code Sessions", 0)
        time.sleep(20)  # Add a pause for the welcome message
        self.play_bell_sound()

        # Iterate through the specified number of cycles
        for i in range(self.cycles):
            self.current_session = i + 1
            # Work Time
            work_phase, work_duration = "Work Time", 25 * 60
            self.countdown(work_phase, work_duration)

            if i < self.cycles - 1:
                self.play_bell_sound()

            # Add a brief pause before starting Break Time
            time.sleep(1)

            # Break Time
            break_phase, break_duration = "Break Time", 5 * 60
            self.countdown(break_phase, break_duration)

            if i < self.cycles - 1:
                self.play_bell_sound()
    
        # Display a message when the timer is finished
        self.update_timer("Great Job!", 0)

Classというコンセプトはオブジェクト指向プログラミングの基盤といっても過言ではありません。Classは新しいデータの型を構築する際の設計図（ブループリント）です。そしてClassから作られたモノ（オブジェクト）がインスタンスと呼ばれます。

コンストラクター

クラス内の一番最初には必ず

def __init__(self):

があります。これはコンストラクターと呼ばれるもので、特殊メソッドの一つです。主にClassの初期設定を行います。前回のNote記事でグローバル変数について話しましたが、グローバル変数と似ています。Class内に入るとグローバル変数ではなくインスタンス変数に変わります。

def __init__(self):
        # Initialize timer-related variables
        self.timer_message = ""
        self.remaining_time = 0
        self.timer_lock = threading.Lock()  # Add a lock for thread safety
        self.cycles = 4
        self.current_session = 0

上の例では５つのインスタンス変数を初期化しています。この変数が秒ごとに、もしくはポモドーロのサイクルを追うごとにアップデートされていきます。

メソッド

Classの中には以下の関数を定義するような部分が数か所見えるかと思います。

    @log_method_call
    def update_timer(self, message, time_remaining) -> None:
        """ 
         Update the timer message and remaining time.
         Parameters:
           message (str): The message to display in the timer.
           time_remaining (int): The remaining time in seconds.
         Returns:
           None.
           """
        with self.timer_lock:
            self.timer_message = message
            self.remaining_time = time_remaining
            # print(f"Timer Updated: {self.timer_message}, Remaining Time: {self.remaining_time} seconds") 

Classの中にあるdefは関数（Function）ではなくメソッドと呼ばれます。メソッドはデータを作成する際の実際の動作の仕方を定義します。このポモドーロタイマーのClass内には５つのメソッドを作りました。

    @log_method_call
    def play_bell_sound(self) -> None:
        """ 
         Play bell sound
           """
        winsound.PlaySound("bell.wav", winsound.SND_ASYNC)

例えば上のメソッドはシンプルにベル音を鳴らす為だけのメソッドです。
このように動作によって振り分けてメソッドを幾つか設定することによってClassというブループリントを構成しています。

ポモドーロタイマークラスのインスタンスを作成

# Create an instance of the PomodoroTimer class
pomodoro_time_instance = PomodoroTimer()

この行は PomodoroTimer クラスのインスタンスを作成し、デフォルトの値で初期化します。

Flask ルート ('/') を定義

# Route definition using the Flask web framework
@app.route('/')
def index():
    with pomodoro_time_instance.timer_lock:
        return render_template("index.html", timer_message=pomodoro_time_instance.timer_message)

ここでは Flask ウェブフレームワークを使用してルート URL ('/') を定義しています。ユーザーがこの URL にアクセスすると、index 関数が呼び出されます。関数は pomodoro_time_instance.timer_lock を使用してタイマー関連のデータに対するスレッドセーフを確保、そして別に用意してある"index.html" という名前の HTML テンプレートをレンダリングし、表示されるべきタイマーメッセージ (timer_message) を渡します。

メインブロック (if __name__ == '__main__':)

if __name__ == '__main__':
    # Start the timer thread
    timer_thread = threading.Thread(target=pomodoro_time_instance.pomodoro_timer)
    timer_thread.start()
    # Run the Flask app in debug mode during development mode
    # Disable it in a production environment for security reasons
    app.run(debug=True)

このブロックはスクリプトがメインプログラムとして実行されているかを確認します。pomodoro_timer メソッドを実行する新しいスレッド (timer_thread) が作成されます。このメソッドはポモドーロタイマーロジック全体を制御します。Flask ウェブアプリ (app) はデバッグモードで実行され (app.run(debug=True))、ウェブブラウザを介してアクセスできるようになります。タイマーロジックはバックグラウンドで実行されます。

実際に動画に反映させてみた

作業用にぜひ使ってみてください。

🖊️何か気づいたことやご意見などがあればコメント欄からお願いします。チャンネルフォローもよろしくお願いします。

🚀 疑問に思った事はデータ化して自分なりの答えを探していこうと思います。そしてその答えがどこかにいる誰かの為になる事を願っています。