Skip to content
PYGWALKER
Referencia de API
API para notebooks

API de PyGWalker para notebooks

En notebooks, empieza con pygwalker.walk(df) o crea un pygwalker.Walker reutilizable. La ruta de renderizado predeterminada actual en Jupyter es anywidget, así que el código nuevo debería omitir env o usar env="JupyterAnywidget".

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

Tabla rápida de decisión

NecesidadUsaPor qué
Explorar un DataFrame una vezpyg.walk(df)La llamada más pequeña para notebook.
Reutilizar la misma configuraciónpyg.Walker(df, ...).show()Un objeto puede renderizarse en notebooks, Streamlit, webserver y HTML.
Renderizar solo gráficos guardadospyg.render(df, spec_path=...)Abre la vista de renderer en lugar del explorador completo.
Mostrar la vista de tabla/perfiladopyg.table(df)Inicia en el modo de datos/tabla.
Guardar el estado de gráficos en un archivo localspec_path="./gw_config.json"El estado local de gráficos tiene un argumento dedicado.

pygwalker.walk

walk abre el explorador completo de Graphic Walker.

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

Firma:

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 puede ser un pandas DataFrame, polars DataFrame, pyarrow Table, Connector de base de datos, cadena con estilo de conector o pygwalker.Walker reutilizable.

Anywidget es el valor predeterminado para notebooks

El código nuevo para notebooks debería usar la ruta anywidget:

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

Los alias heredados de transporte Jupyter aún se resuelven a anywidget y emiten advertencias de obsolescencia:

Valor heredadoComportamiento actualEstado
env="Jupyter"Se trata como JupyterAnywidgetObsoleto, programado para eliminarse en PyGWalker 0.7.0.
env="JupyterWidget"Se trata como JupyterAnywidgetObsoleto, programado para eliminarse en PyGWalker 0.7.0.
Walker.show("jupyter-inline")Se trata como jupyter-anywidgetObsoleto, programado para eliminarse en PyGWalker 0.7.0.
Walker.show("jupyter-widget")Se trata como jupyter-anywidgetObsoleto, programado para eliminarse en PyGWalker 0.7.0.

Walker.show(env="auto") detecta el entorno actual. En notebooks se resuelve a jupyter-anywidget; fuera de notebooks inicia el adaptador webserver.

Reutiliza pygwalker.Walker

Usa Walker cuando el estado de gráficos y el modo de computación deban definirse una sola vez.

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

Constructor:

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étodos útiles:

MétodoDevuelveUso
walker.corePygWalkerAccede al objeto de compatibilidad usado por API antiguas.
walker.show(env="auto", ...)WalkerMuestra en modo notebook o webserver.
walker.to_html()strExporta HTML iframe estático. Solo computación browser.
walker.to_html_without_iframe()strExporta HTML estático sin el wrapper iframe. Solo computación browser.
walker.to_streamlit(**kwargs)StreamlitRendererReutiliza las opciones del constructor en Streamlit.

Cuando se pasa un Walker a otro adaptador, no vuelvas a pasar opciones de construcción. Esto se rechaza:

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

Computación en notebooks

Usa computation para código nuevo.

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

kernel_computation, cloud_computation y use_kernel_calc son flags heredados y están programados para eliminarse en PyGWalker 0.7.0. Si computation se configura como "browser", "kernel" o "cloud", no configures también flags heredados habilitados.

La conversión de notebooks/salida HTML estática no admite computación kernel ni cloud activa. Usa computation="browser" cuando la salida deba ser estática, o ejecuta PyGWalker en un backend activo.

pygwalker.render

render muestra gráficos guardados sin el explorador completo de arrastrar y soltar.

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

Firma:

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

pygwalker.table

table abre el modo de tabla/perfilado de datos de PyGWalker.

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

Firma:

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

Guías relacionadas

Entradas de datosModos de computación