Repolode
gruns

gruns/icecream

変数名や式とその値を、整形・構文ハイライト付きで表示するPythonデバッグヘルパー。ic()でprint()を置き換えられます。

スター
10,109
フォーク
235
未解決の Issue
77
最終コミット
一昨日

これは何?

IceCreamは、print()をより便利に置き換えるic()関数を中心としたPythonデバッグライブラリです。変数や式を渡すと、ic()はソーステキストと評価結果を並べて出力するため、ラベルを手入力しなくても何が渡されたのか確認できます。データ構造は整形され、出力には構文ハイライトが適用されます。

引数なしで呼び出すと、呼び出し元のファイル名、行番号、親関数を表示します。コードのどの分岐が、どの順序で実行されたかを追うのに便利です。また、ic()は引数をそのまま返すため、既存の式を動作を変えずにラップできます。ic.disable()とic.enable()を使えば、すべての出力を一括で無効化・有効化できます。

出力形式、プレフィックス、出力先、値のシリアライズ方法はconfigureOutputでカスタマイズでき、特定の型に対するカスタムフォーマッターも登録できます。Python 3とPyPy3に対応しており、ic.format()を使うと出力を文字列として取得してロギングに利用できます。

主な機能

  • 01変数や式のソース表記と値をあわせて出力します。
  • 02データ構造を整形し、構文ハイライト付きで表示します。
  • 03引数なしで呼び出し元のファイル、行番号、親関数を表示します。
  • 04引数を返すため、既存のコードにそのまま組み込めます。
  • 05出力を一括で無効化・再有効化でき、builtinsにも登録できます。
  • 06出力のプレフィックス、出力先、値のフォーマットをカスタマイズできます。

ユースケース

  • Pythonスクリプトのデバッグ中に、変数の値を手早く確認する。
  • どの分岐や関数が、どの順序で実行されるかを追跡する。
  • ic.format()を使ってデバッグ出力をロガーに渡す。
  • コードにデバッグ呼び出しを残し、本番環境ではdisable()で出力を抑える。

クイックスタート

  1. 1

    pipでIceCreamをインストールする

    pip install icecream
  2. 2

    icをインポートし、変数または式に対して呼び出すと、その名前と値が出力されます

トピック

よくある質問

icecream とは?
変数名や式とその値を、整形・構文ハイライト付きで表示するPythonデバッグヘルパー。ic()でprint()を置き換えられます。 IceCreamは、print()をより便利に置き換えるic()関数を中心としたPythonデバッグライブラリです。変数や式を渡すと、ic()はソーステキストと評価結果を並べて出力するため、ラベルを手入力しなくても何が渡されたのか確認できます。データ構造は整形され、出力には構文ハイライトが適用されます。
icecream は無料で使えますか?ライセンスは?
icecream は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
icecream は今もメンテナンスされていますか?
活発にメンテナンス中。icecream の最終コミットは 2026年10月19日 です。
icecream は何に使えますか?
Pythonスクリプトのデバッグ中に、変数の値を手早く確認する。 どの分岐や関数が、どの順序で実行されるかを追跡する。 ic.format()を使ってデバッグ出力をロガーに渡す。 コードにデバッグ呼び出しを残し、本番環境ではdisable()で出力を抑える。
icecream のインストール方法は?
pipでIceCreamをインストールする: pip install icecream icをインポートし、変数または式に対して呼び出すと、その名前と値が出力されます
icecream はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/gruns/icecream

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト