foxglove-sdk 0.14.1__cp312-cp312-musllinux_1_2_i686.whl → 0.16.6__cp312-cp312-musllinux_1_2_i686.whl

foxglove/tests/test_server.py

@@ -1,4 +1,5 @@
 import time
+import typing
 from urllib.parse import parse_qs, urlparse
 
 import pytest
@@ -10,14 +11,16 @@ from foxglove import (
     Service,
     start_server,
 )
-from foxglove.websocket import ServiceSchema, StatusLevel
+from foxglove.websocket import PlaybackState, PlaybackStatus, ServiceSchema, StatusLevel
 
 
 def test_server_interface() -> None:
     """
     Exercise the server interface; will also be checked with mypy.
     """
-    server = start_server(port=0, session_id="test-session")
+    server = start_server(
+        port=0, session_id="test-session", channel_filter=lambda _: True
+    )
     assert isinstance(server.port, int)
     assert server.port != 0
 
@@ -45,6 +48,15 @@ def test_server_interface() -> None:
 
     server.publish_status("test message", StatusLevel.Info, "some-id")
     server.broadcast_time(time.time_ns())
+    server.broadcast_playback_state(
+        PlaybackState(
+            status=PlaybackStatus.Paused,
+            playback_speed=1.0,
+            current_time=time.time_ns(),
+            did_seek=False,
+            request_id=None,
+        )
+    )
     server.remove_status(["some-id"])
     server.clear_session("new-session")
     server.stop()
@@ -108,3 +120,22 @@ def test_context_can_be_attached_to_server() -> None:
 
     server1.stop()
     server2.stop()
+
+
+@typing.no_type_check
+def test_server_with_invalid_playback_time_range() -> None:
+    with pytest.raises(TypeError):
+        # Tuple of a single element
+        start_server(port=0, playback_time_range=(123,))
+
+    with pytest.raises(TypeError):
+        # Tuple with invalid types
+        start_server(port=0, playback_time_range=("not-a-time", None))
+
+    with pytest.raises(TypeError):
+        # Not a tuple
+        start_server(port=0, playback_time_range=23443)
+
+    with pytest.raises(TypeError):
+        # Tuple with too many elements
+        start_server(port=0, playback_time_range=(123, 456, 789))

foxglove/websocket.py

@@ -1,5 +1,7 @@
+from __future__ import annotations
+
 from collections.abc import Callable
-from typing import Dict, List, Optional, Protocol, Union
+from typing import Optional, Protocol, TypeAlias, Union
 
 from ._foxglove_py.websocket import (
     Capability,
@@ -11,6 +13,10 @@ from ._foxglove_py.websocket import (
     Parameter,
     ParameterType,
     ParameterValue,
+    PlaybackCommand,
+    PlaybackControlRequest,
+    PlaybackState,
+    PlaybackStatus,
     Service,
     ServiceRequest,
     ServiceSchema,
@@ -18,10 +24,9 @@ from ._foxglove_py.websocket import (
     WebSocketServer,
 )
 
-# Redefine types from the stub interface so they're available for documentation.
-ServiceHandler = Callable[["ServiceRequest"], bytes]
-AssetHandler = Callable[[str], Optional[bytes]]
-AnyParameterValue = Union[
+ServiceHandler: TypeAlias = Callable[[ServiceRequest], bytes]
+AssetHandler: TypeAlias = Callable[[str], "bytes | None"]
+AnyParameterValue: TypeAlias = Union[
     ParameterValue.Integer,
     ParameterValue.Bool,
     ParameterValue.Float64,
@@ -29,17 +34,16 @@ AnyParameterValue = Union[
     ParameterValue.Array,
     ParameterValue.Dict,
 ]
-AnyInnerParameterValue = Union[
+AnyInnerParameterValue: TypeAlias = Union[
     AnyParameterValue,
     bool,
     int,
     float,
     str,
-    List["AnyInnerParameterValue"],
-    Dict[str, "AnyInnerParameterValue"],
+    "list[AnyInnerParameterValue]",
+    "dict[str, AnyInnerParameterValue]",
 ]
-
-AnyNativeParameterValue = Union[
+AnyNativeParameterValue: TypeAlias = Union[
     AnyInnerParameterValue,
     bytes,
 ]
@@ -101,9 +105,9 @@ class ServerListener(Protocol):
     def on_get_parameters(
         self,
         client: Client,
-        param_names: List[str],
-        request_id: Optional[str] = None,
-    ) -> List["Parameter"]:
+        param_names: list[str],
+        request_id: str | None = None,
+    ) -> list[Parameter]:
         """
         Called by the server when a client requests parameters.
 
@@ -118,9 +122,9 @@ class ServerListener(Protocol):
     def on_set_parameters(
         self,
         client: Client,
-        parameters: List["Parameter"],
-        request_id: Optional[str] = None,
-    ) -> List["Parameter"]:
+        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
@@ -137,7 +141,7 @@ class ServerListener(Protocol):
 
     def on_parameters_subscribe(
         self,
-        param_names: List[str],
+        param_names: list[str],
     ) -> None:
         """
         Called by the server when a client subscribes to one or more parameters for the first time.
@@ -150,7 +154,7 @@ class ServerListener(Protocol):
 
     def on_parameters_unsubscribe(
         self,
-        param_names: List[str],
+        param_names: list[str],
     ) -> None:
         """
         Called by the server when the last client subscription to one or more parameters has been
@@ -174,11 +178,25 @@ class ServerListener(Protocol):
         """
         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",
@@ -188,6 +206,10 @@ __all__ = [
     "Parameter",
     "ParameterType",
     "ParameterValue",
+    "PlaybackCommand",
+    "PlaybackControlRequest",
+    "PlaybackState",
+    "PlaybackStatus",
     "ServerListener",
     "Service",
     "ServiceHandler",

foxglove_sdk-0.16.6.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: foxglove-sdk
+Version: 0.16.6
+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.6.dist-info/RECORD

@@ -0,0 +1,35 @@
+foxglove/__init__.py,sha256=AXj9sq9K8_YCgkDDtyyw0bUSsuCpDg7gjzmgTvIUyI0,8478
+foxglove/_foxglove_py/__init__.pyi,sha256=Ppw0LllCD5Jos1ZGPwEefRFJXVEj9ZWd_Nez2hUYjSs,6072
+foxglove/_foxglove_py/channels.pyi,sha256=UfltAzsnYnukOD5aUi_3iFrMNkRQ0CireBsEO-Q2DjY,68973
+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=q_wlO-mkKGC3IuzVVXL6Ehxf5I240BOyginxt47EJqA,24212
+foxglove/_foxglove_py/schemas_wkt.pyi,sha256=_nHeIdbOKMgPeL5V360-vZXCnEtyRIFzEd_JVsK49qo,2065
+foxglove/_foxglove_py/websocket.pyi,sha256=NuCIpXp9P2bPNLyvjVYqcaeL71wKRyYB6RbTfkE6X7A,10511
+foxglove/_foxglove_py.cpython-312-i386-linux-musl.so,sha256=NPs33L9BQic8qTfK3Kd5MK_RNKgOlLnAJewJpmUoAFM,6053821
+foxglove/benchmarks/test_mcap_serialization.py,sha256=Ab_J2Mz8Vya5ZD8Yypp2jdfhaOCxYW7hw5fos7LyFXk,4682
+foxglove/channel.py,sha256=N9jUQXhD-wZq1lnZbRlNUPgBb79CiDksTeFYwTnAY6Y,8447
+foxglove/channels/__init__.py,sha256=DOdeiFZ0bSquutHtkVxtmQmX78eiDfTmIl-OdVc7Btg,2452
+foxglove/cloud.py,sha256=eOHV8ZCnut59uBLiw1c5MiwbIALeVwPzxo2Yb-2jbII,1942
+foxglove/layouts/__init__.py,sha256=iC2-pMCrwGKkGWHzAsAbADONmL-tI3Rh_GT1AAfP6YI,517
+foxglove/mcap.py,sha256=LR9TSyRlDWuHZpXR8iglmDp-S-4BRqgmvTOiUKHwlsA,200
+foxglove/notebook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foxglove/notebook/foxglove_widget.py,sha256=o-X47mFMU_WxZqNQxKMGQUFXWrqdSeUB_TYrwqXY4WM,2715
+foxglove/notebook/notebook_buffer.py,sha256=o-m1coYMluqusBIeSAIvfSLaJQyMx7yRTGZzLX6vByw,3784
+foxglove/notebook/static/widget.js,sha256=x5B4Vv_2c38Lx7Xbqn8UBAYEZ57Cz18Gsvwa7TnRzbQ,4035
+foxglove/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+foxglove/schemas/__init__.py,sha256=Jd-tsarhV55ZsK4z75-6BUAqINxoNkeyYLnwWZjmfW4,3291
+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.libs/libgcc_s-8c2f5de4.so.1,sha256=kSGru1K5a_vOr1EMn5GXfvaYMUTnHaCTddYVIrEEuao,552385
+foxglove_sdk-0.16.6.dist-info/METADATA,sha256=H_fB1z_2pxFbjqg902aUJ0uR6AMq1FBr4uVV4BM9w_Q,1716
+foxglove_sdk-0.16.6.dist-info/WHEEL,sha256=rWYtim5tY9WaCqCvXEBzhyghBBzvRtIqa4ih936RQuE,106
+foxglove_sdk-0.16.6.dist-info/RECORD,,

{foxglove_sdk-0.14.1.dist-info → foxglove_sdk-0.16.6.dist-info}/WHEEL

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

foxglove_sdk-0.14.1.dist-info/METADATA

@@ -1,29 +0,0 @@
-Metadata-Version: 2.4
-Name: foxglove-sdk
-Version: 0.14.1
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Rust
-Summary: Foxglove Python SDK
-Author-email: Foxglove <support@foxglove.dev>
-License-Expression: 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
-
-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+
-

foxglove_sdk-0.14.1.dist-info/RECORD

@@ -1,27 +0,0 @@
-foxglove.libs/libgcc_s-27e5a392.so.1,sha256=x5sO63liVwXxrjGGP371wB0RyQe1KEnIynYm82T0G0M,449745
-foxglove/__init__.py,sha256=qS0pU2PgD7u4XwTBKlfKx9LSbscEd2Z5Mm_39dtIhaE,4049
-foxglove/_foxglove_py.cpython-312-i386-linux-musl.so,sha256=B-oH13OLnweXeJTRFSmlEUl9w5I6tcKz7cu6AjYW-nc,6041485
-foxglove/_foxglove_py/__init__.pyi,sha256=HIfNaA81UEoEpRMRHKLhqF5VJdHRowKWjYqgWSy4nAQ,4378
-foxglove/_foxglove_py/channels.pyi,sha256=CJwodbsuczEwkGL1ug8C8gweupiZuD3rcasWMbeNDpY,68538
-foxglove/_foxglove_py/mcap.pyi,sha256=Th06-rPq4an_RjQ_TSmsLSfGAkelFfyLoBAgQUiXl_I,3308
-foxglove/_foxglove_py/schemas.pyi,sha256=j_VBenCal1hQuxuPR1UcYIA8Fde3hl07h3jVqYuxUwk,25347
-foxglove/_foxglove_py/schemas_wkt.pyi,sha256=5IKyMXk6ZFv0v7ElP9843KgE-ESCLo9IQHRH-IJXTTU,2108
-foxglove/_foxglove_py/websocket.pyi,sha256=HACC078Wn0rZPFfG4ufl5iNTkgDPB0KTRNT52ikFgZQ,8910
-foxglove/benchmarks/test_mcap_serialization.py,sha256=Ab_J2Mz8Vya5ZD8Yypp2jdfhaOCxYW7hw5fos7LyFXk,4682
-foxglove/channel.py,sha256=ODWh0umbmQlAQXXbSPMmmG9juUsQkC1zpAYO1YWMZUs,8481
-foxglove/channels/__init__.py,sha256=qTr5-HKlr4e386onX9OiYBPWUsS1n2vO23PncL0TiPY,2398
-foxglove/mcap.py,sha256=LR9TSyRlDWuHZpXR8iglmDp-S-4BRqgmvTOiUKHwlsA,200
-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_logging.py,sha256=r219wdtEO8f6T0LfTTbTmWrEtHD_WznMm_g4SoJ6Byc,355
-foxglove/tests/test_mcap.py,sha256=GpYbsyoSghV7RECl6QRwR1CfQ_mATujLSzrs9f-XolE,3081
-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=FGcnezEuMtublhIQilFSytqPKQDZpCmY4jJzMJhIWn8,2848
-foxglove/tests/test_time.py,sha256=By_sM5r87s9iu4Df12r6p9DJrzTeZSLys3XGUGhvUps,4661
-foxglove/websocket.py,sha256=DF4571PPs0sWRaHq2mRxEYa63BivdHQaH16hkZst6OQ,5697
-foxglove_sdk-0.14.1.dist-info/METADATA,sha256=HyDe4aJQHurgZncD5Z3qhIMO1yCtrvJ3jY428hTANME,873
-foxglove_sdk-0.14.1.dist-info/WHEEL,sha256=-VBVXxxhuW7vs-AzuH1J4ij07cmaOVykeZTmSK682KE,105
-foxglove_sdk-0.14.1.dist-info/RECORD,,