# 26.6. `timeit` --- 小さなコード断片の実行時間計測

バージョン 2.3 で追加.

ソースコード: Lib/timeit.py

このモジュールは小さい Python コードをの時間を計測するシンプルな手段を提供しています。コマンドラインインターフェイス の他 呼び出しも可能 です。このモジュールは実行時間を計測するときに共通するいくつかの罠を回避します。O'Reilly 出版の Python Cookbook にある、Tim Peter による "Algorithms" 章も参照してください。

## 26.6.1. 基本的な例

次の例は コマンドラインインターフェイス を使って 3 つの異なる式の時間を測定する方法を示しています。

    $ python -m timeit '"-".join(str(n) for n in range(100))'
    10000 loops, best of 3: 40.3 usec per loop
    $ python -m timeit '"-".join([str(n) for n in range(100)])'
    10000 loops, best of 3: 33.4 usec per loop
    $ python -m timeit '"-".join(map(str, range(100)))'
    10000 loops, best of 3: 25.2 usec per loop

同じ事を Python インターフェイス を使って実現することもできます:

    >>> import timeit
    >>> timeit.timeit('"-".join(str(n) for n in range(100))', number=10000)
    0.8187260627746582
    >>> timeit.timeit('"-".join([str(n) for n in range(100)])', number=10000)
    0.7288308143615723
    >>> timeit.timeit('"-".join(map(str, range(100)))', number=10000)
    0.5858950614929199

ただし、`timeit` はコマンドラインインターフェイスを使った時だけ繰り返し回数を自動で決定する事に注意してください。例 節でより高度な例を説明しています。

## 26.6.2. Python インターフェイス

このモジュールは 3 つの有用な関数と 1 つの公開クラスを持っています:

`timeit.``timeit`(stmt='pass', setup='pass', timer=<default timer>, number=1000000)

  与えられた命令文、setup コードおよび timer 関数で `Timer` インスタンスを作成し、その `timeit()` メソッドを number 回実行します。

  バージョン 2.6 で追加.

`timeit.``repeat`(stmt='pass', setup='pass', timer=<default timer>, repeat=3, number=1000000)

  与えられた命令文、setup コードおよび timer 関数で `Timer` インスタンスを作成し、その `repeat()` メソッドを number 回実行することを repeat 回繰り返します。

  バージョン 2.6 で追加.

`timeit.``default_timer`()

  プラットフォーム依存の方法でデフォルトのタイマを定義します。 Windows の場合、 `time.clock()` はマイクロ秒の精度がありますが、 `time.time()` は 1/60 秒の精度しかありません。一方 Unix の場合、 `time.clock()` でも 1/100 秒の精度があり、 `time.time()` はもっと正確です。いずれのプラットフォームにおいても、 `default_timer()` 関数は CPU 時間ではなく通常の時間 (wall clock time) を返します。つまり、同じコンピュータ上で別のプロセスが動いている場合、測定に干渉する可能性があるということです。

class `timeit.``Timer`(stmt='pass', setup='pass', timer=<timer function>)

  小さなコード片の実行時間を計測するためのクラスです。

  コンストラクターは、計測する命令文、セットアップのための追加命令およびタイマー関数をとります。2つの命令文のデフォルトは `'pass'` です; タイマー関数はプラットフォーム依存です (モジュールの doctring を参照)。stmt および setup には、複数行の文字列リテラルを含まない限り `;` や改行で区切ることで複数の命令文を指定できます。

  最初の命令文の実行時間を計測するには、`timeit()` メソッドを使用します。`repeat()` メソッドは `timeit()` を複数回呼び出したい時に使用し、結果をリストで返します。

  バージョン 2.6 で変更: stmt と setup 引数は、引数なしの呼び出し可能オブジェクトも受け取れるようになりました。オブジェクトを与えると、そのオブジェクトへの呼び出しがタイマー関数に埋め込まれ、そしてその関数が `timeit()` によって実行されます。この場合、関数呼び出しが増えるために、オーバーヘッドが少し増えることに注意してください。

  `timeit`(number=1000000)

    メイン文を number 回実行した時間を計測します。このメソッドはセットアップ文を1回だけ実行し、メイン文を指定回数実行するのにかかった秒数を浮動小数で返します。引数はループを何回実行するかの指定で、デフォルト値は 100万回です。メイン文、セットアップ文、タイマー関数はコンストラクターで指定されたものを使用します。

    注釈

    デフォルトでは、`timeit()` は計測中、一時的に ガベージコレクション を停止します。この手法の利点は個々の計測結果がより比較しやすくなることです。欠点は、ガベージコレクションが関数の性能を計測するための重要な要素である場合があることです。それに該当する場合、setup 文字列の最初の命令文でガベージコレクションを有効にできます。以下に例を示します:

        timeit.Timer('for i in xrange(10): oct(i)', 'gc.enable()').timeit()

  `repeat`(repeat=3, number=1000000)

    `timeit()` を複数回繰り返します。

    これは `timeit()` を繰り返し呼び出したい時に有用で、結果をリストにして返します。最初の引数で何回 `timeit()` を呼ぶか指定します。第 2 引数で `timeit()` の引数 number を指定します。

    注釈

    結果のベクトルから平均値や標準偏差を計算して出力させたいと思うかもしれませんが、それはあまり意味がありません。多くの場合、最も低い値がそのマシンが与えられたコード断片を実行する場合の下限値です。結果のうち高めの値は、Python のスピードが一定しないために生じたものではなく、その他の計測精度に影響を及ぼすプロセスによるものです。したがって、結果のうち `min()` だけが見るべき値となるでしょう。この点を押さえた上で、統計的な分析よりも常識的な判断で結果を見るようにしてください。

  `print_exc`(file=None)

    計測対象コードのトレースバックを出力するためのヘルパーです。

    利用例:

        t = Timer(...)       # outside the try/except
        try:
            t.timeit(...)    # or t.repeat(...)
        except:
            t.print_exc()

    これが標準のトレースバックよりも優れている点は、コンパイルしたテンプレートのソース行が表示されることです。オプションの引数 file にはトレースバックの出力先を指定します。デフォルトは `sys.stderr` になります。

## 26.6.3. コマンドラインインターフェイス

コマンドラインからプログラムとして呼び出す場合は、次の書式を使います:

    python -m timeit [-n N] [-r N] [-s S] [-t] [-c] [-h] [statement ...]

以下のオプションが使用できます:

`-n` `N``,` `--number``=N`

  'statement' を実行する回数

`-r` `N``,` `--repeat``=N`

  タイマーを繰り返す回数 (デフォルトは 3)

`-s` `S``,` `--setup``=S`

  最初に1回だけ実行する文 (デフォルトは `pass`)

`-t````,` `--time```

  `time.time()` を使用する (Windows を除くすべてのプラットフォームのデフォルト)

`-c````,` `--clock```

  `time.clock()` を使用する(Windows のデフォルト)

`-v````,` `--verbose```

  時間計測の結果をそのまま詳細な数値でくり返し表示する

`-h````,` `--help```

  簡単な使い方を表示して終了する

文は複数行指定することもできます。その場合、各行は独立した文として引数に指定されたものとして処理します。クォートと行頭のスペースを使って、インデントした文を使うことも可能です。この複数行のオプションは `-s` においても同じ形式で指定可能です。

オプション `-n` でループの回数が指定されていない場合、10 回から始めて、所要時間が 0.2 秒になるまで回数を増やすことで適切なループ回数が自動計算されるようになっています。

`default_timer()` の結果は同じコンピュータ上で動作している別のプロセスに影響を受けることがあります。そのため、正確な時間を計測する必要がある場合に最善の方法は、時間の取得を数回くり返してその中の最短の時間を採用することです。 `-r` オプションはこれをおこなうもので、デフォルトのくり返し回数は3回になっています。多くの場合はデフォルトのままで充分でしょう。 Unix の場合 `time.clock()` を使って CPU 時間で測定することもできます。

注釈

pass 文の実行による基本的なオーバーヘッドが存在することに注意してください。ここにあるコードはこの事実を隠そうとはしていませんが、注意する必要があります。基本的なオーバーヘッドは引数なしでプログラムを起動することにより計測でき、それは Python のバージョンによって異なるでしょう。 Python 2.3 とそれ以前の Python の公平な比較をおこなう場合、古い Python では `-O` オプション (最適化 を参照) を付けて起動して `SET_LINENO` 命令の実行時間が含まれないようにする必要があります。

## 26.6.4. 例

最初に 1 回だけ実行されるセットアップ文を指定することが可能です:

    $ python -m timeit -s 'text = "sample string"; char = "g"'  'char in text'
    10000000 loops, best of 3: 0.0877 usec per loop
    $ python -m timeit -s 'text = "sample string"; char = "g"'  'text.find(char)'
    1000000 loops, best of 3: 0.342 usec per loop

    >>> import timeit
    >>> timeit.timeit('char in text', setup='text = "sample string"; char = "g"')
    0.41440500499993504
    >>> timeit.timeit('text.find(char)', setup='text = "sample string"; char = "g"')
    1.7246671520006203

同じことは `Timer` クラスとそのメソッドを使用して行うこともできます:

    >>> import timeit
    >>> t = timeit.Timer('char in text', setup='text = "sample string"; char = "g"')
    >>> t.timeit()
    0.3955516149999312
    >>> t.repeat()
    [0.40193588800002544, 0.3960157959998014, 0.39594301399984033]

以下の例は、複数行を含んだ式を計測する方法を示しています。ここでは、オブジェクトの存在する属性と存在しない属性に対してテストするために `hasattr()` と `try`/`except` を使用した場合のコストを比較しています:

    $ python -m timeit 'try:' '  str.__nonzero__' 'except AttributeError:' '  pass'
    100000 loops, best of 3: 15.7 usec per loop
    $ python -m timeit 'if hasattr(str, "__nonzero__"): pass'
    100000 loops, best of 3: 4.26 usec per loop

    $ python -m timeit 'try:' '  int.__nonzero__' 'except AttributeError:' '  pass'
    1000000 loops, best of 3: 1.43 usec per loop
    $ python -m timeit 'if hasattr(int, "__nonzero__"): pass'
    100000 loops, best of 3: 2.23 usec per loop

    >>> import timeit
    >>> # attribute is missing
    >>> s = """\
    ... try:
    ...     str.__nonzero__
    ... except AttributeError:
    ...     pass
    ... """
    >>> timeit.timeit(stmt=s, number=100000)
    0.9138244460009446
    >>> s = "if hasattr(str, '__bool__'): pass"
    >>> timeit.timeit(stmt=s, number=100000)
    0.5829014980008651
    >>>
    >>> # attribute is present
    >>> s = """\
    ... try:
    ...     int.__nonzero__
    ... except AttributeError:
    ...     pass
    ... """
    >>> timeit.timeit(stmt=s, number=100000)
    0.04215312199994514
    >>> s = "if hasattr(int, '__bool__'): pass"
    >>> timeit.timeit(stmt=s, number=100000)
    0.08588060699912603

定義した関数に `timeit` モジュールがアクセスできるようにするために、 import 文の入った setup パラメーターを渡すことができます:

    def test():
        """Stupid test function"""
        L = []
        for i in range(100):
            L.append(i)

    if __name__ == '__main__':
        import timeit
        print(timeit.timeit("test()", setup="from __main__ import test"))