wxyz.dvcs#

DVCS widgets

At present, none of these widgets work in jupyterlite.

class wxyz.dvcs.Brancher(**kwargs: Any)[source]#

Bases: HBox

Create a new branch from the current commit

box_style#: Use a predefined styling for the box.

children#: List of widget children

create(*args, **kwargs)[source]#: actually create the new branch

class wxyz.dvcs.Committer(**kwargs: Any)[source]#

Bases: VBox

Create commits with a message

box_style#: Use a predefined styling for the box.

change_btn_desc(changes)[source]#: update button description

children#: List of widget children

commit(*args)[source]#: actually commit

class wxyz.dvcs.Git(**kwargs: Any)[source]#

Bases: Repo

A git repository widget

add_remote(name, url, **kwargs)#: add a new reference to a remote repository

branch(name, ref='HEAD')[source]#: create and checkout a new branch

checkout(name)[source]#: checkout a named reference

commit(message)[source]#: create a commit

head#: the symbolic name of the current head

head_hash#: the full hash of the current head

merge(ref)[source]#: create a merge commit on the active branch with the given ref

revert(ref)[source]#: restore to a committish

stage(path)[source]#: stage a single path to the index

track(**kwargs)#: create a tracker for the given widget

unstage(path)[source]#: remove a path from the index

class wxyz.dvcs.HeadPicker(**kwargs: Any)[source]#

Bases: HBox

a simple dropdown-based picker of current DVCS heads

box_style#: Use a predefined styling for the box.

checkout(*args, **kwargs)[source]#: check out a ref

children#: List of widget children

refresh(*args, **kwargs)[source]#: refresh the heads

class wxyz.dvcs.HeadStatus(**kwargs: Any)[source]#

Bases: HBox

a status bar

box_style#: Use a predefined styling for the box.

children#: List of widget children

class wxyz.dvcs.JSONDictTracker(**kwargs: Any)[source]#

Bases: DictTracker, ExecutorTracker

sync a widget’s traits to single JSON file on disk

classmethod detect_tracker(path, base_cls=None)#: naive tracker finder… needs something cleverer

dict_from_widget()#: generate a JSON-ready dict from a widget

property loop#: get the current event loop, if available

async on_file_change()#: react to a file change

on_file_change_sync()[source]#: perform JSON reading in thread

async on_user_change()#: react to a user change

on_user_change_sync()[source]#: perform JSON writing on thread

tracked_traits#: trait names to track (default all)

user_idle_interval#: seconds to wait before declaring the user idle

widget_from_dict(content)#: update a widget from a dict

class wxyz.dvcs.Remoter(**kwargs: Any)[source]#

Bases: VBox

Adds remotes

box_style#: Use a predefined styling for the box.

children#: List of widget children

class wxyz.dvcs.Repo(**kwargs: Any)[source]#

Bases: Widget

base class for a DVCS repo

add_remote(name, url, **kwargs)[source]#: add a new reference to a remote repository

head#: the symbolic name of the current head

head_hash#: the full hash of the current head

track(**kwargs)[source]#: create a tracker for the given widget

class wxyz.dvcs.TimeTraveler(**kwargs: Any)[source]#

Bases: HBox

Show a selection widget

box_style#: Use a predefined styling for the box.

children#: List of widget children

class wxyz.dvcs.Tracker(**kwargs: Any)[source]#

Bases: Widget

base class for trackers

classmethod detect_tracker(path, base_cls=None)[source]#: naive tracker finder… needs something cleverer

property loop#: get the current event loop, if available

async on_file_change()[source]#: react to a file changing on disk

async on_user_change()[source]#: react to a user changing a widget

tracked_traits#: trait names to track (default all)

user_idle_interval#: seconds to wait before declaring the user idle

class wxyz.dvcs.Watcher(**kwargs: Any)[source]#

Bases: Widget

A lightweight watcher

TODO: expose more bits

changes#: the last changes that were detected

path#: the root path to watch

watching#: whether to be watching

class wxyz.dvcs.YAMLDictTracker(**kwargs: Any)[source]#

Bases: JSONDictTracker

sync a widget’s traits to single YAML file on disk

classmethod detect_tracker(path, base_cls=None)#: naive tracker finder… needs something cleverer

dict_from_widget()#: generate a JSON-ready dict from a widget

property loop#: get the current event loop, if available

async on_file_change()#: react to a file change

on_file_change_sync()#: perform JSON reading in thread

async on_user_change()#: react to a user change

on_user_change_sync()#: perform JSON writing on thread

tracked_traits#: trait names to track (default all)

user_idle_interval#: seconds to wait before declaring the user idle

widget_from_dict(content)#: update a widget from a dict