日時

[Python] timeitモジュールの使い方 – コードの処理時間の計測

timeitモジュールは、Pythonコードの実行時間を正確に計測するための標準ライブラリです。

主にコードのパフォーマンス比較や最適化に使用されます。

timeit.timeit()関数を使うと、指定したコードを複数回実行し、その平均実行時間を取得できます。

引数には計測対象のコード(文字列形式)と、必要に応じて準備コード(setup引数)を指定します。

また、timeit.repeat()を使うと、複数回の計測結果をリストで取得可能です。

コマンドラインからも利用できます。

目次から探す

timeitモジュールとは

timeitモジュールは、Pythonにおいてコードの実行時間を計測するための便利なツールです。

このモジュールを使用することで、特定のコードスニペットの実行速度を簡単に測定し、パフォーマンスの最適化に役立てることができます。

特に、アルゴリズムの効率性を比較したり、異なる実装の速度を評価したりする際に非常に有用です。

timeitモジュールは、以下のような特徴を持っています。

簡単なインターフェース: コードを簡単に計測できるシンプルなAPIを提供しています。
高精度な計測: 複数回の実行を行い、平均値を算出することで、より正確な結果を得ることができます。
自動的なガーベジコレクション: 実行時に不要なオブジェクトを自動的に処理し、計測結果に影響を与えないようにします。

このモジュールは、特にパフォーマンスが重要なアプリケーションや、最適化が必要なコードの分析に役立ちます。

次のセクションでは、timeitモジュールの基本的な使い方について詳しく見ていきます。

timeitモジュールの基本的な使い方

timeitモジュールを使用することで、特定のコードの実行時間を簡単に計測できます。

基本的な使い方は、以下の手順で行います。

モジュールのインポート

まず、timeitモジュールをインポートします。

以下のコードを実行することで、timeitモジュールを使用する準備が整います。

import timeit

計測したいコードの定義

次に、計測したいコードを文字列として定義します。

例えば、リストの合計を計算するコードを考えてみましょう。

code_to_test = """
total = 0
for i in range(1000):
    total += i
"""

timeitを使って実行時間を計測

timeitモジュールのtimeit関数を使用して、定義したコードの実行時間を計測します。

以下のように記述します。

execution_time = timeit.timeit(code_to_test, number=10000)
print(f"実行時間: {execution_time}秒")

このコードでは、code_to_testを10,000回実行し、その合計実行時間を計測しています。

以下に、上記の手順をまとめたサンプルコードを示します。

import timeit
# 計測したいコード
code_to_test = """
total = 0
for i in range(1000):
    total += i
"""
# 実行時間を計測
execution_time = timeit.timeit(code_to_test, number=10000)
print(f"実行時間: {execution_time}秒")

実行時間: 0.123456秒

timeitモジュールを使用することで、簡単にコードの実行時間を計測できることがわかります。

次のセクションでは、実際の計測例を通じて、より具体的な使い方を見ていきます。

コード計測の実践例

ここでは、timeitモジュールを使用して、異なるアルゴリズムの実行時間を比較する実践例を紹介します。

具体的には、リストの要素を合計する2つの異なる方法を計測します。

1つはループを使用した方法、もう1つは組み込み関数sum()を使用した方法です。

ループを使用した合計計算

まず、ループを使用してリストの合計を計算するコードを定義します。

code_loop = """
total = 0
numbers = list(range(1000))
for number in numbers:
    total += number
"""

sum()関数を使用した合計計算

次に、Pythonの組み込み関数sum()を使用して同じリストの合計を計算するコードを定義します。

code_sum = """
numbers = list(range(1000))
total = sum(numbers)
"""

実行時間の計測

それぞれのコードの実行時間を計測します。

以下のように記述します。

import timeit
# ループを使用した合計計算の実行時間
loop_time = timeit.timeit(code_loop, number=10000)
print(f"ループを使用した合計計算の実行時間: {loop_time}秒")
# sum()関数を使用した合計計算の実行時間
sum_time = timeit.timeit(code_sum, number=10000)
print(f"sum()関数を使用した合計計算の実行時間: {sum_time}秒")

以下に、上記の手順をまとめたサンプルコードを示します。

import timeit
# ループを使用した合計計算
code_loop = """
total = 0
numbers = list(range(1000))
for number in numbers:
    total += number
"""
# sum()関数を使用した合計計算
code_sum = """
numbers = list(range(1000))
total = sum(numbers)
"""
# 実行時間を計測
loop_time = timeit.timeit(code_loop, number=10000)
print(f"ループを使用した合計計算の実行時間: {loop_time}秒")
sum_time = timeit.timeit(code_sum, number=10000)
print(f"sum()関数を使用した合計計算の実行時間: {sum_time}秒")

ループを使用した合計計算の実行時間: 0.456789秒
sum()関数を使用した合計計算の実行時間: 0.123456秒

この結果から、sum()関数を使用した方が、ループを使用した場合よりもはるかに高速であることがわかります。timeitモジュールを活用することで、異なる実装のパフォーマンスを簡単に比較できることが確認できました。

次のセクションでは、timeitモジュールを使用する際の注意点について説明します。

timeitモジュールを使う際の注意点

timeitモジュールを使用する際には、いくつかの注意点があります。

これらを理解しておくことで、より正確な計測結果を得ることができます。

以下に主な注意点を挙げます。

実行回数の設定

timeit関数のnumber引数は、計測するコードを何回実行するかを指定します。少なすぎる回数では、実行時間が短すぎてノイズの影響を受けやすくなります。

逆に、多すぎる回数では、計測に時間がかかりすぎることがあります。

一般的には、数千回から数万回の実行が推奨されます。

ガーベジコレクションの影響

Pythonは自動的にメモリ管理を行うため、ガーベジコレクションが実行されるタイミングによって計測結果が変わることがあります。

timeitモジュールは、デフォルトでガーベジコレクションを無効にするオプションを提供しています。

これにより、より安定した計測が可能になります。

ガーベジコレクションを無効にするには、以下のようにtimeit関数を呼び出します。

execution_time = timeit.timeit(code_to_test, number=10000, globals=globals(), disable_gc=True)

環境の影響

計測を行う環境(CPUの負荷、メモリの使用状況など)によって、実行時間が変わることがあります。

特に、他のプロセスがCPUを使用している場合、計測結果に影響を与える可能性があります。

計測を行う際は、できるだけ他のアプリケーションを閉じ、安定した環境で実行することが望ましいです。

コードの最適化

Pythonインタプリタは、実行時にコードを最適化することがあります。

これにより、同じコードでも実行時間が異なる場合があります。

特に、短いコードスニペットでは、最適化の影響を受けやすいです。

計測するコードは、実際の使用ケースに近い形で記述することが重要です。

結果の解釈

計測結果は、単に実行時間を示すだけでなく、他の実装との比較や、アルゴリズムの効率性を評価するための指標としても利用できます。

しかし、実行時間が短いからといって必ずしもその実装が最適であるとは限りません。メモリ使用量や可読性など、他の要素も考慮する必要があります。

これらの注意点を理解し、適切にtimeitモジュールを活用することで、より信頼性の高いパフォーマンス計測が可能になります。

次のセクションでは、コマンドラインでのtimeitモジュールの利用方法について説明します。

コマンドラインでのtimeitモジュールの利用

timeitモジュールは、Pythonのスクリプト内だけでなく、コマンドラインからも簡単に利用できます。

これにより、特定のコードスニペットの実行時間を素早く計測することが可能です。

以下に、コマンドラインでの基本的な使い方を説明します。

コマンドラインでの実行方法

コマンドラインからtimeitモジュールを使用するには、python -m timeitコマンドを使用します。

基本的な構文は以下の通りです。

python -m timeit -s "セットアップコード" "計測したいコード"

-sオプションは、計測前に実行するセットアップコードを指定します。
セットアップコードは、計測するコードが依存する変数や関数を定義するために使用します。
計測したいコードは、実行時間を測定したい具体的なコードスニペットです。

実際の例

例えば、リストの合計を計算するコードをコマンドラインで計測する場合、以下のように実行します。

python -m timeit -s "numbers = list(range(1000))" "total = sum(numbers)"

このコマンドでは、まずnumbersというリストをセットアップし、その後sum(numbers)の実行時間を計測します。

出力結果の解釈

コマンドを実行すると、以下のような出力が得られます。

10000 loops, best of 3: 20.1 usec per loop

この出力は、以下の情報を含んでいます。

10000 loops: 計測した回数
best of 3: 3回の計測の中で最も良い結果
20.1 usec per loop: 1回のループあたりの平均実行時間(マイクロ秒単位)

その他のオプション

コマンドラインでのtimeitモジュールには、いくつかの便利なオプションがあります。

主なものを以下に示します。

-n: 1回の計測で実行するループの回数を指定します。
-r: 計測を繰り返す回数を指定します。
-h: ヘルプを表示します。

例えば、1回の計測で5000回実行し、3回の繰り返しを行う場合は、以下のように指定します。

python -m timeit -n 5000 -r 3 -s "numbers = list(range(1000))" "total = sum(numbers)"

コマンドラインからtimeitモジュールを利用することで、簡単にコードの実行時間を計測できることがわかります。

特に、スクリプトを作成することなく、手軽にパフォーマンスを評価できる点が魅力です。

次のセクションでは、timeitモジュールの応用的な使い方について説明します。

応用的な使い方

timeitモジュールは、基本的な使い方だけでなく、さまざまな応用的な使い方も可能です。

ここでは、いくつかの応用例を紹介します。

これにより、より複雑なシナリオでの計測や、特定のニーズに応じた使い方が理解できるようになります。

複数のコードスニペットの比較

複数の異なる実装を比較する場合、timeitモジュールを使ってそれぞれの実行時間を計測し、結果を比較することができます。

以下の例では、リストの合計を計算する2つの方法を比較します。

import timeit
# ループを使用した合計計算
code_loop = """
total = 0
numbers = list(range(1000))
for number in numbers:
    total += number
"""
# sum()関数を使用した合計計算
code_sum = """
numbers = list(range(1000))
total = sum(numbers)
"""
# 実行時間を計測
loop_time = timeit.timeit(code_loop, number=10000)
sum_time = timeit.timeit(code_sum, number=10000)
print(f"ループを使用した合計計算の実行時間: {loop_time}秒")
print(f"sum()関数を使用した合計計算の実行時間: {sum_time}秒")

このように、異なる実装のパフォーマンスを比較することで、最適な方法を選択することができます。

クラスメソッドの計測

timeitモジュールは、クラスのメソッドの実行時間を計測することも可能です。

以下の例では、クラス内のメソッドを計測します。

import timeit
class Calculator:
    def sum_numbers(self, n):
        total = 0
        for i in range(n):
            total += i
        return total
# インスタンスを作成
calc = Calculator()
# メソッドの実行時間を計測
execution_time = timeit.timeit(lambda: calc.sum_numbers(1000), number=10000)
print(f"メソッドの実行時間: {execution_time}秒")

このように、クラスメソッドを計測する際は、lambda関数を使用してメソッドを呼び出すことができます。

複雑なセットアップコード

計測するコードが複雑な場合、セットアップコードを使用して必要な環境を整えることができます。

以下の例では、NumPyを使用して大きな配列を生成し、その合計を計測します。

import timeit
import numpy as np
# セットアップコード
setup_code = "import numpy as np; arr = np.random.rand(1000000)"
# 計測するコード
code_to_test = "total = np.sum(arr)"
# 実行時間を計測
execution_time = timeit.timeit(code_to_test, setup=setup_code, number=100)
print(f"NumPyを使用した合計計算の実行時間: {execution_time}秒")

このように、セットアップコードを使うことで、複雑な初期化を行った後に計測を行うことができます。

結果の可視化

計測結果を可視化することで、パフォーマンスの違いをより明確に理解することができます。

以下の例では、matplotlibを使用して結果をグラフ化します。

import timeit
import matplotlib.pyplot as plt
# 計測するコード
code_loop = """
total = 0
numbers = list(range(1000))
for number in numbers:
    total += number
"""
code_sum = """
numbers = list(range(1000))
total = sum(numbers)
"""
# 実行時間を計測
loop_time = timeit.timeit(code_loop, number=10000)
sum_time = timeit.timeit(code_sum, number=10000)
# 結果を可視化
methods = ['ループ', 'sum()関数']
times = [loop_time, sum_time]
plt.bar(methods, times, color=['blue', 'orange'])
plt.ylabel('実行時間 (秒)')
plt.title('異なる合計計算方法の実行時間比較')
plt.show()

このように、計測結果をグラフ化することで、視覚的にパフォーマンスの違いを把握することができます。

timeitモジュールは、基本的な使い方だけでなく、さまざまな応用が可能です。

複数のコードスニペットの比較、クラスメソッドの計測、複雑なセットアップコードの使用、結果の可視化など、さまざまなシナリオで活用できます。

これにより、パフォーマンスの最適化やアルゴリズムの評価がより効果的に行えるようになります。