Référence de l'API PyGWalker

Utilisez pygwalker.walk(df) pour ouvrir rapidement un explorateur interactif. Utilisez pygwalker.Walker(...) lorsque le même dataset, le même état de graphique et le même mode de calcul doivent être réutilisés dans notebooks, Streamlit, webserver ou export HTML.

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

Choisir un point d'entrée

API	Idéal pour	Notes
`pygwalker.walk(dataset, ...)`	Exploration rapide dans notebooks ou scripts	Utilise anywidget par défaut dans Jupyter et un webserver local hors notebooks.
`pygwalker.Walker(dataset, ...)`	Réutiliser un objet PyGWalker dans plusieurs adaptateurs	Placez les options de construction comme `spec_path`, `field_specs` et `computation` sur le `Walker`.
`pygwalker.render(dataset, spec=..., ...)`	Rendre des graphiques enregistrés sans l'explorateur complet	Utilisez `spec_path` pour les fichiers de graphiques locaux.
`pygwalker.table(dataset, ...)`	Ouvrir la vue table/profiling	Accepte les mêmes options de dataset et de calcul que `render`.
`pygwalker.to_html(dataset_or_walker, ...)`	Export HTML statique	Browser-only. Refuse `computation="kernel"` et `computation="cloud"`.
`StreamlitRenderer(dataset_or_walker, ...)`	Applications Streamlit	Mettez le renderer en cache avec `st.cache_resource` pour les applications longues.
`get_html_on_gradio(dataset, ...)`	Applications Gradio	Retourne le HTML iframe et monte `PYGWALKER_ROUTE`.
`pygwalker.component(dataset, ...)`	Constructeurs de graphiques programmatiques	Chaînez les méthodes de mark, encode, layout et export.
`pygwalker.spec.migrate(spec)`	Mettre à jour l'état de graphiques enregistré	Accepte un objet spec chargé, une chaîne JSON ou un chemin de fichier local.

Datasets pris en charge

La plupart des API publiques acceptent les DataFrame pandas, les DataFrame polars, les pyarrow Table, les Connector de base de données et les chaînes SQL/source de données de style connecteur lorsque l'adaptateur prend les connecteurs en charge. pygwalker.walk, les adaptateurs notebook anywidget/marimo/webserver, StreamlitRenderer et to_html peuvent aussi accepter un objet pygwalker.Walker réutilisable.

Voir Entrées de données pour les détails et exemples.

Options courantes

Option	Type	Valeur par défaut	Usage
`spec_path`	`str` ou `None`	`None`	Fichier local d'état des graphiques à charger et enregistrer. Préférez cette option à un chemin de fichier local passé via `spec`.
`spec`	`str`	`""`	JSON inline, ID de configuration ou URL de spec distante.
`computation`	`auto`, `browser`, `kernel`, `cloud` ou `None`	`None`	Choisit où PyGWalker exécute les requêtes de données. Omettez cette option ou utilisez `"auto"` pour le comportement automatique.
`field_specs`	`List[FieldSpec]` ou `None`	`None`	Remplace les types sémantiques et analytiques inférés des champs.
`theme_key`	`vega`, `g2` ou `streamlit`	`"g2"`	Sélectionne la famille de thème du renderer.
`appearance`	`media`, `light` ou `dark`	`"media"`	`media` suit le mode de couleur du système d'exploitation.
`default_tab`	`data` ou `vis`	`"vis"`	Choisit l'onglet initial des vues explorateur.

Modes de calcul

Utilisez computation, pas les anciens booléens de calcul.

Valeur	Comportement	Usage typique
omise ou `"auto"`	Conserve la sélection automatique de PyGWalker	Cas par défaut pour la plupart des utilisateurs.
`"browser"`	Exécute les requêtes dans le frontend/browser	Exports HTML statiques et petites données locales.
`"kernel"`	Exécute les requêtes via le calcul Python local basé sur DuckDB	Datasets locaux plus volumineux dans des sessions notebook, Streamlit, Gradio ou webserver actives.
`"cloud"`	Exécute les requêtes via le calcul cloud Kanaries	Workflows cloud avec une clé API Kanaries.

kernel_computation, cloud_computation et use_kernel_calc sont des anciennes options de compatibilité. Elles sont obsolètes et leur suppression est prévue dans PyGWalker 0.7.0. Ne combinez pas d'anciennes options activées avec une valeur computation non automatique ; PyGWalker lève ValueError.

Voir Modes de calcul pour des exemples de migration.

Réutiliser un `Walker`

Créez un Walker lorsque plusieurs adaptateurs doivent partager une seule configuration.

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()

Lorsqu'un adaptateur reçoit un Walker, les options de construction doivent déjà être sur le Walker. Par exemple, pyg.to_html(walker, spec_path="./other.json") est refusé, car cela tenterait de reconstruire l'objet existant avec un état contradictoire.

Limites du HTML statique

Les exports HTML statiques n'ont pas de backend Python ou cloud actif. Utilisez computation="browser" ou omettez l'option de calcul lorsque vous appelez pyg.to_html(...), walker.to_html() ou les exports HTML de composants. Utilisez un adaptateur actif comme API Notebook, Streamlit ou Gradio pour le calcul kernel ou cloud.