foxglove-sdk 0.15.1__cp39-cp39-win_amd64.whl → 0.15.2__cp39-cp39-win_amd64.whl

foxglove/websocket.py

@@ -1,205 +1,205 @@
-from __future__ import annotations
-
-import sys
-from collections.abc import Callable
-from typing import Protocol, Union
-
-if sys.version_info >= (3, 10):
-    from typing import TypeAlias
-else:
-    from typing import Any as TypeAlias
-
-from ._foxglove_py.websocket import (
-    Capability,
-    ChannelView,
-    Client,
-    ClientChannel,
-    ConnectionGraph,
-    MessageSchema,
-    Parameter,
-    ParameterType,
-    ParameterValue,
-    Service,
-    ServiceRequest,
-    ServiceSchema,
-    StatusLevel,
-    WebSocketServer,
-)
-
-ServiceHandler: TypeAlias = Callable[[ServiceRequest], bytes]
-AssetHandler: TypeAlias = Callable[[str], "bytes | None"]
-AnyParameterValue: TypeAlias = Union[
-    ParameterValue.Integer,
-    ParameterValue.Bool,
-    ParameterValue.Float64,
-    ParameterValue.String,
-    ParameterValue.Array,
-    ParameterValue.Dict,
-]
-AnyInnerParameterValue: TypeAlias = Union[
-    AnyParameterValue,
-    bool,
-    int,
-    float,
-    str,
-    "list[AnyInnerParameterValue]",
-    "dict[str, AnyInnerParameterValue]",
-]
-AnyNativeParameterValue: TypeAlias = Union[
-    AnyInnerParameterValue,
-    bytes,
-]
-
-
-class ServerListener(Protocol):
-    """
-    A mechanism to register callbacks for handling client message events.
-    """
-
-    def on_subscribe(self, client: Client, channel: ChannelView) -> None:
-        """
-        Called by the server when a client subscribes to a channel.
-
-        :param client: The client (id) that sent the message.
-        :param channel: The channel (id, topic) that the message was sent on.
-        """
-        return None
-
-    def on_unsubscribe(self, client: Client, channel: ChannelView) -> None:
-        """
-        Called by the server when a client unsubscribes from a channel or disconnects.
-
-        :param client: The client (id) that sent the message.
-        :param channel: The channel (id, topic) that the message was sent on.
-        """
-        return None
-
-    def on_client_advertise(self, client: Client, channel: ClientChannel) -> None:
-        """
-        Called by the server when a client advertises a channel.
-
-        :param client: The client (id) that sent the message.
-        :param channel: The client channel that is being advertised.
-        """
-        return None
-
-    def on_client_unadvertise(self, client: Client, client_channel_id: int) -> None:
-        """
-        Called by the server when a client unadvertises a channel.
-
-        :param client: The client (id) that is unadvertising the channel.
-        :param client_channel_id: The client channel id that is being unadvertised.
-        """
-        return None
-
-    def on_message_data(
-        self, client: Client, client_channel_id: int, data: bytes
-    ) -> None:
-        """
-        Called by the server when a message is received from a client.
-
-        :param client: The client (id) that sent the message.
-        :param client_channel_id: The client channel id that the message was sent on.
-        :param data: The message data.
-        """
-        return None
-
-    def on_get_parameters(
-        self,
-        client: Client,
-        param_names: list[str],
-        request_id: str | None = None,
-    ) -> list[Parameter]:
-        """
-        Called by the server when a client requests parameters.
-
-        Requires :py:data:`Capability.Parameters`.
-
-        :param client: The client (id) that sent the message.
-        :param param_names: The names of the parameters to get.
-        :param request_id: An optional request id.
-        """
-        return []
-
-    def on_set_parameters(
-        self,
-        client: Client,
-        parameters: list[Parameter],
-        request_id: str | None = None,
-    ) -> list[Parameter]:
-        """
-        Called by the server when a client sets parameters.
-        Note that only `parameters` which have changed are included in the callback, but the return
-        value must include all parameters. If a parameter that is unset is included in the return
-        value, it will not be published to clients.
-
-        Requires :py:data:`Capability.Parameters`.
-
-        :param client: The client (id) that sent the message.
-        :param parameters: The parameters to set.
-        :param request_id: An optional request id.
-        """
-        return parameters
-
-    def on_parameters_subscribe(
-        self,
-        param_names: list[str],
-    ) -> None:
-        """
-        Called by the server when a client subscribes to one or more parameters for the first time.
-
-        Requires :py:data:`Capability.Parameters`.
-
-        :param param_names: The names of the parameters to subscribe to.
-        """
-        return None
-
-    def on_parameters_unsubscribe(
-        self,
-        param_names: list[str],
-    ) -> None:
-        """
-        Called by the server when the last client subscription to one or more parameters has been
-        removed.
-
-        Requires :py:data:`Capability.Parameters`.
-
-        :param param_names: The names of the parameters to unsubscribe from.
-        """
-        return None
-
-    def on_connection_graph_subscribe(self) -> None:
-        """
-        Called by the server when the first client subscribes to the connection graph.
-        """
-        return None
-
-    def on_connection_graph_unsubscribe(self) -> None:
-        """
-        Called by the server when the last client unsubscribes from the connection graph.
-        """
-        return None
-
-
-__all__ = [
-    "AnyInnerParameterValue",
-    "AnyNativeParameterValue",
-    "AnyParameterValue",
-    "AssetHandler",
-    "Capability",
-    "ChannelView",
-    "Client",
-    "ClientChannel",
-    "ConnectionGraph",
-    "MessageSchema",
-    "Parameter",
-    "ParameterType",
-    "ParameterValue",
-    "ServerListener",
-    "Service",
-    "ServiceHandler",
-    "ServiceRequest",
-    "ServiceSchema",
-    "StatusLevel",
-    "WebSocketServer",
-]
+from __future__ import annotations
+
+import sys
+from collections.abc import Callable
+from typing import Protocol, Union
+
+if sys.version_info >= (3, 10):
+    from typing import TypeAlias
+else:
+    from typing import Any as TypeAlias
+
+from ._foxglove_py.websocket import (
+    Capability,
+    ChannelView,
+    Client,
+    ClientChannel,
+    ConnectionGraph,
+    MessageSchema,
+    Parameter,
+    ParameterType,
+    ParameterValue,
+    Service,
+    ServiceRequest,
+    ServiceSchema,
+    StatusLevel,
+    WebSocketServer,
+)
+
+ServiceHandler: TypeAlias = Callable[[ServiceRequest], bytes]
+AssetHandler: TypeAlias = Callable[[str], "bytes | None"]
+AnyParameterValue: TypeAlias = Union[
+    ParameterValue.Integer,
+    ParameterValue.Bool,
+    ParameterValue.Float64,
+    ParameterValue.String,
+    ParameterValue.Array,
+    ParameterValue.Dict,
+]
+AnyInnerParameterValue: TypeAlias = Union[
+    AnyParameterValue,
+    bool,
+    int,
+    float,
+    str,
+    "list[AnyInnerParameterValue]",
+    "dict[str, AnyInnerParameterValue]",
+]
+AnyNativeParameterValue: TypeAlias = Union[
+    AnyInnerParameterValue,
+    bytes,
+]
+
+
+class ServerListener(Protocol):
+    """
+    A mechanism to register callbacks for handling client message events.
+    """
+
+    def on_subscribe(self, client: Client, channel: ChannelView) -> None:
+        """
+        Called by the server when a client subscribes to a channel.
+
+        :param client: The client (id) that sent the message.
+        :param channel: The channel (id, topic) that the message was sent on.
+        """
+        return None
+
+    def on_unsubscribe(self, client: Client, channel: ChannelView) -> None:
+        """
+        Called by the server when a client unsubscribes from a channel or disconnects.
+
+        :param client: The client (id) that sent the message.
+        :param channel: The channel (id, topic) that the message was sent on.
+        """
+        return None
+
+    def on_client_advertise(self, client: Client, channel: ClientChannel) -> None:
+        """
+        Called by the server when a client advertises a channel.
+
+        :param client: The client (id) that sent the message.
+        :param channel: The client channel that is being advertised.
+        """
+        return None
+
+    def on_client_unadvertise(self, client: Client, client_channel_id: int) -> None:
+        """
+        Called by the server when a client unadvertises a channel.
+
+        :param client: The client (id) that is unadvertising the channel.
+        :param client_channel_id: The client channel id that is being unadvertised.
+        """
+        return None
+
+    def on_message_data(
+        self, client: Client, client_channel_id: int, data: bytes
+    ) -> None:
+        """
+        Called by the server when a message is received from a client.
+
+        :param client: The client (id) that sent the message.
+        :param client_channel_id: The client channel id that the message was sent on.
+        :param data: The message data.
+        """
+        return None
+
+    def on_get_parameters(
+        self,
+        client: Client,
+        param_names: list[str],
+        request_id: str | None = None,
+    ) -> list[Parameter]:
+        """
+        Called by the server when a client requests parameters.
+
+        Requires :py:data:`Capability.Parameters`.
+
+        :param client: The client (id) that sent the message.
+        :param param_names: The names of the parameters to get.
+        :param request_id: An optional request id.
+        """
+        return []
+
+    def on_set_parameters(
+        self,
+        client: Client,
+        parameters: list[Parameter],
+        request_id: str | None = None,
+    ) -> list[Parameter]:
+        """
+        Called by the server when a client sets parameters.
+        Note that only `parameters` which have changed are included in the callback, but the return
+        value must include all parameters. If a parameter that is unset is included in the return
+        value, it will not be published to clients.
+
+        Requires :py:data:`Capability.Parameters`.
+
+        :param client: The client (id) that sent the message.
+        :param parameters: The parameters to set.
+        :param request_id: An optional request id.
+        """
+        return parameters
+
+    def on_parameters_subscribe(
+        self,
+        param_names: list[str],
+    ) -> None:
+        """
+        Called by the server when a client subscribes to one or more parameters for the first time.
+
+        Requires :py:data:`Capability.Parameters`.
+
+        :param param_names: The names of the parameters to subscribe to.
+        """
+        return None
+
+    def on_parameters_unsubscribe(
+        self,
+        param_names: list[str],
+    ) -> None:
+        """
+        Called by the server when the last client subscription to one or more parameters has been
+        removed.
+
+        Requires :py:data:`Capability.Parameters`.
+
+        :param param_names: The names of the parameters to unsubscribe from.
+        """
+        return None
+
+    def on_connection_graph_subscribe(self) -> None:
+        """
+        Called by the server when the first client subscribes to the connection graph.
+        """
+        return None
+
+    def on_connection_graph_unsubscribe(self) -> None:
+        """
+        Called by the server when the last client unsubscribes from the connection graph.
+        """
+        return None
+
+
+__all__ = [
+    "AnyInnerParameterValue",
+    "AnyNativeParameterValue",
+    "AnyParameterValue",
+    "AssetHandler",
+    "Capability",
+    "ChannelView",
+    "Client",
+    "ClientChannel",
+    "ConnectionGraph",
+    "MessageSchema",
+    "Parameter",
+    "ParameterType",
+    "ParameterValue",
+    "ServerListener",
+    "Service",
+    "ServiceHandler",
+    "ServiceRequest",
+    "ServiceSchema",
+    "StatusLevel",
+    "WebSocketServer",
+]

{foxglove_sdk-0.15.1.dist-info → foxglove_sdk-0.15.2.dist-info}/METADATA

@@ -1,8 +1,12 @@
 Metadata-Version: 2.4
 Name: foxglove-sdk
-Version: 0.15.1
+Version: 0.15.2
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Rust
+Requires-Dist: anywidget ; extra == 'notebook'
+Requires-Dist: mcap ; extra == 'notebook'
+Requires-Dist: traitlets ; extra == 'notebook'
+Provides-Extra: notebook
 Summary: Foxglove Python SDK
 Author-email: Foxglove <support@foxglove.dev>
 License-Expression: MIT
@@ -11,39 +15,39 @@ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
 Project-URL: repository, https://github.com/foxglove/foxglove-sdk
 Project-URL: documentation, https://docs.foxglove.dev/
 
-# Foxglove Python SDK
-
-The official [Foxglove](https://docs.foxglove.dev/docs) SDK for Python.
-
-This package provides support for integrating with the Foxglove platform. It can be used to log
-events to local [MCAP](https://mcap.dev/) files or a local visualization server that communicates
-with the Foxglove app.
-
-## Get Started
-
-See https://foxglove.github.io/foxglove-sdk/python/
-
-## Requirements
-
-- Python 3.9+
-
-## Examples
-
-We're using uv as a Python package manager in the foxglove-sdk-examples.
-
-To test that all examples run (as the CI does) you can use `yarn run-python-sdk-examples` in the repo root.
-
-To run a specific example (e.g. write-mcap-file) with local changes:
-
-```
-cd python/foxglove-sdk-examples/write-mcap-file
-uv run --with ../../foxglove-sdk main.py [args]
-```
-
-Keep in mind that uv does two layers of caching.
-There's the .venv in your project directory, plus a global cache at ~/.cache/uv.
-
-uv tries to be smart about not rebuilding things it has already built,
-which means that if you make changes and you want them to show up,
-you also need to run `uv cache clean`.
+# Foxglove Python SDK
+
+The official [Foxglove](https://docs.foxglove.dev/docs) SDK for Python.
+
+This package provides support for integrating with the Foxglove platform. It can be used to log
+events to local [MCAP](https://mcap.dev/) files or a local visualization server that communicates
+with the Foxglove app.
+
+## Get Started
+
+See https://foxglove.github.io/foxglove-sdk/python/
+
+## Requirements
+
+- Python 3.9+
+
+## Examples
+
+We're using uv as a Python package manager in the foxglove-sdk-examples.
+
+To test that all examples run (as the CI does) you can use `yarn run-python-sdk-examples` in the repo root.
+
+To run a specific example (e.g. write-mcap-file) with local changes:
+
+```
+cd python/foxglove-sdk-examples/write-mcap-file
+uv run --with ../../foxglove-sdk main.py [args]
+```
+
+Keep in mind that uv does two layers of caching.
+There's the .venv in your project directory, plus a global cache at ~/.cache/uv.
+
+uv tries to be smart about not rebuilding things it has already built,
+which means that if you make changes and you want them to show up,
+you also need to run `uv cache clean`.
 

foxglove_sdk-0.15.2.dist-info/RECORD

@@ -0,0 +1,33 @@
+foxglove/__init__.py,sha256=07Fz3ZZJdqsXRl0uKpIOID8ysa1HpQ741pQlvz1yA3I,8222
+foxglove/_foxglove_py.cp39-win_amd64.pyd,sha256=zO5CeBYea-64mylt5uyHG2RTnfWE94CdQqfGeIVmHqs,4819968
+foxglove/_foxglove_py/__init__.pyi,sha256=lh2gtNThduHDOIO1pQ7NaGnjAPr6s_VlbdBMRKM2dns,5201
+foxglove/_foxglove_py/channels.pyi,sha256=c3WXhK5FfeCJ1aDGB-AsayIossnC8v8qFij0XWl1AEA,67327
+foxglove/_foxglove_py/cloud.pyi,sha256=9Hqj7b9S2CTiWeWOIqaAw3GSmR-cGoSL4R7fi5WI-QA,255
+foxglove/_foxglove_py/mcap.pyi,sha256=3ZLmrcomTN0bXoseDYGyAOd33I7fkzT4WkT130RlKJA,3693
+foxglove/_foxglove_py/schemas.pyi,sha256=oVF6fwYlgoZ8a1FmlLhVgCYbz-ueM52NyuuTtwhGuFc,23092
+foxglove/_foxglove_py/schemas_wkt.pyi,sha256=_nHeIdbOKMgPeL5V360-vZXCnEtyRIFzEd_JVsK49qo,2065
+foxglove/_foxglove_py/websocket.pyi,sha256=CrfkGZMqVR4xn2cV7fQHUA2T6h2WddzMOQfSaj-KWBw,8097
+foxglove/benchmarks/test_mcap_serialization.py,sha256=Ab_J2Mz8Vya5ZD8Yypp2jdfhaOCxYW7hw5fos7LyFXk,4682
+foxglove/channel.py,sha256=MRiiOm09ZNATOvVCFuvn19KB9HkVCtsDTJYiqE7LQlA,8452
+foxglove/channels/__init__.py,sha256=qTr5-HKlr4e386onX9OiYBPWUsS1n2vO23PncL0TiPY,2398
+foxglove/cloud.py,sha256=eOHV8ZCnut59uBLiw1c5MiwbIALeVwPzxo2Yb-2jbII,1942
+foxglove/mcap.py,sha256=LR9TSyRlDWuHZpXR8iglmDp-S-4BRqgmvTOiUKHwlsA,200
+foxglove/notebook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foxglove/notebook/foxglove_widget.py,sha256=mOXElZLZSIQfvzbZfMd2jtvmWA-H4Z8j7fa39Vwns34,3418
+foxglove/notebook/notebook_buffer.py,sha256=ooQIb8xcyNeuCoRm7CL0Uhnh9VPcd41YMUNYRu15FYg,3801
+foxglove/notebook/static/widget.js,sha256=LAmo9HlxLgNAgDSROag8_3KWFLVc7gcE8EGU1ZaFjMk,3639
+foxglove/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foxglove/schemas/__init__.py,sha256=bqYBLc0HXRe-BMRP3VnF9IUB2yKYsvku3pZnulss3GY,3232
+foxglove/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foxglove/tests/test_channel.py,sha256=coIPG-P_8Uczhw2-zRo4FoanlkReiE1CKUppM9mO1oE,7146
+foxglove/tests/test_context.py,sha256=OvtvjzsRaZZHPT0RyRkwrpBip-7uLaxVPwlu2RJ12yY,256
+foxglove/tests/test_logging.py,sha256=G2Mljb9nN5BOY5qKAeYo0x_2blY1iIRh9s80k0O3vaI,1472
+foxglove/tests/test_mcap.py,sha256=F_g9WLazTt-fJaRPQIS1Fjgf-gK_bwhgswdz17tqdEE,5646
+foxglove/tests/test_parameters.py,sha256=18YsSPNnSM3VjVCh-Ag4S9mBv2G-x2zSwi5wzQClvqo,4861
+foxglove/tests/test_schemas.py,sha256=4empQg8gqS7MD63ibU3kdQgJUSsUpnNQQWQ7oAf-4xk,423
+foxglove/tests/test_server.py,sha256=PHraaIt4m27MXn1UveV6BRpzYCMFOQfjQD4d4ZHRjIY,2893
+foxglove/tests/test_time.py,sha256=By_sM5r87s9iu4Df12r6p9DJrzTeZSLys3XGUGhvUps,4661
+foxglove/websocket.py,sha256=oPcI2dttjr-RdL7z30MKEEF1cswyoDu_VetEaxAiwtQ,5812
+foxglove_sdk-0.15.2.dist-info/METADATA,sha256=Iz7-5YqTaMpdYHLi-lpy-qzKOPfvqm38pHrDUC2sn_E,1714
+foxglove_sdk-0.15.2.dist-info/WHEEL,sha256=W6WIdFr622-ULMOF24xhHMFUik89lyVEABV17NfNcas,94
+foxglove_sdk-0.15.2.dist-info/RECORD,,

foxglove_sdk-0.15.1.dist-info/RECORD

@@ -1,29 +0,0 @@
-foxglove/__init__.py,sha256=IoAckiOfEEq_q2sPGnl6UFz0_lwQouVbUz4wQnUY7Ik,6294
-foxglove/_foxglove_py.cp39-win_amd64.pyd,sha256=LNYGudliMEp_bfE3wZm0T2Jd0SjRhogykIjlakwX1RM,4817408
-foxglove/_foxglove_py/__init__.pyi,sha256=IEbE6b_d_7gRuq4UG-UAuzW5S-qJfctn-qbU1DUluT8,5411
-foxglove/_foxglove_py/channels.pyi,sha256=XpRPi9sATRRag_90KGO0D3raw77JMF6BoD7A29hKXlM,70119
-foxglove/_foxglove_py/cloud.pyi,sha256=HnZbDn28uaJskR5J9KVgVb9lYDGYPsn8ayFEHlpu__k,264
-foxglove/_foxglove_py/mcap.pyi,sha256=X_mtf0z3i8ZFjg4YBHy1DqTaaksX6LETCiQ2J4chkaM,3789
-foxglove/_foxglove_py/schemas.pyi,sha256=MuJaYH3cgacu9TD1gBq6OSzZ24bryM6myPb_qS-Z_xg,24101
-foxglove/_foxglove_py/schemas_wkt.pyi,sha256=JLUHl54JYnhpOILzzw8jn9AWk3LpeXhgWzmH3zXbbQ0,2150
-foxglove/_foxglove_py/websocket.pyi,sha256=nmh5sy17sD_bWcNCZ2OhfhLngHJeG-vDXXBeeVXfasc,8418
-foxglove/benchmarks/test_mcap_serialization.py,sha256=KVL_7G6Yyd83JbVdH7izMg98XPaNAJAzUdW2Pn53Uh4,4842
-foxglove/channel.py,sha256=4qvmSoeu2BENLuMrpbOGbskQVJeuToYztFSayiAmpi0,8693
-foxglove/channels/__init__.py,sha256=hszBT1f_Hia0wqjS6XRZ9b-oRLwPaYmcu4DqAa_JlHc,2492
-foxglove/cloud.py,sha256=AdNYm86chYu9jDvnyViYP7KzCI7oYf-MJTWzExOTwnM,2003
-foxglove/mcap.py,sha256=P1hI5bfHdD11qhkU8iMIPSuGsONEPh_k6fmcOfMOFR0,212
-foxglove/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foxglove/schemas/__init__.py,sha256=EDT_bmMwE0sWN06IJyisVWxWF7Fyuij1OwjHWkybAeE,3395
-foxglove/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foxglove/tests/test_channel.py,sha256=vG3FyDgDYPuxyNqNwq-GQj37K9O1o62Tif88AXPQDvs,7389
-foxglove/tests/test_context.py,sha256=lE758b3JmBCiWbdlqZeb2h9drY2dvex_ldhOvkAtOso,266
-foxglove/tests/test_logging.py,sha256=58oti-2DXG2fBKHl3oobay1LVYCTCxHr2Ni4tSPAfc4,1534
-foxglove/tests/test_mcap.py,sha256=4zD8DfPGjw8Ow5p0udb5KuWNjvlCU8x0Cjhx6wvAW9g,5845
-foxglove/tests/test_parameters.py,sha256=QSCcDjq3pk5_8q4OOqH-Kp6v791dCW8UkfUukKHSGMI,5039
-foxglove/tests/test_schemas.py,sha256=5QZHLFdDC7rcN7mQyOdfIckTOjo9P-dxMvMg1VXVmzo,440
-foxglove/tests/test_server.py,sha256=kDVcBjPxAb-HuRODwENZwtZMCNlzBQ4YxGNMXhLk3kE,3005
-foxglove/tests/test_time.py,sha256=OgAqZg7qHPoWcevVGyfmtz8dnqKpNsbC9mB04FB8OYk,4798
-foxglove/websocket.py,sha256=ReAs1wR4jjgE-pd-7bWYL8ntIR2QPr__MYxzn76MvwQ,6017
-foxglove_sdk-0.15.1.dist-info/METADATA,sha256=lbIrgWNo0M8fFdBXQpKFi0PtYGKHj8CIt51MNT_s6nY,1588
-foxglove_sdk-0.15.1.dist-info/WHEEL,sha256=W6WIdFr622-ULMOF24xhHMFUik89lyVEABV17NfNcas,94
-foxglove_sdk-0.15.1.dist-info/RECORD,,