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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sift_stack_py
-Version: 0.16.2
+Version: 0.17.0.dev1
 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.dev1}/lib/sift_client/_internal/grpc_transport/transport.py

@@ -8,7 +8,6 @@ from __future__ import annotations
 
 from importlib.metadata import PackageNotFoundError, version
 from typing import TYPE_CHECKING, Any, TypedDict, cast
-from urllib.parse import ParseResult, urlparse
 
 import grpc
 import grpc.aio as grpc_aio
@@ -21,6 +20,7 @@ from sift_client._internal.grpc_transport._interceptors.metadata import (
     Metadata,
     MetadataInterceptor,
 )
+from sift_client._internal.urls import parse_host
 
 if TYPE_CHECKING:
     from sift_client._internal.grpc_transport._async_interceptors.base import ClientAsyncInterceptor
@@ -78,7 +78,7 @@ def use_sift_channel(
 
     credentials = get_ssl_credentials(cert_via_openssl)
     options = _compute_channel_options(config)
-    api_uri = _clean_uri(config["uri"], use_ssl)
+    api_uri = parse_host(config["uri"])
     channel = grpc.secure_channel(api_uri, credentials, options)
     interceptors = _compute_sift_interceptors(config, metadata)
     return grpc.intercept_channel(channel, *interceptors)
@@ -98,7 +98,7 @@ def use_sift_async_channel(
         return _use_insecure_sift_async_channel(config, metadata)
 
     return grpc_aio.secure_channel(
-        target=_clean_uri(config["uri"], use_ssl),
+        target=parse_host(config["uri"]),
         credentials=get_ssl_credentials(cert_via_openssl),
         options=_compute_channel_options(config),
         interceptors=_compute_sift_async_interceptors(config, metadata),
@@ -112,7 +112,7 @@ def _use_insecure_sift_channel(
     FOR DEVELOPMENT PURPOSES ONLY
     """
     options = _compute_channel_options(config)
-    api_uri = _clean_uri(config["uri"], False)
+    api_uri = parse_host(config["uri"])
     channel = grpc.insecure_channel(api_uri, options)
     interceptors = _compute_sift_interceptors(config, metadata)
     return grpc.intercept_channel(channel, *interceptors)
@@ -125,7 +125,7 @@ def _use_insecure_sift_async_channel(
     FOR DEVELOPMENT PURPOSES ONLY
     """
     return grpc_aio.insecure_channel(
-        target=_clean_uri(config["uri"], False),
+        target=parse_host(config["uri"]),
         options=_compute_channel_options(config),
         interceptors=_compute_sift_async_interceptors(config, metadata),
     )
@@ -205,21 +205,6 @@ def _metadata_async_interceptor(
     return MetadataAsyncInterceptor(md)
 
 
-def _clean_uri(uri: str, use_ssl: bool) -> str:
-    """
-    This will automatically transform the URI to an acceptable form regardless of whether or not
-    users included the scheme in the URL or included trailing slashes.
-    """
-
-    if "http://" in uri or "https://" in uri:
-        parsed: ParseResult = urlparse(uri)
-        return parsed.netloc
-
-    full_uri = f"https://{uri}" if use_ssl else f"http://{uri}"
-    parsed_res: ParseResult = urlparse(full_uri)
-    return parsed_res.netloc
-
-
 def _compute_user_agent() -> str:
     try:
         return f"sift_stack_py/{version('sift_stack_py')}"

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

@@ -3,7 +3,7 @@ from __future__ import annotations
 import logging
 import uuid
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, cast
+from typing import TYPE_CHECKING, Any, TypeVar, cast
 
 from google.protobuf import json_format
 from sift.test_reports.v1.test_reports_pb2 import (
@@ -68,6 +68,9 @@ if TYPE_CHECKING:
 logger = logging.getLogger(__name__)
 
 
+_EntityT = TypeVar("_EntityT", TestReport, TestStep, TestMeasurement)
+
+
 class TestResultsLowLevelClient(LowLevelClientBase, WithGrpcClient):
     """Low-level client for the TestResultsAPI.
 
@@ -82,6 +85,16 @@ class TestResultsLowLevelClient(LowLevelClientBase, WithGrpcClient):
         """
         super().__init__(grpc_client)
 
+    @staticmethod
+    def _mark_simulated(instance: _EntityT) -> _EntityT:
+        """Stamp an entity as having been produced by the simulate path.
+
+        Mirrors the ``__dict__`` write used by ``BaseType._apply_client_to_instance``
+        to bypass pydantic's frozen-model guard.
+        """
+        instance.__dict__["_simulated"] = True
+        return instance
+
     @staticmethod
     def simulate_create_test_report_response(
         request: CreateTestReportRequest,
@@ -387,7 +400,7 @@ class TestResultsLowLevelClient(LowLevelClientBase, WithGrpcClient):
                     request,
                     response_id=simulated_proto.test_report_id,
                 )
-            return TestReport._from_proto(simulated_proto)
+            return self._mark_simulated(TestReport._from_proto(simulated_proto))
 
         response = await self._grpc_client.get_stub(TestReportServiceStub).CreateTestReport(request)
         grpc_test_report = cast("CreateTestReportResponse", response).test_report
@@ -505,7 +518,9 @@ class TestResultsLowLevelClient(LowLevelClientBase, WithGrpcClient):
         if log_file is not None or simulate:
             if log_file is not None:
                 log_request_to_file(log_file, "UpdateTestReport", request)
-            return self.simulate_update_test_report_response(request, existing=existing)
+            return self._mark_simulated(
+                self.simulate_update_test_report_response(request, existing=existing)
+            )
 
         response = await self._grpc_client.get_stub(TestReportServiceStub).UpdateTestReport(request)
         grpc_test_report = cast("UpdateTestReportResponse", response).test_report
@@ -560,7 +575,7 @@ class TestResultsLowLevelClient(LowLevelClientBase, WithGrpcClient):
                     request,
                     response_id=simulated_proto.test_step_id,
                 )
-            return TestStep._from_proto(simulated_proto)
+            return self._mark_simulated(TestStep._from_proto(simulated_proto))
 
         response = await self._grpc_client.get_stub(TestReportServiceStub).CreateTestStep(request)
         grpc_test_step = cast("CreateTestStepResponse", response).test_step
@@ -661,7 +676,9 @@ class TestResultsLowLevelClient(LowLevelClientBase, WithGrpcClient):
         if log_file is not None or simulate:
             if log_file is not None:
                 log_request_to_file(log_file, "UpdateTestStep", request)
-            return self.simulate_update_test_step_response(request, existing=existing)
+            return self._mark_simulated(
+                self.simulate_update_test_step_response(request, existing=existing)
+            )
 
         response = await self._grpc_client.get_stub(TestReportServiceStub).UpdateTestStep(request)
         grpc_test_step = cast("UpdateTestStepResponse", response).test_step
@@ -716,7 +733,7 @@ class TestResultsLowLevelClient(LowLevelClientBase, WithGrpcClient):
                     request,
                     response_id=simulated_proto.measurement_id,
                 )
-            return TestMeasurement._from_proto(simulated_proto)
+            return self._mark_simulated(TestMeasurement._from_proto(simulated_proto))
 
         response = await self._grpc_client.get_stub(TestReportServiceStub).CreateTestMeasurement(
             request
@@ -861,7 +878,9 @@ class TestResultsLowLevelClient(LowLevelClientBase, WithGrpcClient):
         if log_file is not None or simulate:
             if log_file is not None:
                 log_request_to_file(log_file, "UpdateTestMeasurement", request)
-            return self.simulate_update_test_measurement_response(request, existing=existing)
+            return self._mark_simulated(
+                self.simulate_update_test_measurement_response(request, existing=existing)
+            )
 
         response = await self._grpc_client.get_stub(TestReportServiceStub).UpdateTestMeasurement(
             request

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

@@ -6,7 +6,7 @@ from requests.adapters import HTTPAdapter
 from typing_extensions import NotRequired
 from urllib3.util import Retry
 
-from sift_client._internal.grpc_transport.transport import _clean_uri
+from sift_client._internal.urls import parse_host
 
 _DEFAULT_REST_RETRY = Retry(total=3, status_forcelist=[500, 502, 503, 504], backoff_factor=1)
 
@@ -33,7 +33,7 @@ class SiftRestConfig(TypedDict):
 def compute_uri(restconf: SiftRestConfig) -> str:
     uri = restconf["uri"]
     use_ssl = restconf.get("use_ssl", True)
-    clean_uri = _clean_uri(uri, use_ssl)
+    clean_uri = parse_host(uri)
 
     if use_ssl:
         return f"https://{clean_uri}"

sift_stack_py-0.17.0.dev1/lib/sift_client/_internal/urls.py

@@ -0,0 +1,55 @@
+"""Helpers for turning Sift API endpoints into web-app (frontend) URLs.
+
+The Sift frontend can be hosted on several domains and the backend exposes no
+field for its own URL, so the frontend origin is derived client-side from the
+API host. This table mirrors the canonical mapping used by the Grafana
+datasource (sift-stack/sift-grafana-datasource,
+``src/components/sharelink/getFrontendHostnameDefaults.ts``). Hosts outside the
+table (on-prem and custom deployments) require an explicit override.
+"""
+
+from __future__ import annotations
+
+from urllib.parse import urlparse
+
+# API host (host[:port], no scheme) -> frontend origin (with scheme).
+_API_HOST_TO_FRONTEND_ORIGIN: dict[str, str] = {
+    "api.siftstack.com": "https://app.siftstack.com",
+    "gov.api.siftstack.com": "https://gov.siftstack.com",
+}
+
+
+def parse_origin(url: str) -> str:
+    """Normalize a URL or bare host into a ``scheme://host[:port]`` origin.
+
+    Bare hosts (no scheme) are assumed to be ``https``.
+    """
+    candidate = url if "://" in url else f"https://{url}"
+    parsed = urlparse(candidate)
+    return f"{parsed.scheme}://{parsed.netloc}".rstrip("/")
+
+
+def parse_host(url: str) -> str:
+    """Extract ``host[:port]`` from a URL or bare host string."""
+    candidate = url if "://" in url else f"https://{url}"
+    return urlparse(candidate).netloc
+
+
+def frontend_origin_for_api(api_base_url: str, override: str | None = None) -> str | None:
+    """Return the Sift web-app origin for a given API base URL.
+
+    Args:
+        api_base_url: The REST API base URL (e.g. ``https://api.siftstack.com``).
+        override: An explicit frontend origin (host or full URL) to use instead
+            of the derived value. Set this for on-prem or custom deployments
+            whose API host isn't in the built-in mapping.
+
+    Returns:
+        The frontend origin (e.g. ``https://app.siftstack.com``), or ``None``
+        when no override is given and the API host isn't recognized.
+    """
+    if override:
+        return parse_origin(override)
+    if not api_base_url:
+        return None
+    return _API_HOST_TO_FRONTEND_ORIGIN.get(parse_host(api_base_url))

{sift_stack_py-0.16.2 → sift_stack_py-0.17.0.dev1}/lib/sift_client/client.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from sift_client._internal.urls import frontend_origin_for_api
 from sift_client.resources import (
     AssetsAPI,
     AssetsAPIAsync,
@@ -124,6 +125,7 @@ class SiftClient(
         grpc_url: str | None = None,
         rest_url: str | None = None,
         connection_config: SiftConnectionConfig | None = None,
+        app_url: str | None = None,
     ):
         """Initialize the SiftClient with specific connection parameters or a connection_config.
 
@@ -132,6 +134,10 @@ class SiftClient(
             grpc_url: The Sift gRPC API URL.
             rest_url: The Sift REST API URL.
             connection_config: A SiftConnectionConfig object to configure the connection behavior of the SiftClient.
+            app_url: The Sift web-app origin (e.g. ``https://app.siftstack.com``).
+                Set this for on-prem or custom deployments whose API host can't be
+                mapped to a frontend automatically; see the ``app_url`` property.
+                A value here takes precedence over ``connection_config.app_url``.
         """
         if not (api_key and grpc_url and rest_url) and not connection_config:
             raise ValueError(
@@ -152,6 +158,17 @@ class SiftClient(
         WithGrpcClient.__init__(self, grpc_client=grpc_client)
         WithRestClient.__init__(self, rest_client=rest_client)
 
+        # Explicit web-app origin override; falls back to the connection config's
+        # value, then to host-based derivation in the ``app_url`` property.
+        self._app_url: str | None = app_url or (
+            connection_config.app_url if connection_config else None
+        )
+
+        # When set, test-results writes return synthesized responses without
+        # contacting Sift. Read by `TestResultsAPIAsync._simulate`. Used by the
+        # pytest plugin's ``--sift-disabled`` mode.
+        self._simulate: bool = False
+
         self.ping = PingAPI(self)
         self.assets = AssetsAPI(self)
         self.calculated_channels = CalculatedChannelsAPI(self)
@@ -193,3 +210,18 @@ class SiftClient(
     def rest_client(self) -> RestClient:
         """The REST client used by the SiftClient for making REST API calls."""
         return self._rest_client
+
+    @property
+    def app_url(self) -> str | None:
+        """The Sift web-app origin for this client, or None if it can't be determined.
+
+        Uses the explicit override passed at construction when set, otherwise
+        derives the origin from the REST host for known Sift deployments (e.g.
+        ``https://api.siftstack.com`` -> ``https://app.siftstack.com``). Returns
+        None for unrecognized hosts with no override.
+
+        # TODO: Add a ``WithAppPage`` mixin on BaseType so resources (TestReport,
+        # Run, ...) can expose their own web-app link from ``_client.app_url`` plus
+        # a per-type path, instead of callers assembling paths by hand.
+        """
+        return frontend_origin_for_api(self.rest_client.base_url, override=self._app_url)