PyGWalker API リファレンス

すばやく対話型エクスプローラーを開くには pygwalker.walk(df) を使います。同じデータセット、チャート状態、計算モードをノートブック、Streamlit、webserver、HTML エクスポートで再利用したい場合は pygwalker.Walker(...) を使います。

import pygwalker as pyg
 
walker = pyg.Walker(df, spec_path="./gw_config.json", computation="browser")
walker.show()

エントリーポイントの選び方

対応データセット

ほとんどの公開 API は pandas DataFrame、polars DataFrame、pyarrow Table、データベース Connector、およびアダプターが Connector をサポートする場合の Connector 形式 SQL / データソース文字列を受け取れます。pygwalker.walk、ノートブック anywidget / marimo / webserver アダプター、StreamlitRenderer、to_html は再利用可能な pygwalker.Walker オブジェクトも受け取れます。

詳細と例は データセット入力 を参照してください。

共通オプション

計算モード

レガシーな計算用 boolean ではなく、computation を使います。

kernel_computation、cloud_computation、use_kernel_calc はレガシー互換フラグです。これらは非推奨で、PyGWalker 0.7.0 で削除予定です。非 auto の computation 値と有効化されたレガシーフラグを同時に指定しないでください。PyGWalker は ValueError を送出します。

移行例は 計算モード を参照してください。

Walker を再利用する

複数のアダプターで 1 つの設定を共有したい場合は Walker を作成します。

import pygwalker as pyg
 
walker = pyg.Walker(
    df,
    spec_path="./gw_config.json",
    spec_io_mode="rw",
    computation="kernel",
)
 
walker.show()
renderer = walker.to_streamlit()

アダプターが Walker を受け取る場合、構築オプションはすでに Walker 側に設定されている必要があります。たとえば pyg.to_html(walker, spec_path="./other.json") は、既存オブジェクトを矛盾する状態で再構築しようとするため拒否されます。

静的 HTML の制限

静的 HTML エクスポートにはライブの Python バックエンドやクラウドバックエンドがありません。pyg.to_html(...)、walker.to_html()、component の HTML エクスポートでは、computation="browser" を使うか computation オプションを省略してください。kernel や cloud computation が必要な場合は、ノートブック API、Streamlit、Gradio などのライブアダプターを使います。

関連ガイド

• ノートブック API
• Streamlit
• HTML エクスポート
• Spec ファイル
• Component API