Vuer package#

Module contents#

class vuer.Vuer(_deps=None, **overrides)#

Bases: PrefixProto, Server

A Vuer is a document that can be rendered in a browser.

WEBSOCKET_MAX_SIZE = 268435456#

cors = 'https://vuer.ai,https://dash.ml,http://localhost:8000,http://127.0.0.1:8000,*'#

device = 'cuda'#

domain = 'https://vuer.ai'#

free_port = True#

host = 'localhost'#

name = 'vuer'#

port = 8012#

queries = {}#

queue_len = 100#

static_root = '.'#

uri = 'ws://localhost:8012'#

vuer.base module#

class vuer.base.Server#

Bases: object

WEBSOCKET_MAX_SIZE = 268435456#

cors = Proto(default='*', dtype=<class 'str'>, help=":str '*' Enable CORS", metavar='\x08')#

host = Proto(default='localhost', dtype=<class 'str'>, help=":str 'localhost' ", metavar='\x08')#

port = Proto(default=8012, dtype=<class 'int'>, help=':int 8012 ', metavar='\x08')#

run()#

async vuer.base.default_handler(request, ws)#

async vuer.base.handle_file_request(request, root)#

async vuer.base.websocket_handler(request, handler, **ws_kwargs)#

vuer.events module#

class vuer.events.Add(*elements: List[Element], to: str | None = None)#

Bases: ServerEvent

ADD Operator is used to insert new nodes to the scene graph. By default it inserts into the root node, but you can specify a parent node to insert into via the to argument.

Note: only supports a single parent key right now.

Example:

app.add @ Element(…)

app.add @ [ Element(…), Element(…), … ]

app.add(Element, to=”my_parent_key”)

app.add([Element, …], to=”my_parent_key”)

etype = 'ADD'#

serialize()#: Serialize the event to a dictionary for sending over the websocket. :return: A dictionary representing the event.

class vuer.events.ClientEvent(etype=None, **kwargs)#

Bases: Event

value = None#

class vuer.events.End(**kwargs)#

Bases: ServerEvent

A higher-level ServerEvent that wraps other ServerEvents

etype = 'TERMINATE'#

class vuer.events.Event#

Bases: object

An event is a message sent from the server to the client.

class vuer.events.Frame(data: ServerEvent, frame_rate=60.0, **kwargs)#

Bases: ServerEvent

A higher-level ServerEvent that wraps other ServerEvents

ServerEvent: ServerEvent#

etype = 'FRAME'#

class vuer.events.GrabRender(key='DEFAULT', **kwargs)#

Bases: ServerRPC

A higher-level ServerEvent that wraps other ServerEvents

etype = 'GRAB_RENDER'#

uuid: str#

class vuer.events.InitEvent(**kwargs)#: Bases: ClientEvent

class vuer.events.Noop(**kwargs)#

Bases: ServerEvent

etype = 'NOOP'#

class vuer.events.NullEvent(**kwargs)#: Bases: ClientEvent

class vuer.events.Remove(*keys: List[str], **kwargs)#

Bases: ServerEvent

An Update ServerEvent is sent to the client when the server wants to update the client’s state. It appends the data sent in the Update ServerEvent to the client’s current state.

etype = 'REMOVE'#

class vuer.events.ServerEvent(data, etype=None, **kwargs)#

Bases: Event

serialize()#: Serialize the event to a dictionary for sending over the websocket. :return: A dictionary representing the event.

class vuer.events.ServerRPC(data, uuid=None, **kwargs)#

Bases: ServerEvent

etype = 'RPC'#

rtype = 'RPC_RESPONSE@{uuid}'#

uuid: str#

class vuer.events.Set(data: Type[Scene])#

Bases: ServerEvent

SET Operator is used exclusively to set the root Scene node. Throws an error (on the client side) if the data is not a Scene object.

etype = 'SET'#

class vuer.events.Update(*elements: List[Element], strict=False)#

Bases: ServerEvent

UPDATE Operator is used to update a specific node in the scene graph.

Use “$delete” value for elements you want to remove. Or “$strict” mode to copy the element verbatim.

Example:

app.update @ { “key”: “my_key”, “value”: “$delete” }

app.update({ “key”: “my_key”, “value”: “$delete” }, strict=True)

app.update @ [ { “key”: “my_key”, “value”: “$delete” }, … ]

app.update({ “key”: “my_key”, “value”: “$delete” }, …, strict=True)

etype = 'UPDATE'#

serialize()#: Serialize the event to a dictionary for sending over the websocket. :return: A dictionary representing the event.

class vuer.events.Upsert(*elements: List[Element], to: str | None = None, strict=False)#

Bases: ServerEvent

UPSERT Operator is used to update nodes to new values, when then they do not exist, insert new ones to the scene graph.

Note: only supports a single parent key right now.

Example:

app.upsert @ Element(…)

app.upsert @ [ Element(…), Element(…), … ]

app.upsert(Element, to=”my_parent_key”)

app.upsert([Element, …], to=”my_parent_key”)

etype = 'UPSERT'#

serialize()#: Serialize the event to a dictionary for sending over the websocket. :return: A dictionary representing the event.

vuer.schemas module#

class vuer.schemas.AmbientLight(*children, **kwargs)#

Vuer package#

Module contents#

vuer.base module#

vuer.events module#

vuer.schemas module#

vuer.serdes module#

vuer.server module#

vuer.types module#