Skip to content
PYGWALKER
API-Referenz
Notebook-APIs

PyGWalker Notebook-APIs

Beginnen Sie in Notebooks mit pygwalker.walk(df) oder erstellen Sie einen wiederverwendbaren pygwalker.Walker. Der aktuelle Standard-Rendering-Pfad für Jupyter ist anywidget, daher sollte neuer Code env weglassen oder env="JupyterAnywidget" verwenden.

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

Schnelle Entscheidungstabelle

BedarfVerwendenWarum
Einen DataFrame einmal explorierenpyg.walk(df)Kleinster Notebook-Aufruf.
Dieselbe Konfiguration wiederverwendenpyg.Walker(df, ...).show()Ein Objekt kann in Notebooks, Streamlit, Webserver und HTML rendern.
Nur gespeicherte Diagramme rendernpyg.render(df, spec_path=...)Öffnet die Renderer-Ansicht statt des vollständigen Explorers.
Tabellen-/Profiling-Ansicht anzeigenpyg.table(df)Startet im Daten-/Tabellenmodus.
Diagrammzustand in einer lokalen Datei speichernspec_path="./gw_config.json"Lokaler Diagrammzustand hat ein eigenes Argument.

pygwalker.walk

walk öffnet den vollständigen Graphic-Walker-Explorer.

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

Signatur:

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 kann ein pandas DataFrame, polars DataFrame, pyarrow Table, Datenbank-Connector, connectorartiger String oder wiederverwendbarer pygwalker.Walker sein.

Anywidget ist der Notebook-Standard

Neuer Notebook-Code sollte den anywidget-Pfad verwenden:

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

Legacy-Jupyter-Transport-Aliase werden weiterhin auf anywidget aufgelöst und geben Deprecation-Warnungen aus:

Legacy-WertAktuelles VerhaltenStatus
env="Jupyter"Wird als JupyterAnywidget behandeltVeraltet, zur Entfernung in PyGWalker 0.7.0 vorgesehen.
env="JupyterWidget"Wird als JupyterAnywidget behandeltVeraltet, zur Entfernung in PyGWalker 0.7.0 vorgesehen.
Walker.show("jupyter-inline")Wird als jupyter-anywidget behandeltVeraltet, zur Entfernung in PyGWalker 0.7.0 vorgesehen.
Walker.show("jupyter-widget")Wird als jupyter-anywidget behandeltVeraltet, zur Entfernung in PyGWalker 0.7.0 vorgesehen.

Walker.show(env="auto") erkennt die aktuelle Umgebung. In Notebooks wird dies zu jupyter-anywidget aufgelöst; außerhalb von Notebooks startet der Webserver-Adapter.

pygwalker.Walker wiederverwenden

Verwenden Sie Walker, wenn Diagrammzustand und Berechnungsmodus einmal definiert werden sollen.

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

Konstruktor:

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

Nützliche Methoden:

MethodeRückgabeVerwendung
walker.corePygWalkerZugriff auf das Kompatibilitätsobjekt, das ältere APIs verwenden.
walker.show(env="auto", ...)WalkerAnzeige im Notebook- oder Webserver-Modus.
walker.to_html()strExportiert statisches iframe-HTML. Nur Browser-Berechnung.
walker.to_html_without_iframe()strExportiert statisches HTML ohne iframe-Wrapper. Nur Browser-Berechnung.
walker.to_streamlit(**kwargs)StreamlitRendererVerwendet die Konstruktoroptionen in Streamlit wieder.

Wenn ein Walker an einen anderen Adapter übergeben wird, dürfen Konstruktionsoptionen nicht erneut übergeben werden. Dies wird abgelehnt:

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

Berechnung in Notebooks

Verwenden Sie computation für neuen Code.

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

kernel_computation, cloud_computation und use_kernel_calc sind Legacy-Flags und zur Entfernung in PyGWalker 0.7.0 vorgesehen. Wenn computation auf "browser", "kernel" oder "cloud" gesetzt ist, setzen Sie keine aktivierten Legacy-Flags zusätzlich.

Notebook-Konvertierung und statische HTML-Ausgabe unterstützen keine Live-Kernel- oder Cloud-Berechnung. Verwenden Sie computation="browser", wenn die Ausgabe statisch sein muss, oder führen Sie PyGWalker in einem Live-Backend aus.

pygwalker.render

render zeigt gespeicherte Diagramme ohne den vollständigen Drag-and-drop-Explorer.

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

Signatur:

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

pygwalker.table

table öffnet PyGWalkers Daten-/Profiling-Tabellenmodus.

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

Signatur:

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

Verwandte Anleitungen

Datensatz-EingabenBerechnungsmodi