sift-stack-py 0.16.2__tar.gz → 0.17.0__tar.gz

{sift_stack_py-0.16.2 → sift_stack_py-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sift_stack_py
-Version: 0.16.2
+Version: 0.17.0
 Summary: Python client library for the Sift API
 Maintainer-email: Sift Software Engineers <engineering@siftstack.com>
 License: Copyright (c) 2024 Azimuth Industries Inc.
@@ -53,7 +53,7 @@ Requires-Dist: npTDMS~=1.9; extra == "all"
 Requires-Dist: polars~=1.8; extra == "all"
 Requires-Dist: pyOpenSSL<24.0.0; extra == "all"
 Requires-Dist: pyarrow>=17.0.0; extra == "all"
-Requires-Dist: rosbags~=0.0; extra == "all"
+Requires-Dist: rosbags~=0.0; python_full_version >= "3.8.2" and extra == "all"
 Requires-Dist: sift-stream-bindings==0.3.0; extra == "all"
 Requires-Dist: types-pyOpenSSL<24.0.0; extra == "all"
 Provides-Extra: build
@@ -89,7 +89,7 @@ Requires-Dist: pytest-benchmark==4.0.0; extra == "dev-all"
 Requires-Dist: pytest-dotenv==0.5.2; extra == "dev-all"
 Requires-Dist: pytest-mock==3.14.0; extra == "dev-all"
 Requires-Dist: pytest==8.2.2; extra == "dev-all"
-Requires-Dist: rosbags~=0.0; extra == "dev-all"
+Requires-Dist: rosbags~=0.0; python_full_version >= "3.8.2" and extra == "dev-all"
 Requires-Dist: ruff~=0.12.10; extra == "dev-all"
 Requires-Dist: sift-stream-bindings==0.3.0; extra == "dev-all"
 Requires-Dist: tomlkit~=0.13.3; extra == "dev-all"
@@ -106,27 +106,27 @@ Requires-Dist: pytest==8.2.2; extra == "development"
 Requires-Dist: ruff~=0.12.10; extra == "development"
 Requires-Dist: tomlkit~=0.13.3; extra == "development"
 Provides-Extra: docs
-Requires-Dist: griffe-pydantic==1.3.1; extra == "docs"
-Requires-Dist: mike==2.1.3; extra == "docs"
-Requires-Dist: mkdocs-api-autonav==0.4.0; extra == "docs"
-Requires-Dist: mkdocs-include-markdown-plugin==7.1.6; extra == "docs"
-Requires-Dist: mkdocs-jupyter==0.25.1; extra == "docs"
-Requires-Dist: mkdocs-material==9.7.5; extra == "docs"
-Requires-Dist: mkdocs==1.6.1; extra == "docs"
-Requires-Dist: mkdocstrings[python]==1.0.3; extra == "docs"
+Requires-Dist: griffe-pydantic==1.3.1; python_version >= "3.10" and extra == "docs"
+Requires-Dist: mike==2.1.3; python_version >= "3.10" and extra == "docs"
+Requires-Dist: mkdocs-api-autonav==0.4.0; python_version >= "3.10" and extra == "docs"
+Requires-Dist: mkdocs-include-markdown-plugin==7.1.6; python_version >= "3.10" and extra == "docs"
+Requires-Dist: mkdocs-jupyter==0.25.1; python_version >= "3.10" and extra == "docs"
+Requires-Dist: mkdocs-material==9.7.5; python_version >= "3.10" and extra == "docs"
+Requires-Dist: mkdocs==1.6.1; python_version >= "3.10" and extra == "docs"
+Requires-Dist: mkdocstrings[python]==1.0.3; python_version >= "3.10" and extra == "docs"
 Provides-Extra: docs-build
 Requires-Dist: build==1.2.1; extra == "docs-build"
 Requires-Dist: cffi~=1.14; extra == "docs-build"
-Requires-Dist: griffe-pydantic==1.3.1; extra == "docs-build"
+Requires-Dist: griffe-pydantic==1.3.1; python_version >= "3.10" and extra == "docs-build"
 Requires-Dist: grpcio-testing~=1.13; extra == "docs-build"
 Requires-Dist: h5py~=3.11; extra == "docs-build"
-Requires-Dist: mike==2.1.3; extra == "docs-build"
-Requires-Dist: mkdocs-api-autonav==0.4.0; extra == "docs-build"
-Requires-Dist: mkdocs-include-markdown-plugin==7.1.6; extra == "docs-build"
-Requires-Dist: mkdocs-jupyter==0.25.1; extra == "docs-build"
-Requires-Dist: mkdocs-material==9.7.5; extra == "docs-build"
-Requires-Dist: mkdocs==1.6.1; extra == "docs-build"
-Requires-Dist: mkdocstrings[python]==1.0.3; extra == "docs-build"
+Requires-Dist: mike==2.1.3; python_version >= "3.10" and extra == "docs-build"
+Requires-Dist: mkdocs-api-autonav==0.4.0; python_version >= "3.10" and extra == "docs-build"
+Requires-Dist: mkdocs-include-markdown-plugin==7.1.6; python_version >= "3.10" and extra == "docs-build"
+Requires-Dist: mkdocs-jupyter==0.25.1; python_version >= "3.10" and extra == "docs-build"
+Requires-Dist: mkdocs-material==9.7.5; python_version >= "3.10" and extra == "docs-build"
+Requires-Dist: mkdocs==1.6.1; python_version >= "3.10" and extra == "docs-build"
+Requires-Dist: mkdocstrings[python]==1.0.3; python_version >= "3.10" and extra == "docs-build"
 Requires-Dist: mypy==1.10.0; extra == "docs-build"
 Requires-Dist: npTDMS~=1.9; extra == "docs-build"
 Requires-Dist: pdoc==14.5.0; extra == "docs-build"
@@ -139,7 +139,7 @@ Requires-Dist: pytest-benchmark==4.0.0; extra == "docs-build"
 Requires-Dist: pytest-dotenv==0.5.2; extra == "docs-build"
 Requires-Dist: pytest-mock==3.14.0; extra == "docs-build"
 Requires-Dist: pytest==8.2.2; extra == "docs-build"
-Requires-Dist: rosbags~=0.0; extra == "docs-build"
+Requires-Dist: rosbags~=0.0; python_full_version >= "3.8.2" and extra == "docs-build"
 Requires-Dist: ruff~=0.12.10; extra == "docs-build"
 Requires-Dist: sift-stream-bindings==0.3.0; extra == "docs-build"
 Requires-Dist: tomlkit~=0.13.3; extra == "docs-build"
@@ -148,7 +148,7 @@ Provides-Extra: file-imports
 Requires-Dist: h5py~=3.11; extra == "file-imports"
 Requires-Dist: npTDMS~=1.9; extra == "file-imports"
 Requires-Dist: polars~=1.8; extra == "file-imports"
-Requires-Dist: rosbags~=0.0; extra == "file-imports"
+Requires-Dist: rosbags~=0.0; python_full_version >= "3.8.2" and extra == "file-imports"
 Provides-Extra: hdf5
 Requires-Dist: h5py~=3.11; extra == "hdf5"
 Requires-Dist: polars~=1.8; extra == "hdf5"
@@ -157,7 +157,7 @@ Requires-Dist: cffi~=1.14; extra == "openssl"
 Requires-Dist: pyOpenSSL<24.0.0; extra == "openssl"
 Requires-Dist: types-pyOpenSSL<24.0.0; extra == "openssl"
 Provides-Extra: rosbags
-Requires-Dist: rosbags~=0.0; extra == "rosbags"
+Requires-Dist: rosbags~=0.0; python_full_version >= "3.8.2" and extra == "rosbags"
 Provides-Extra: sift-stream
 Requires-Dist: sift-stream-bindings==0.3.0; extra == "sift-stream"
 Provides-Extra: sift-stream-bindings

{sift_stack_py-0.16.2 → sift_stack_py-0.17.0}/lib/sift_client/_internal/grpc_transport/_retry.py

@@ -4,7 +4,13 @@ import json
 from typing import ClassVar, TypedDict
 
 from grpc import StatusCode
-from typing_extensions import Self
+from typing_extensions import NotRequired, Self
+
+
+def _format_grpc_duration(seconds: float) -> str:
+    """Format seconds as a protobuf Duration string, e.g. ``60s`` or ``0.5s``."""
+    trimmed = f"{seconds:.9f}".rstrip("0").rstrip(".")
+    return f"{trimmed}s"
 
 
 class RetryPolicy:
@@ -50,8 +56,24 @@ class RetryPolicy:
         return json.dumps(self.config)
 
     @classmethod
-    def default(cls) -> Self:
-        return cls(config=cls.DEFAULT_POLICY)
+    def default(cls, timeout_seconds: float | None = None) -> Self:
+        """Build the default policy, optionally with a per-call deadline.
+
+        When ``timeout_seconds`` is set, every method config carries a
+        ``timeout`` so the C-core fails a stalled call with ``DEADLINE_EXCEEDED``
+        instead of hanging. The deadline bounds the whole call, retries included,
+        and a per-call ``timeout=`` still overrides it.
+        """
+        if timeout_seconds is None:
+            return cls(config=cls.DEFAULT_POLICY)
+        duration = _format_grpc_duration(timeout_seconds)
+        config: RetryConfig = {
+            "methodConfig": [
+                {**method_config, "timeout": duration}
+                for method_config in cls.DEFAULT_POLICY["methodConfig"]
+            ]
+        }
+        return cls(config=config)
 
 
 class RetryConfig(TypedDict):
@@ -61,6 +83,10 @@ class RetryConfig(TypedDict):
 class MethodConfigDict(TypedDict):
     name: list[dict[str, str]]
     retryPolicy: RetryConfigDict
+    # Applies to all methods via the wildcard `name` matcher above. If a
+    # server-streaming RPC is ever added to this channel, scope this by method
+    # name so the deadline doesn't clip a long-lived stream.
+    timeout: NotRequired[str]
 
 
 class RetryConfigDict(TypedDict):

{sift_stack_py-0.16.2 → sift_stack_py-0.17.0}/lib/sift_client/_internal/grpc_transport/transport.py

@@ -31,6 +31,9 @@ from sift_client._internal.grpc_transport.keepalive import DEFAULT_KEEPALIVE_CON
 SiftChannel: TypeAlias = grpc.Channel
 SiftAsyncChannel: TypeAlias = grpc_aio.Channel
 
+DEFAULT_REQUEST_TIMEOUT_SECONDS = 60.0
+"""Default per-call deadline applied to unary RPCs that don't set their own."""
+
 
 def get_ssl_credentials(cert_via_openssl: bool) -> grpc.ChannelCredentials:
     """
@@ -155,9 +158,10 @@ def _compute_channel_options(opts: SiftChannelConfig) -> list[tuple[str, Any]]:
     Initialize all [channel options](https://github.com/grpc/grpc/blob/v1.64.x/include/grpc/impl/channel_arg_names.h) here.
     """
 
+    request_timeout = opts.get("request_timeout", DEFAULT_REQUEST_TIMEOUT_SECONDS)
     options = [
         ("grpc.enable_retries", 1),
-        ("grpc.service_config", RetryPolicy.default().as_json()),
+        ("grpc.service_config", RetryPolicy.default(timeout_seconds=request_timeout).as_json()),
         # Primary cannot be overriden:
         #  https://github.com/grpc/grpc/blob/0498194240f55d7f4b12633ad01339fb690621bf/src/core/ext/filters/http/client/http_client_filter.cc#L97
         ("grpc.secondary_user_agent", _compute_user_agent()),
@@ -248,6 +252,8 @@ class SiftChannelConfig(TypedDict):
     Run `pip install sift-stack-py[openssl]` to install the dependencies required to use this option.
     This works around this issue with grpc loading SSL certificates: https://github.com/grpc/grpc/issues/29682.
     Default is False.
+    - `request_timeout`: Default deadline in seconds applied to unary RPCs that don't set their own.
+    Defaults to 60s. Set to `None` to disable the default deadline.
     """
 
     uri: str
@@ -255,3 +261,4 @@ class SiftChannelConfig(TypedDict):
     enable_keepalive: NotRequired[bool | KeepaliveConfig]
     use_ssl: NotRequired[bool]
     cert_via_openssl: NotRequired[bool]
+    request_timeout: NotRequired[float | None]

{sift_stack_py-0.16.2 → sift_stack_py-0.17.0}/lib/sift_client/_internal/low_level_wrappers/__init__.py

@@ -12,6 +12,7 @@ from sift_client._internal.low_level_wrappers.rules import RulesLowLevelClient
 from sift_client._internal.low_level_wrappers.runs import RunsLowLevelClient
 from sift_client._internal.low_level_wrappers.tags import TagsLowLevelClient
 from sift_client._internal.low_level_wrappers.test_results import TestResultsLowLevelClient
+from sift_client._internal.low_level_wrappers.units import UnitsLowLevelClient
 from sift_client._internal.low_level_wrappers.upload import UploadLowLevelClient
 
 __all__ = [
@@ -27,5 +28,6 @@ __all__ = [
     "RunsLowLevelClient",
     "TagsLowLevelClient",
     "TestResultsLowLevelClient",
+    "UnitsLowLevelClient",
     "UploadLowLevelClient",
 ]

{sift_stack_py-0.16.2 → sift_stack_py-0.17.0}/lib/sift_client/_internal/low_level_wrappers/channels.py

@@ -10,12 +10,17 @@ from sift.channels.v3.channels_pb2 import (
     GetChannelResponse,
     ListChannelsRequest,
     ListChannelsResponse,
+    UpdateChannelRequest,
+    UpdateChannelResponse,
 )
+from sift.channels.v3.channels_pb2 import Channel as ChannelProto
 from sift.channels.v3.channels_pb2_grpc import ChannelServiceStub
 
 from sift_client._internal.low_level_wrappers.base import LowLevelClientBase
-from sift_client.sift_types.channel import Channel
+from sift_client._internal.low_level_wrappers.units import UnitsLowLevelClient
+from sift_client.sift_types.channel import Channel, ChannelUpdate
 from sift_client.transport import WithGrpcClient
+from sift_client.util import cel_utils as cel
 
 if TYPE_CHECKING:
     from sift_client.transport.grpc_transport import GrpcClient
@@ -39,6 +44,38 @@ class ChannelsLowLevelClient(LowLevelClientBase, WithGrpcClient):
             grpc_client: The gRPC client to use for making API calls.
         """
         super().__init__(grpc_client)
+        self._units_low_level_client = UnitsLowLevelClient(grpc_client=grpc_client)
+
+    async def _build_channels(self, protos: list[ChannelProto]) -> list[Channel]:
+        """Build Channels from protos, resolving each unit id to its name.
+
+        The proto carries the unit as an id, so the ids are looked up against the Units
+        service and the Channel is built with the abbreviated name. This keeps a Channel's
+        ``unit`` field a human-readable name, never an id.
+
+        Args:
+            protos: The channel protos to build.
+
+        Returns:
+            The built Channels, with unit names resolved.
+        """
+        unit_ids = {(proto.display_unit_id or proto.unit_id) for proto in protos}
+        unit_ids.discard("")
+        names: dict[str, str] = {}
+        if unit_ids:
+            units = await self._units_low_level_client.list_all_units(
+                query_filter=cel.in_("unit_id", list(unit_ids)),
+            )
+            names = {unit.unit_id: unit.abbreviated_name for unit in units}
+        return [
+            Channel._from_proto(proto, unit=names.get(proto.display_unit_id or proto.unit_id, ""))
+            for proto in protos
+        ]
+
+    async def _build_channel(self, proto: ChannelProto) -> Channel:
+        """Build a single Channel from a proto, resolving its unit id to a name."""
+        channels = await self._build_channels([proto])
+        return channels[0]
 
     async def get_channel(self, channel_id: str) -> Channel:
         """Get a channel by channel_id.
@@ -55,8 +92,7 @@ class ChannelsLowLevelClient(LowLevelClientBase, WithGrpcClient):
         request = GetChannelRequest(channel_id=channel_id)
         response = await self._grpc_client.get_stub(ChannelServiceStub).GetChannel(request)
         grpc_channel = cast("GetChannelResponse", response).channel
-        channel = Channel._from_proto(grpc_channel)
-        return channel
+        return await self._build_channel(grpc_channel)
 
     async def list_channels(
         self,
@@ -91,7 +127,7 @@ class ChannelsLowLevelClient(LowLevelClientBase, WithGrpcClient):
         response = await self._grpc_client.get_stub(ChannelServiceStub).ListChannels(request)
         response = cast("ListChannelsResponse", response)
 
-        channels = [Channel._from_proto(channel) for channel in response.channels]
+        channels = await self._build_channels(list(response.channels))
         return channels, response.next_page_token
 
     async def list_all_channels(
@@ -120,6 +156,21 @@ class ChannelsLowLevelClient(LowLevelClientBase, WithGrpcClient):
             max_results=max_results,
         )
 
+    async def update_channel(self, update: ChannelUpdate) -> Channel:
+        """Update a channel.
+
+        Args:
+            update: The ChannelUpdate to apply.
+
+        Returns:
+            The updated Channel.
+        """
+        grpc_channel, update_mask = update.to_proto_with_mask()
+        request = UpdateChannelRequest(channel=grpc_channel, update_mask=update_mask)
+        response = await self._grpc_client.get_stub(ChannelServiceStub).UpdateChannel(request)
+        updated_grpc_channel = cast("UpdateChannelResponse", response).channel
+        return await self._build_channel(updated_grpc_channel)
+
     async def batch_archive_channels(self, channel_ids: list[str]) -> None:
         """Batch archive channels by setting active to false.
 

sift_stack_py-0.17.0/lib/sift_client/_internal/low_level_wrappers/units.py

@@ -0,0 +1,120 @@
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, cast
+
+from sift.unit.v2.unit_pb2 import (
+    CreateUnitRequest,
+    CreateUnitResponse,
+    ListUnitsRequest,
+    ListUnitsResponse,
+)
+from sift.unit.v2.unit_pb2 import Unit as UnitProto
+from sift.unit.v2.unit_pb2_grpc import UnitServiceStub
+
+from sift_client._internal.low_level_wrappers.base import DEFAULT_PAGE_SIZE, LowLevelClientBase
+from sift_client.transport import WithGrpcClient
+
+if TYPE_CHECKING:
+    from sift_client.transport.grpc_transport import GrpcClient
+
+# Configure logging
+logger = logging.getLogger(__name__)
+
+
+class UnitsLowLevelClient(LowLevelClientBase, WithGrpcClient):
+    """Low-level client for the Units service.
+
+    This class provides a thin wrapper around the autogenerated bindings for the Units service.
+    """
+
+    def __init__(self, grpc_client: GrpcClient):
+        """Initialize the UnitsLowLevelClient.
+
+        Args:
+            grpc_client: The gRPC client to use for making API calls.
+        """
+        super().__init__(grpc_client)
+
+    async def create_unit(self, name: str) -> UnitProto:
+        """Create a new unit.
+
+        If a unit with the same name already exists, it is returned instead of creating a duplicate.
+
+        Args:
+            name: The name of the unit.
+
+        Returns:
+            The created unit proto, whose unit_id is used to reference the unit.
+
+        Raises:
+            ValueError: If name is not provided.
+        """
+        if not name:
+            raise ValueError("name must be provided")
+
+        request = CreateUnitRequest(name=name)
+        response = await self._grpc_client.get_stub(UnitServiceStub).CreateUnit(request)
+        return cast("CreateUnitResponse", response).unit
+
+    async def list_units(
+        self,
+        *,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
+        page_token: str | None = None,
+        query_filter: str | None = None,
+        order_by: str | None = None,
+    ) -> tuple[list[UnitProto], str]:
+        """List units with optional filtering and pagination.
+
+        Args:
+            page_size: The maximum number of units to return.
+            page_token: A page token for pagination.
+            query_filter: A CEL filter string (e.g. filtering on unit_id or abbreviated_name).
+            order_by: How to order the retrieved units.
+
+        Returns:
+            A tuple of (unit protos, next_page_token).
+        """
+        request_kwargs: dict[str, Any] = {}
+        if page_size is not None:
+            request_kwargs["page_size"] = page_size
+        if page_token is not None:
+            request_kwargs["page_token"] = page_token
+        if query_filter is not None:
+            request_kwargs["filter"] = query_filter
+        if order_by is not None:
+            request_kwargs["order_by"] = order_by
+
+        request = ListUnitsRequest(**request_kwargs)
+        response = await self._grpc_client.get_stub(UnitServiceStub).ListUnits(request)
+        response = cast("ListUnitsResponse", response)
+
+        return list(response.units), response.next_page_token
+
+    async def list_all_units(
+        self,
+        *,
+        query_filter: str | None = None,
+        order_by: str | None = None,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
+        max_results: int | None = None,
+    ) -> list[UnitProto]:
+        """List all units with optional filtering, following pagination.
+
+        Args:
+            query_filter: A CEL filter string.
+            order_by: How to order the retrieved units.
+            page_size: The number of units to fetch per request.
+            max_results: Maximum number of results to return.
+
+        Returns:
+            A list of all matching unit protos.
+        """
+        return await self._handle_pagination(
+            self.list_units,
+            kwargs={"query_filter": query_filter},
+            page_size=page_size,
+            order_by=order_by,
+            max_results=max_results,
+        )

{sift_stack_py-0.16.2 → sift_stack_py-0.17.0}/lib/sift_client/_internal/sync_wrapper.py

@@ -53,7 +53,22 @@ def generate_sync_api(cls: type[ResourceBase], sync_name: str) -> type:
         self._async_impl._is_sync = True
 
     def _run(self, coro):
-        loop = self._async_impl.client.get_asyncio_loop()
+        client = self._async_impl.client
+        loop = client.get_asyncio_loop()
+
+        # Fail fast if the loop has stopped (e.g. the client was closed during
+        # teardown). Scheduling onto a stopped loop would block forever because
+        # the coroutine can never run.
+        loop_running = getattr(client, "is_loop_running", None)
+        if loop_running is None:
+            loop_running = loop.is_running()
+        if not loop_running:
+            coro.close()
+            raise RuntimeError("Sift client is closed; cannot make synchronous API calls.")
+
+        # No wall-clock cap here: stalled calls are bounded at the transport layer
+        # (GrpcConfig/RestConfig request_timeout), and waiting on the whole coroutine
+        # lets methods like wait_until_complete honor their own timeout_secs.
         return asyncio.run_coroutine_threadsafe(coro, loop).result()
 
     namespace = {