vuer 0.0.15rc1__py3-none-any.whl → 0.0.15rc2__py3-none-any.whl

vuer/base.py

@@ -16,13 +16,9 @@ async def default_handler(request, ws):
 
 
 async def websocket_handler(request, handler, **ws_kwargs):
-    print("New connection!!!")
-
     ws = web.WebSocketResponse(**ws_kwargs)
     await ws.prepare(request)
 
-    print("Socket stored")
-
     try:
         await handler(request, ws)
 
@@ -101,7 +97,8 @@ class Server:
             site = web.TCPSite(runner, self.host, self.port)
             await site.start()
 
-            print(f"Serving on http://{self.host}:{self.port}")
+            # This print has been very confusing to the user. Remove. - Ge
+            # print(f"Serving on http://{self.host}:{self.port}")
 
         event_loop = asyncio.get_event_loop()
 

vuer/events.py

@@ -89,14 +89,19 @@ NOOP = Noop()
 
 
 class Set(ServerEvent):
-    """
+    """Set Operation (Server Event).
+
     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"
+    """The Event Type."""
 
-    def __init__(self, data: Type[Scene]):
+    def __init__(self, data: Scene):
+        """
+        :param data: The data to set.
+        """
         super().__init__(data)
 
 
@@ -276,14 +281,18 @@ class GrabRender(ServerRPC):
 
     etype = "GRAB_RENDER"
 
-    def __init__(self, key="DEFAULT", **kwargs):
-        super().__init__(data=kwargs, key=key)
+    def __init__(self, *, key: str = "DEFAULT", **kwargs):
+        super().__init__(data=kwargs)
+        self.key = key
         self.rtype = f"GRAB_RENDER_RESPONSE@{self.uuid}"
 
-# if __name__ == "__main__":
-#     e = Frame @ {"hey": "yo"}
-#     print(e)
-#     print(e.data)
-#
-#     e = Set @ {"data": "new"}
-#     print(e.serialize())
+
+if __name__ == "__main__":
+    # e = Frame @ {"hey": "yo"}
+    # print(e)
+    # print(e.data)
+    #
+    # e = Set @ {"data": "new"}
+    # print(e.serialize())
+    e = GrabRender({"message": "hey"})
+    print(e.serialize())

vuer/schemas.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Union, Tuple, List
 
 import numpy as np
 import PIL.Image as pil_image
@@ -262,8 +262,8 @@ class Scene(BlockElement):
         rawChildren=None,
         htmlChildren=None,
         bgChildren=None,
-        # default to z-up
-        up=[0, 0, 1],
+        # default to y-up to be consistent with three.js. Blender uses z-up though.
+        up=[0, 1, 0],
         **kwargs,
     ):
         super().__init__(*children, up=up, **kwargs)
@@ -334,10 +334,34 @@ class TriMesh(SceneElement):
 
 
 class PointCloud(SceneElement):
-    tag = "PointCloud"
-    children = []
+    """PointCould element, highly optimized for payload size and speed.
+
+    :param vertices: An optional numpy array of shape (N, 3) containing the vertices of the pointcloud.
+    :type  vertices: NDArray[np.float16]
+    :param colors: An optional numpy array of shape (N, 3) containing the colors of the point cloud.
+    :type  color: NDArray[np.uint8]
+    :param size: An optional float that sets the size of the points.
+    :type  size: float
+    :param key: str An optional string that sets the key of the element.
+    :type  key: str
+
+    Usage::
+
+        sess.upsert @ PointCloud(
+            vertices=np.random.rand(1000, 3),
+            colors=np.random.rand(1000, 3),
+            size=0.01,
+            key="pointcloud",
+        )
+
+    """
+
+    tag: str = "PointCloud"
     vertices: NDArray[np.float16] = None
+    """An optional numpy array of shape (N, 3) containing the vertices of the point cloud."""
     colors: NDArray[np.uint8] = None
+    """An optional numpy array of shape (N, 3) containing the colors of the point cloud."""
+    children = []
 
     def __post_init__(self, **kwargs):
         self.vertices = self.vertices.astype(np.float16).flatten().tobytes()
@@ -573,23 +597,70 @@ class Grid(SceneElement):
 
 class GrabRender(SceneElement):
     tag = "GrabRender"
+    key = "DEFAULT"
+    """We do not want the client to set keys automatically since GrabRender is 
+    usually used a singleton component as default."""
 
 
 class TimelineControls(SceneElement):
     tag = "TimelineControls"
+    # todo: consider adding default component keys here.
 
 
 class PointerControls(SceneElement):
     tag = "PointerControls"
+    # todo: consider adding default component keys here.
 
 
 class DefaultScene(Scene):
+    """Default Scene that includes a basic setup of ambient lights.
+
+
+    :param children: list of children elements to be rendered in the scene.
+    :type children: SceneElement, ...
+    :param rawChildren: list of children elements to be rendered in the scene.
+    :param htmlChildren: list of children elements to be rendered in the scene.
+    :param bgChildren: list of children elements to be rendered in the scene.
+    :param show_helper: list of children elements to be rendered in the scene.
+    :param startStep: list of children elements to be rendered in the scene.
+    :param endStep: list of children elements to be rendered in the scene.
+    :param up: list of children elements to be rendered in the scene.
+    :param kwargs: list of children elements to be rendered in the scene.
+
+    Example Usage::
+
+        DefaultScene(
+            # Ambient Light does not have helper because it is ambient.
+            AmbientLight(intensity=1.0, key="default_ambient_light"),
+            DirectionalLight(
+                intensity=1, key="default_directional_light", helper=show_helper
+            ),
+            *children,
+            rawChildren=rawChildren,
+            htmlChildren=htmlChildren,
+            bgChildren=[
+                GrabRender(),
+                *[
+                    # we use a key here so that we can replace the timeline controls via update
+                    TimelineControls(start=startStep, end=endStep, key="timeline")
+                    if endStep
+                    else None,
+                ],
+                PointerControls(),
+                Grid(),
+                *bgChildren,
+            ],
+            up=up,
+            **kwargs,
+        )
+    """
+
     def __init__(
         self,
-        *children,
-        rawChildren=None,
-        htmlChildren=None,
-        bgChildren=[],
+        *children: SceneElement,
+        rawChildren: List[SceneElement] = None,
+        htmlChildren: List[Element] = None,
+        bgChildren: List[SceneElement] = [],
         show_helper=True,
         startStep=0,
         endStep=None,
@@ -599,9 +670,7 @@ class DefaultScene(Scene):
     ):
         rawChildren = [
             AmbientLight(intensity=1.0, key="default_ambient_light"),
-            DirectionalLight(
-                intensity=1, key="default_directional_light", helper=show_helper
-            ),
+            DirectionalLight(intensity=1, key="default_directional_light", helper=show_helper),
             *(rawChildren or []),
         ]
 
@@ -611,7 +680,8 @@ class DefaultScene(Scene):
             rawChildren=rawChildren,
             htmlChildren=htmlChildren,
             bgChildren=[
-                GrabRender(),
+                # skey spec here is a little redundant.
+                GrabRender(key="DEFAULT"),
                 *[
                     # we use a key here so that we can replace the timeline controls via update
                     TimelineControls(start=startStep, end=endStep, key="timeline")

vuer/server.py

@@ -92,7 +92,7 @@ class VuerSession:
 
         event = GrabRender(**kwargs)
 
-        return await self.vuer.rpc(self.vuer.CURRENT_WS_ID, event, ttl=ttl)
+        return await self.vuer.rpc(self.CURRENT_WS_ID, event, ttl=ttl)
 
     @property
     def set(self) -> At:
@@ -116,7 +116,7 @@ class VuerSession:
         Supports passing in a list of elements. (Thank God I implemented this...
         so handy! - Ge)
 
-        Example Usage:
+        Example Usage::
 
             app.update @ [element1, element2, ...]
         """
@@ -136,11 +136,11 @@ class VuerSession:
 
         Requires a parentKey, or treats the Scene root node as the default parent.
 
-        Example Usage:
+        Example Usage::
 
             app.add(element1, element2, ..., to=parentKey.)
 
-            or using the Scene root node as the default parent:
+        or using the Scene root node as the default parent: ::
 
             app.add @ element1
 
@@ -161,11 +161,11 @@ class VuerSession:
 
         Requires a parentKey, or treats the Scene root node as the default parent.
 
-        Example Usage:
+        Example Usage::
 
             app.upsert(element1, element2, ..., to=parentKey.)
 
-            or using the Scene root node as the default parent:
+        or using the Scene root node as the default parent: ::
 
             app.upsert @ element1
 
@@ -184,11 +184,11 @@ class VuerSession:
     def remove(self) -> At:
         """Remove elements by keys.
 
-        Example Usage:
+        Example Usage::
 
             app.remove @ ["key1", "key2", ...]
 
-            or a single key:
+        or a single key: ::
 
             app.remove @ "key1"
 
@@ -269,7 +269,6 @@ class Vuer(PrefixProto, Server):
         self.ws = {}
         self.spawned_fn: Spawnable = None
         self.spawned_coroutines = []
-        self.CURRENT_WS_ID = None
 
     async def relay(self, request):
         """This is the relay object for sending events to the server.
@@ -436,7 +435,7 @@ class Vuer(PrefixProto, Server):
         # note: by-pass the uplink message queue entirely, rendering it immune
         #   to the effects of queue length.
         await self.send(ws_id, event)
-        await sleep(0.5)
+        # await sleep(0.5)
         try:
             await asyncio.wait_for(rpc_event.wait(), ttl)
         except asyncio.TimeoutError as e:
@@ -462,7 +461,7 @@ class Vuer(PrefixProto, Server):
         ws_id = proxy.CURRENT_WS_ID
         queue = proxy.uplink_queue
 
-        print(f"\rUplink task running:{ws_id}")
+        print(f"\rUplink task running. id:{ws_id}")
         while True:
             if ws_id not in self.ws:
                 print(f"uplink:{ws_id} is not in websocket pool")
@@ -599,7 +598,7 @@ class Vuer(PrefixProto, Server):
         return ttl_handler()
 
     def run(self, kill=None, *args, **kwargs):
-        print("Vuer running at: " + self.get_url())
+        import os
 
         # protocol, host, _ = self.uri.split(":")
         # port = int(_)
@@ -614,7 +613,9 @@ class Vuer(PrefixProto, Server):
         self._socket("", self.downlink)
         # serve local files via /static endpoint
         self._static("/static", self.static_root)
-        print("serving static files from", self.static_root, "at", "/static")
+        print("Serving file://" + os.path.abspath(self.static_root), "at", "/static")
         self._route("/relay", self.relay, method="POST")
 
+        print("Visit: " + self.get_url())
+
         super().run()

{vuer-0.0.15rc1.dist-info → vuer-0.0.15rc2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vuer
-Version: 0.0.15rc1
+Version: 0.0.15rc2
 Home-page: https://github.com/geyang/vuer
 Author: Ge Yang<ge.ike.yang@gmail.com>
 Author-email: ge.ike.yang@gmail.com

{vuer-0.0.15rc1.dist-info → vuer-0.0.15rc2.dist-info}/RECORD

@@ -1,16 +1,16 @@
 vuer/__init__.py,sha256=HMgKfbQAW77ukrMOnE2oKNOYbSNEkBwElpkWxLofvP8,41
-vuer/base.py,sha256=mODsrpH8qePkfVjx5rXdXs7xjt2zpjcSOs_jzUpNbLI,3051
-vuer/events.py,sha256=hPCCGZxL090rz3u_ySB_vFB0d7tgOwdQVPNL487z37k,7069
-vuer/schemas.py,sha256=JI2-91cvGKCuA5mjbE29YVIBNajKge9ZnxiJzqcd4m0,14403
+vuer/base.py,sha256=R-PtD39ouihiEGmSfJL26chlU0XkFJP-JmBNYzDdEvM,3068
+vuer/events.py,sha256=2N6B9sYkxxVv6BhegBq-dIc8mxb3A42lgJz-pD1MCRU,7272
+vuer/schemas.py,sha256=_jQYPTtYQ0JoN5_bTygfX8CdB1tCTZlif6o6nPuXmAM,17502
 vuer/serdes.py,sha256=gD2iA9Yypu1QjocneOT3Nc0y6q_mdHn9zW1ko5j3I7c,2600
-vuer/server.py,sha256=i-ShDfxAr5KBXtgCTLDbbqpj1ExjaAROF_mv4P0jOSM,18521
+vuer/server.py,sha256=vdnKH4WwvJYTkE1v3lVjY_GKGL1dOcwxq6OqSeKD8OI,18506
 vuer/types.py,sha256=YpRQrBzB2uGM1Lhu8eSaBGB88IgSnY4Czl5cgthxGkM,1003
 vuer/__pycache__/__init__.cpython-38.pyc,sha256=rS-9zzAjFEXnObk5q3E5Rex_uvoJ-Ccfz7Hs9DGNVgs,188
-vuer/__pycache__/base.cpython-38.pyc,sha256=cxwPAy8hWCo5t9TaTaaT1gs2MpByDbAOKCMVbqVldds,3930
-vuer/__pycache__/events.cpython-38.pyc,sha256=7NT7W5ObDyCz542mhDQkLWYzMOIP0Ihx7syjnJZT6lE,9409
-vuer/__pycache__/schemas.cpython-38.pyc,sha256=D0fWjYOBNPSbQkH_aR_-yOz4BZcgflUB6c6TjnTt2DI,19936
-vuer/__pycache__/serdes.cpython-38.pyc,sha256=oT1A94H8ayRCxNnw0L-7Q5Dt3535MOwXZMkvyQQvB9M,2032
-vuer/__pycache__/server.cpython-38.pyc,sha256=aup7KkU3-iKB4LZKQRHmABOd7NQMw-iCNhl1geH4Um4,17318
+vuer/__pycache__/base.cpython-38.pyc,sha256=Z5EFlRX9RqZsQUszvqPtAhLv_5QG5wlUXW7JbFd_XDc,3824
+vuer/__pycache__/events.cpython-38.pyc,sha256=d8eqZPmim4QsTts1dkNmWmjcV4jbULFB3VjjqcHOtxo,9612
+vuer/__pycache__/schemas.cpython-38.pyc,sha256=uqtDpdCxc8izVnUoLL4FuBKsWaG0pDdq7sxkhghoI8c,22588
+vuer/__pycache__/serdes.cpython-38.pyc,sha256=KMxTjPEWuSGn2bqBAl5OLIDSCSoqfPDGfk3fvNnRDYA,2253
+vuer/__pycache__/server.cpython-38.pyc,sha256=o8MqpilH06wXjccPBtg6sN36viU8lr7pkR3q1GLvi68,17302
 vuer/__pycache__/types.cpython-38.pyc,sha256=eM6bZ35nB-AYALbZXf9goHjLoHxllqbIwHloi0yCOeA,1868
 vuer/addons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vuer/addons/nerf_vuer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -21,9 +21,9 @@ vuer/addons/nerf_vuer/render_components.py,sha256=XilHnJySJWVgmdUbPFNYyc_YWV8O5A
 vuer/addons/nerf_vuer/render_nodes.py,sha256=5TKqIbMPiOtBxfF4FQI6uB0w_9FTfGiwS8xRbhPa0_g,14441
 vuer/addons/nerfuer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vuer/addons/nerfuer/render_nodes.py,sha256=EJK5N3xne5n7abTaAoLPX7SRqQ_tEen9zNypvSnZTTw,4465
-vuer-0.0.15rc1.dist-info/LICENSE,sha256=MGF-inVBUaGe2mEjqT0g6XsHIXwoNXgNHqD7Z1MzR0k,1063
-vuer-0.0.15rc1.dist-info/METADATA,sha256=y2jKpbzYnJYYT28RCpPyA6SMZ6lWbvc0PHjte1sZ6xQ,4280
-vuer-0.0.15rc1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-vuer-0.0.15rc1.dist-info/entry_points.txt,sha256=J_NM6fbpipmD9oP7cdxd1UyBR8mVEQVx0xjlE_56yss,41
-vuer-0.0.15rc1.dist-info/top_level.txt,sha256=ermmVkwvGFAK4gfSgDIwOmKpxwpqNt-oo7gVQQUSHok,5
-vuer-0.0.15rc1.dist-info/RECORD,,
+vuer-0.0.15rc2.dist-info/LICENSE,sha256=MGF-inVBUaGe2mEjqT0g6XsHIXwoNXgNHqD7Z1MzR0k,1063
+vuer-0.0.15rc2.dist-info/METADATA,sha256=kvvvLn_s9UAOKj-ZyxK65be2eQeXU72ovktFOmJv0nM,4280
+vuer-0.0.15rc2.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+vuer-0.0.15rc2.dist-info/entry_points.txt,sha256=J_NM6fbpipmD9oP7cdxd1UyBR8mVEQVx0xjlE_56yss,41
+vuer-0.0.15rc2.dist-info/top_level.txt,sha256=ermmVkwvGFAK4gfSgDIwOmKpxwpqNt-oo7gVQQUSHok,5
+vuer-0.0.15rc2.dist-info/RECORD,,