Skip to content

APIs de Notebook do PyGWalker

Em notebooks, comece com pygwalker.walk(df) ou crie um pygwalker.Walker reutilizável. O caminho atual padrão de renderização no Jupyter é anywidget, então código novo deve omitir env ou usar env="JupyterAnywidget".

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

Tabela rápida de decisão

NecessidadeUsePor quê
Explorar um DataFrame uma vezpyg.walk(df)Menor chamada em notebook.
Reutilizar a mesma configuraçãopyg.Walker(df, ...).show()Um objeto pode renderizar em notebooks, Streamlit, webserver e HTML.
Renderizar apenas gráficos salvospyg.render(df, spec_path=...)Abre a visualização de renderer em vez do explorador completo.
Mostrar a visualização de tabela/perfilpyg.table(df)Inicia no modo de dados/tabela.
Salvar estado de gráficos em um arquivo localspec_path="./gw_config.json"Estado local de gráficos tem um argumento dedicado.

pygwalker.walk

walk abre o explorador completo do Graphic Walker.

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

Assinatura:

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 pode ser um pandas DataFrame, polars DataFrame, pyarrow Table, Connector de banco de dados, string no estilo de conector ou pygwalker.Walker reutilizável.

Anywidget é o padrão para notebooks

Código novo em notebook deve usar o caminho anywidget:

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

Aliases legados de transporte Jupyter ainda resolvem para anywidget e emitem avisos de depreciação:

Valor legadoComportamento atualStatus
env="Jupyter"Tratado como JupyterAnywidgetDepreciado, com remoção programada para o PyGWalker 0.7.0.
env="JupyterWidget"Tratado como JupyterAnywidgetDepreciado, com remoção programada para o PyGWalker 0.7.0.
Walker.show("jupyter-inline")Tratado como jupyter-anywidgetDepreciado, com remoção programada para o PyGWalker 0.7.0.
Walker.show("jupyter-widget")Tratado como jupyter-anywidgetDepreciado, com remoção programada para o PyGWalker 0.7.0.

Walker.show(env="auto") detecta o ambiente atual. Em notebooks, resolve para jupyter-anywidget; fora de notebooks, inicia o adaptador webserver.

Reutilize pygwalker.Walker

Use Walker quando o estado de gráficos e o modo de computação devem ser definidos uma vez.

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

Construtor:

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 úteis:

MétodoRetornaUso
walker.corePygWalkerAcessa o objeto de compatibilidade usado por APIs antigas.
walker.show(env="auto", ...)WalkerExibe em modo notebook ou webserver.
walker.to_html()strExporta HTML estático com iframe. Apenas computação no navegador.
walker.to_html_without_iframe()strExporta HTML estático sem o wrapper de iframe. Apenas computação no navegador.
walker.to_streamlit(**kwargs)StreamlitRendererReutiliza as opções do construtor no Streamlit.

Quando um Walker é passado para outro adaptador, não passe opções de construção novamente. Isto é rejeitado:

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

Computação em notebooks

Use computation para código novo.

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

kernel_computation, cloud_computation e use_kernel_calc são flags legadas e têm remoção programada para o PyGWalker 0.7.0. Se computation for definido como "browser", "kernel" ou "cloud", não defina também flags legadas habilitadas.

Saída de notebook convertida/HTML estático não oferece suporte a computação ativa em kernel ou nuvem. Use computation="browser" quando a saída precisar ser estática, ou execute o PyGWalker em um backend ativo.

pygwalker.render

render mostra gráficos salvos sem o explorador completo de arrastar e soltar.

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

Assinatura:

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 o modo de tabela/perfil de dados do PyGWalker.

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

Assinatura:

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

Guias Relacionados