Referencia de la API de PyGWalker

Usa pygwalker.walk(df) para abrir rápidamente un explorador interactivo. Usa pygwalker.Walker(...) cuando quieras reutilizar el mismo dataset, estado de gráficos y modo de computación en notebooks, Streamlit, webserver o exportaciones HTML.

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

Elige un punto de entrada

API	Mejor para	Notas
`pygwalker.walk(dataset, ...)`	Exploración rápida en notebooks o scripts	Usa anywidget en Jupyter de forma predeterminada y un webserver local fuera de notebooks.
`pygwalker.Walker(dataset, ...)`	Reutilizar un objeto PyGWalker en varios adaptadores	Coloca opciones de construcción como `spec_path`, `field_specs` y `computation` en el `Walker`.
`pygwalker.render(dataset, spec=..., ...)`	Renderizar gráficos guardados sin el explorador completo	Usa `spec_path` para archivos locales de gráficos.
`pygwalker.table(dataset, ...)`	Abrir la vista de tabla/perfilado	Acepta las mismas opciones de dataset y computación que `render`.
`pygwalker.to_html(dataset_or_walker, ...)`	Exportación HTML estática	Solo navegador. Rechaza `computation="kernel"` y `computation="cloud"`.
`StreamlitRenderer(dataset_or_walker, ...)`	Apps de Streamlit	Guarda el renderer en caché con `st.cache_resource` para apps de larga duración.
`get_html_on_gradio(dataset, ...)`	Apps de Gradio	Devuelve el HTML del iframe y monta `PYGWALKER_ROUTE`.
`pygwalker.component(dataset, ...)`	Constructores programáticos de gráficos	Encadena métodos de marca, codificación, layout y exportación.
`pygwalker.spec.migrate(spec)`	Actualizar estados de gráficos guardados	Acepta un objeto spec cargado, una cadena JSON o una ruta de archivo local.

Datasets compatibles

La mayoría de las API públicas aceptan pandas DataFrame, polars DataFrame, pyarrow Table, Connector de base de datos y cadenas SQL/fuente de datos con estilo de conector donde el adaptador admite conectores. pygwalker.walk, los adaptadores anywidget/marimo/webserver de notebooks, StreamlitRenderer y to_html también pueden aceptar un objeto reutilizable pygwalker.Walker.

Consulta Entradas de datos para ver detalles y ejemplos.

Opciones comunes

Opción	Tipo	Predeterminado	Uso
`spec_path`	`str` o `None`	`None`	Archivo local de estado de gráficos que se carga y se guarda. Prefiérelo antes que pasar una ruta local mediante `spec`.
`spec`	`str`	`""`	JSON en línea, ID de configuración o URL remota de spec.
`computation`	`auto`, `browser`, `kernel`, `cloud` o `None`	`None`	Elige dónde ejecuta PyGWalker las consultas de datos. Omítelo o usa `"auto"` para el comportamiento automático.
`field_specs`	`List[FieldSpec]` o `None`	`None`	Sobrescribe los tipos semánticos y analíticos inferidos de los campos.
`theme_key`	`vega`, `g2` o `streamlit`	`"g2"`	Selecciona la familia de tema del renderer.
`appearance`	`media`, `light` o `dark`	`"media"`	`media` sigue el esquema de color del sistema operativo.
`default_tab`	`data` o `vis`	`"vis"`	Elige la pestaña inicial para las vistas de exploración.

Modos de computación

Usa computation, no los booleanos heredados de computación.

Valor	Comportamiento	Uso típico
omitido o `"auto"`	Mantiene la selección automática de modo de PyGWalker	Valor predeterminado para la mayoría de los usuarios.
`"browser"`	Ejecuta consultas de datos en el frontend/navegador	Exportaciones HTML estáticas y datos locales más pequeños.
`"kernel"`	Ejecuta consultas mediante computación Python local basada en DuckDB	Datasets locales más grandes en sesiones activas de notebook, Streamlit, Gradio o webserver.
`"cloud"`	Ejecuta consultas mediante la computación cloud de Kanaries	Flujos de trabajo respaldados por cloud con una clave API de Kanaries.

kernel_computation, cloud_computation y use_kernel_calc son flags heredados de compatibilidad. Están obsoletos y programados para eliminarse en PyGWalker 0.7.0. No combines flags heredados habilitados con un valor computation no automático; PyGWalker genera ValueError.

Consulta Modos de computación para ver ejemplos de migración.

Reutiliza un `Walker`

Crea un Walker cuando varios adaptadores deban compartir una misma configuración.

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

Cuando un adaptador recibe un Walker, las opciones de construcción ya deben estar en el Walker. Por ejemplo, pyg.to_html(walker, spec_path="./other.json") se rechaza porque intentaría reconstruir el objeto existente con un estado conflictivo.

Límites del HTML estático

Las exportaciones HTML estáticas no tienen un backend Python ni cloud activo. Usa computation="browser" u omite la opción de computación al llamar a pyg.to_html(...), walker.to_html() o exportaciones HTML de componentes. Usa un adaptador activo como API para notebooks, Streamlit o Gradio para computación kernel o cloud.