wxyz.lab

Widgets for reusing parts of the JupyterLab interface

class wxyz.lab.DockBox(**kwargs)[source]

Bases: wxyz.lab.base.LabBase, ipywidgets.widgets.widget_box.Box

A Box that renders as a DockPanel

class wxyz.lab.DockPop(**kwargs)[source]

Bases: wxyz.lab.base.LabBase, ipywidgets.widgets.widget_box.Box

A “box” that just adds stuff to the main JupyterLab area

class wxyz.lab.Editor(**kwargs)[source]

Bases: wxyz.lab.base.LabBase, ipywidgets.widgets.widget_string.Textarea

A basic editor

get_interact_value()

Return the value for this widget which should be passed to interactive functions. Custom widgets can change this method to process the raw value self.value.

class wxyz.lab.EditorConfig(**kwargs)[source]

Bases: ipywidgets.widgets.widget.Widget

JSON-compatible CodeMirror configuration options.

class wxyz.lab.EditorModeInfo(**kwargs)[source]

Bases: ipywidgets.widgets.widget.Widget

CodeMirror modes known to the frontend

class wxyz.lab.Markdown(**kwargs)[source]

Bases: wxyz.core.base.Fn, wxyz.lab.base.LabBase

A widget that turns markdown source into HTML source

the_function(source)[source]

Render some Jupyter markdown

the_observer(*_)

Base observer that updates value and/or error

class wxyz.lab.Terminal(**kwargs)[source]

Bases: wxyz.lab.base.LabBase

A basic terminal

data(content)[source]

programmatically call all data listeners

on_data(callback, remove=False)[source]

register a callback which will receive a message

send_line(line)[source]

convenience wrapper around send

Classes

digraph "classes_lab" { graph [fontname = "sans-serif"]; node [fontname = "sans-serif"]; edge [fontname = "sans-serif"]; charset="utf-8" rankdir=BT "0" [label="{/home/runner/work/wxyz/wxyz/envs/_base/lib/python3.8/site-packages/wxyz/lab/base.py.LabBase|_model_module : Unicode\l_model_module_version : Unicode\l_view_module : Unicode\l_view_module_version : Unicode\l|}", shape="record"]; "1" [label="{/home/runner/work/wxyz/wxyz/envs/_base/lib/python3.8/site-packages/wxyz/lab/widget_dock.py.DockBox|_model_name\l_view_name\lborder_size\ldock_layout\lhide_tabs\lspacing\ltab_size\l|}", shape="record"]; "2" [label="{/home/runner/work/wxyz/wxyz/envs/_base/lib/python3.8/site-packages/wxyz/lab/widget_dock.py.DockPop|_model_name\l_view_name\lmode\l|}", shape="record"]; "3" [label="{/home/runner/work/wxyz/wxyz/envs/_base/lib/python3.8/site-packages/wxyz/lab/widget_editor.py.Editor|_model_name\l_view_name\lconfig\lscroll_x\lscroll_y\lvalue\l|}", shape="record"]; "4" [label="{/home/runner/work/wxyz/wxyz/envs/_base/lib/python3.8/site-packages/wxyz/lab/widget_editor.py.EditorConfig|_model_module\l_model_module_version\l_model_name\lautofocus\lcursorBlinkRate\lcursorHeight\ldragDrop\lelectricChars\lfirstLineNumber\lfixedGutter\lflattenSpans\lfoldGutter\lgutters\lhistoryEventDelay\lindentUnit\lindentWithTabs\lkeyMap\llineNumbers\llineWrapping\lmaxHighlightLength\lmode\lplaceholder\lpollInterval\lreadOnly\lrtlMoveVisually\lscrollbarStyle\lshowCursorWhenSelecting\lsmartIndent\ltabSize\ltabindex\ltheme\lundoDepth\lviewportMargin\lworkDelay\lworkTime\l|}", shape="record"]; "5" [label="{/home/runner/work/wxyz/wxyz/envs/_base/lib/python3.8/site-packages/wxyz/lab/widget_editor.py.EditorModeInfo|_model_module\l_model_module_version\l_model_name\lmodes\l|}", shape="record"]; "6" [label="{/home/runner/work/wxyz/wxyz/envs/_base/lib/python3.8/site-packages/wxyz/lab/widget_markdown.py.Markdown|_model_name\l|the_function(source)\l}", shape="record"]; "7" [label="{/home/runner/work/wxyz/wxyz/envs/_base/lib/python3.8/site-packages/wxyz/lab/widget_term.py.Terminal|_data_handlers\l_model_name\l_view_name\lactive_terminals\lcols\lfit\llocal_echo\lrows\lscroll\lselection\ltheme\l|__init__()\l_handle_terminal_msg(_, content, buffers)\ldata(content)\lon_data(callback, remove)\lsend_line(line)\l}", shape="record"]; "8" [label="{ipywidgets.widgets.widget.LoggingHasTraits|log : Instance\l|_log_default()\l}", shape="record"]; "9" [label="{ipywidgets.widgets.widget.Widget|_display_callbacks : Instance\l_holding_sync : bool\l_holding_sync : bool\l_ipython_display_ : NoneType\l_model_id\l_model_module : Unicode\l_model_module_version : Unicode\l_model_name : Unicode\l_msg_callbacks : Instance\l_property_lock : Dict\l_property_lock : dict\l_states_to_send : Set\l_view_count : Int\l_view_module : Unicode\l_view_module_version : Unicode\l_view_name : Unicode\l_widget_construction_callback : NoneType\lcomm : Comm, NoneType\lcomm : Instance\lkeys : List\lmodel_id\lwidget_types : WidgetRegistry\lwidgets : dict\l|__del__()\l__init__()\l__repr__()\l_call_widget_constructed(widget)\l_comm_changed(change)\l_compare(a, b)\l_default_keys()\l_gen_repr_from_keys(keys)\l_get_embed_state(drop_defaults)\l_handle_custom_msg(content, buffers)\l_handle_displayed()\l_handle_msg(msg)\l_ipython_display_()\l_is_numpy(x)\l_lock_property()\l_repr_keys()\l_send(msg, buffers)\l_should_send_property(key, value)\l_trait_from_json(x)\l_trait_to_json(x)\ladd_traits()\lclose()\lclose_all(cls)\lget_manager_state(drop_defaults, widgets)\lget_state(key, drop_defaults)\lget_view_spec()\lhandle_comm_opened(comm, msg)\lhold_sync()\lnotify_change(change)\lon_displayed(callback, remove)\lon_msg(callback, remove)\lon_widget_constructed(callback)\lopen()\lsend(content, buffers)\lsend_state(key)\lset_state(sync_data)\l}", shape="record"]; "10" [label="{traitlets.traitlets.HasDescriptors|\l|__new__()\lsetup_instance()\l}", shape="record"]; "11" [label="{traitlets.traitlets.HasTraits|__class__\l__dict__\l_cross_validation_lock : bool\l_trait_notifiers : dict\lcross_validation_lock\lnotify_change\l|__getstate__()\l__init__()\l__setstate__(state)\l_add_notifiers(handler, name, type)\l_get_trait_default_generator(name)\l_notify_observers(event)\l_notify_trait(name, old_value, new_value)\l_register_validator(handler, names)\l_remove_notifiers(handler, name, type)\ladd_traits()\lclass_own_trait_events(cls, name)\lclass_own_traits(cls)\lclass_trait_names(cls)\lclass_traits(cls)\lhas_trait(name)\lhold_trait_notifications()\lnotify_change(change)\lobserve(handler, names, type)\lon_trait_change(handler, name, remove)\lset_trait(name, value)\lsetup_instance()\ltrait_defaults()\ltrait_events(cls, name)\ltrait_has_value(name)\ltrait_metadata(traitname, key, default)\ltrait_names()\ltrait_values()\ltraits()\lunobserve(handler, names, type)\lunobserve_all(name)\l}", shape="record"]; "12" [label="{wxyz.core.base.Base|_model_module : Unicode\l_model_module_version : Unicode\l_view_module : Unicode\l_view_module_version : Unicode\lclosable : Bool\ldescription : Unicode\lerror : CUnicode\licon_class : Unicode\l|}", shape="record"]; "13" [label="{wxyz.core.base.Fn|_observed_traits : list\lerror : str\lmode : Enum\lsource : Any\lvalue : Any\lvalue : NoneType\l|__init__()\lthe_observer()\l}", shape="record"]; "14" [label="{wxyz.core.base.WXYZBase|_model_module : Unicode\l_model_module_version : Unicode\l_view_module : Unicode\l_view_module_version : Unicode\l|}", shape="record"]; "0" -> "12" [arrowhead="empty", arrowtail="none"]; "6" -> "13" [arrowhead="empty", arrowtail="none"]; "8" -> "11" [arrowhead="empty", arrowtail="none"]; "9" -> "8" [arrowhead="empty", arrowtail="none"]; "11" -> "10" [arrowhead="empty", arrowtail="none"]; "12" -> "14" [arrowhead="empty", arrowtail="none"]; "13" -> "12" [arrowhead="empty", arrowtail="none"]; "14" -> "9" [arrowhead="empty", arrowtail="none"]; }