UncountablePythonSDK 0.0.29__py3-none-any.whl → 0.0.31__py3-none-any.whl

uncountable/core/client.py

@@ -1,10 +1,11 @@
 import base64
-from datetime import datetime, timedelta
 import json
 import typing
 from dataclasses import dataclass
+from datetime import datetime, timedelta
 from enum import StrEnum
 from urllib.parse import urljoin
+from uuid import uuid4
 
 import requests
 from requests.exceptions import JSONDecodeError
@@ -18,6 +19,7 @@ from .file_upload import FileUpload, FileUploader, UploadedFile
 from .types import AuthDetailsAll, AuthDetailsApiKey, AuthDetailsOAuth
 
 DT = typing.TypeVar("DT")
+UNC_REQUEST_ID_HEADER = "X-UNC-REQUEST-ID"
 
 
 class EndpointMethod(StrEnum):
@@ -30,19 +32,17 @@ class HTTPRequestBase:
     method: EndpointMethod
     url: str
     headers: dict[str, str]
-    body: typing.Optional[typing.Union[str, dict[str, str]]] = None
-    query_params: typing.Optional[dict[str, str]] = None
 
 
 @dataclass(kw_only=True)
 class HTTPGetRequest(HTTPRequestBase):
-    method: typing.Literal[EndpointMethod.GET]
+    method = EndpointMethod.GET
     query_params: dict[str, str]
 
 
 @dataclass(kw_only=True)
 class HTTPPostRequest(HTTPRequestBase):
-    method: typing.Literal[EndpointMethod.POST]
+    method = EndpointMethod.POST
     body: typing.Union[str, dict[str, str]]
 
 
@@ -101,13 +101,15 @@ class APIResponseError(BaseException):
 
 class SDKError(BaseException):
     message: str
+    request_id: str
 
-    def __init__(self, message: str) -> None:
+    def __init__(self, message: str, *, request_id: str) -> None:
         super().__init__(message)
         self.message = message
+        self.request_id = request_id
 
     def __str__(self) -> str:
-        return f"internal SDK error, please contact Uncountable support: {self.message}"
+        return f"internal SDK error (request id {self.request_id}), please contact Uncountable support: {self.message}"
 
 
 @dataclass(kw_only=True)
@@ -147,7 +149,9 @@ class Client(ClientMethods):
         self._file_uploader = FileUploader(self._base_url, self._auth_details)
         self._cfg = config or ClientConfig()
 
-    def _get_response_json(self, response: requests.Response) -> dict[str, JsonValue]:
+    def _get_response_json(
+        self, response: requests.Response, request_id: str
+    ) -> dict[str, JsonValue]:
         if response.status_code < 200 or response.status_code > 299:
             extra_details: dict[str, JsonValue] | None = None
             try:
@@ -160,12 +164,15 @@ class Client(ClientMethods):
                 status_code=response.status_code, extra_details=extra_details
             )
         try:
-            return response.json()
-        except JSONDecodeError:
-            raise SDKError("unable to process response")
+            return typing.cast(dict[str, JsonValue], response.json())
+        except JSONDecodeError as e:
+            raise SDKError("unable to process response", request_id=request_id) from e
 
     def do_request(self, *, api_request: APIRequest, return_type: type[DT]) -> DT:
-        http_request = self._build_http_request(api_request=api_request)
+        request_id = str(uuid4())
+        http_request = self._build_http_request(
+            api_request=api_request, request_id=request_id
+        )
         match http_request:
             case HTTPGetRequest():
                 response = requests.get(
@@ -179,18 +186,17 @@ class Client(ClientMethods):
                     http_request.url,
                     headers=http_request.headers,
                     data=http_request.body,
-                    params=http_request.query_params,
                     verify=not self._cfg.allow_insecure_tls,
                 )
             case _:
                 typing.assert_never(http_request)
-        response_data = self._get_response_json(response)
+        response_data = self._get_response_json(response, request_id=request_id)
         cached_parser = self._get_cached_parser(return_type)
         try:
             data = response_data["data"]
             return cached_parser.parse_api(data)
         except (ValueError, JSONDecodeError, KeyError) as e:
-            raise SDKError("unable to process response") from e
+            raise SDKError("unable to process response", request_id=request_id) from e
 
     def _get_cached_parser(self, data_type: type[DT]) -> CachedParser[DT]:
         if data_type not in self._parser_map:
@@ -213,8 +219,9 @@ class Client(ClientMethods):
                     "scope": oauth_details.scope,
                     "grant_type": "client_credentials",
                 },
+                verify=not self._cfg.allow_insecure_tls,
             )
-            data = self._get_response_json(response)
+            data = self._get_response_json(response, request_id=str(uuid4()))
             token_data = oauth_bearer_token_data_parser.parse_storage(data)
             self._oauth_bearer_token_cache = OAuthBearerTokenCache(
                 token=token_data.access_token,
@@ -235,8 +242,11 @@ class Client(ClientMethods):
                 return {"Authorization": f"Bearer {token}"}
         typing.assert_never(self._auth_details)
 
-    def _build_http_request(self, *, api_request: APIRequest) -> HTTPRequest:
+    def _build_http_request(
+        self, *, api_request: APIRequest, request_id: str
+    ) -> HTTPRequest:
         headers = self._build_auth_headers()
+        headers[UNC_REQUEST_ID_HEADER] = request_id
         method = api_request.method.lower()
         data = {"data": json.dumps(serialize_for_api(api_request.args))}
         match method:

uncountable/core/file_upload.py

@@ -4,7 +4,7 @@ from dataclasses import dataclass
 from enum import StrEnum
 from io import BytesIO
 from pathlib import Path
-from typing import Generator, Self
+from typing import Generator, Literal, Self
 
 import aiohttp
 import aiotus
@@ -23,7 +23,7 @@ class MediaFileUpload:
     """Upload file from a path on disk"""
 
     path: str
-    type: FileUploadType.MEDIA_FILE_UPLOAD = FileUploadType.MEDIA_FILE_UPLOAD
+    type: Literal[FileUploadType.MEDIA_FILE_UPLOAD] = FileUploadType.MEDIA_FILE_UPLOAD
 
 
 FileUpload = MediaFileUpload
@@ -90,9 +90,7 @@ class FileUploader:
                     name=file_bytes.name, file_id=int(location.path.split("/")[-1])
                 )
 
-    def upload_files(
-        self: Self, *, file_uploads: list[FileUpload]
-    ) -> list[UploadedFile]:
+    def upload_files(self: Self, *, file_uploads: list[FileUpload]) -> list[UploadedFile]:
         return [
             asyncio.run(self._upload_file(file_upload)) for file_upload in file_uploads
         ]

uncountable/core/types.py

@@ -13,5 +13,5 @@ class AuthDetailsOAuth:
     scope: str = "unc.rnd"
 
 
-AuthDetails = AuthDetailsApiKey # Legacy Mapping
+AuthDetails = AuthDetailsApiKey  # Legacy Mapping
 AuthDetailsAll = AuthDetailsApiKey | AuthDetailsOAuth

uncountable/integration/construct_client.py

@@ -1,7 +1,7 @@
 import os
 from typing import assert_never
 
-from uncountable.core.client import AuthDetailsApiKey, Client
+from uncountable.core import AuthDetailsApiKey, Client
 from uncountable.integration.types import (
     AuthRetrievalEnv,
     ProfileMetadata,

uncountable/integration/cron.py

@@ -23,6 +23,8 @@ def cron_job_executor(**kwargs: dict) -> None:
         client=construct_uncountable_client(profile_meta=args_passed.profile_metadata),
     )
 
-    job = resolve_script_executor(args_passed.definition.executor, args_passed.profile_metadata)
+    job = resolve_script_executor(
+        args_passed.definition.executor, args_passed.profile_metadata
+    )
 
-    job.run(args)
+    job.run(args=args)

uncountable/integration/db/connect.py

@@ -1,8 +1,8 @@
 import os
+
 from sqlalchemy import create_engine
 from sqlalchemy.engine.base import Engine
 
 
 def create_db_engine() -> Engine:
     return create_engine(os.environ["UNC_SQLITE_URI"])
-

uncountable/integration/entrypoint.py

@@ -1,11 +1,10 @@
 import os
 from importlib import resources
 
-from uncountable.integration.server import IntegrationServer
-from uncountable.integration.types import ProfileDefinition
 from pkgs.argument_parser import CachedParser
 from uncountable.integration.db.connect import create_db_engine
-
+from uncountable.integration.server import IntegrationServer
+from uncountable.integration.types import ProfileDefinition
 
 profile_parser = CachedParser(ProfileDefinition)
 
@@ -19,8 +18,8 @@ def main() -> None:
             for entry in resources.files(profiles_module).iterdir()
             if entry.is_dir()
         ]
-        for profile in profiles:
-            profile_name = profile.name
+        for profile_file in profiles:
+            profile_name = profile_file.name
             try:
                 profile = profile_parser.parse_yaml_resource(
                     package=".".join([profiles_module, profile_name]),

uncountable/integration/executors/script_executor.py

@@ -1,15 +1,21 @@
-
-import os
 import importlib
 import inspect
+import os
+
 from uncountable.integration.job import Job
 from uncountable.integration.types import JobExecutorScript, ProfileMetadata
 
 
-def resolve_script_executor(executor: JobExecutorScript, profile_metadata: ProfileMetadata) -> type[Job]:
-    job_module_path = ".".join([os.environ["UNC_PROFILES_MODULE"], profile_metadata.name, executor.import_path])
+def resolve_script_executor(
+    executor: JobExecutorScript, profile_metadata: ProfileMetadata
+) -> Job:
+    job_module_path = ".".join([
+        os.environ["UNC_PROFILES_MODULE"],
+        profile_metadata.name,
+        executor.import_path,
+    ])
     job_module = importlib.import_module(job_module_path)
-    found_jobs: list[type[Job]] = []
+    found_jobs: list[Job] = []
     for _, job_class in inspect.getmembers(job_module, inspect.isclass):
         if getattr(job_class, "_unc_job_registered", False):
             found_jobs.append(job_class())

uncountable/integration/job.py

@@ -1,9 +1,9 @@
+from abc import ABC, abstractmethod
 from dataclasses import dataclass
+
 from uncountable.core.client import Client
 from uncountable.integration.types import JobDefinition
 
-from abc import ABC, abstractmethod
-
 
 @dataclass
 class JobArgumentsBase:
@@ -29,17 +29,14 @@ class Job(ABC):
     _unc_job_registered: bool = False
 
     @abstractmethod
-    def run(self, args: JobArguments) -> JobResult:
-        ...
+    def run(self, args: JobArguments) -> JobResult: ...
 
 
 class CronJob(Job):
-
     @abstractmethod
-    def run(self, args: CronJobArguments) -> JobResult:
-        ...
+    def run(self, args: CronJobArguments) -> JobResult: ...
 
 
-def register_job(cls: Job):
+def register_job(cls: Job) -> Job:
     cls._unc_job_registered = True
     return cls

uncountable/integration/server.py

@@ -1,15 +1,16 @@
 import signal
-from types import TracebackType
 from dataclasses import asdict
+from types import TracebackType
 from typing import Optional, assert_never
+
+from apscheduler.executors.pool import ThreadPoolExecutor
+from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
 from apscheduler.schedulers.background import BackgroundScheduler
 from apscheduler.schedulers.base import BaseScheduler
-from apscheduler.jobstores.sqlalchemy import SQLAlchemyJobStore
-from apscheduler.executors.pool import ThreadPoolExecutor
-from uncountable.integration.cron import CronJobArgs, cron_job_executor
 from apscheduler.triggers.cron import CronTrigger
 from sqlalchemy.engine.base import Engine
 
+from uncountable.integration.cron import CronJobArgs, cron_job_executor
 from uncountable.integration.types import (
     AuthRetrieval,
     CronJobDefinition,
@@ -17,7 +18,6 @@ from uncountable.integration.types import (
     ProfileMetadata,
 )
 
-
 _MAX_APSCHEDULER_CONCURRENT_JOBS = 1
 
 

uncountable/types/__init__.py

@@ -3,6 +3,7 @@
 # ruff: noqa: E402
 # fmt: off
 # isort: skip_file
+from .api.recipes import add_recipe_to_project as add_recipe_to_project_t
 from .api.recipes import archive_recipes as archive_recipes_t
 from .api.recipes import associate_recipe_as_input as associate_recipe_as_input_t
 from .api.recipes import associate_recipe_as_lot as associate_recipe_as_lot_t
@@ -61,6 +62,8 @@ from . import recipe_metadata as recipe_metadata_t
 from . import recipe_output_metadata as recipe_output_metadata_t
 from . import recipe_tags as recipe_tags_t
 from . import recipe_workflow_steps as recipe_workflow_steps_t
+from . import recipes as recipes_t
+from .api.recipes import remove_recipe_from_project as remove_recipe_from_project_t
 from .api.entity import resolve_entity_ids as resolve_entity_ids_t
 from .api.outputs import resolve_output_conditions as resolve_output_conditions_t
 from . import response as response_t
@@ -69,6 +72,7 @@ from .api.permissions import set_core_permissions as set_core_permissions_t
 from .api.inputs import set_input_attribute_values as set_input_attribute_values_t
 from .api.inputs import set_input_category as set_input_category_t
 from .api.inputs import set_input_subcategories as set_input_subcategories_t
+from .api.inputs import set_intermediate_type as set_intermediate_type_t
 from .api.recipes import set_recipe_inputs as set_recipe_inputs_t
 from .api.recipes import set_recipe_metadata as set_recipe_metadata_t
 from .api.recipes import set_recipe_outputs as set_recipe_outputs_t
@@ -85,6 +89,7 @@ from . import workflows as workflows_t
 
 
 __all__: list[str] = [
+    "add_recipe_to_project_t",
     "archive_recipes_t",
     "associate_recipe_as_input_t",
     "associate_recipe_as_lot_t",
@@ -143,6 +148,8 @@ __all__: list[str] = [
     "recipe_output_metadata_t",
     "recipe_tags_t",
     "recipe_workflow_steps_t",
+    "recipes_t",
+    "remove_recipe_from_project_t",
     "resolve_entity_ids_t",
     "resolve_output_conditions_t",
     "response_t",
@@ -151,6 +158,7 @@ __all__: list[str] = [
     "set_input_attribute_values_t",
     "set_input_category_t",
     "set_input_subcategories_t",
+    "set_intermediate_type_t",
     "set_recipe_inputs_t",
     "set_recipe_metadata_t",
     "set_recipe_outputs_t",

uncountable/types/api/entity/list_entities.py

@@ -8,6 +8,7 @@ import typing  # noqa: F401
 import datetime  # noqa: F401
 from decimal import Decimal  # noqa: F401
 from dataclasses import dataclass
+from pkgs.serialization import serial_class
 from pkgs.serialization import OpaqueKey
 from ... import base as base_t
 from ... import entity as entity_t
@@ -26,6 +27,9 @@ ENDPOINT_PATH = "api/external/entity/external_list_entities"
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    unconverted_values={"attributes"},
+)
 @dataclass(kw_only=True)
 class Arguments:
     entity_type: entity_t.EntityType
@@ -36,6 +40,9 @@ class Arguments:
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    unconverted_values={"column_values"},
+)
 @dataclass(kw_only=True)
 class EntityResult:
     entity: entity_t.Entity

uncountable/types/api/inputs/set_intermediate_type.py

@@ -0,0 +1,43 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from pkgs.strenum_compat import StrEnum
+from dataclasses import dataclass
+from ... import identifier as identifier_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+    "IntermediateType",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/inputs/set_intermediate_type"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class IntermediateType(StrEnum):
+    FINAL_PRODUCT = "final_product"
+    COMPOUND_AS_INTERMEDIATE = "compound_as_intermediate"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    input_key: identifier_t.IdentifierKey
+    intermediate_type: IntermediateType
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data:
+    pass
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/add_recipe_to_project.py

@@ -0,0 +1,35 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from dataclasses import dataclass
+from ... import identifier as identifier_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/recipes/add_recipe_to_project"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    recipe_key: identifier_t.IdentifierKey
+    project_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data:
+    pass
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/associate_recipe_as_input.py

@@ -27,6 +27,7 @@ ENDPOINT_PATH = "api/external/recipes/associate_recipe_as_input"
 class Arguments:
     recipe_key: identifier_t.IdentifierKey
     input_key: typing.Optional[identifier_t.IdentifierKey] = None
+    show_in_listings: typing.Optional[bool] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/edit_recipe_inputs.py

@@ -15,6 +15,7 @@ from ... import recipe_inputs as recipe_inputs_t
 from ... import recipe_workflow_steps as recipe_workflow_steps_t
 
 __all__: list[str] = [
+    "AnnotationEdit",
     "Arguments",
     "Data",
     "ENDPOINT_METHOD",
@@ -25,6 +26,7 @@ __all__: list[str] = [
     "RecipeInputEditClearInputs",
     "RecipeInputEditInputBase",
     "RecipeInputEditType",
+    "RecipeInputEditUpdateAnnotations",
     "RecipeInputEditUpsertInput",
 ]
 
@@ -37,6 +39,7 @@ class RecipeInputEditType(StrEnum):
     CLEAR_INPUTS = "clear_inputs"
     UPSERT_INPUT = "upsert_input"
     ADD_INPUT = "add_input"
+    UPDATE_ANNOTATIONS = "update_annotations"
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
@@ -88,7 +91,30 @@ class RecipeInputEditAddInput(RecipeInputEditInputBase):
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
-RecipeInputEdit = typing.Union[RecipeInputEditClearInputs, RecipeInputEditUpsertInput, RecipeInputEditAddInput]
+@serial_class(
+    to_string_values={"lower_value", "upper_value"},
+)
+@dataclass(kw_only=True)
+class AnnotationEdit:
+    annotation_type_key: identifier_t.IdentifierKey
+    lower_value: typing.Optional[Decimal] = None
+    upper_value: typing.Optional[Decimal] = None
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class RecipeInputEditUpdateAnnotations(RecipeInputEditInputBase):
+    type: typing.Literal[RecipeInputEditType.UPDATE_ANNOTATIONS] = RecipeInputEditType.UPDATE_ANNOTATIONS
+    ingredient_key: identifier_t.IdentifierKey
+    clear_first: bool
+    annotations: list[AnnotationEdit]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+RecipeInputEdit = typing.Union[RecipeInputEditClearInputs, RecipeInputEditUpsertInput, RecipeInputEditAddInput, RecipeInputEditUpdateAnnotations]
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/remove_recipe_from_project.py

@@ -0,0 +1,35 @@
+# DO NOT MODIFY -- This file is generated by type_spec
+# flake8: noqa: F821
+# ruff: noqa: E402
+# fmt: off
+# isort: skip_file
+from __future__ import annotations
+import typing  # noqa: F401
+import datetime  # noqa: F401
+from decimal import Decimal  # noqa: F401
+from dataclasses import dataclass
+from ... import identifier as identifier_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/recipes/remove_recipe_from_project"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    recipe_key: identifier_t.IdentifierKey
+    project_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data:
+    pass
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/set_recipe_outputs.py

@@ -10,6 +10,7 @@ from decimal import Decimal  # noqa: F401
 from dataclasses import dataclass
 from pkgs.serialization import serial_class
 from ... import base as base_t
+from ... import recipes as recipes_t
 from ... import response as response_t
 
 __all__: list[str] = [
@@ -45,6 +46,7 @@ class RecipeOutputValue:
     value_numeric: typing.Optional[Decimal] = None
     value_str: typing.Optional[str] = None
     value_curve: typing.Optional[CurveValues] = None
+    formatting: typing.Optional[recipes_t.RecipeAttributeFormatting] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/async_batch_processor.py

@@ -19,7 +19,6 @@ from uncountable.types import recipe_workflow_steps as recipe_workflow_steps_t
 import uncountable.types.api.recipes.set_recipe_metadata as set_recipe_metadata_t
 import uuid
 from abc import ABC, abstractmethod
-from dataclasses import dataclass
 from pkgs.serialization_util.serialization_helpers import serialize_for_api