foxglove-sdk 0.16.6__cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl

foxglove/schemas/__init__.py

@@ -0,0 +1,166 @@
+"""
+This module contains the definitions of the well-known Foxglove schemas for logging.
+
+Log messages to a corresponding channel type from :py:mod:`foxglove.channels`.
+
+Note that the schema classes are currently immutable and do not expose
+getters and setters for their fields. This is a limitation we plan to address in the future.
+"""
+
+# Generated by https://github.com/foxglove/foxglove-sdk
+
+from typing import Union
+
+from foxglove._foxglove_py.schemas import (
+    ArrowPrimitive,
+    CameraCalibration,
+    CircleAnnotation,
+    Color,
+    CompressedImage,
+    CompressedVideo,
+    CubePrimitive,
+    CylinderPrimitive,
+    Duration,
+    FrameTransform,
+    FrameTransforms,
+    GeoJson,
+    Grid,
+    ImageAnnotations,
+    KeyValuePair,
+    LaserScan,
+    LinePrimitive,
+    LinePrimitiveLineType,
+    LocationFix,
+    LocationFixes,
+    LocationFixPositionCovarianceType,
+    Log,
+    LogLevel,
+    ModelPrimitive,
+    PackedElementField,
+    PackedElementFieldNumericType,
+    Point2,
+    Point3,
+    Point3InFrame,
+    PointCloud,
+    PointsAnnotation,
+    PointsAnnotationType,
+    Pose,
+    PoseInFrame,
+    PosesInFrame,
+    Quaternion,
+    RawAudio,
+    RawImage,
+    SceneEntity,
+    SceneEntityDeletion,
+    SceneEntityDeletionType,
+    SceneUpdate,
+    SpherePrimitive,
+    TextAnnotation,
+    TextPrimitive,
+    Timestamp,
+    TriangleListPrimitive,
+    Vector2,
+    Vector3,
+    VoxelGrid,
+)
+
+FoxgloveSchema = Union[
+    ArrowPrimitive,
+    CameraCalibration,
+    CircleAnnotation,
+    Color,
+    CompressedImage,
+    CompressedVideo,
+    CubePrimitive,
+    CylinderPrimitive,
+    Duration,
+    FrameTransform,
+    FrameTransforms,
+    GeoJson,
+    Grid,
+    ImageAnnotations,
+    KeyValuePair,
+    LaserScan,
+    LinePrimitive,
+    LocationFix,
+    LocationFixes,
+    Log,
+    ModelPrimitive,
+    PackedElementField,
+    Point2,
+    Point3,
+    Point3InFrame,
+    PointCloud,
+    PointsAnnotation,
+    Pose,
+    PoseInFrame,
+    PosesInFrame,
+    Quaternion,
+    RawAudio,
+    RawImage,
+    SceneEntity,
+    SceneEntityDeletion,
+    SceneUpdate,
+    SpherePrimitive,
+    TextAnnotation,
+    TextPrimitive,
+    Timestamp,
+    TriangleListPrimitive,
+    Vector2,
+    Vector3,
+    VoxelGrid,
+]
+
+__all__ = [
+    "FoxgloveSchema",
+    "ArrowPrimitive",
+    "CameraCalibration",
+    "CircleAnnotation",
+    "Color",
+    "CompressedImage",
+    "CompressedVideo",
+    "CubePrimitive",
+    "CylinderPrimitive",
+    "Duration",
+    "FrameTransform",
+    "FrameTransforms",
+    "GeoJson",
+    "Grid",
+    "ImageAnnotations",
+    "KeyValuePair",
+    "LaserScan",
+    "LinePrimitive",
+    "LinePrimitiveLineType",
+    "LocationFix",
+    "LocationFixPositionCovarianceType",
+    "LocationFixes",
+    "Log",
+    "LogLevel",
+    "ModelPrimitive",
+    "PackedElementField",
+    "PackedElementFieldNumericType",
+    "Point2",
+    "Point3",
+    "Point3InFrame",
+    "PointCloud",
+    "PointsAnnotation",
+    "PointsAnnotationType",
+    "Pose",
+    "PoseInFrame",
+    "PosesInFrame",
+    "Quaternion",
+    "RawAudio",
+    "RawImage",
+    "SceneEntity",
+    "SceneEntityDeletion",
+    "SceneEntityDeletionType",
+    "SceneUpdate",
+    "SpherePrimitive",
+    "TextAnnotation",
+    "TextPrimitive",
+    "Timestamp",
+    "TriangleListPrimitive",
+    "Vector2",
+    "Vector3",
+    "VoxelGrid",
+]

foxglove/tests/test_channel.py

@@ -0,0 +1,243 @@
+import json
+import logging
+import random
+
+import pytest
+from foxglove import Channel, Context, Schema
+from foxglove.channels import LogChannel
+from foxglove.schemas import Log
+
+
+@pytest.fixture
+def new_topic() -> str:
+    return f"/{random.random()}"
+
+
+def test_warns_on_duplicate_topics(caplog: pytest.LogCaptureFixture) -> None:
+    schema = {"type": "object"}
+    c1 = Channel("test-duplicate", schema=schema)
+    c2 = Channel("test-duplicate", schema=schema)
+    assert c1.id() == c2.id()
+
+    with caplog.at_level(logging.WARNING):
+        # Same topic, different schema
+        c3 = Channel(
+            "test-duplicate",
+            schema={
+                "type": "object",
+                "additionalProperties": False,
+            },
+        )
+        assert c1.id() != c3.id()
+
+    assert len(caplog.records) == 1
+    for _, _, message in caplog.record_tuples:
+        assert (
+            "Channel with topic test-duplicate already exists in this context"
+            in message
+        )
+
+
+def test_does_not_warn_on_duplicate_topics_in_contexts(
+    caplog: pytest.LogCaptureFixture,
+) -> None:
+    ctx1 = Context()
+    ctx2 = Context()
+
+    _ = Channel("test-duplicate", context=ctx1)
+
+    with caplog.at_level(logging.WARNING):
+        Channel("test-duplicate", context=ctx2)
+
+    assert len(caplog.records) == 0
+
+
+def test_requires_an_object_schema(new_topic: str) -> None:
+    schema = {"type": "array"}
+    with pytest.raises(ValueError, match="Only object schemas are supported"):
+        Channel(new_topic, schema=schema)
+
+
+def test_log_dict_on_json_channel(new_topic: str) -> None:
+    json_schema = {"type": "object", "additionalProperties": True}
+    channel = Channel(new_topic, schema=json_schema)
+
+    assert channel.message_encoding == "json"
+
+    schema = channel.schema()
+    assert schema is not None
+    assert schema.encoding == "jsonschema"
+    assert json.loads(schema.data) == json_schema
+
+    channel.log({"test": "test"})
+
+
+def test_log_dict_on_schemaless_channel(new_topic: str) -> None:
+    channel = Channel(new_topic)
+    assert channel.message_encoding == "json"
+
+    schema = channel.schema()
+    assert schema is not None
+    assert schema.encoding == "jsonschema"
+    assert schema.data == b""
+
+    channel.log({"test": "test"})
+
+
+def test_log_dict_with_empty_schema(new_topic: str) -> None:
+    channel = Channel(new_topic, schema={})
+    assert channel.message_encoding == "json"
+
+    schema = channel.schema()
+    assert schema is not None
+    assert schema.encoding == "jsonschema"
+    assert schema.data == b""
+
+    channel.log({"test": "test"})
+
+
+def test_log_dict_on_schemaless_json_channel(new_topic: str) -> None:
+    channel = Channel(
+        new_topic,
+        message_encoding="json",
+    )
+    assert channel.message_encoding == "json"
+
+    schema = channel.schema()
+    assert schema is not None
+    assert schema.encoding == "jsonschema"
+    assert schema.data == b""
+
+    channel.log({"test": "test"})
+
+
+def test_log_must_serialize_on_protobuf_channel(new_topic: str) -> None:
+    schema = Schema(
+        name="my_schema",
+        encoding="protobuf",
+        data=b"\x01",
+    )
+    channel = Channel(
+        new_topic,
+        message_encoding="protobuf",
+        schema=schema,
+    )
+
+    assert channel.message_encoding == "protobuf"
+    assert channel.schema() == schema
+
+    with pytest.raises(TypeError, match="Unsupported message type"):
+        channel.log({"test": "test"})
+
+    channel.log(b"\x01")
+
+
+def test_channel_attributes(new_topic: str) -> None:
+    channel = Channel(new_topic, message_encoding="json")
+    assert channel.topic() == new_topic
+    assert channel.message_encoding == "json"
+    assert channel.schema() is not None
+    assert channel.metadata() == {}
+    assert not channel.has_sinks()
+
+
+def test_typed_channel_attributes(new_topic: str) -> None:
+    channel = LogChannel(new_topic)
+    assert channel.topic() == new_topic
+    assert channel.message_encoding == "protobuf"
+    assert channel.schema() == Log.get_schema()
+    assert channel.metadata() == {}
+    assert not channel.has_sinks()
+
+
+def test_channel_metadata(new_topic: str) -> None:
+    channel = Channel(new_topic, metadata={"foo": "bar"})
+    assert channel.metadata() == {"foo": "bar"}
+
+
+def test_channel_metadata_mistyped(new_topic: str) -> None:
+    with pytest.raises(TypeError, match="argument 'metadata'"):
+        Channel(new_topic, metadata={"1": 1})  # type: ignore
+
+
+def test_typed_channel_metadata(new_topic: str) -> None:
+    channel = LogChannel(new_topic, metadata={"foo": "bar"})
+    assert channel.metadata() == {"foo": "bar"}
+    channel = LogChannel(new_topic, context=Context(), metadata={"foo": "baz"})
+    assert channel.metadata() == {"foo": "baz"}
+
+
+def test_typed_channel_metadata_mistyped(new_topic: str) -> None:
+    with pytest.raises(TypeError, match="argument 'metadata'"):
+        LogChannel(new_topic, metadata={"1": 1})  # type: ignore
+
+
+def test_closed_channel_log(new_topic: str, caplog: pytest.LogCaptureFixture) -> None:
+    channel = Channel(new_topic, schema={"type": "object"})
+    channel.close()
+    with caplog.at_level(logging.WARNING):
+        channel.log(b"\x01")
+
+    assert len(caplog.records) == 1
+    for log_name, _, message in caplog.record_tuples:
+        assert log_name == "foxglove.channel.raw_channel"
+        assert message == f"Cannot log on closed channel for {new_topic}"
+
+
+def test_close_typed_channel(new_topic: str, caplog: pytest.LogCaptureFixture) -> None:
+    channel = LogChannel(new_topic)
+    channel.close()
+    with caplog.at_level(logging.WARNING):
+        channel.log(Log())
+
+    assert len(caplog.records) == 1
+    for log_name, _, message in caplog.record_tuples:
+        assert log_name == "foxglove.channel.raw_channel"
+        assert message == f"Cannot log on closed channel for {new_topic}"
+
+
+def test_typed_channel_requires_kwargs_after_message(new_topic: str) -> None:
+    channel = LogChannel(new_topic)
+
+    channel.log(Log(), log_time=0)
+
+    with pytest.raises(
+        TypeError,
+        match="takes 1 positional arguments but 2 were given",
+    ):
+        channel.log(Log(), 0)  # type: ignore
+
+
+def test_generates_names_for_schemas(new_topic: str) -> None:
+    ch_1 = Channel(
+        new_topic + "-1",
+        schema={"type": "object", "properties": {"foo": {"type": "string"}}},
+    )
+    ch_2 = Channel(
+        new_topic + "-2",
+        schema={"type": "object", "additionalProperties": True},
+    )
+    # Same schema will have the same name
+    ch_3 = Channel(
+        new_topic + "-3",
+        schema={"type": "object", "additionalProperties": True},
+    )
+
+    assert ch_1.schema_name() != ch_2.schema_name()
+    assert ch_2.schema_name() == ch_3.schema_name()
+
+
+def test_exposes_unique_channel_ids(new_topic: str) -> None:
+    ch_1 = Channel(new_topic + "-1")
+    ch_2 = Channel(new_topic + "-2")
+    ch_3 = LogChannel(new_topic + "-3")
+
+    assert ch_1.id() > 0
+    assert ch_1.id() < ch_2.id()
+    assert ch_2.id() < ch_3.id()
+
+
+def test_log_message_to_specific_sink(new_topic: str) -> None:
+    ctx = Context()
+    ch = Channel(new_topic, context=ctx)
+    ch.log("test", sink_id=1)

foxglove/tests/test_context.py

@@ -0,0 +1,10 @@
+from foxglove import Context
+
+
+def test_default_context_is_singleton() -> None:
+    assert Context.default() is Context.default()
+
+
+def test_context_is_distinct() -> None:
+    assert Context() is not Context.default()
+    assert Context() is not Context()

foxglove/tests/test_logging.py

@@ -0,0 +1,62 @@
+import logging
+import os
+import subprocess
+import sys
+
+import pytest
+from foxglove import set_log_level
+
+
+def test_set_log_level_accepts_string_or_int() -> None:
+    set_log_level("DEBUG")
+    set_log_level(logging.DEBUG)
+    with pytest.raises(ValueError):
+        set_log_level("debug")
+
+
+def test_set_log_level_clamps_illegal_values() -> None:
+    set_log_level(-1)
+    set_log_level(2**64)
+
+
+def test_logging_config_with_env() -> None:
+    # Run a script in a child process so logger can be re-initialized from env.
+    test_script = """
+import logging
+import foxglove
+
+logging.basicConfig(level=logging.DEBUG)
+
+server = foxglove.start_server(port=0)
+server.stop()
+
+print("test_init_with_env_complete")
+"""
+
+    # Default: unset
+    env = os.environ.copy()
+    env["FOXGLOVE_LOG_LEVEL"] = ""
+
+    result = subprocess.run(
+        [sys.executable, "-c", test_script],
+        env=env,
+        capture_output=True,
+        text=True,
+        timeout=5,
+    )
+    assert "test_init_with_env_complete" in result.stdout
+    assert "Started server" in result.stderr
+
+    # Quiet the WS server logging
+    env = os.environ.copy()
+    env["FOXGLOVE_LOG_LEVEL"] = "debug,foxglove::websocket::server=warn"
+
+    result = subprocess.run(
+        [sys.executable, "-c", test_script],
+        env=env,
+        capture_output=True,
+        text=True,
+        timeout=5,
+    )
+    assert "test_init_with_env_complete" in result.stdout
+    assert "Started server" not in result.stderr