scale-gp-beta 0.1.0a22__tar.gz → 0.1.0a23__tar.gz

scale_gp_beta-0.1.0a23/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0-alpha.23"
+}

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a23}/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.1.0-alpha.23 (2025-06-20)
+
+Full Changelog: [v0.1.0-alpha.22...v0.1.0-alpha.23](https://github.com/scaleapi/sgp-python-beta/compare/v0.1.0-alpha.22...v0.1.0-alpha.23)
+
+### Features
+
+* Added set_error() to trace and span. ([#114](https://github.com/scaleapi/sgp-python-beta/issues/114)) ([2f08610](https://github.com/scaleapi/sgp-python-beta/commit/2f086103d8eed97a27f744e803717527ef64875c))
+
+
+### Bug Fixes
+
+* **tests:** fix: tests which call HTTP endpoints directly with the example parameters ([2a67032](https://github.com/scaleapi/sgp-python-beta/commit/2a6703258180ed241018002e3092d90d7974da56))
+
+
+### Chores
+
+* **ci:** enable for pull requests ([05e2eb0](https://github.com/scaleapi/sgp-python-beta/commit/05e2eb00b7d50d7c4d46d488f5b64cb9d2dcbb0d))
+* **internal:** codegen related update ([9ae2242](https://github.com/scaleapi/sgp-python-beta/commit/9ae2242e355b8f1cfbaa28eab55d4b9ef7776833))
+* **internal:** update conftest.py ([357f5ed](https://github.com/scaleapi/sgp-python-beta/commit/357f5ed5a3447bc889e5260911d8b4200c5f982f))
+* **tests:** add tests for httpx client instantiation & proxies ([6ae6d18](https://github.com/scaleapi/sgp-python-beta/commit/6ae6d18ff82de7bec888e6617fdf9f54be0f4aa6))
+
+
+### Documentation
+
+* **client:** fix httpx.Timeout documentation reference ([dc2482b](https://github.com/scaleapi/sgp-python-beta/commit/dc2482bf483a51b0178db63d1a4dd24ed97e351b))
+
 ## 0.1.0-alpha.22 (2025-06-16)
 
 Full Changelog: [v0.1.0-alpha.21...v0.1.0-alpha.22](https://github.com/scaleapi/sgp-python-beta/compare/v0.1.0-alpha.21...v0.1.0-alpha.22)

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scale-gp-beta
-Version: 0.1.0a22
+Version: 0.1.0a23
 Summary: The official Python library for the Scale GP API
 Project-URL: Homepage, https://github.com/scaleapi/sgp-python-beta
 Project-URL: Repository, https://github.com/scaleapi/sgp-python-beta
@@ -31,7 +31,7 @@ Description-Content-Type: text/markdown
 
 # Scale GP Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/scale-gp-beta.svg)](https://pypi.org/project/scale-gp-beta/)
+[![PyPI version](https://github.com/scaleapi/sgp-python-beta/tree/main/<https://img.shields.io/pypi/v/scale-gp-beta.svg?label=pypi%20(stable)>)](https://pypi.org/project/scale-gp-beta/)
 
 The Scale GP Python library provides convenient access to the Scale GP REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -578,7 +578,7 @@ client.with_options(max_retries=5).chat.completions.create(
 ### Timeouts
 
 By default requests time out after 1 minute. You can configure this with a `timeout` option,
-which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
 from scale_gp_beta import SGPClient

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a23}/README.md

@@ -1,6 +1,6 @@
 # Scale GP Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/scale-gp-beta.svg)](https://pypi.org/project/scale-gp-beta/)
+[![PyPI version](<https://img.shields.io/pypi/v/scale-gp-beta.svg?label=pypi%20(stable)>)](https://pypi.org/project/scale-gp-beta/)
 
 The Scale GP Python library provides convenient access to the Scale GP REST API from any Python 3.8+
 application. The library includes type definitions for all request params and response fields,
@@ -547,7 +547,7 @@ client.with_options(max_retries=5).chat.completions.create(
 ### Timeouts
 
 By default requests time out after 1 minute. You can configure this with a `timeout` option,
-which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
 
 ```python
 from scale_gp_beta import SGPClient

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a23}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "scale-gp-beta"
-version = "0.1.0-alpha.22"
+version = "0.1.0-alpha.23"
 description = "The official Python library for the Scale GP API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a23}/src/scale_gp_beta/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "scale_gp_beta"
-__version__ = "0.1.0-alpha.22"  # x-release-please-version
+__version__ = "0.1.0-alpha.23"  # x-release-please-version

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a23}/src/scale_gp_beta/lib/tracing/span.py

@@ -59,18 +59,18 @@ class BaseSpan:
         metadata: Optional[SpanMetadataParam] = None,
         span_type: SpanTypeLiterals = "STANDALONE"
     ):
-        self.name = name
-        self.trace_id = trace_id or "no_trace_id"
-        self.group_id = group_id
-        self.span_id: str = span_id or generate_span_id()
-        self.parent_span_id = parent_span_id
+        self._name = name
+        self._trace_id: str = trace_id or "no_trace_id"
+        self._group_id = group_id
+        self._span_id: str = span_id or generate_span_id()
+        self._parent_span_id = parent_span_id
         self.start_time: Optional[str] = None
         self.end_time: Optional[str] = None
-        self.input: SpanInputParam = input or {}
-        self.output: SpanOutputParam = output or {}
-        self.metadata: SpanMetadataParam = metadata or {}
-        self.span_type: SpanTypeLiterals = span_type
-        self.status: SpanStatusLiterals = "SUCCESS"
+        self._input: SpanInputParam = input or {}
+        self._output: SpanOutputParam = output or {}
+        self._metadata: SpanMetadataParam = metadata or {}
+        self._span_type: SpanTypeLiterals = span_type
+        self._status: SpanStatusLiterals = "SUCCESS"
         self._queue_manager = queue_manager
 
         self._contextvar_token: Optional[contextvars.Token[Optional[BaseSpan]]] = None
@@ -84,6 +84,73 @@ class BaseSpan:
     def flush(self, blocking: bool = True) -> None:
         pass
 
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def trace_id(self) -> str:
+        return self._trace_id
+
+    @property
+    def group_id(self) -> Optional[str]:
+        return self._group_id
+
+    @property
+    def span_id(self) -> str:
+        return self._span_id
+
+    @property
+    def parent_span_id(self) -> Optional[str]:
+        return self._parent_span_id
+
+    @property
+    def status(self) -> SpanStatusLiterals:
+        return self._status
+
+    @property
+    def span_type(self) -> SpanTypeLiterals:
+        return self._span_type
+
+    # with setters
+    @property
+    def metadata(self) -> SpanMetadataParam:
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, value: SpanMetadataParam) -> None:
+        self._metadata = value
+
+    @property
+    def input(self) -> SpanInputParam:
+        return self._input
+
+    @input.setter
+    def input(self, value: SpanInputParam) -> None:
+        self._input = value
+
+    @property
+    def output(self) -> SpanOutputParam:
+        return self._output
+
+    @output.setter
+    def output(self, value: SpanOutputParam) -> None:
+        self._output = value
+
+    def set_error(
+            self,
+            error_type: Optional[str] = None,
+            error_message: Optional[str] = None,
+            exception: Optional[BaseException] = None,
+    ) -> None:
+        # Naively record details in metadata for now, note that error capture only supported in context manager
+        exception_type = type(exception).__name__ if exception else None
+        exception_message = str(exception) if exception else None
+        self._status = "ERROR"
+        self.metadata["error"] = True
+        self.metadata["error_type"] = error_type or exception_type
+        self.metadata["error_message"] = error_message or exception_message
+
     def __enter__(self) -> BaseSpan:
         self.start()
         return self
@@ -94,13 +161,9 @@ class BaseSpan:
             exc_val: Optional[BaseException],
             exc_tb: Optional[TracebackType]
     ) -> None:
-        # Naively record details in metadata for now, note that error capture only supported in context manager
         # TODO: support error observations when using direct span.start() and span.end()
         if exc_type is not None:
-            self.metadata["error"] = True
-            self.metadata["error.type"] = exc_type.__name__
-            self.metadata["error.message"] = str(exc_val)
-            self.status = "ERROR"
+            self.set_error(exception=exc_val)
         self.end()
 
     def to_request_params(self) -> SpanCreateRequest:
@@ -203,7 +266,7 @@ class Span(BaseSpan):
     ):
         super().__init__(name, trace_id, queue_manager, span_id, parent_span_id, group_id, input, output, metadata, span_type)
         self._queue_manager: TraceQueueManager = queue_manager
-        self.trace_id: str = trace_id
+        self._trace_id: str = trace_id
 
     @override
     def flush(self, blocking: bool = True) -> None:

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a23}/src/scale_gp_beta/lib/tracing/trace.py

@@ -4,23 +4,30 @@ from types import TracebackType
 from typing import Type, Optional
 from typing_extensions import override
 
-from .span import Span, NoOpSpan
+from .span import Span, BaseSpan, NoOpSpan
 from .util import generate_trace_id
 from .scope import Scope
-from .types import SpanInputParam, SpanOutputParam, SpanTypeLiterals, SpanMetadataParam
+from .types import SpanInputParam, SpanOutputParam, SpanTypeLiterals, SpanMetadataParam, SpanStatusLiterals
 from .trace_queue_manager import TraceQueueManager
 
 log: logging.Logger = logging.getLogger(__name__)
 
 
 class BaseTrace:
-    def __init__(self, queue_manager: Optional[TraceQueueManager], trace_id: Optional[str] = None):
-        self.trace_id = trace_id or generate_trace_id()
+    def __init__(
+            self,
+            queue_manager: Optional[TraceQueueManager],
+            root_span: BaseSpan,
+            trace_id: str
+    ) -> None:
+        self._trace_id = trace_id
         self.queue_manager = queue_manager
 
         self._in_progress = False
         self._contextvar_token: Optional[contextvars.Token[Optional[BaseTrace]]] = None
 
+        self.root_span = root_span
+
     def start(self) -> None:
         pass
 
@@ -30,8 +37,62 @@ class BaseTrace:
     def flush(self, blocking: bool = True) -> None:
         pass
 
+    @property
+    def metadata(self) -> SpanMetadataParam:
+        return self.root_span.metadata
+
+    @metadata.setter
+    def metadata(self, value: SpanMetadataParam) -> None:
+        self.root_span.metadata = value
+
+    @property
+    def input(self) -> SpanInputParam:
+        return self.root_span.input
+
+    @input.setter
+    def input(self, value: SpanInputParam) -> None:
+        self.root_span.input = value
+
+    @property
+    def output(self) -> SpanOutputParam:
+        return self.root_span.output
+
+    @output.setter
+    def output(self, value: SpanOutputParam) -> None:
+        self.root_span.output = value
+
+    # no setters
+    @property
+    def name(self) -> Optional[str]:
+        return self.root_span.name
+
+    @property
+    def span_id(self) -> Optional[str]:
+        return self.root_span.span_id
+
+    @property
+    def trace_id(self) -> Optional[str]:
+        return self._trace_id
+
+    @property
     def group_id(self) -> Optional[str]:
-        return None
+        return self.root_span.group_id
+
+    @property
+    def span_type(self) -> SpanTypeLiterals:
+        return self.root_span.span_type
+
+    @property
+    def status(self) -> SpanStatusLiterals:
+        return self.root_span.status
+
+    def set_error(
+            self,
+            error_type: Optional[str] = None,
+            error_message: Optional[str] = None,
+            exception: Optional[BaseException] = None,
+    ) -> None:
+        self.root_span.set_error(error_type=error_type, error_message=error_message, exception=exception)
 
     def __enter__(self) -> "BaseTrace":
         self.start()
@@ -47,7 +108,12 @@ class BaseTrace:
 
     @override
     def __repr__(self) -> str:
-        return f"{self.__class__.__name__}(trace_id='{self.trace_id})"
+        return (
+            f"{self.__class__.__name__}("
+            f"trace_id='{self.trace_id}', "
+            f"root_span='{repr(self.root_span)}', "
+            ")"
+        )
 
     @override
     def __str__(self) -> str:
@@ -67,12 +133,11 @@ class NoOpTrace(BaseTrace):
             output: Optional[SpanOutputParam] = None,
             metadata: Optional[SpanMetadataParam] = None,
     ):
-        super().__init__(queue_manager, trace_id)
-
-        self.root_span = NoOpSpan(
+        trace_id = trace_id or generate_trace_id()
+        root_span = NoOpSpan(
             name=name,
             span_id=span_id,
-            trace_id=self.trace_id,
+            trace_id=trace_id,
             group_id=group_id,
             queue_manager=queue_manager,
             metadata=metadata,
@@ -80,15 +145,7 @@ class NoOpTrace(BaseTrace):
             input=input,
             output=output,
         )
-
-    @override
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"trace_id='{self.trace_id}', "
-            f"root_span='{repr(self.root_span)}', "
-            ")"
-        )
+        super().__init__(queue_manager, root_span, trace_id)
 
     @override
     def start(self) -> None:
@@ -98,10 +155,6 @@ class NoOpTrace(BaseTrace):
     def end(self) -> None:
         self.root_span.end()
 
-    @override
-    def group_id(self) -> Optional[str]:
-        return self.root_span.group_id
-
 
 class Trace(BaseTrace):
     def __init__(
@@ -116,13 +169,11 @@ class Trace(BaseTrace):
             output: Optional[SpanOutputParam] = None,
             metadata: Optional[SpanMetadataParam] = None,
     ):
-        super().__init__(queue_manager, trace_id)
-        self.queue_manager: TraceQueueManager = queue_manager
-
-        self.root_span = Span(
+        trace_id = trace_id or generate_trace_id()
+        root_span = Span(
             name=name,
             span_id=span_id,
-            trace_id=self.trace_id,
+            trace_id=trace_id,
             group_id=group_id,
             queue_manager=queue_manager,
             metadata=metadata,
@@ -130,6 +181,8 @@ class Trace(BaseTrace):
             input=input,
             output=output,
         )
+        super().__init__(queue_manager, root_span, trace_id)
+        self.queue_manager: TraceQueueManager = queue_manager
 
     @override
     def start(self) -> None:
@@ -162,16 +215,3 @@ class Trace(BaseTrace):
     @override
     def flush(self, blocking: bool = True) -> None:
         self.root_span.flush(blocking=blocking)
-
-    @override
-    def group_id(self) -> Optional[str]:
-        return self.root_span.group_id
-
-    @override
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"trace_id='{self.trace_id}', "
-            f"root_span='{repr(self.root_span)}', "
-            ")"
-        )

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a23}/src/scale_gp_beta/lib/tracing/tracing.py

@@ -182,7 +182,7 @@ def create_span(
 
     scoped_trace = current_trace()
     scoped_trace_id = scoped_trace.trace_id if scoped_trace else None
-    scoped_group_id = scoped_trace.group_id() if scoped_trace else None
+    scoped_group_id = scoped_trace.group_id if scoped_trace else None
     scoped_span = current_span()
     scoped_span_id = scoped_span.span_id if scoped_span else None
 

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a23}/tests/conftest.py

@@ -1,3 +1,5 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
 from __future__ import annotations
 
 import os

{scale_gp_beta-0.1.0a22/tests/lib → scale_gp_beta-0.1.0a23/tests/lib/tracing}/test_span.py

@@ -82,8 +82,8 @@ class TestBaseSpan:
 
         assert span.metadata is not None
         assert span.metadata["error"] is True
-        assert span.metadata["error.type"] == "ValueError"
-        assert span.metadata["error.message"] == "Test error"
+        assert span.metadata["error_type"] == "ValueError"
+        assert span.metadata["error_message"] == "Test error"
         assert span.start_time == "start-ts"
         assert span.end_time == "end-ts"
         assert span.status == "ERROR"
@@ -325,6 +325,6 @@ class TestSpan:
         # NOTE: will likely change this functionality soon
         assert span.metadata is not None
         assert span.metadata["error"] is True
-        assert span.metadata["error.type"] == "RuntimeError"
-        assert span.metadata["error.message"] == "Operational error"
+        assert span.metadata["error_type"] == "RuntimeError"
+        assert span.metadata["error_message"] == "Operational error"
         assert span.status == "ERROR"

{scale_gp_beta-0.1.0a22/tests/lib → scale_gp_beta-0.1.0a23/tests/lib/tracing}/test_trace.py

@@ -6,6 +6,7 @@ from unittest.mock import Mock, MagicMock, patch
 import pytest
 from pytest import MonkeyPatch, LogCaptureFixture
 
+from scale_gp_beta.lib.tracing.span import NoOpSpan
 from scale_gp_beta.lib.tracing.trace import Trace, BaseTrace, NoOpTrace
 from scale_gp_beta.lib.tracing.trace_queue_manager import TraceQueueManager
 
@@ -52,23 +53,21 @@ def patched_trace_utils(monkeypatch: MonkeyPatch) -> Dict[str, Mock]:
 
 
 class TestBaseTrace:
-    def test_initialization_defaults(self, mock_queue_manager: Mock, patched_trace_utils: Dict[str, Mock]) -> None:
-        trace = BaseTrace(queue_manager=mock_queue_manager)
+    def test_initialization_defaults(self, mock_queue_manager: Mock) -> None:
+        trace = BaseTrace(queue_manager=mock_queue_manager, trace_id="test-trace-id", root_span=NoOpSpan("test-root"))
         assert trace.trace_id == "test-trace-id"
         assert trace.queue_manager == mock_queue_manager
         assert trace._in_progress is False
         assert trace._contextvar_token is None
-        patched_trace_utils["generate_trace_id"].assert_called_once()
-
 
     def test_initialization_with_custom_trace_id(self, mock_queue_manager: Mock) -> None:
         custom_id = "my-custom-trace-id"
-        trace = BaseTrace(queue_manager=mock_queue_manager, trace_id=custom_id)
+        trace = BaseTrace(queue_manager=mock_queue_manager, trace_id=custom_id, root_span=NoOpSpan("test-root"))
         assert trace.trace_id == custom_id
         assert trace.queue_manager == mock_queue_manager
 
     def test_context_manager_calls_start_end(self, mock_queue_manager: Mock) -> None:
-        trace = BaseTrace(queue_manager=mock_queue_manager)
+        trace = BaseTrace(queue_manager=mock_queue_manager, trace_id="test-trace", root_span=NoOpSpan("test-root"))
         trace.start = Mock()
         trace.end = Mock()
 
@@ -79,7 +78,7 @@ class TestBaseTrace:
         trace.end.assert_called_once()
 
     def test_context_manager_propagates_exception(self, mock_queue_manager: Mock) -> None:
-        trace = BaseTrace(queue_manager=mock_queue_manager)
+        trace = BaseTrace(queue_manager=mock_queue_manager, trace_id="test-trace", root_span=NoOpSpan("test-root"))
         trace.end = Mock()
 
         with pytest.raises(ValueError, match="Test error in trace"):
@@ -255,3 +254,50 @@ class TestTrace:
         mock_scope_reset_current_trace.assert_called_once_with(expected_token)
         mock_scope_reset_current_span.assert_called_once_with(expected_span_token)
         assert trace._contextvar_token is None
+
+    def test_updating_trace_status(
+            self,
+            mock_queue_manager: Mock,
+            patched_trace_utils: Dict[str, Mock] # noqa: ARG002
+    ) -> None:
+        trace = Trace(queue_manager=mock_queue_manager, name="request_123")
+        with pytest.raises(AttributeError):
+            trace.status = "ERROR"  # type: ignore[attr-defined]
+        assert trace.root_span.status == "SUCCESS"
+
+
+    def test_setting_trace_metadata(
+            self,
+            mock_queue_manager: Mock,
+            patched_trace_utils: Dict[str, Mock] # noqa: ARG002
+    ) -> None:
+        trace = Trace(queue_manager=mock_queue_manager, name="request_123")
+        trace.metadata = {"foo": "bar"}
+        trace.metadata["other"] = "baz"
+        assert trace.root_span.metadata == {"foo": "bar", "other": "baz"}
+
+    def test_setting_trace_input(
+            self,
+            mock_queue_manager: Mock,
+            patched_trace_utils: Dict[str, Mock]  # noqa: ARG002
+    ) -> None:
+        trace = Trace(queue_manager=mock_queue_manager, name="request_123")
+        trace.input = {"foo": "bar"}
+        assert trace.root_span.input == {"foo": "bar"}
+
+    def test_setting_trace_output(
+            self,
+            mock_queue_manager: Mock,
+            patched_trace_utils: Dict[str, Mock]  # noqa: ARG002
+    ) -> None:
+        trace = Trace(queue_manager=mock_queue_manager, name="request_123")
+        trace.output = {"foo": "bar"}
+        assert trace.root_span.output == {"foo": "bar"}
+
+    def test_set_error(self, mock_queue_manager: Mock) -> None:
+        trace = Trace(queue_manager=mock_queue_manager, name="request_123")
+        e = AttributeError("this is a test")
+        assert trace.metadata == {}
+        trace.set_error(exception=e)
+
+        assert trace.metadata == {"error": True, "error_message": "this is a test", "error_type": "AttributeError"}

{scale_gp_beta-0.1.0a22/tests/lib → scale_gp_beta-0.1.0a23/tests/lib/tracing}/test_tracing.py

@@ -321,7 +321,7 @@ class TestCreateSpan:
             name="span_uses_scope_trace",
             span_id=None,
             parent_span_id=None,
-            group_id=mock_active_trace_instance.group_id(),
+            group_id=mock_active_trace_instance.group_id,
             trace_id=mock_active_trace_instance.trace_id,
             input={}, output={}, metadata={},
             queue_manager=mock_queue_manager_instance,
@@ -355,7 +355,7 @@ class TestCreateSpan:
             span_id=None,
             parent_span_id=mock_active_span_instance.span_id,
             trace_id=mock_active_trace_instance.trace_id,
-            group_id=mock_active_trace_instance.group_id(),
+            group_id=mock_active_trace_instance.group_id,
             input={}, output={}, metadata={},
             queue_manager=mock_queue_manager_instance,
             span_type="STANDALONE"