Skip to content
PYGWALKER
Référence de l'API
API Notebook

API Notebook PyGWalker

Dans les notebooks, commencez avec pygwalker.walk(df) ou créez un pygwalker.Walker réutilisable. Le chemin de rendu Jupyter actuel par défaut est anywidget ; le nouveau code doit donc omettre env ou utiliser env="JupyterAnywidget".

import pygwalker as pyg
 
walker = pyg.walk(df, spec_path="./gw_config.json", computation="kernel")

Tableau de décision rapide

BesoinUtiliserPourquoi
Explorer une DataFrame une seule foispyg.walk(df)L'appel notebook le plus court.
Réutiliser la même configurationpyg.Walker(df, ...).show()Un seul objet peut être rendu dans notebooks, Streamlit, webserver et HTML.
Rendre seulement des graphiques enregistréspyg.render(df, spec_path=...)Ouvre la vue renderer au lieu de l'explorateur complet.
Afficher la vue table/profilingpyg.table(df)Démarre en mode données/table.
Enregistrer l'état des graphiques dans un fichier localspec_path="./gw_config.json"L'état local des graphiques a un argument dédié.

pygwalker.walk

walk ouvre l'explorateur Graphic Walker complet.

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

Signature :

pyg.walk(
    dataset,
    gid=None,
    *,
    env="JupyterAnywidget",
    field_specs=None,
    theme_key="g2",
    appearance="media",
    spec="",
    spec_path=None,
    computation=None,
    use_kernel_calc=None,
    kernel_computation=None,
    cloud_computation=False,
    show_cloud_tool=True,
    kanaries_api_key="",
    default_tab="vis",
    **kwargs,
)

dataset peut être une DataFrame pandas, une DataFrame polars, une pyarrow Table, un Connector de base de données, une chaîne de style connecteur ou un pygwalker.Walker réutilisable.

Anywidget est le défaut notebook

Le nouveau code notebook doit utiliser le chemin anywidget :

pyg.walk(df)
pyg.walk(df, env="JupyterAnywidget")
pyg.Walker(df).show()
pyg.Walker(df).show(env="jupyter-anywidget")

Les anciens alias de transport Jupyter pointent encore vers anywidget et émettent des avertissements de dépréciation :

Ancienne valeurComportement actuelStatut
env="Jupyter"Traitée comme JupyterAnywidgetObsolète, suppression prévue dans PyGWalker 0.7.0.
env="JupyterWidget"Traitée comme JupyterAnywidgetObsolète, suppression prévue dans PyGWalker 0.7.0.
Walker.show("jupyter-inline")Traitée comme jupyter-anywidgetObsolète, suppression prévue dans PyGWalker 0.7.0.
Walker.show("jupyter-widget")Traitée comme jupyter-anywidgetObsolète, suppression prévue dans PyGWalker 0.7.0.

Walker.show(env="auto") détecte l'environnement courant. Dans les notebooks, il se résout en jupyter-anywidget ; hors notebook, il démarre l'adaptateur webserver.

Réutiliser pygwalker.Walker

Utilisez Walker lorsque l'état des graphiques et le mode de calcul doivent être définis une seule fois.

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

Constructeur :

pyg.Walker(
    dataset,
    gid=None,
    *,
    field_specs=None,
    theme_key="g2",
    appearance="media",
    spec="",
    spec_path=None,
    spec_io_mode="rw",
    computation=None,
    use_kernel_calc=None,
    kernel_computation=None,
    cloud_computation=False,
    show_cloud_tool=True,
    kanaries_api_key="",
    default_tab="vis",
    **kwargs,
)

Méthodes utiles :

MéthodeRetourneUtilisation
walker.corePygWalkerAccéder à l'objet de compatibilité utilisé par les anciennes API.
walker.show(env="auto", ...)WalkerAfficher en mode notebook ou webserver.
walker.to_html()strExporter du HTML iframe statique. Calcul browser uniquement.
walker.to_html_without_iframe()strExporter du HTML statique sans wrapper iframe. Calcul browser uniquement.
walker.to_streamlit(**kwargs)StreamlitRendererRéutiliser les options du constructeur dans Streamlit.

Lorsqu'un Walker est passé à un autre adaptateur, ne repassez pas les options de construction. Ceci est refusé :

walker = pyg.Walker(df, spec_path="./gw_config.json", computation="browser")
 
# Raises ValueError: spec_path belongs on the original Walker.
pyg.walk(walker, spec_path="./other.json")

Calcul dans les notebooks

Utilisez computation pour le nouveau code.

pyg.walk(df, computation="browser")
pyg.walk(df, computation="kernel")
pyg.walk(df, computation="cloud", kanaries_api_key="...")

kernel_computation, cloud_computation et use_kernel_calc sont des options héritées et leur suppression est prévue dans PyGWalker 0.7.0. Si computation vaut "browser", "kernel" ou "cloud", n'activez pas aussi ces anciennes options.

La sortie notebook convertie ou HTML statique ne prend pas en charge le calcul kernel ou cloud en direct. Utilisez computation="browser" lorsque la sortie doit être statique, ou exécutez PyGWalker dans un backend actif.

pygwalker.render

render affiche des graphiques enregistrés sans l'explorateur glisser-déposer complet.

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

Signature :

pyg.render(
    dataset,
    spec="",
    *,
    theme_key="g2",
    appearance="media",
    spec_path=None,
    computation=None,
    kernel_computation=None,
    kanaries_api_key="",
    **kwargs,
)

pygwalker.table

table ouvre le mode table de données/profiling de PyGWalker.

import pygwalker as pyg
 
pyg.table(df, spec_path="./gw_config.json")

Signature :

pyg.table(
    dataset,
    *,
    theme_key="g2",
    appearance="media",
    spec_path=None,
    computation=None,
    kernel_computation=None,
    kanaries_api_key="",
    **kwargs,
)

Guides associés

Entrées de donnéesModes de calcul