joerick/pyinstrument

これは何？

主な機能

• 01低オーバーヘッドでコールスタックをサンプリングし、関数ごとの所要時間をレポートします。
• 02コンソール、インタラクティブHTML、JSON、pstats、speedscope形式で出力できます。
• 03asyncに対応したプロファイリングにより、待機時間を適切な呼び出しに割り当てます。
• 04コマンドラインからスクリプト全体を、または`with`文やデコレーターで特定のコードブロックをプロファイルできます。
• 05Django middlewareおよびIPython/Jupyterのマジックコマンドと統合できます。
• 06デフォルトでライブラリのフレームを隠し、アプリケーションコードを見つけやすくします。

ユースケース

• 実行に時間がかかるPythonスクリプトの遅い関数を特定する。
• Djangoのviewやmiddlewareをプロファイルし、リクエスト時間の内訳を確認する。
• タスクがI/O待ちに時間を費やす遅いasyncコードを調査する。
• Jupyter上でノートブックのセルのパフォーマンスを直接確認する。

クイックスタート

1. 1

   PyPIからpyinstrumentをインストールする

   pip install pyinstrument
2. 2

   コマンドラインからスクリプトをプロファイルする

   pyinstrument script.py

使う前に知っておきたいこと

• !READMEには、タイミング関連のシステムコールが遅いため、Dockerコンテナ内でプロファイリングすると異常な結果になることがあると記載されています。
• !pyinstrumentで実行したスクリプト内のクラスをpickle化すると、`__main__`のシリアライズエラーが発生する場合があります。

収録されている特集

トピック

よくある質問

pyinstrument とは？

Pythonコードのどこで時間がかかっているかを、コンソールやHTMLなどで確認できるコールスタックプロファイラー。 PyinstrumentはPython向けの統計型プロファイラーです。プログラムの実行中にコールスタックをサンプリングし、経過時間の大部分を占める関数をレポートするため、コードの中で最も遅い部分に絞って最適化できます。

pyinstrument は無料で使えますか？ライセンスは？

pyinstrument は BSD-3-Clause ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

pyinstrument は今もメンテナンスされていますか？

活発にメンテナンス中。pyinstrument の最終コミットは 2026年11月1日 です。

pyinstrument は何に使えますか？

実行に時間がかかるPythonスクリプトの遅い関数を特定する。 Djangoのviewやmiddlewareをプロファイルし、リクエスト時間の内訳を確認する。 タスクがI/O待ちに時間を費やす遅いasyncコードを調査する。 Jupyter上でノートブックのセルのパフォーマンスを直接確認する。

pyinstrument のインストール方法は？

PyPIからpyinstrumentをインストールする: pip install pyinstrument コマンドラインからスクリプトをプロファイルする: pyinstrument script.py

pyinstrument はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/joerick/pyinstrument