UncountablePythonSDK 0.0.156__tar.gz → 0.0.158__tar.gz

{uncountablepythonsdk-0.0.156 → 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.156 → 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.156 → uncountablepythonsdk-0.0.158}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.156
+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.156 → uncountablepythonsdk-0.0.158}/UncountablePythonSDK.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.156
+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.156 → uncountablepythonsdk-0.0.158}/UncountablePythonSDK.egg-info/SOURCES.txt

@@ -122,6 +122,11 @@ uncountable/core/client.py
 uncountable/core/environment.py
 uncountable/core/file_upload.py
 uncountable/core/types.py
+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.156 → 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.156 → 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.156 → 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.156 → 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.158/uncountable/core/query/builder.py

@@ -0,0 +1,200 @@
+from __future__ import annotations
+
+import json
+import time
+from copy import copy
+from dataclasses import make_dataclass
+from decimal import Decimal
+from typing import Self
+
+from pkgs.argument_parser import CachedParser
+from pkgs.serialization.serial_class import serial_class
+from uncountable.core.client import Client
+from uncountable.core.query.column import (
+    Column,
+    ColumnFilter,
+    EnumColumn,
+    NullableColumn,
+    PrimaryKeyColumn,
+    get_column_base,
+)
+from uncountable.core.query.row import QueryRow
+from uncountable.types import (
+    async_jobs_t,
+    base_t,
+    entity_t,
+    identifier_t,
+    listing_t,
+)
+from uncountable.types.api.entity import list_entities as list_entities_t
+from uncountable.types.api.files.download_file import FileDownloadQueryEntityField
+
+_ASYNC_EXPORT_TIMEOUT_SECONDS = 60 * 10
+_ASYNC_EXPORT_POLL_INTERVAL_SECONDS = 1
+
+
+class _AsyncExportJob(QueryRow):
+    id = PrimaryKeyColumn(base_type=entity_t.EntityType.ASYNC_JOB)
+    status = EnumColumn(
+        identifier=listing_t.ColumnIdentifierEntityRefName(
+            entity_type=entity_t.EntityType.ASYNC_JOB, ref_name="core_async_job_status"
+        ),
+        nullable=NullableColumn,
+        enum_type=async_jobs_t.AsyncJobStatus,
+    )
+
+
+class QueryBuilder[QueryRowT: QueryRow]:
+    """
+    Used in conjunction with the QueryRow and Column classes to fetch structured data from the Uncountable API.
+
+    Create a QueryBuilder instance from a subclass of QueryRow. Use this to apply filters and fetch structured data.
+
+    WARNING: This class is in beta and subject to breaking changes. Always check the SDK changelog for breaking changes before updating your SDK version.
+    """
+
+    def __init__(self, client: Client, model: type[QueryRowT]):
+        self._filters: tuple[listing_t.FilterSpec, ...] = ()
+        self._model: type[QueryRowT] = model
+        self._client = client
+        if base_type := model._validate_column_base_types():
+            self._base_type = base_type
+        else:
+            raise ValueError(
+                f"Failed to resolve base type of model {model.__name__}. Ensure at least one column property is defined"
+            )
+
+        column_definitions: dict[str, Column] = {
+            key: value
+            for cls in reversed(self._model.__mro__)
+            for key, value in cls.__dict__.items()
+            if isinstance(value, Column)
+        }
+        self._column_identifiers: tuple[listing_t.ColumnIdentifier, ...] = tuple(
+            column.identifier for column in column_definitions.values()
+        )
+        self._property_names: tuple[str, ...] = tuple(column_definitions.keys())
+        self._parser: CachedParser = CachedParser(
+            serial_class(unconverted_keys={*self._property_names})(
+                make_dataclass(
+                    cls_name=self._model.__name__,
+                    fields=[
+                        (name, value._parse_type)
+                        for name, value in column_definitions.items()
+                    ],
+                )
+            )
+        )
+
+    def filter(self, *filters: ColumnFilter) -> Self:
+        for filter in filters:
+            if get_column_base(filter.identifier) != self._base_type:
+                raise ValueError(
+                    "Filter column base type does not match query base type"
+                )
+        branch = copy(self)
+        branch._filters = (
+            *self._filters,
+            *(filter.filter(filter.identifier) for filter in filters),
+        )
+        return branch
+
+    def _fetch(self, limit: int = 100, offset: int = 0) -> list[QueryRowT]:
+        rows = self._client.fetch_listing(
+            entity_type=self._base_type,
+            columns=list(self._column_identifiers),
+            filters=listing_t.FilterNodeColumnAnd(filters=tuple(self._filters)),
+            limit=limit,
+            offset=offset,
+        ).results
+
+        return [self._parse_row(row.column_values) for row in rows]
+
+    def _hook_after_parse_row(self, row: QueryRowT) -> None:
+        pass
+
+    def _parse_row(self, row: list[base_t.JsonValue]) -> QueryRowT:
+        parsed = self._parser.parse_api({
+            key: value for key, value in zip(self._property_names, row, strict=True)
+        })
+        parsed_model = self._model()
+        for key, value in parsed.__dict__.items():
+            parsed_model.__dict__[key] = value
+        self._hook_after_parse_row(parsed_model)
+        return parsed_model
+
+    def one(self) -> QueryRowT:
+        results = self._fetch()
+        if len(results) != 1:
+            raise ValueError(f"Expected one result, received {len(results)}")
+        return results[0]
+
+    def one_or_none(self) -> QueryRowT | None:
+        results = self._fetch()
+        if len(results) > 1:
+            raise ValueError(f"Expected one result, received {len(results)}")
+        if len(results) == 0:
+            return None
+        return results[0]
+
+    def first(self) -> QueryRowT | None:
+        results = self._fetch(limit=1)
+        return None if len(results) == 0 else results[0]
+
+    def all(self) -> list[QueryRowT]:
+        results = self._fetch()
+        if len(results) < 100:
+            return results
+        return self._await_async_export()
+
+    def _await_async_export(self) -> list[QueryRowT]:
+        async_job_entity = self._client.export_listing(
+            entity_type=self._base_type,
+            columns=list(self._column_identifiers),
+            filters=listing_t.FilterNodeColumnAnd(filters=tuple(self._filters)),
+        ).entity
+        if async_job_entity is None:
+            raise ValueError("Listing export failed to create async job")
+
+        status_query = QueryBuilder(client=self._client, model=_AsyncExportJob)
+
+        start_time = time.time()
+        while time.time() - start_time < _ASYNC_EXPORT_TIMEOUT_SECONDS:
+            match (
+                status_query
+                .filter(_AsyncExportJob.id == async_job_entity.id)
+                .one()
+                .status
+            ):
+                case async_jobs_t.AsyncJobStatus.COMPLETED:
+                    export_file = self._client.download_files(
+                        file_query=FileDownloadQueryEntityField(
+                            entity=entity_t.EntityIdentifier(
+                                identifier_key=identifier_t.IdentifierKeyId(
+                                    id=async_job_entity.id
+                                ),
+                                type=entity_t.EntityType.ASYNC_JOB,
+                            ),
+                            field_key=identifier_t.IdentifierKeyRefName(
+                                ref_name="unc_async_listing_export_file"
+                            ),
+                        )
+                    )[0].data.read()
+
+                    return [
+                        self._parse_row(row.column_values)
+                        for row in CachedParser(list_entities_t.Data)
+                        .parse_api(
+                            json.loads(
+                                export_file,
+                                parse_float=Decimal,
+                            )
+                        )
+                        .results
+                    ]
+                case async_jobs_t.AsyncJobStatus.ERROR:
+                    raise ValueError("Listing export failed")
+            time.sleep(_ASYNC_EXPORT_POLL_INTERVAL_SECONDS)
+        raise TimeoutError(
+            f"Async listing export timed out after {_ASYNC_EXPORT_TIMEOUT_SECONDS} seconds"
+        )