pywry.widget¶

Jupyter widget classes using anywidget for inline notebook rendering.

pywry.widget.PyWryWidget ¶

PyWryWidget(**kwargs: Any)

Bases: EmittingWidget

Fallback widget used when anywidget is not installed.

The fallback preserves the public API shape of the notebook widgets so imports remain valid, but interactive behavior is unavailable.

Initialize fallback widget.

_label `instance-attribute` ¶

_label = f'w-{hex[:8]}'

content `instance-attribute` ¶

content = get('content', '')

_handlers `instance-attribute` ¶

_handlers: dict[str, list[Callable[..., Any]]] = {}

label `property` ¶

label: str

Get widget label.

on ¶

on(event_type: str, callback: Callable[..., Any], label: str | None = None) -> PyWryWidget

Register an event handler.

Parameters:

Name	Type	Description	Default
`event_type`	`str`	Event name to subscribe to.	required
`callback`	`Callable[..., Any]`	Callback that would handle the event in a real anywidget runtime.	required
`label`	`str or None`	Ignored (accepted for API compatibility with `PyWry.on()`).	`None`

Returns:

Type	Description
`PyWryWidget`	Self for method chaining.

Notes

This is a no-op in fallback mode.

emit ¶

emit(event_type: str, data: dict[str, Any] | None = None) -> None

Send an event.

Parameters:

Name	Type	Description	Default
`event_type`	`str`	Event name that would be emitted to the frontend.	required
`data`	`dict[str, Any] \| None`	Payload that would be delivered with the event.	`None`

Notes

This is a no-op in fallback mode.

set_content ¶

set_content(content: str) -> None

Set content.

update ¶

update(html: str) -> None

Update the widget's HTML content.

_repr_html_ ¶

_repr_html_() -> str

HTML representation.

display ¶

display() -> None

Display the widget (no-op in fallback).

from_html `classmethod` ¶

from_html(content: str, callbacks: dict[str, Callable[[dict[str, Any], str, str], Any]] | None = None, theme: str = 'dark', width: str = '100%', height: str = '500px', toolbars: list | None = None, modals: list | None = None) -> PyWryWidget

Build a fallback widget; ignores callbacks/toolbars/modals.

alert ¶

alert(message: str, alert_type: Literal['info', 'success', 'warning', 'error', 'confirm'] = 'info', title: str | None = None, duration: int | None = None, callback_event: str | None = None, position: Literal['top-right', 'top-left', 'bottom-right', 'bottom-left'] = 'top-right') -> None

Show a toast notification.

Parameters:

Name	Type	Description	Default
`message`	`str`	The message to display.	required
`alert_type`	`str`	Alert type: 'info', 'success', 'warning', 'error', or 'confirm'.	`'info'`
`title`	`str`	Optional title for the toast.	`None`
`duration`	`int`	Auto-dismiss duration in ms. Defaults based on type.	`None`
`callback_event`	`str`	Event name to emit when confirm dialog is answered.	`None`
`position`	`str`	Toast position: 'top-right', 'top-left', 'bottom-right', 'bottom-left'.	`'top-right'`

pywry.widget.PyWryPlotlyWidget ¶

PyWryPlotlyWidget(**kwargs: Any)

Bases: PyWryWidget

Fallback Plotly widget when anywidget is not available.

Initialize fallback widget.

_label `instance-attribute` ¶

_label = f'w-{hex[:8]}'

content `instance-attribute` ¶

content = get('content', '')

_handlers `instance-attribute` ¶

_handlers: dict[str, list[Callable[..., Any]]] = {}

label `property` ¶

label: str

Get widget label.

emit ¶

emit(event_type: str, data: dict[str, Any] | None = None) -> None

Send an event.

Parameters:

Name	Type	Description	Default
`event_type`	`str`	Event name that would be emitted to the frontend.	required
`data`	`dict[str, Any] \| None`	Payload that would be delivered with the event.	`None`

Notes

This is a no-op in fallback mode.

alert ¶

alert(message: str, alert_type: Literal['info', 'success', 'warning', 'error', 'confirm'] = 'info', title: str | None = None, duration: int | None = None, callback_event: str | None = None, position: Literal['top-right', 'top-left', 'bottom-right', 'bottom-left'] = 'top-right') -> None

Show a toast notification.

Parameters:

Name	Type	Description	Default
`message`	`str`	The message to display.	required
`alert_type`	`str`	Alert type: 'info', 'success', 'warning', 'error', or 'confirm'.	`'info'`
`title`	`str`	Optional title for the toast.	`None`
`duration`	`int`	Auto-dismiss duration in ms. Defaults based on type.	`None`
`callback_event`	`str`	Event name to emit when confirm dialog is answered.	`None`
`position`	`str`	Toast position: 'top-right', 'top-left', 'bottom-right', 'bottom-left'.	`'top-right'`

on ¶

on(event_type: str, callback: Callable[..., Any], label: str | None = None) -> PyWryWidget

Register an event handler.

Parameters:

Name	Type	Description	Default
`event_type`	`str`	Event name to subscribe to.	required
`callback`	`Callable[..., Any]`	Callback that would handle the event in a real anywidget runtime.	required
`label`	`str or None`	Ignored (accepted for API compatibility with `PyWry.on()`).	`None`

Returns:

Type	Description
`PyWryWidget`	Self for method chaining.

Notes

This is a no-op in fallback mode.

set_content ¶

set_content(content: str) -> None

Set content.

update ¶

update(html: str) -> None

Update the widget's HTML content.

_repr_html_ ¶

_repr_html_() -> str

HTML representation.

display ¶

display() -> None

Display the widget (no-op in fallback).

from_html `classmethod` ¶

from_html(content: str, callbacks: dict[str, Callable[[dict[str, Any], str, str], Any]] | None = None, theme: str = 'dark', width: str = '100%', height: str = '500px', toolbars: list | None = None, modals: list | None = None) -> PyWryWidget

Build a fallback widget; ignores callbacks/toolbars/modals.

pywry.widget.PyWryAgGridWidget ¶

PyWryAgGridWidget(**kwargs: Any)

Bases: PyWryWidget

Fallback AG Grid widget when anywidget is not available.

Initialize fallback widget.

_label `instance-attribute` ¶

_label = f'w-{hex[:8]}'

content `instance-attribute` ¶

content = get('content', '')

_handlers `instance-attribute` ¶

_handlers: dict[str, list[Callable[..., Any]]] = {}

label `property` ¶

label: str

Get widget label.

update_data ¶

update_data(data: Any) -> None

Update grid data (no-op in fallback).

update_columns ¶

update_columns(columns: list[dict[str, Any]]) -> None

Update columns (no-op in fallback).

update_grid ¶

update_grid(data: Any = None, columns: list[dict[str, Any]] | None = None) -> None

Update grid (no-op in fallback).

emit ¶

emit(event_type: str, data: dict[str, Any] | None = None) -> None

Send an event.

Parameters:

Name	Type	Description	Default
`event_type`	`str`	Event name that would be emitted to the frontend.	required
`data`	`dict[str, Any] \| None`	Payload that would be delivered with the event.	`None`

Notes

This is a no-op in fallback mode.

alert ¶

alert(message: str, alert_type: Literal['info', 'success', 'warning', 'error', 'confirm'] = 'info', title: str | None = None, duration: int | None = None, callback_event: str | None = None, position: Literal['top-right', 'top-left', 'bottom-right', 'bottom-left'] = 'top-right') -> None

Show a toast notification.

Parameters:

Name	Type	Description	Default
`message`	`str`	The message to display.	required
`alert_type`	`str`	Alert type: 'info', 'success', 'warning', 'error', or 'confirm'.	`'info'`
`title`	`str`	Optional title for the toast.	`None`
`duration`	`int`	Auto-dismiss duration in ms. Defaults based on type.	`None`
`callback_event`	`str`	Event name to emit when confirm dialog is answered.	`None`
`position`	`str`	Toast position: 'top-right', 'top-left', 'bottom-right', 'bottom-left'.	`'top-right'`

on ¶

on(event_type: str, callback: Callable[..., Any], label: str | None = None) -> PyWryWidget

Register an event handler.

Parameters:

Name	Type	Description	Default
`event_type`	`str`	Event name to subscribe to.	required
`callback`	`Callable[..., Any]`	Callback that would handle the event in a real anywidget runtime.	required
`label`	`str or None`	Ignored (accepted for API compatibility with `PyWry.on()`).	`None`

Returns:

Type	Description
`PyWryWidget`	Self for method chaining.

Notes

This is a no-op in fallback mode.

set_content ¶

set_content(content: str) -> None

Set content.

update ¶

update(html: str) -> None

Update the widget's HTML content.

_repr_html_ ¶

_repr_html_() -> str

HTML representation.

display ¶

display() -> None

Display the widget (no-op in fallback).

from_html `classmethod` ¶

from_html(content: str, callbacks: dict[str, Callable[[dict[str, Any], str, str], Any]] | None = None, theme: str = 'dark', width: str = '100%', height: str = '500px', toolbars: list | None = None, modals: list | None = None) -> PyWryWidget

Build a fallback widget; ignores callbacks/toolbars/modals.

pywry.widget¶

Base Widget¶

pywry.widget.PyWryWidget ¶

Attributes¶

_label instance-attribute ¶

content instance-attribute ¶

_handlers instance-attribute ¶

label property ¶

Functions¶

on ¶

emit ¶

set_content ¶

update ¶

_repr_html_ ¶

display ¶

from_html classmethod ¶

alert ¶

Plotly Widget¶

pywry.widget.PyWryPlotlyWidget ¶

Attributes¶

_label instance-attribute ¶

content instance-attribute ¶

_handlers instance-attribute ¶

label property ¶

Functions¶

emit ¶

alert ¶

on ¶

set_content ¶

update ¶

_repr_html_ ¶

display ¶

from_html classmethod ¶

AG Grid Widget¶

pywry.widget.PyWryAgGridWidget ¶

Attributes¶

_label instance-attribute ¶

content instance-attribute ¶

_handlers instance-attribute ¶

label property ¶

Functions¶

update_data ¶

update_columns ¶

update_grid ¶

emit ¶

alert ¶

on ¶

set_content ¶

update ¶

_repr_html_ ¶

display ¶

from_html classmethod ¶

_label `instance-attribute` ¶

content `instance-attribute` ¶

_handlers `instance-attribute` ¶

label `property` ¶

from_html `classmethod` ¶

_label `instance-attribute` ¶

content `instance-attribute` ¶

_handlers `instance-attribute` ¶

label `property` ¶

from_html `classmethod` ¶

_label `instance-attribute` ¶

content `instance-attribute` ¶

_handlers `instance-attribute` ¶

label `property` ¶

from_html `classmethod` ¶