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

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

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

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

@@ -1,5 +1,40 @@
 # Changelog
 
+## 0.1.0-alpha.24 (2025-06-20)
+
+Full Changelog: [v0.1.0-alpha.23...v0.1.0-alpha.24](https://github.com/scaleapi/sgp-python-beta/compare/v0.1.0-alpha.23...v0.1.0-alpha.24)
+
+### Features
+
+* Add queue_manger override for create span and trace & explicit option to disable daemon worker on TraceQueueManager. ([#117](https://github.com/scaleapi/sgp-python-beta/issues/117)) ([746ffa0](https://github.com/scaleapi/sgp-python-beta/commit/746ffa07ef7e31dfde972f443a440b0c7267b4fd))
+* make span.py thread safe. ([#115](https://github.com/scaleapi/sgp-python-beta/issues/115)) ([55116b9](https://github.com/scaleapi/sgp-python-beta/commit/55116b9a296c64a9d94773a230a25c5ba22ca1ee))
+
+## 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.0a24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scale-gp-beta
-Version: 0.1.0a22
+Version: 0.1.0a24
 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.0a24}/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.0a24}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "scale-gp-beta"
-version = "0.1.0-alpha.22"
+version = "0.1.0-alpha.24"
 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.0a24}/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.24"  # x-release-please-version

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

@@ -1,7 +1,9 @@
 from __future__ import annotations
 
 import logging
+from copy import deepcopy
 from typing import TYPE_CHECKING, Type, Optional
+from threading import RLock
 from typing_extensions import override
 
 from scale_gp_beta.types.span_upsert_batch_params import Item as SpanCreateRequest
@@ -59,21 +61,22 @@ 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.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._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._queue_manager = queue_manager
 
         self._contextvar_token: Optional[contextvars.Token[Optional[BaseSpan]]] = None
+        self._lock = RLock()
 
     def start(self) -> None:
         pass
@@ -84,6 +87,96 @@ 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 start_time(self) -> Optional[str]:
+        return self._start_time
+
+    @start_time.setter
+    def start_time(self, value: Optional[str]) -> None:
+        with self._lock:
+            self._start_time = value
+
+    @property
+    def end_time(self) -> Optional[str]:
+        return self._end_time
+
+    @end_time.setter
+    def end_time(self, value: Optional[str]) -> None:
+        with self._lock:
+            self._end_time = value
+
+    @property
+    def metadata(self) -> SpanMetadataParam:
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, value: SpanMetadataParam) -> None:
+        # this does not protect against span.metadata["foo"] = "bar" which uses the getter, ditto input and output
+        with self._lock:
+            self._metadata = value
+
+    @property
+    def input(self) -> SpanInputParam:
+        return self._input
+
+    @input.setter
+    def input(self, value: SpanInputParam) -> None:
+        with self._lock:
+            self._input = value
+
+    @property
+    def output(self) -> SpanOutputParam:
+        return self._output
+
+    @output.setter
+    def output(self, value: SpanOutputParam) -> None:
+        with self._lock:
+            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
+        with self._lock:
+            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,42 +187,41 @@ 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:
-        if self.start_time is None:
-            raise ParamsCreationError("No start time specified")
-
-        request_data = SpanCreateRequest(
-            name=self.name,
-            id=self.span_id,
-            trace_id=self.trace_id,
-            start_timestamp=self.start_time,
-            input=self.input,
-            output=self.output,
-            metadata=self.metadata,
-            status=self.status,
-            type=self.span_type
-        )
+        with self._lock:
+            if self.start_time is None:
+                raise ParamsCreationError("No start time specified")
+
+            request_data = SpanCreateRequest(
+                name=self.name,
+                id=self.span_id,
+                trace_id=self.trace_id,
+                start_timestamp=self.start_time,
+                input=self.input,
+                output=self.output,
+                metadata=self.metadata,
+                status=self.status,
+                type=self.span_type
+            )
 
-        if self.end_time is not None:
-            request_data["end_timestamp"] = self.end_time
+            if self.end_time is not None:
+                request_data["end_timestamp"] = self.end_time
 
-        # parent_span_id is optional (root spans)
-        if self.parent_span_id is not None:
-            request_data["parent_id"] = self.parent_span_id
+            # parent_span_id is optional (root spans)
+            if self.parent_span_id is not None:
+                request_data["parent_id"] = self.parent_span_id
 
-        if self.group_id is not None:
-            request_data["group_id"] = self.group_id
+            if self.group_id is not None:
+                request_data["group_id"] = self.group_id
 
-        return request_data
+            # ensure no future changes to metadata, input or output changes request_data, full isolation
+            request_data = deepcopy(request_data)
+            return request_data
 
     @override
     def __repr__(self) -> str:
@@ -203,7 +295,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:
@@ -225,13 +317,14 @@ class Span(BaseSpan):
         Sets the `start_time`, reports the span start to the `TraceQueueManager`
         , and registers this span as the current span.
         """
-        if self.start_time is not None:
-            log.warning(f"Span {self.name}: {self.span_id} has already started at {self.start_time}")
-            return
+        with self._lock:
+            if self.start_time is not None:
+                log.warning(f"Span {self.name}: {self.span_id} has already started at {self.start_time}")
+                return
 
-        self.start_time = iso_timestamp()
-        self._queue_manager.report_span_start(self)
-        self._contextvar_token = Scope.set_current_span(self)
+            self.start_time = iso_timestamp()
+            self._queue_manager.report_span_start(self)
+            self._contextvar_token = Scope.set_current_span(self)
 
     @override
     def end(self) -> None:
@@ -241,19 +334,20 @@ class Span(BaseSpan):
         `TraceQueueManager` for queuing and export, and resets this span from the
         `Scope`.
         """
-        if self.end_time is not None:
-            log.warning(f"Span {self.name}: {self.span_id} has already ended at {self.end_time}")
-            return
-        if self._contextvar_token is None:
-            log.warning(
-                (
-                    f"Span {self.name}: {self.span_id} attempting to end without a valid context token. "
-                    "Was start() called and completed successfully?"
+        with self._lock:
+            if self.end_time is not None:
+                log.warning(f"Span {self.name}: {self.span_id} has already ended at {self.end_time}")
+                return
+            if self._contextvar_token is None:
+                log.warning(
+                    (
+                        f"Span {self.name}: {self.span_id} attempting to end without a valid context token. "
+                        "Was start() called and completed successfully?"
+                    )
                 )
-            )
-            return
+                return
 
-        self.end_time = iso_timestamp()
-        self._queue_manager.report_span_end(self)
-        Scope.reset_current_span(self._contextvar_token)
-        self._contextvar_token = None
+            self.end_time = iso_timestamp()
+            self._queue_manager.report_span_end(self)
+            Scope.reset_current_span(self._contextvar_token)
+            self._contextvar_token = None

{scale_gp_beta-0.1.0a22 → scale_gp_beta-0.1.0a24}/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.0a24}/src/scale_gp_beta/lib/tracing/trace_queue_manager.py

@@ -30,7 +30,7 @@ class TraceQueueManager:
     """Manage trace and spans queue
     Store spans in-memory until the threshold has been reached then flush to server.
 
-    Optionally provide a client, if unprovided we will attempt to create a default client.
+    Optionally provide a client, if unprovided, we will attempt to create a default client.
     """
 
     def __init__(
@@ -41,6 +41,7 @@ class TraceQueueManager:
         trigger_queue_size: int = DEFAULT_TRIGGER_QUEUE_SIZE,
         trigger_cadence: float = DEFAULT_TRIGGER_CADENCE,
         retries: int = DEFAULT_RETRIES,
+        worker_enabled: Optional[bool] = None,
     ):
         self._client = client
         self._attempted_local_client_creation = False
@@ -54,7 +55,9 @@ class TraceQueueManager:
         self._shutdown_event = threading.Event()
         self._queue: queue.Queue[Span] = queue.Queue(maxsize=max_queue_size)
 
-        if not is_disabled():
+        self._worker_enabled = worker_enabled if worker_enabled is not None else not is_disabled()
+
+        if self._worker_enabled:
             self._worker = threading.Thread(daemon=True, target=self._run)
             self._worker.start()
 
@@ -66,7 +69,7 @@ class TraceQueueManager:
         self._client = client
 
     def shutdown(self, timeout: Optional[float] = None) -> None:
-        if is_disabled():
+        if not self._worker_enabled:
             log.debug("No worker to shutdown")
             return
         log.info(f"Shutting down trace queue manager, joining worker thread with timeout {timeout}")
@@ -92,6 +95,7 @@ class TraceQueueManager:
 
     def enqueue(self, span: "Span") -> None:
         try:
+            # Should this be a deep copy of span instead? Currently is a reference
             self._queue.put_nowait(span)
         except queue.Full:
             log.warning(f"Queue full, ignoring span {span.span_id}")