PyGWalker API-Referenz
Verwenden Sie pygwalker.walk(df) für eine schnelle interaktive Analyse. Verwenden Sie pygwalker.Walker(...), wenn derselbe Datensatz, Diagrammzustand und Berechnungsmodus in Notebooks, Streamlit, Webserver oder HTML-Export wiederverwendet werden soll.
import pygwalker as pyg
walker = pyg.Walker(df, spec_path="./gw_config.json", computation="browser")
walker.show()Einstiegspunkt wählen
| API | Am besten für | Hinweise |
|---|---|---|
pygwalker.walk(dataset, ...) | Schnelle Exploration in Notebooks oder Skripten | Verwendet in Jupyter standardmäßig anywidget und außerhalb von Notebooks einen lokalen Webserver. |
pygwalker.Walker(dataset, ...) | Wiederverwendung eines PyGWalker-Objekts über Adapter hinweg | Setzen Sie Konstruktionsoptionen wie spec_path, field_specs und computation auf dem Walker. |
pygwalker.render(dataset, spec=..., ...) | Rendern gespeicherter Diagramme ohne vollständigen Explorer | Verwenden Sie spec_path für lokale Diagrammdateien. |
pygwalker.table(dataset, ...) | Öffnen der Tabellen-/Profiling-Ansicht | Akzeptiert dieselben Datensatz- und Berechnungsoptionen wie render. |
pygwalker.to_html(dataset_or_walker, ...) | Statischer HTML-Export | Nur Browser. Lehnt computation="kernel" und computation="cloud" ab. |
StreamlitRenderer(dataset_or_walker, ...) | Streamlit-Apps | Cachen Sie den Renderer mit st.cache_resource für langlebige Apps. |
get_html_on_gradio(dataset, ...) | Gradio-Apps | Geben Sie das iframe-HTML zurück und mounten Sie PYGWALKER_ROUTE. |
pygwalker.component(dataset, ...) | Programmgesteuerte Diagramm-Builder | Verketten Sie Mark-, Encode-, Layout- und Exportmethoden. |
pygwalker.spec.migrate(spec) | Aktualisieren gespeicherter Diagrammzustände | Akzeptiert ein geladenes Spec-Objekt, einen JSON-String oder einen lokalen Dateipfad. |
Unterstützte Datensätze
Die meisten öffentlichen APIs akzeptieren pandas DataFrame, polars DataFrame, pyarrow Table, Datenbank-Connector und connectorartige SQL-/Datenquellen-Strings, sofern der jeweilige Adapter Connectors unterstützt. pygwalker.walk, Notebook-anywidget-/marimo-/Webserver-Adapter, StreamlitRenderer und to_html können außerdem ein wiederverwendbares pygwalker.Walker-Objekt akzeptieren.
Weitere Details und Beispiele finden Sie unter Datensatz-Eingaben.
Häufige Optionen
| Option | Typ | Standard | Verwendung |
|---|---|---|---|
spec_path | str oder None | None | Lokale Diagrammzustandsdatei zum Laden und Speichern. Bevorzugen Sie dies gegenüber einem lokalen Dateipfad über spec. |
spec | str | "" | Inline-JSON, Config-ID oder Remote-Spec-URL. |
computation | auto, browser, kernel, cloud oder None | None | Wählt, wo PyGWalker Datenabfragen ausführt. Weglassen oder "auto" für automatisches Verhalten verwenden. |
field_specs | List[FieldSpec] oder None | None | Überschreibt abgeleitete semantische und analytische Feldtypen. |
theme_key | vega, g2 oder streamlit | "g2" | Wählt die Renderer-Theme-Familie. |
appearance | media, light oder dark | "media" | media folgt dem Farbschema des Betriebssystems. |
default_tab | data oder vis | "vis" | Wählt den initialen Tab für Explorer-Ansichten. |
Berechnungsmodi
Verwenden Sie computation, nicht die alten Berechnungs-Flags.
| Wert | Verhalten | Typische Verwendung |
|---|---|---|
weggelassen oder "auto" | Behält PyGWalkers automatische Moduswahl bei | Standard für die meisten Benutzer. |
"browser" | Führt Datenabfragen im Frontend/Browser aus | Statische HTML-Exporte und kleinere lokale Daten. |
"kernel" | Führt Abfragen über lokale DuckDB-basierte Python-Berechnung aus | Größere lokale Datensätze in Live-Notebook-, Streamlit-, Gradio- oder Webserver-Sitzungen. |
"cloud" | Führt Abfragen über Kanaries Cloud Computation aus | Cloud-gestützte Workflows mit Kanaries API-Schlüssel. |
kernel_computation, cloud_computation und use_kernel_calc sind Legacy-Kompatibilitäts-Flags. Sie sind veraltet und zur Entfernung in PyGWalker 0.7.0 vorgesehen. Kombinieren Sie aktivierte Legacy-Flags nicht mit einem nicht automatischen computation-Wert; PyGWalker löst ValueError aus.
Migrationsbeispiele finden Sie unter Berechnungsmodi.
Einen Walker wiederverwenden
Erstellen Sie einen Walker, wenn mehrere Adapter dieselbe Konfiguration teilen sollen.
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()Wenn ein Adapter einen Walker erhält, müssen Konstruktionsoptionen bereits auf dem Walker gesetzt sein. Zum Beispiel wird pyg.to_html(walker, spec_path="./other.json") abgelehnt, weil dadurch versucht würde, das vorhandene Objekt mit widersprüchlichem Zustand neu aufzubauen.
Grenzen statischer HTML-Exporte
Statische HTML-Exporte haben kein Live-Python- oder Cloud-Backend. Verwenden Sie computation="browser" oder lassen Sie die Berechnungsoption weg, wenn Sie pyg.to_html(...), walker.to_html() oder Komponenten-HTML-Exporte aufrufen. Verwenden Sie einen Live-Adapter wie Notebook-APIs, Streamlit oder Gradio für Kernel- oder Cloud-Berechnung.