Skip to content
PYGWALKER
API 참조
노트북 API

PyGWalker 노트북 API

노트북에서는 pygwalker.walk(df)로 시작하거나 재사용 가능한 pygwalker.Walker를 만드세요. 현재 Jupyter의 기본 렌더링 경로는 anywidget이므로 새 코드는 env를 생략하거나 env="JupyterAnywidget"을 사용해야 합니다.

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

빠른 선택 표

필요사용이유
DataFrame을 한 번 탐색pyg.walk(df)가장 작은 노트북 호출입니다.
같은 설정 재사용pyg.Walker(df, ...).show()하나의 객체를 노트북, Streamlit, 웹서버, HTML에서 렌더링할 수 있습니다.
저장된 차트만 렌더링pyg.render(df, spec_path=...)전체 탐색기 대신 renderer 뷰를 엽니다.
테이블/프로파일링 뷰 표시pyg.table(df)data/table 모드에서 시작합니다.
차트 상태를 로컬 파일에 저장spec_path="./gw_config.json"로컬 차트 상태 전용 인자입니다.

pygwalker.walk

walk는 전체 Graphic Walker 탐색기를 엽니다.

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

시그니처:

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은 pandas DataFrame, polars DataFrame, pyarrow Table, 데이터베이스 Connector, connector 스타일 문자열, 재사용 가능한 pygwalker.Walker일 수 있습니다.

Anywidget이 노트북 기본값입니다

새 노트북 코드는 anywidget 경로를 사용해야 합니다.

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

레거시 Jupyter 전송 별칭은 여전히 anywidget으로 해석되며 deprecation 경고를 냅니다.

레거시 값현재 동작상태
env="Jupyter"JupyterAnywidget으로 처리Deprecated, PyGWalker 0.7.0에서 제거 예정입니다.
env="JupyterWidget"JupyterAnywidget으로 처리Deprecated, PyGWalker 0.7.0에서 제거 예정입니다.
Walker.show("jupyter-inline")jupyter-anywidget으로 처리Deprecated, PyGWalker 0.7.0에서 제거 예정입니다.
Walker.show("jupyter-widget")jupyter-anywidget으로 처리Deprecated, PyGWalker 0.7.0에서 제거 예정입니다.

Walker.show(env="auto")는 현재 환경을 감지합니다. 노트북에서는 jupyter-anywidget으로 해석되고, 노트북 밖에서는 웹서버 어댑터를 시작합니다.

pygwalker.Walker 재사용

차트 상태와 계산 모드를 한 번만 정의해야 한다면 Walker를 사용하세요.

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

생성자:

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

유용한 메서드:

메서드반환용도
walker.corePygWalker이전 API가 사용하는 호환성 객체에 접근합니다.
walker.show(env="auto", ...)Walker노트북 또는 웹서버 모드로 표시합니다.
walker.to_html()str정적 iframe HTML을 내보냅니다. 브라우저 계산만 지원합니다.
walker.to_html_without_iframe()striframe wrapper 없이 정적 HTML을 내보냅니다. 브라우저 계산만 지원합니다.
walker.to_streamlit(**kwargs)StreamlitRendererStreamlit에서 생성자 옵션을 재사용합니다.

Walker를 다른 어댑터에 전달할 때 생성 옵션을 다시 전달하지 마세요. 다음 코드는 거부됩니다.

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

노트북의 계산

새 코드에는 computation을 사용하세요.

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

kernel_computation, cloud_computation, use_kernel_calc는 레거시 플래그이며 PyGWalker 0.7.0에서 제거될 예정입니다. computation을 "browser", "kernel", "cloud"로 설정했다면 활성화된 레거시 플래그도 함께 설정하지 마세요.

노트북 변환/정적 HTML 출력은 라이브 kernel 또는 cloud 계산을 지원하지 않습니다. 출력이 정적이어야 한다면 computation="browser"를 사용하거나, 라이브 백엔드에서 PyGWalker를 실행하세요.

pygwalker.render

render는 전체 drag-and-drop 탐색기 없이 저장된 차트를 보여줍니다.

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

시그니처:

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

pygwalker.table

table은 PyGWalker의 데이터 테이블/프로파일링 모드를 엽니다.

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

시그니처:

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

관련 가이드

데이터셋 입력계산 모드