vuer 0.0.17__py3-none-any.whl → 0.0.19__py3-none-any.whl

vuer/schemas/drei_components.py

@@ -118,29 +118,29 @@ class Facemesh(SceneElement):
     """Renders an oriented MediaPipe face mesh:
 
     :param points: An array of 468+ keypoints as returned by google/mediapipe tasks-vision. Defaults to a sample face.
-    :type points: MediaPipePoints, optional
+    :type  points: MediaPipePoints, optional
     :param face: An face object as returned by tensorflow/tfjs-models face-landmarks-detection. This parameter is deprecated.
-    :type face: MediaPipeFaceMesh, optional
+    :type  face: MediaPipeFaceMesh, optional
     :param width: Constant width of the mesh. Defaults to undefined.
-    :type width: int, optional
+    :type  width: int, optional
     :param height: Constant height of the mesh. Defaults to undefined.
-    :type height: int, optional
+    :type  height: int, optional
     :param depth: Constant depth of the mesh. Defaults to 1.
-    :type depth: int, optional
+    :type  depth: int, optional
     :param verticalTri: A landmarks tri supposed to be vertical. Defaults to [159, 386, 200]. See: https://github.com/tensorflow/tfjs-models/tree/master/face-landmarks-detection#mediapipe-facemesh-keypoints
-    :type verticalTri: Tuple[int, int, int], optional
+    :type  verticalTri: Tuple[int, int, int], optional
     :param origin: A landmark index (to get the position from) or a vec3 to be the origin of the mesh. Defaults to undefined (i.e., the bbox center).
-    :type origin: Union[int, THREE.Vector3], optional
+    :type  origin: Union[int, THREE.Vector3], optional
     :param facialTransformationMatrix: A facial transformation matrix, as returned by FaceLandmarkerResult.facialTransformationMatrixes. See: https://developers.google.com/mediapipe/solutions/vision/face_landmarker/web_js#handle_and_display_results
-    :type facialTransformationMatrix: FacemeshDatas.SAMPLE_FACELANDMARKER_RESULT.facialTransformationMatrixes[0], optional
+    :type  facialTransformationMatrix: FacemeshDatas.SAMPLE_FACELANDMARKER_RESULT.facialTransformationMatrixes[0], optional
     :param offset: Apply position offset extracted from `facialTransformationMatrix`.
-    :type offset: bool, optional
+    :type  offset: bool, optional
     :param offsetScalar: Offset sensitivity factor, less is more sensible.
-    :type offsetScalar: float, optional
+    :type  offsetScalar: float, optional
     :param faceBlendshapes: Face blendshapes, as returned by FaceLandmarkerResult.faceBlendshapes. See: https://developers.google.com/mediapipe/solutions/vision/face_landmarker/web_js#handle_and_display_results
-    :type faceBlendshapes: FacemeshDatas.SAMPLE_FACELANDMARKER_RESULT.faceBlendshapes[0], optional
+    :type  faceBlendshapes: FacemeshDatas.SAMPLE_FACELANDMARKER_RESULT.faceBlendshapes[0], optional
     :param eyes: Whether to enable eyes (note: `faceBlendshapes` is required for this). Defaults to True.
-    :type eyes: bool, optional
+    :type  eyes: bool, optional
 
     Usage::
 

vuer/schemas/html_components.py

@@ -30,6 +30,7 @@ class Element:
     def serialize(self):
         """
         Serialize the element to a dictionary for sending over the websocket.
+
         :return: Dictionary representing the element.
         """
 

vuer/schemas/scene_components.py

@@ -39,6 +39,56 @@ class SceneElement(BlockElement):
 
 
 class Frustum(SceneElement):
+    """Camera Frustum
+
+    :param position: An optional tuple of three numbers representing the position.
+    :type position: tuple[float, float, float]
+    :param rotation: An optional tuple of three numbers representing the rotation.
+    :type rotation: tuple[float, float, float]
+    :param matrix: An optional tuple of sixteen numbers representing the matrix.
+    :type matrix: tuple[float, float, float, float, float, float, float, float, float, float, float, float, float, float, float, float]
+    :param aspect: An optional number representing the aspect.
+    :type aspect: float
+    :param focus: An optional number representing the focus.
+    :type focus: float
+    :param fov: An optional number representing the field of view.
+    :type fov: float
+    :param near: An optional number representing the near field.
+    :type near: float
+    :param far: An optional number representing the far field.
+    :type far: float
+    :param scale: An optional number representing the scale.
+    :type scale: float
+    :param upScale: An optional number representing the up scale.
+    :type upScale: float
+    :param focalLength: An optional number representing the focal length.
+    :type focalLength: float
+    :param showUp: An optional boolean indicating whether to show up.
+    :type showUp: bool
+    :param showFrustum: An optional boolean indicating whether to show the frustum.
+    :type showFrustum: bool
+    :param showFocalPlane: An optional boolean indicating whether to show the focal plane.
+    :type showFocalPlane: bool
+    :param showImagePlane: An optional boolean indicating whether to show the image plane.
+    :type showImagePlane: bool
+    :param src: An optional string representing the source.
+    :type src: str
+    :param colorOrigin: An optional ColorRepresentation for the origin color.
+    :type colorOrigin: ColorRepresentation
+    :param colorFrustum: An optional ColorRepresentation for the frustum color.
+    :type colorFrustum: ColorRepresentation
+    :param colorCone: An optional ColorRepresentation for the cone color.
+    :type colorCone: ColorRepresentation
+    :param colorFocalPlane: An optional ColorRepresentation for the focal plane color.
+    :type colorFocalPlane: ColorRepresentation
+    :param colorUp: An optional ColorRepresentation for the up color.
+    :type colorUp: ColorRepresentation
+    :param colorTarget: An optional ColorRepresentation for the target color.
+    :type colorTarget: ColorRepresentation
+    :param colorCross: An optional ColorRepresentation for the cross color.
+    :type colorCross: ColorRepresentation
+    """
+
     tag = "Frustum"
 
 
@@ -132,6 +182,9 @@ class PointCloud(SceneElement):
         self.colors = self.colors.flatten().tobytes()
 
 
+p = PointCloud
+
+
 class Box(SceneElement):
     tag = "Box"
 
@@ -442,9 +495,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 []),
         ]
 
@@ -468,4 +519,4 @@ class DefaultScene(Scene):
             ],
             up=up,
             **kwargs,
-        )
+        )

vuer/server.py

@@ -2,10 +2,12 @@ import asyncio
 from asyncio import sleep
 from collections import deque, defaultdict
 from functools import partial
-from typing import cast, Callable, Coroutine
+from typing import cast, Callable, Coroutine, Dict
 from uuid import uuid4
 
+from aiohttp.web_request import Request
 from aiohttp.web_response import Response
+from aiohttp.web_ws import WebSocketResponse
 from msgpack import packb, unpackb
 from params_proto import Proto, PrefixProto
 from websockets import ConnectionClosedError
@@ -27,7 +29,7 @@ from vuer.events import (
     Upsert,
 )
 from vuer.schemas import Page
-from vuer.types import EventHandler, Spawnable
+from vuer.types import EventHandler, SocketHandler
 
 
 class At:
@@ -55,6 +57,24 @@ class VuerSession:
         self.downlink_queue = que_maker()
         self.uplink_queue = que_maker()
 
+    @property
+    def socket(self):
+        """Getter for the websocket object.
+
+        this is useful for closing the socket session from the client side.
+
+        Example Usage::
+
+            @app.spawn(start=True):
+            async def main(session: VuerSession):
+                print("doing something...")
+                await sleep(1.0)
+
+                print("I am done! closing the socket.")
+                session.socket.close()
+        """
+        return self.vuer.ws[self.CURRENT_WS_ID]
+
     def __matmul__(self, event: ServerEvent):
         """
         Send a ServerEvent to the client.
@@ -242,6 +262,22 @@ class Vuer(PrefixProto, Server):
 
         app.run()
 
+
+    .. automethod:: bind
+    .. automethod:: spawn
+    .. automethod:: relay
+    .. automethod:: bound_fn
+    .. automethod:: spawn_task
+    .. automethod:: get_url
+    .. automethod:: send
+    .. automethod:: rpc
+    .. automethod:: rpc_stream
+    .. automethod:: close_ws
+    .. automethod:: uplink
+    .. automethod:: downlink
+    .. automethod:: add_handler
+    .. automethod:: _ttl_handler
+    .. automethod:: run
     """
 
     name = "vuer"
@@ -278,8 +314,8 @@ class Vuer(PrefixProto, Server):
         # todo: can remove
         self.page = Page()
 
-        self.ws = {}
-        self.spawned_fn: Spawnable = None
+        self.ws: Dict[str, WebSocketResponse] = {}
+        self.socket_handler: SocketHandler = None
         self.spawned_coroutines = []
 
     async def relay(self, request):
@@ -290,11 +326,11 @@ class Vuer(PrefixProto, Server):
 
         Interface:
             <uri>/relay?sid=<websocket_id>
+
         :return:
             - Status 200
             - Status 400
 
-
         """
         # todo: need to implement msgpack encoding, interface
         bytes = request.bytes()
@@ -350,20 +386,18 @@ class Vuer(PrefixProto, Server):
         loop = asyncio.get_running_loop()
         return loop.create_task(task)
 
-    def spawn(self, fn: Spawnable = None, start=False):
+    def spawn(self, fn: SocketHandler = None, start=False):
         """
-        Spawn a function as a task. This is useful in the following scenario:
-
-        code::
 
+        Note: this is really a misnomer.
 
         :param fn: The function to spawn.
         :param start: Start server after binding
         :return: None
         """
 
-        def wrap_fn(fn: Spawnable):
-            self.spawned_fn = fn
+        def wrap_fn(fn: SocketHandler):
+            self.socket_handler = fn
             if start:
                 self.run()
 
@@ -375,7 +409,7 @@ class Vuer(PrefixProto, Server):
 
     def bind(self, fn=None, start=False):
         """
-        Bind a function to the Tassa. The function should be a generator that yields Page objects.
+        Bind an asynchronous generator function for use in socket connection handler. The function should be a generator that yields Page objects.
 
         :param fn: The function to bind.
         :return: None
@@ -496,7 +530,7 @@ class Vuer(PrefixProto, Server):
             else:
                 await sleep(0.0)
 
-    async def downlink(self, request, ws):
+    async def downlink(self, request: Request, ws: WebSocketResponse):
         """
         The websocket handler for receiving messages from the client.
 
@@ -515,8 +549,18 @@ class Vuer(PrefixProto, Server):
 
         self._add_task(self.uplink(vuer_proxy))
 
-        if self.spawned_fn is not None:
-            task = self._add_task(self.spawned_fn(vuer_proxy))
+        if self.socket_handler is not None:
+
+            async def handler():
+                try:
+                    await self.socket_handler(vuer_proxy)
+                except Exception:
+                    await self.close_ws(ws_id)
+                    return
+
+                await self.close_ws(ws_id)
+
+            task = self._add_task(handler())
 
         if hasattr(generator, "__anext__"):
             serverEvent = await generator.__anext__()

vuer/types.py

@@ -16,7 +16,7 @@ EventHandler = Callable[[ClientEvent, "VuerProxy"], None]
 """Defines a function that handles a client event. Second argument is the VuerProxy instance bound
 to a specific client connected through a websocket session."""
 
-Spawnable = Callable[["VuerProxy"], Coroutine]
+SocketHandler = Callable[["VuerProxy"], Coroutine]
 """Defines a function that spawns a new entity. Argument is the VuerProxy instance."""
 
 

{vuer-0.0.17.dist-info → vuer-0.0.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vuer
-Version: 0.0.17
+Version: 0.0.19
 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.17.dist-info → vuer-0.0.19.dist-info}/RECORD

@@ -3,15 +3,15 @@ vuer/base.py,sha256=R-PtD39ouihiEGmSfJL26chlU0XkFJP-JmBNYzDdEvM,3068
 vuer/events.py,sha256=8AAzkfbm5jHkeMh17Z57n8YTxF4mheWC3Qbya4XkQSc,7291
 vuer/schemas.py,sha256=aZOocE02gO43SLLfeYSxxac0x38TmyTcfs_iFh5hsJ4,18152
 vuer/serdes.py,sha256=gD2iA9Yypu1QjocneOT3Nc0y6q_mdHn9zW1ko5j3I7c,2600
-vuer/server.py,sha256=L57AATVFQpCrTyt3_bINixvMarEx9RkiRZeI4cHA2wE,19508
-vuer/types.py,sha256=TjRtc2UfRHTDBL0gTr7GGA9bh8FqMMU5Rk1DnJSQoew,1275
+vuer/server.py,sha256=gIYbWwc-25JwtK9eeojQJtPSRMrCZ8rRcmZToDMnrpg,20851
+vuer/types.py,sha256=N2KLa0fl6z8Jm6cJwZoD8Vqrins_AayG5BCGk1p3Eek,1279
 vuer/__pycache__/__init__.cpython-38.pyc,sha256=rS-9zzAjFEXnObk5q3E5Rex_uvoJ-Ccfz7Hs9DGNVgs,188
 vuer/__pycache__/base.cpython-38.pyc,sha256=Z5EFlRX9RqZsQUszvqPtAhLv_5QG5wlUXW7JbFd_XDc,3824
 vuer/__pycache__/events.cpython-38.pyc,sha256=zx3bXeJixqOyCFe2nA7qpq6jiCJ49kRaXO-xONGUyeQ,9616
 vuer/__pycache__/schemas.cpython-38.pyc,sha256=hvY9Aak8zE-zKcWiwuNe6DghOw9qH_zSe_FtkBOAPPk,23234
 vuer/__pycache__/serdes.cpython-38.pyc,sha256=KMxTjPEWuSGn2bqBAl5OLIDSCSoqfPDGfk3fvNnRDYA,2253
-vuer/__pycache__/server.cpython-38.pyc,sha256=1DKrzznGhC9ReG4UYlDED8GC-YKYOd-UhC5f_yD_BmA,18270
-vuer/__pycache__/types.cpython-38.pyc,sha256=OcUWJXEUF2K2w-pmEybOVKY7xJqjtr_N0UuyMIKzEG4,1815
+vuer/__pycache__/server.cpython-38.pyc,sha256=z44pZ0u3x6ZLwDOh2skBFlvNEnGO2re4cdhRAippzy0,19636
+vuer/__pycache__/types.cpython-38.pyc,sha256=IhlXtkT-XWM0V1420FDuoqIYnpvRvekYVkGqEK7fAV8,1819
 vuer/addons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vuer/addons/nerf_vuer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vuer/addons/nerf_vuer/control_components.py,sha256=K4PU0nD572L4J7lLFfShWficWZQnH4t-x6WWMrAVw8g,290
@@ -22,16 +22,16 @@ vuer/addons/nerf_vuer/render_nodes.py,sha256=5TKqIbMPiOtBxfF4FQI6uB0w_9FTfGiwS8x
 vuer/addons/nerfuer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 vuer/addons/nerfuer/render_nodes.py,sha256=EJK5N3xne5n7abTaAoLPX7SRqQ_tEen9zNypvSnZTTw,4465
 vuer/schemas/__init__.py,sha256=ZI6UyeLZXqJbHmp6LiE3Q3mHvt1zeV-SJmmcqq-wBZE,94
-vuer/schemas/drei_components.py,sha256=Y8c7Oey3IYkJxoSwaH7ry4MfwVfzW6MlSeb6muzVXec,6977
-vuer/schemas/html_components.py,sha256=tS_RxkuiAFMdFCJLL7xKaOganvRiYTqgb4j5At76yrY,5925
-vuer/schemas/scene_components.py,sha256=vK1ZvgNGf0u43TmGNtdKrRXHh7774lZu7retXBQLJOs,12338
+vuer/schemas/drei_components.py,sha256=U9svEOnNprhZaobLagaFnqEtZxo5hiriSqjDnvQutoA,6989
+vuer/schemas/html_components.py,sha256=NCqmSPic-ExPrXqNPXbKjtTXMB8sGBywIpE6cXpiy08,5926
+vuer/schemas/scene_components.py,sha256=L9GbgFnrhxUYKi4EyexaAun7gmn6aHnCQIeSGSGwIRU,14913
 vuer/schemas/__pycache__/__init__.cpython-38.pyc,sha256=NRnVrpIDBKne93xOUY1-WpavCG7vwYiqU3VDTEEwuUE,221
-vuer/schemas/__pycache__/drei_components.cpython-38.pyc,sha256=gSH1mBOidXpib8V9d2PjRlwhLsbzNZdGR9BG1agIhuo,7700
-vuer/schemas/__pycache__/html_components.cpython-38.pyc,sha256=MzfeVcGa2fMgFh_g0qphppvXscmgL8egJQci2Y5dATw,8214
-vuer/schemas/__pycache__/scene_components.cpython-38.pyc,sha256=eN-zQIxYDeFsBiKuOeXPh2Q5z24IskdiCBacE_numJg,15548
-vuer-0.0.17.dist-info/LICENSE,sha256=MGF-inVBUaGe2mEjqT0g6XsHIXwoNXgNHqD7Z1MzR0k,1063
-vuer-0.0.17.dist-info/METADATA,sha256=zHj5jx1Y0W5nhwobQXXFLoT721bXzF4c1wUdy90P0Zo,4277
-vuer-0.0.17.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-vuer-0.0.17.dist-info/entry_points.txt,sha256=J_NM6fbpipmD9oP7cdxd1UyBR8mVEQVx0xjlE_56yss,41
-vuer-0.0.17.dist-info/top_level.txt,sha256=ermmVkwvGFAK4gfSgDIwOmKpxwpqNt-oo7gVQQUSHok,5
-vuer-0.0.17.dist-info/RECORD,,
+vuer/schemas/__pycache__/drei_components.cpython-38.pyc,sha256=g_ufcKxf-XKfZLdUV-HqKnjIrgxGWFv51aHLWQgH-ws,7712
+vuer/schemas/__pycache__/html_components.cpython-38.pyc,sha256=q0DMFwNkYbnaH1A8w3BowMiQAlmGpFWOOKsjLVE6CIk,8215
+vuer/schemas/__pycache__/scene_components.cpython-38.pyc,sha256=eRxB-Tp24yqBR4zbLMGX_4o1P_D-tW1nrDeBPSJKoU4,18135
+vuer-0.0.19.dist-info/LICENSE,sha256=MGF-inVBUaGe2mEjqT0g6XsHIXwoNXgNHqD7Z1MzR0k,1063
+vuer-0.0.19.dist-info/METADATA,sha256=IY8XfDtcj6-Z8xww_0qN2r9Nh-1_j01_63eGS2OLoto,4277
+vuer-0.0.19.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+vuer-0.0.19.dist-info/entry_points.txt,sha256=J_NM6fbpipmD9oP7cdxd1UyBR8mVEQVx0xjlE_56yss,41
+vuer-0.0.19.dist-info/top_level.txt,sha256=ermmVkwvGFAK4gfSgDIwOmKpxwpqNt-oo7gVQQUSHok,5
+vuer-0.0.19.dist-info/RECORD,,