foxglove-sdk 0.6.2__cp312-cp312-win32.whl → 0.16.6__cp312-cp312-win32.whl

foxglove/tests/test_schemas.py

@@ -0,0 +1,17 @@
+from foxglove.schemas import Log, LogLevel, Timestamp
+
+""" Asserts that foxglove schemas can be encoded as protobuf. """
+
+
+def test_can_encode() -> None:
+    msg = Log(
+        timestamp=Timestamp(5, 10),
+        level=LogLevel.Error,
+        message="hello",
+        name="logger",
+        file="file",
+        line=123,
+    )
+    encoded = msg.encode()
+    assert isinstance(encoded, bytes)
+    assert len(encoded) == 34

foxglove/tests/test_server.py

@@ -1,68 +1,141 @@
-import time
-
-import pytest
-from foxglove import (
-    Capability,
-    ServerListener,
-    Service,
-    start_server,
-)
-from foxglove.websocket import ServiceSchema, StatusLevel
-
-
-def test_server_interface() -> None:
-    """
-    Exercise the server interface; will also be checked with mypy.
-    """
-    server = start_server(port=0)
-    assert isinstance(server.port, int)
-    assert server.port != 0
-    server.publish_status("test message", StatusLevel.Info, "some-id")
-    server.broadcast_time(time.time_ns())
-    server.remove_status(["some-id"])
-    server.clear_session()
-    server.stop()
-
-
-def test_server_listener_provides_default_implementation() -> None:
-    class DefaultServerListener(ServerListener):
-        pass
-
-    listener = DefaultServerListener()
-
-    listener.on_parameters_subscribe(["test"])
-    listener.on_parameters_unsubscribe(["test"])
-
-
-def test_services_interface() -> None:
-    test_svc = Service(
-        name="test",
-        schema=ServiceSchema(name="test-schema"),
-        handler=lambda *_: b"{}",
-    )
-    test2_svc = Service(
-        name="test2",
-        schema=ServiceSchema(name="test-schema"),
-        handler=lambda *_: b"{}",
-    )
-    server = start_server(
-        port=0,
-        capabilities=[Capability.Services],
-        supported_encodings=["json"],
-        services=[test_svc],
-    )
-
-    # Add a new service.
-    server.add_services([test2_svc])
-
-    # Can't add a service with the same name.
-    with pytest.raises(RuntimeError):
-        server.add_services([test_svc])
-
-    # Remove services.
-    server.remove_services(["test", "test2"])
-
-    # Re-add a service.
-    server.add_services([test_svc])
-
-    server.stop()
+import time
+import typing
+from urllib.parse import parse_qs, urlparse
+
+import pytest
+from foxglove import (
+    Capability,
+    Channel,
+    Context,
+    ServerListener,
+    Service,
+    start_server,
+)
+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", channel_filter=lambda _: True
+    )
+    assert isinstance(server.port, int)
+    assert server.port != 0
+
+    raw_url = server.app_url()
+    assert raw_url is not None
+    url = urlparse(raw_url)
+    assert url.scheme == "https"
+    assert url.netloc == "app.foxglove.dev"
+    assert parse_qs(url.query) == {
+        "ds": ["foxglove-websocket"],
+        "ds.url": [f"ws://127.0.0.1:{server.port}"],
+    }
+
+    raw_url = server.app_url(layout_id="lay_123", open_in_desktop=True)
+    assert raw_url is not None
+    url = urlparse(raw_url)
+    assert url.scheme == "https"
+    assert url.netloc == "app.foxglove.dev"
+    assert parse_qs(url.query) == {
+        "ds": ["foxglove-websocket"],
+        "ds.url": [f"ws://127.0.0.1:{server.port}"],
+        "layoutId": ["lay_123"],
+        "openIn": ["desktop"],
+    }
+
+    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()
+
+
+def test_server_listener_provides_default_implementation() -> None:
+    class DefaultServerListener(ServerListener):
+        pass
+
+    listener = DefaultServerListener()
+
+    listener.on_parameters_subscribe(["test"])
+    listener.on_parameters_unsubscribe(["test"])
+
+
+def test_services_interface() -> None:
+    test_svc = Service(
+        name="test",
+        schema=ServiceSchema(name="test-schema"),
+        handler=lambda *_: b"{}",
+    )
+    test2_svc = Service(
+        name="test2",
+        schema=ServiceSchema(name="test-schema"),
+        handler=lambda *_: b"{}",
+    )
+    server = start_server(
+        port=0,
+        capabilities=[Capability.Services],
+        supported_encodings=["json"],
+        services=[test_svc],
+    )
+
+    # Add a new service.
+    server.add_services([test2_svc])
+
+    # Can't add a service with the same name.
+    with pytest.raises(RuntimeError):
+        server.add_services([test_svc])
+
+    # Remove services.
+    server.remove_services(["test", "test2"])
+
+    # Re-add a service.
+    server.add_services([test_svc])
+
+    server.stop()
+
+
+def test_context_can_be_attached_to_server() -> None:
+    ctx1 = Context()
+    ctx2 = Context()
+
+    server1 = start_server(port=0, context=ctx1)
+    server2 = start_server(port=0, context=ctx2)
+
+    ch1 = Channel("/1", context=ctx1)
+    ch2 = Channel("/2", context=ctx2)
+    ch1.log("test")
+    ch2.log("test")
+
+    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/tests/test_time.py

@@ -1,137 +1,137 @@
-import datetime
-
-import pytest
-from foxglove.schemas import Duration, Timestamp
-
-
-def test_duration_normalization() -> None:
-    assert Duration(sec=0, nsec=1_111_222_333) == Duration(sec=1, nsec=111_222_333)
-    assert Duration(sec=0, nsec=2**32 - 1) == Duration(sec=4, nsec=294_967_295)
-    assert Duration(sec=-2, nsec=1_000_000_001) == Duration(sec=-1, nsec=1)
-    assert Duration(sec=-(2**31), nsec=1_000_000_001) == Duration(
-        sec=-(2**31) + 1, nsec=1
-    )
-
-    # argument conversions
-    d = Duration(sec=-(2**31))
-    assert d.sec == -(2**31)
-    assert d.nsec == 0
-
-    d = Duration(sec=0, nsec=2**32 - 1)
-    assert d.sec == 4
-    assert d.nsec == 294_967_295
-
-    d = Duration(sec=2**31 - 1, nsec=999_999_999)
-    assert d.sec == 2**31 - 1
-    assert d.nsec == 999_999_999
-
-    with pytest.raises(OverflowError):
-        Duration(sec=-(2**31) - 1)
-    with pytest.raises(OverflowError):
-        Duration(sec=2**31)
-    with pytest.raises(OverflowError):
-        Duration(sec=0, nsec=-1)
-    with pytest.raises(OverflowError):
-        Duration(sec=0, nsec=2**32)
-
-    # overflow past upper bound
-    with pytest.raises(OverflowError):
-        Duration(sec=2**31 - 1, nsec=1_000_000_000)
-
-    # we don't handle this corner case, where seconds is beyond the lower
-    # bound, but nanoseconds overflow to bring the duration within range.
-    with pytest.raises(OverflowError):
-        Duration(sec=-(2**31) - 1, nsec=1_000_000_000)
-
-
-def test_duration_from_secs() -> None:
-    assert Duration.from_secs(1.123) == Duration(sec=1, nsec=123_000_000)
-    assert Duration.from_secs(-0.123) == Duration(sec=-1, nsec=877_000_000)
-    assert Duration.from_secs(-1.123) == Duration(sec=-2, nsec=877_000_000)
-
-    with pytest.raises(OverflowError):
-        Duration.from_secs(-1e42)
-
-    with pytest.raises(OverflowError):
-        Duration.from_secs(1e42)
-
-
-def test_duration_from_timedelta() -> None:
-    td = datetime.timedelta(seconds=1, milliseconds=123)
-    assert Duration.from_timedelta(td) == Duration(sec=1, nsec=123_000_000)
-
-    # no loss of precision
-    td = datetime.timedelta(days=9876, microseconds=123_456)
-    assert Duration.from_timedelta(td) == Duration(sec=853_286_400, nsec=123_456_000)
-
-    # timedeltas are normalized
-    td = datetime.timedelta(seconds=8 * 24 * 3600, milliseconds=99_111)
-    assert Duration.from_timedelta(td) == Duration(sec=691_299, nsec=111_000_000)
-
-    with pytest.raises(OverflowError):
-        Duration.from_timedelta(datetime.timedelta.min)
-
-    with pytest.raises(OverflowError):
-        Duration.from_timedelta(datetime.timedelta.max)
-
-
-def test_timestamp_normalization() -> None:
-    assert Timestamp(sec=0, nsec=1_111_222_333) == Timestamp(sec=1, nsec=111_222_333)
-    assert Timestamp(sec=0, nsec=2**32 - 1) == Timestamp(sec=4, nsec=294_967_295)
-
-    # argument conversions
-    t = Timestamp(sec=0)
-    assert t.sec == 0
-    assert t.nsec == 0
-
-    t = Timestamp(sec=0, nsec=2**32 - 1)
-    assert t.sec == 4
-    assert t.nsec == 294_967_295
-
-    t = Timestamp(sec=2**32 - 1, nsec=999_999_999)
-    assert t.sec == 2**32 - 1
-    assert t.nsec == 999_999_999
-
-    with pytest.raises(OverflowError):
-        Timestamp(sec=-1)
-    with pytest.raises(OverflowError):
-        Timestamp(sec=2**32)
-    with pytest.raises(OverflowError):
-        Timestamp(sec=0, nsec=-1)
-    with pytest.raises(OverflowError):
-        Timestamp(sec=0, nsec=2**32)
-
-    # overflow past upper bound
-    with pytest.raises(OverflowError):
-        Timestamp(sec=2**32 - 1, nsec=1_000_000_000)
-
-
-def test_timestamp_from_epoch_secs() -> None:
-    assert Timestamp.from_epoch_secs(1.123) == Timestamp(sec=1, nsec=123_000_000)
-
-    with pytest.raises(OverflowError):
-        Timestamp.from_epoch_secs(-1.0)
-
-    with pytest.raises(OverflowError):
-        Timestamp.from_epoch_secs(1e42)
-
-
-def test_timestamp_from_datetime() -> None:
-    utc = datetime.timezone.utc
-    dt = datetime.datetime(1970, 1, 1, tzinfo=utc)
-    assert Timestamp.from_datetime(dt) == Timestamp(sec=0)
-
-    # no loss of precision
-    dt = datetime.datetime(2025, 1, 1, microsecond=42, tzinfo=utc)
-    assert Timestamp.from_datetime(dt) == Timestamp(sec=1_735_689_600, nsec=42_000)
-
-    # alternative timezone
-    local_tz = datetime.timezone(datetime.timedelta(hours=-1))
-    dt = datetime.datetime(1970, 1, 1, 0, 0, 1, 123_000, tzinfo=local_tz)
-    assert Timestamp.from_datetime(dt) == Timestamp(sec=3601, nsec=123_000_000)
-
-    with pytest.raises(OverflowError):
-        Timestamp.from_datetime(datetime.datetime(1969, 12, 31, tzinfo=utc))
-
-    with pytest.raises(OverflowError):
-        Timestamp.from_datetime(datetime.datetime(2106, 2, 8, tzinfo=utc))
+import datetime
+
+import pytest
+from foxglove.schemas import Duration, Timestamp
+
+
+def test_duration_normalization() -> None:
+    assert Duration(sec=0, nsec=1_111_222_333) == Duration(sec=1, nsec=111_222_333)
+    assert Duration(sec=0, nsec=2**32 - 1) == Duration(sec=4, nsec=294_967_295)
+    assert Duration(sec=-2, nsec=1_000_000_001) == Duration(sec=-1, nsec=1)
+    assert Duration(sec=-(2**31), nsec=1_000_000_001) == Duration(
+        sec=-(2**31) + 1, nsec=1
+    )
+
+    # argument conversions
+    d = Duration(sec=-(2**31))
+    assert d.sec == -(2**31)
+    assert d.nsec == 0
+
+    d = Duration(sec=0, nsec=2**32 - 1)
+    assert d.sec == 4
+    assert d.nsec == 294_967_295
+
+    d = Duration(sec=2**31 - 1, nsec=999_999_999)
+    assert d.sec == 2**31 - 1
+    assert d.nsec == 999_999_999
+
+    with pytest.raises(OverflowError):
+        Duration(sec=-(2**31) - 1)
+    with pytest.raises(OverflowError):
+        Duration(sec=2**31)
+    with pytest.raises(OverflowError):
+        Duration(sec=0, nsec=-1)
+    with pytest.raises(OverflowError):
+        Duration(sec=0, nsec=2**32)
+
+    # overflow past upper bound
+    with pytest.raises(OverflowError):
+        Duration(sec=2**31 - 1, nsec=1_000_000_000)
+
+    # we don't handle this corner case, where seconds is beyond the lower
+    # bound, but nanoseconds overflow to bring the duration within range.
+    with pytest.raises(OverflowError):
+        Duration(sec=-(2**31) - 1, nsec=1_000_000_000)
+
+
+def test_duration_from_secs() -> None:
+    assert Duration.from_secs(1.123) == Duration(sec=1, nsec=123_000_000)
+    assert Duration.from_secs(-0.123) == Duration(sec=-1, nsec=877_000_000)
+    assert Duration.from_secs(-1.123) == Duration(sec=-2, nsec=877_000_000)
+
+    with pytest.raises(OverflowError):
+        Duration.from_secs(-1e42)
+
+    with pytest.raises(OverflowError):
+        Duration.from_secs(1e42)
+
+
+def test_duration_from_timedelta() -> None:
+    td = datetime.timedelta(seconds=1, milliseconds=123)
+    assert Duration.from_timedelta(td) == Duration(sec=1, nsec=123_000_000)
+
+    # no loss of precision
+    td = datetime.timedelta(days=9876, microseconds=123_456)
+    assert Duration.from_timedelta(td) == Duration(sec=853_286_400, nsec=123_456_000)
+
+    # timedeltas are normalized
+    td = datetime.timedelta(seconds=8 * 24 * 3600, milliseconds=99_111)
+    assert Duration.from_timedelta(td) == Duration(sec=691_299, nsec=111_000_000)
+
+    with pytest.raises(OverflowError):
+        Duration.from_timedelta(datetime.timedelta.min)
+
+    with pytest.raises(OverflowError):
+        Duration.from_timedelta(datetime.timedelta.max)
+
+
+def test_timestamp_normalization() -> None:
+    assert Timestamp(sec=0, nsec=1_111_222_333) == Timestamp(sec=1, nsec=111_222_333)
+    assert Timestamp(sec=0, nsec=2**32 - 1) == Timestamp(sec=4, nsec=294_967_295)
+
+    # argument conversions
+    t = Timestamp(sec=0)
+    assert t.sec == 0
+    assert t.nsec == 0
+
+    t = Timestamp(sec=0, nsec=2**32 - 1)
+    assert t.sec == 4
+    assert t.nsec == 294_967_295
+
+    t = Timestamp(sec=2**32 - 1, nsec=999_999_999)
+    assert t.sec == 2**32 - 1
+    assert t.nsec == 999_999_999
+
+    with pytest.raises(OverflowError):
+        Timestamp(sec=-1)
+    with pytest.raises(OverflowError):
+        Timestamp(sec=2**32)
+    with pytest.raises(OverflowError):
+        Timestamp(sec=0, nsec=-1)
+    with pytest.raises(OverflowError):
+        Timestamp(sec=0, nsec=2**32)
+
+    # overflow past upper bound
+    with pytest.raises(OverflowError):
+        Timestamp(sec=2**32 - 1, nsec=1_000_000_000)
+
+
+def test_timestamp_from_epoch_secs() -> None:
+    assert Timestamp.from_epoch_secs(1.123) == Timestamp(sec=1, nsec=123_000_000)
+
+    with pytest.raises(OverflowError):
+        Timestamp.from_epoch_secs(-1.0)
+
+    with pytest.raises(OverflowError):
+        Timestamp.from_epoch_secs(1e42)
+
+
+def test_timestamp_from_datetime() -> None:
+    utc = datetime.timezone.utc
+    dt = datetime.datetime(1970, 1, 1, tzinfo=utc)
+    assert Timestamp.from_datetime(dt) == Timestamp(sec=0)
+
+    # no loss of precision
+    dt = datetime.datetime(2025, 1, 1, microsecond=42, tzinfo=utc)
+    assert Timestamp.from_datetime(dt) == Timestamp(sec=1_735_689_600, nsec=42_000)
+
+    # alternative timezone
+    local_tz = datetime.timezone(datetime.timedelta(hours=-1))
+    dt = datetime.datetime(1970, 1, 1, 0, 0, 1, 123_000, tzinfo=local_tz)
+    assert Timestamp.from_datetime(dt) == Timestamp(sec=3601, nsec=123_000_000)
+
+    with pytest.raises(OverflowError):
+        Timestamp.from_datetime(datetime.datetime(1969, 12, 31, tzinfo=utc))
+
+    with pytest.raises(OverflowError):
+        Timestamp.from_datetime(datetime.datetime(2106, 2, 8, tzinfo=utc))