foxglove-sdk 0.8.1__cp312-cp312-win32.whl → 0.16.3__cp312-cp312-win32.whl

foxglove/websocket.py

@@ -1,195 +1,220 @@
-from collections.abc import Callable
-from typing import Dict, List, Optional, Protocol, Union
-
-from ._foxglove_py.websocket import (
-    Capability,
-    ChannelView,
-    Client,
-    ClientChannel,
-    ConnectionGraph,
-    MessageSchema,
-    Parameter,
-    ParameterType,
-    ParameterValue,
-    Service,
-    ServiceRequest,
-    ServiceSchema,
-    StatusLevel,
-    WebSocketServer,
-)
-
-# Redefine types from the stub interface so they're available for documentation.
-ServiceHandler = Callable[["ServiceRequest"], bytes]
-AssetHandler = Callable[[str], Optional[bytes]]
-AnyParameterValue = Union[
-    ParameterValue.Bool,
-    ParameterValue.Number,
-    ParameterValue.String,
-    ParameterValue.Array,
-    ParameterValue.Dict,
-]
-AnyInnerParameterValue = Union[
-    AnyParameterValue,
-    bool,
-    float,
-    str,
-    List["AnyInnerParameterValue"],
-    Dict[str, "AnyInnerParameterValue"],
-]
-
-AnyNativeParameterValue = 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: Optional[str] = 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: Optional[str] = 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.
-
-        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",
-    "Capability",
-    "ChannelView",
-    "Client",
-    "ClientChannel",
-    "ConnectionGraph",
-    "MessageSchema",
-    "Parameter",
-    "ParameterType",
-    "ParameterValue",
-    "ServerListener",
-    "Service",
-    "ServiceHandler",
-    "ServiceRequest",
-    "ServiceSchema",
-    "StatusLevel",
-    "WebSocketServer",
-]
+from __future__ import annotations
+
+from collections.abc import Callable
+from typing import Optional, Protocol, TypeAlias, Union
+
+from ._foxglove_py.websocket import (
+    Capability,
+    ChannelView,
+    Client,
+    ClientChannel,
+    ConnectionGraph,
+    MessageSchema,
+    Parameter,
+    ParameterType,
+    ParameterValue,
+    PlaybackCommand,
+    PlaybackControlRequest,
+    PlaybackState,
+    PlaybackStatus,
+    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
+
+    def on_playback_control_request(
+        self, playback_control_request: PlaybackControlRequest
+    ) -> Optional[PlaybackState]:
+        """
+        Called by the server when it receives an updated player state from the client.
+
+        Requires :py:data:`Capability.RangedPlayback`.
+
+        :meta private:
+        :param playback_control_request: The playback control request sent from the client
+        """
+        return None
+
+
+__all__ = [
+    "AnyInnerParameterValue",
+    "AnyNativeParameterValue",
+    "AnyParameterValue",
+    "AssetHandler",
+    "Capability",
+    "ChannelView",
+    "Client",
+    "ClientChannel",
+    "ConnectionGraph",
+    "MessageSchema",
+    "Parameter",
+    "ParameterType",
+    "ParameterValue",
+    "PlaybackCommand",
+    "PlaybackControlRequest",
+    "PlaybackState",
+    "PlaybackStatus",
+    "ServerListener",
+    "Service",
+    "ServiceHandler",
+    "ServiceRequest",
+    "ServiceSchema",
+    "StatusLevel",
+    "WebSocketServer",
+]

foxglove_sdk-0.16.3.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: foxglove-sdk
+Version: 0.16.3
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: documentation, https://docs.foxglove.dev/
+Project-URL: repository, https://github.com/foxglove/foxglove-sdk
+
+# 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.10+
+
+## 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.16.3.dist-info/RECORD

@@ -0,0 +1,32 @@
+foxglove\__init__.py,sha256=utf_uU_ViL7xDrTqheP6JGs3ezfPsnve2EXFdS0uq-A,8490
+foxglove\_foxglove_py\__init__.pyi,sha256=Ppw0LllCD5Jos1ZGPwEefRFJXVEj9ZWd_Nez2hUYjSs,6072
+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=yh3RDXNiqSN5URCQF0efxezmWldvdQk_VHlW-clS0Cw,4936
+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=NuCIpXp9P2bPNLyvjVYqcaeL71wKRyYB6RbTfkE6X7A,10511
+foxglove\_foxglove_py.cp312-win32.pyd,sha256=iJG5RiaN-fYfdGQIbENlqLOn4XR4MOgEaa168c4cXtI,4063744
+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\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=Y4OYgWvkPSD288rJdlrgg1haVGeDRR39sWeUcb6VO8E,14863
+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=rR50x21OOUMVuyYmYqiRTxOrgJFyL4ZL9W4pOshfAFc,3795
+foxglove\tests\test_time.py,sha256=By_sM5r87s9iu4Df12r6p9DJrzTeZSLys3XGUGhvUps,4661
+foxglove\websocket.py,sha256=PvsSGmWFayjRV20u86ZEZ9zcUD7nBC9j6CKPWNZy5ks,6331
+foxglove_sdk-0.16.3.dist-info\METADATA,sha256=-R_TiQnJptVFk1IqvoAQ10Fbk0wSm17dC-gEUe8MPDw,1716
+foxglove_sdk-0.16.3.dist-info\WHEEL,sha256=akdtKPhgZFKWiFB2PSXRQPXzLs0y-XAkg8eqWX78MDg,93
+foxglove_sdk-0.16.3.dist-info\RECORD,,

{foxglove_sdk-0.8.1.dist-info → foxglove_sdk-0.16.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.8.6)
+Generator: maturin (1.11.5)
 Root-Is-Purelib: false
 Tag: cp312-cp312-win32

foxglove_sdk-0.8.1.dist-info/METADATA

@@ -1,51 +0,0 @@
-Metadata-Version: 2.4
-Name: foxglove-sdk
-Version: 0.8.1
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Rust
-Summary: Foxglove Python SDK
-Author-email: Foxglove <support@foxglove.dev>
-License: MIT
-Requires-Python: >=3.9
-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
-
-## Requirements
-
-- Python 3.9+
-
-### Examples
-
-To get started, install Poetry https://python-poetry.org/docs/#installation, and then the project dependencies. For example:
-
-```sh
-pipx install poetry
-poetry install
-```
-
-Examples are available in [foxglove-sdk-examples](https://github.com/foxglove/foxglove-sdk/tree/main/python/foxglove-sdk-examples).
-
-## Overview
-
-To record messages, you need at least one sink and at least one channel.
-
-A "sink" is a destination for logged messages — either an MCAP file or a live visualization server.
-Use `open_mcap` to register a new MCAP sink. Use `start_server` to create a new live visualization
-server.
-
-A "channel" gives a way to log related messages which have the same schema. Each channel is
-instantiated with a unique topic name.
-
-The SDK provides classes for well-known schemas. These can be used in conjunction with associated
-channel classes for type-safe logging, which ensures at compile time that messages logged to a
-channel all share a common schema. For example, you may create a `SceneUpdateChannel` on which you
-will log `SceneUpdate` messages.
-
-You can also log messages with arbitrary schemas and provide your own encoding, by instantiating a
-`Channel` class.
-
-See the examples for more details.
-

foxglove_sdk-0.8.1.dist-info/RECORD

@@ -1,25 +0,0 @@
-foxglove/__init__.py,sha256=eihG2U7jpXxdbyD5d45ZONK_QdqUy9tosrNrj7tAUwo,3898
-foxglove/_foxglove_py.cp312-win32.pyd,sha256=0bRwi4g-Z3aGjLD1y1G1oEyZwVh0oWnFVsctfet_mMY,3838464
-foxglove/_foxglove_py/__init__.pyi,sha256=RjyH1wpkiWKoAfQ-GichqoI2TEMjYtru0KcxqyACHIw,4348
-foxglove/_foxglove_py/channels.pyi,sha256=3Q8k0Z9Hpo07P6ceB4YGEB6miNLuWWh-M8PM6UdRBnE,64397
-foxglove/_foxglove_py/mcap.pyi,sha256=XO0cURiojQMSy05M-_jTqfkGePJ5e07XDlu-M_FLkAY,3392
-foxglove/_foxglove_py/schemas.pyi,sha256=XhGoo-5x4COydZ66iJQ-DiJj1FnEgcwO1rCWye-z9SE,21680
-foxglove/_foxglove_py/schemas_wkt.pyi,sha256=fPO1Tc7-9P5uGnylpdVRCzLVn1DwR1ujAmj98wwKDwI,1958
-foxglove/_foxglove_py/websocket.pyi,sha256=8vN2kM_57m9InXG6ZxOpL2tEtv6LakNYXng6-TzkUTw,9098
-foxglove/benchmarks/test_mcap_serialization.py,sha256=KVL_7G6Yyd83JbVdH7izMg98XPaNAJAzUdW2Pn53Uh4,4842
-foxglove/channel.py,sha256=cT9duERtTsnXzJjXIcya5YrzOpZGSsCpO1B9wcAd-iM,8400
-foxglove/channels/__init__.py,sha256=10IOHDUghm1a2Vg3nhbsF5p1WY_vcBnfjw2fvDXrro4,2381
-foxglove/mcap.py,sha256=P1hI5bfHdD11qhkU8iMIPSuGsONEPh_k6fmcOfMOFR0,212
-foxglove/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foxglove/schemas/__init__.py,sha256=cxgr_rkDM76LFVKmqL-3d4B3eHbcR7vPyhHrnucTi0k,3252
-foxglove/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-foxglove/tests/test_channel.py,sha256=tbreO-W-UvhCybKUnfpeP-Uk430X3244wU7Eidl244E,6365
-foxglove/tests/test_logging.py,sha256=ZDs75WO3OgQFQ_wA056ZfLvNChdbfF1rKC52VKoesiA,371
-foxglove/tests/test_mcap.py,sha256=XdRfi1Ocp57VfiyqsuO2un6ecBVoukvKrfFqf-WcTNU,3197
-foxglove/tests/test_parameters.py,sha256=g2HtvOpmlE6K8kmE5W9k4CPt6nHmrfXHHg12LjiIvH0,4322
-foxglove/tests/test_server.py,sha256=EUV9PUYDXB6VW8dHxHYVSz134XrEAH4ipZUqcBRENxY,2918
-foxglove/tests/test_time.py,sha256=OgAqZg7qHPoWcevVGyfmtz8dnqKpNsbC9mB04FB8OYk,4798
-foxglove/websocket.py,sha256=nSEmLEAko9WSALois-Jkru_yCiV6r52Yu0759gHCdpg,5747
-foxglove_sdk-0.8.1.dist-info/METADATA,sha256=sULaD-QUTltXmrbpkiR7l6AwqlHhcXa6Sus_f7ATbvg,1765
-foxglove_sdk-0.8.1.dist-info/WHEEL,sha256=iip_4jp1VbEiG4s9Isod9Q3MUK3z1pesoEwCO-vGFn0,92
-foxglove_sdk-0.8.1.dist-info/RECORD,,