UncountablePythonSDK 0.0.157__tar.gz → 0.0.158__tar.gz

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/.github/workflows/documentation.yml

@@ -9,7 +9,7 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
       - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6
       - uses: extractions/setup-crate@4993624604c307fbca528d28a3c8b60fa5ecc859 # v1
         with:

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/.github/workflows/publish.yml

@@ -19,7 +19,7 @@ jobs:
     name: Build distribution packages
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
         with:
           fetch-depth: 0
           tags: true
@@ -36,7 +36,7 @@ jobs:
         run: |
           export SETUPTOOLS_SCM_PRETEND_VERSION_FOR_uncountablepythonsdk=$(git describe --tags --exact-match)
           python3 -m build
-      - uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6
+      - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7
         with:
           name: package-distributions
           path: dist/

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.157
+Version: 0.0.158
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/UncountablePythonSDK.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.157
+Version: 0.0.158
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/UncountablePythonSDK.egg-info/SOURCES.txt

@@ -126,6 +126,7 @@ uncountable/core/query/__init__.py
 uncountable/core/query/builder.py
 uncountable/core/query/column.py
 uncountable/core/query/row.py
+uncountable/core/query/types.py
 uncountable/integration/__init__.py
 uncountable/integration/cli.py
 uncountable/integration/construct_client.py

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/docs/integration_examples/upload_file.md

@@ -13,8 +13,7 @@ from uncountable.core.file_upload import DataFileUpload, UploadedFile
 client: Client = Client(
     base_url="<BASE_URL>",
     auth_details=AuthDetailsApiKey(
-        api_id="<API_ID>", 
-        api_secret_key="<API_SECRET_KEY>"
+        api_id="<API_ID>", api_secret_key="<API_SECRET_KEY>"
     ),
     config=ClientConfig(allow_insecure_tls=False),
 )

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/examples/integration-server/pyproject.toml

@@ -18,7 +18,7 @@ dependencies = [
   "pandas-stubs",
   "xlrd == 2.*",
   "msgspec ==0.20.*",
-  "websockets==15.0.1",
+  "websockets==16.0",
 ]
 
 [tool.mypy]

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/pkgs/type_spec/emit_open_api.py

@@ -105,7 +105,11 @@ def _open_api_info(
     info["version"] = "1.0.0"
     info["title"] = "Uncountable API Documentation"
     info["description"] = full_description
-    info["x-logo"] = {"url": "../static/images/logo_blue.png", "altText": "Logo"}
+    info["x-logo"] = {
+        "url": "../static/images/logo_blue.png",
+        "altText": "Logo",
+        "href": "#",
+    }
     return info
 
 

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/uncountable/core/client.py

@@ -23,6 +23,7 @@ from uncountable.integration.telemetry import Logger, push_scope_optional
 from uncountable.types import download_file_t
 from uncountable.types.client_base import APIRequest, ClientMethods
 from uncountable.types.client_config import ClientConfigOptions
+from uncountable.types.client_config_t import RequestContext
 
 from .file_upload import FileUpload, FileUploader, UploadedFile
 from .types import AuthDetailsAll, AuthDetailsApiKey, AuthDetailsOAuth
@@ -65,6 +66,7 @@ class ClientConfig(ClientConfigOptions):
         None
     )
     logger: Logger | None = None
+    request_context: RequestContext | None = None
 
 
 OAUTH_REFRESH_WINDOW_SECONDS = 60 * 5

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/uncountable/core/query/column.py

@@ -8,11 +8,13 @@ from decimal import Decimal
 from enum import StrEnum
 from types import UnionType
 from typing import (
+    Never,
     Self,
     assert_never,
     overload,
 )
 
+from uncountable.core.query.types import TranslatedText
 from uncountable.types import base_t, entity_t, listing_t
 from uncountable.types.listing import ColumnIdentifier
 
@@ -84,6 +86,9 @@ class Column[
         assert self.name is not None
         return obj.__dict__[self.name]  # type: ignore[no-any-return]
 
+    def __set__(self, obj: Never, value: Never) -> None:
+        raise AttributeError("Columns are read-only")
+
     def __init__(
         self,
         *,
@@ -159,6 +164,55 @@ class TextColumn[
     # IMPROVE: Implement "Not Exists" and "Not Equals" filters (when supported in SDK)
 
 
+class TranslatedTextColumn[
+    NullableT: NullableColumn | NonNullableColumn,
+](Column[TranslatedText, NullableT]):
+    __hash__ = Column.__hash__
+
+    def __init__(
+        self,
+        identifier: listing_t.ColumnIdentifier,
+        nullable: type[NullableT],
+    ) -> None:
+        super().__init__(
+            identifier=identifier,
+            nullable=nullable,
+            value_type=TranslatedText,
+        )
+
+    def __ne__(self, other: None) -> ColumnFilter:  # type: ignore[override]
+        return ColumnFilter(
+            identifier=self.identifier,
+            filter=lambda identifier: listing_t.FilterSpecExists(column=identifier),
+        )
+
+    def __eq__(self, other: str) -> ColumnFilter:  # type: ignore[override]
+        return ColumnFilter(
+            identifier=self.identifier,
+            filter=lambda x: listing_t.FilterSpecEquals(column=x, value=other),
+        )
+
+    def contains(self, other: str) -> ColumnFilter:
+        return ColumnFilter(
+            identifier=self.identifier,
+            filter=lambda x: listing_t.FilterSpecIStrContains(column=x, value=other),
+        )
+
+    def startswith(self, other: str) -> ColumnFilter:
+        return ColumnFilter(
+            identifier=self.identifier,
+            filter=lambda x: listing_t.FilterSpecIStrStartsWith(column=x, value=other),
+        )
+
+    def includes(self, other: str | tuple[str, ...]) -> ColumnFilter:
+        return ColumnFilter(
+            identifier=self.identifier,
+            filter=lambda x: listing_t.FilterSpecInclude(column=x, value=other),
+        )
+
+    # IMPROVE: Implement "Not Exists" and "Not Equals" filters (when supported in SDK)
+
+
 class EnumColumn[
     EnumT: StrEnum,
     NullableT: NullableColumn | NonNullableColumn,
@@ -513,6 +567,19 @@ class IdColumn[
         column: TextColumn[BaseNullableT],
     ) -> TextColumn[BaseNullableT]: ...
 
+    # Translated Text
+    @overload
+    def __rshift__[BaseNullableT: NullableColumn | NonNullableColumn](
+        self: IdColumn[NullableColumn],
+        column: TranslatedTextColumn[BaseNullableT],
+    ) -> TranslatedTextColumn[NullableColumn]: ...
+
+    @overload
+    def __rshift__[BaseNullableT: NullableColumn | NonNullableColumn](
+        self: IdColumn[NonNullableColumn],
+        column: TranslatedTextColumn[BaseNullableT],
+    ) -> TranslatedTextColumn[BaseNullableT]: ...
+
     # Enum
     @overload
     def __rshift__[EnumT: StrEnum, BaseNullableT: NullableColumn | NonNullableColumn](
@@ -658,6 +725,7 @@ class IdColumn[
         self,
         column: ColumnFilter
         | TextColumn[BaseNullableT]
+        | TranslatedTextColumn[BaseNullableT]
         | EnumColumn[EnumT, BaseNullableT]
         | EnumsColumn[EnumT, BaseNullableT]
         | BooleanColumn[BaseNullableT]
@@ -673,6 +741,9 @@ class IdColumn[
         | TextColumn[BaseNullableT]
         | TextColumn[NonNullableColumn | NullableColumn]
         | TextColumn[NullableColumn]
+        | TranslatedTextColumn[BaseNullableT]
+        | TranslatedTextColumn[NonNullableColumn | NullableColumn]
+        | TranslatedTextColumn[NullableColumn]
         | EnumColumn[EnumT, BaseNullableT]
         | EnumColumn[EnumT, NonNullableColumn | NullableColumn]
         | EnumColumn[EnumT, NullableColumn]
@@ -731,6 +802,13 @@ class IdColumn[
                     if self.nullable is NonNullableColumn
                     else NullableColumn,
                 )
+            case TranslatedTextColumn():
+                return TranslatedTextColumn(
+                    identifier=transitive_identifier,
+                    nullable=column.nullable
+                    if self.nullable is NonNullableColumn
+                    else NullableColumn,
+                )
             case EnumColumn():
                 return EnumColumn(
                     identifier=transitive_identifier,
@@ -896,6 +974,19 @@ class IdsColumn[
         column: TextColumn[BaseNullableT],
     ) -> AggregatedColumn[tuple[str, ...], BaseNullableT]: ...
 
+    # Translated Text
+    @overload
+    def __rshift__[BaseNullableT: NullableColumn | NonNullableColumn](
+        self: IdsColumn[NullableColumn],
+        column: TranslatedTextColumn[BaseNullableT],
+    ) -> AggregatedColumn[tuple[TranslatedText, ...], NullableColumn]: ...
+
+    @overload
+    def __rshift__[BaseNullableT: NullableColumn | NonNullableColumn](
+        self: IdsColumn[NonNullableColumn],
+        column: TranslatedTextColumn[BaseNullableT],
+    ) -> AggregatedColumn[tuple[TranslatedText, ...], BaseNullableT]: ...
+
     # Enum
     @overload
     def __rshift__[EnumT: StrEnum, BaseNullableT: NullableColumn | NonNullableColumn](
@@ -1030,6 +1121,7 @@ class IdsColumn[
     ](
         self,
         column: TextColumn[BaseNullableT]
+        | TranslatedTextColumn[BaseNullableT]
         | EnumColumn[EnumT, BaseNullableT]
         | BooleanColumn[BaseNullableT]
         | DatetimeColumn[BaseNullableT]
@@ -1043,6 +1135,12 @@ class IdsColumn[
         AggregatedColumn[tuple[str, ...], BaseNullableT]
         | AggregatedColumn[tuple[str, ...], NonNullableColumn | NullableColumn]
         | AggregatedColumn[tuple[str, ...], NullableColumn]
+        | AggregatedColumn[tuple[TranslatedText, ...], BaseNullableT]
+        | AggregatedColumn[
+            tuple[TranslatedText, ...],
+            NonNullableColumn | NullableColumn,
+        ]
+        | AggregatedColumn[tuple[TranslatedText, ...], NullableColumn]
         | AggregatedColumn[tuple[str | None, ...], BaseNullableT]
         | AggregatedColumn[
             tuple[str | None, ...],
@@ -1090,6 +1188,14 @@ class IdsColumn[
                     else NullableColumn,
                     tuple_value_type=tuple[str, ...],
                 )
+            case TranslatedTextColumn():
+                return AggregatedColumn(
+                    identifier=transitive_aggregate_identifier,
+                    nullable=column.nullable
+                    if self.nullable is NonNullableColumn
+                    else NullableColumn,
+                    tuple_value_type=tuple[TranslatedText, ...],
+                )
             case EnumColumn():
                 return AggregatedColumn(
                     identifier=transitive_aggregate_identifier,

uncountablepythonsdk-0.0.158/uncountable/core/query/types.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+
+# This file contains types exclusively used to parse column values.
+# Column types must be more permissive than generated SDK types to allow for disparity between the installed client and the platform.
+# Eg. types containing an Enum must be typed as EnumType | str to handle future expansion of the Enum by the platform.
+
+
+@dataclass(kw_only=True, frozen=True)
+class TranslatedText:
+    value: str
+    display_value: str
+    inferred_locale: str

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/uncountable/integration/construct_client.py

@@ -4,6 +4,7 @@ from uncountable.core.types import AuthDetailsAll, AuthDetailsOAuth
 from uncountable.integration.secret_retrieval.retrieve_secret import retrieve_secret
 from uncountable.integration.telemetry import JobLogger
 from uncountable.types import auth_retrieval_t
+from uncountable.types.client_config_t import RequestContext
 from uncountable.types.job_definition_t import (
     ProfileMetadata,
 )
@@ -30,23 +31,34 @@ def _construct_auth_details(profile_meta: ProfileMetadata) -> AuthDetailsAll:
 
 
 def _construct_client_config(
-    *, profile_meta: ProfileMetadata, job_logger: JobLogger
+    *,
+    profile_meta: ProfileMetadata,
+    job_logger: JobLogger,
+    request_context: RequestContext | None = None,
 ) -> ClientConfig:
     if profile_meta.client_options is None:
-        return ClientConfig(logger=job_logger)
+        return ClientConfig(logger=job_logger, request_context=request_context)
     return ClientConfig(
         allow_insecure_tls=profile_meta.client_options.allow_insecure_tls,
         extra_headers=profile_meta.client_options.extra_headers,
         logger=job_logger,
+        request_context=request_context,
     )
 
 
 def construct_uncountable_client(
-    profile_meta: ProfileMetadata, logger: JobLogger
+    profile_meta: ProfileMetadata,
+    logger: JobLogger,
+    *,
+    request_context: RequestContext | None = None,
 ) -> Client:
     return Client(
         base_url=profile_meta.base_url,
         auth_details=_construct_auth_details(profile_meta),
-        config=_construct_client_config(profile_meta=profile_meta, job_logger=logger),
+        config=_construct_client_config(
+            profile_meta=profile_meta,
+            job_logger=logger,
+            request_context=request_context,
+        ),
         app_base_url=profile_meta.app_base_url,
     )

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/uncountable/integration/queue_runner/command_server/command_client.py

@@ -41,8 +41,7 @@ def command_server_connection(
 ) -> Generator[CommandServerStub, None, None]:
     try:
         with grpc.insecure_channel(f"{host}:{port}") as channel:
-            stub = CommandServerStub(channel)
-            yield stub
+            yield CommandServerStub(channel)
     except grpc._channel._InactiveRpcError as e:
         raise CommandServerTimeout() from e
 

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/uncountable/types/client_config.py

@@ -4,5 +4,7 @@
 # DO NOT MODIFY -- This file is generated by type_spec
 # Kept only for SDK backwards compatibility
 from .client_config_t import ClientConfigOptions as ClientConfigOptions
+from .client_config_t import SdkLocale as SdkLocale
+from .client_config_t import RequestContext as RequestContext
 from .client_config_t import RequestOptions as RequestOptions
 # DO NOT MODIFY -- This file is generated by type_spec

{uncountablepythonsdk-0.0.157 → uncountablepythonsdk-0.0.158}/uncountable/types/client_config_t.py

@@ -6,13 +6,16 @@ from __future__ import annotations
 import typing  # noqa: F401
 import datetime  # noqa: F401
 from decimal import Decimal  # noqa: F401
+from enum import StrEnum
 import dataclasses
 from pkgs.serialization import serial_class
 from . import base_t
 
 __all__: list[str] = [
     "ClientConfigOptions",
+    "RequestContext",
     "RequestOptions",
+    "SdkLocale",
 ]
 
 
@@ -26,6 +29,39 @@ class ClientConfigOptions:
     extra_headers: dict[str, str] | None = None
 
 
+# DO NOT MODIFY -- This file is generated by type_spec
+class SdkLocale(StrEnum):
+    EN_US = "en-US"
+    DE_DE = "de-DE"
+    JA_JP = "ja-JP"
+    ES_ES = "es-ES"
+    ES_MX = "es-MX"
+    PT_BR = "pt-BR"
+    FR_FR = "fr-FR"
+    KO_KO = "ko-KR"
+    TH_TH = "th-TH"
+    ZH_CN = "zh-CN"
+    IT_IT = "it-IT"
+    AR_SA = "ar-SA"
+    TR_TR = "tr-TR"
+    PL_PL = "pl-PL"
+    RU_RU = "ru-RU"
+    ID_ID = "id-ID"
+    NO_NO = "no-NO"
+    MR_MR = "mr-MR"
+    ZH_TW = "zh-TW"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    named_type_path="sdk.client_config.RequestContext",
+)
+@dataclasses.dataclass(slots=base_t.ENABLE_SLOTS, kw_only=True)  # type: ignore[literal-required]
+class RequestContext:
+    user_timezone: str | None = None
+    user_locale: SdkLocale | None = None
+
+
 # DO NOT MODIFY -- This file is generated by type_spec
 @serial_class(
     named_type_path="sdk.client_config.RequestOptions",