strings_sum_benchmark.py ダウンロード/コピー
strings_sum_benchmark.py をダウンロード
strings_sum_benchmark.py
strings_sum_benchmark.py
1#!/usr/bin/env python3
2"""
3概要:
4 繰り返し文字列を連結して構築する様々な手法のベンチマークを行います。
5詳細説明:
6 s = s + chunk のような単純な連結は、CPythonのインプレースな += の最適化を意図的に避けています。
7 これにより、イミュータブルな文字列の繰り返し連結がなぜ高コストになるかを示します。
8実行例:
9 python strings_sum_benchmark.py
10 python strings_sum_benchmark.py -n 1000000 -r 5
11関連リンク:
12 strings_sum_benchmark_usage
13"""
14
15from __future__ import annotations
16
17import argparse
18import statistics
19import time
20from io import StringIO
21from typing import Callable
22
23
24CHUNK = "#" * 80
25
26
27def concat_plus(n: int) -> str:
28 """
29 概要:
30 + 演算子を使用して文字列を連結します。
31 引数:
32 :param n: 連結するチャンクの数
33 :type n: int
34 戻り値:
35 :returns: 連結された文字列
36 :rtype: str
37 """
38 result = ""
39 for _ in range(n):
40 result = result + CHUNK
41 return result
42
43
44def concat_iadd(n: int) -> str:
45 """
46 概要:
47 += 演算子を使用して文字列を連結します。
48 引数:
49 :param n: 連結するチャンクの数
50 :type n: int
51 戻り値:
52 :returns: 連結された文字列
53 :rtype: str
54 """
55 result = ""
56 for _ in range(n):
57 result += CHUNK
58 return result
59
60
61def list_join(n: int) -> str:
62 """
63 概要:
64 リストにチャンクを追加し、joinメソッドを使用して文字列を連結します。
65 引数:
66 :param n: 連結するチャンクの数
67 :type n: int
68 戻り値:
69 :returns: 連結された文字列
70 :rtype: str
71 """
72 parts: list[str] = []
73 for _ in range(n):
74 parts.append(CHUNK)
75 return "".join(parts)
76
77
78def string_io(n: int) -> str:
79 """
80 概要:
81 StringIOを使用して文字列を連結します。
82 引数:
83 :param n: 連結するチャンクの数
84 :type n: int
85 戻り値:
86 :returns: 連結された文字列
87 :rtype: str
88 """
89 out = StringIO()
90 for _ in range(n):
91 out.write(CHUNK)
92 return out.getvalue()
93
94
95def benchmark(name: str, func: Callable[[int], str], n: int, repeat: int) -> None:
96 """
97 概要:
98 指定された関数を使用して文字列連結のベンチマークを実行します。
99 詳細説明:
100 実行結果の実行時間の中央値と最小値を標準出力に表示します。
101 引数:
102 :param name: ベンチマーク対象の手法名
103 :type name: str
104 :param func: チャンク数を引数に取り文字列を返す関数
105 :type func: Callable
106 :param n: 連結するチャンクの数
107 :type n: int
108 :param repeat: ベンチマークを繰り返す回数
109 :type repeat: int
110 戻り値:
111 :returns: なし
112 :rtype: None
113 例外:
114 :raises RuntimeError: 生成された文字列の長さが期待値と異なる場合に発生します
115 """
116 times: list[float] = []
117 expected_length = len(CHUNK) * n
118
119 for _ in range(repeat):
120 start = time.perf_counter()
121 result = func(n)
122 times.append(time.perf_counter() - start)
123 if len(result) != expected_length:
124 raise RuntimeError(f"{name}: unexpected result length")
125
126 print(
127 f"{name:<18} {statistics.median(times):10.6f} s "
128 f"min={min(times):10.6f} s"
129 )
130
131
132def main() -> None:
133 """
134 概要:
135 スクリプトのエントリポイントです。
136 詳細説明:
137 コマンドライン引数を解析し、各文字列連結手法のベンチマークを実行して結果を出力します。
138 戻り値:
139 :returns: なし
140 :rtype: None
141 """
142 parser = argparse.ArgumentParser(
143 description="Benchmark repeated concatenation of '#' * 80."
144 )
145 parser.add_argument("-n", "--count", type=int, default=100_000,
146 help="number of chunks (default: 100000)")
147 parser.add_argument("-r", "--repeat", type=int, default=3,
148 help="number of runs per method (default: 3)")
149 args = parser.parse_args()
150
151 if args.count < 0 or args.repeat < 1:
152 parser.error("count must be non-negative and repeat must be at least 1")
153
154 total_mib = len(CHUNK) * args.count / 1024**2
155 print(f"chunk = '#' * {len(CHUNK)}, count = {args.count:,}, output = {total_mib:.2f} MiB")
156 print(f"{'method':<18} {'median':>12} minimum")
157 print("-" * 56)
158
159 for name, func in (
160 ("s = s + chunk", concat_plus),
161 ("s += chunk", concat_iadd),
162 ("list.append + join", list_join),
163 ("StringIO.write", string_io),
164 ):
165 benchmark(name, func, args.count, args.repeat)
166
167
168if __name__ == "__main__":
169 main()