UncountablePythonSDK 0.0.20__py3-none-any.whl → 0.0.22__py3-none-any.whl

uncountable/core/client.py

@@ -6,11 +6,16 @@ from enum import StrEnum
 from urllib.parse import urljoin
 
 import requests
+from requests.exceptions import JSONDecodeError
 
 from pkgs.argument_parser import CachedParser
 from pkgs.serialization_util import serialize_for_api
+from pkgs.serialization_util.serialization_helpers import JsonValue
 from uncountable.types.client_base import APIRequest, ClientMethods
 
+from .file_upload import FileUpload, FileUploader, UploadedFile
+from .types import AuthDetails, AuthDetailsApiKey
+
 DT = typing.TypeVar("DT")
 
 
@@ -43,23 +48,77 @@ class HTTPPostRequest(HTTPRequestBase):
 HTTPRequest = HTTPPostRequest | HTTPGetRequest
 
 
+
 @dataclass(kw_only=True)
-class AuthDetailsApiKey:
-    api_id: str
-    api_secret_key: str
+class ClientConfig():
+    allow_insecure_tls: bool = False
+      
+
+class APIResponseError(BaseException):
+    status_code: int
+    message: str
+    extra_details: dict[str, JsonValue] | None
+
+    def __init__(
+        self, status_code: int, message: str, extra_details: dict[str, JsonValue] | None
+    ) -> None:
+        super().__init__(status_code, message, extra_details)
+        self.status_code = status_code
+        self.message = message
+        self.extra_details = extra_details
+
+    @classmethod
+    def construct_error(
+        cls, status_code: int, extra_details: dict[str, JsonValue] | None
+    ) -> "APIResponseError":
+        message: str
+        match status_code:
+            case 403:
+                message = "unexpected: unauthorized"
+            case 410:
+                message = "unexpected: not found"
+            case 400:
+                message = "unexpected: bad arguments"
+            case 501:
+                message = "unexpected: unimplemented"
+            case 504:
+                message = "unexpected: timeout"
+            case 404:
+                message = "not found"
+            case 409:
+                message = "bad arguments"
+            case 422:
+                message = "unprocessable"
+            case _:
+                message = "unknown error"
+        return APIResponseError(
+            status_code=status_code, message=message, extra_details=extra_details
+        )
 
 
-AuthDetails = AuthDetailsApiKey
+class SDKError(BaseException):
+    message: str
+
+    def __init__(self, message: str) -> None:
+        super().__init__(message)
+        self.message = message
+
+    def __str__(self) -> str:
+        return f"internal SDK error, please contact Uncountable support: {self.message}"
 
 
 class Client(ClientMethods):
     _parser_map: dict[type, CachedParser] = {}
     _auth_details: AuthDetails
     _base_url: str
+    _file_uploader: FileUploader
+    _cfg: ClientConfig
 
-    def __init__(self, *, base_url: str, auth_details: AuthDetails):
+    def __init__(self, *, base_url: str, auth_details: AuthDetails, config: ClientConfig | None = None):
         self._auth_details = auth_details
         self._base_url = base_url
+        self._file_uploader = FileUploader(self._base_url, self._auth_details)
+        self._cfg = config or ClientConfig()
 
     def do_request(self, *, api_request: APIRequest, return_type: type[DT]) -> DT:
         http_request = self._build_http_request(api_request=api_request)
@@ -69,6 +128,7 @@ class Client(ClientMethods):
                     http_request.url,
                     headers=http_request.headers,
                     params=http_request.query_params,
+                    verify=not self._cfg.allow_insecure_tls
                 )
             case HTTPPostRequest():
                 response = requests.post(
@@ -76,19 +136,27 @@ class Client(ClientMethods):
                     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)
         if response.status_code < 200 or response.status_code > 299:
-            # TODO: handle_error
-            pass
+            extra_details: dict[str, JsonValue] | None = None
+            try:
+                data = response.json()
+                if "error" in data:
+                    extra_details = data["error"]
+            except JSONDecodeError:
+                pass
+            raise APIResponseError.construct_error(
+                status_code=response.status_code, extra_details=extra_details
+            )
         cached_parser = self._get_cached_parser(return_type)
         try:
             data = response.json()["data"]
             return cached_parser.parse_api(data)
-        except ValueError as err:
-            # TODO: handle parse error
-            raise err
+        except ValueError | JSONDecodeError:
+            raise SDKError("unable to process response")
 
     def _get_cached_parser(self, data_type: type[DT]) -> CachedParser[DT]:
         if data_type not in self._parser_map:
@@ -125,3 +193,9 @@ class Client(ClientMethods):
                 )
             case _:
                 raise ValueError(f"unsupported request method: {method}")
+
+    def upload_files(
+        self: typing.Self, *, file_uploads: list[FileUpload]
+    ) -> list[UploadedFile]:
+        """Upload files to uncountable, returning file ids that are usable with other SDK operations."""
+        return self._file_uploader.upload_files(file_uploads=file_uploads)

uncountable/core/file_upload.py

@@ -0,0 +1,95 @@
+import asyncio
+from contextlib import contextmanager
+from dataclasses import dataclass
+from enum import StrEnum
+from io import BytesIO
+from pathlib import Path
+from typing import Generator, Literal, Self
+
+import aiohttp
+import aiotus
+
+from .types import AuthDetails
+
+_CHUNK_SIZE = 5 * 1024 * 1024  # s3 requires 5MiB minimum
+
+
+class FileUploadType(StrEnum):
+    MEDIA_FILE_UPLOAD = "MEDIA_FILE_UPLOAD"
+
+
+@dataclass(kw_only=True)
+class MediaFileUpload:
+    """Upload file from a path on disk"""
+
+    path: str
+    type: FileUploadType.MEDIA_FILE_UPLOAD = FileUploadType.MEDIA_FILE_UPLOAD
+
+
+FileUpload = MediaFileUpload
+
+
+@dataclass(kw_only=True)
+class FileBytes:
+    name: str
+    bytes_data: BytesIO
+
+
+@contextmanager
+def file_upload_data(file_upload: FileUpload) -> Generator[FileBytes, None, None]:
+    match file_upload.type:
+        case FileUploadType.MEDIA_FILE_UPLOAD:
+            with open(file_upload.path, "rb") as f:
+                yield FileBytes(
+                    name=Path(file_upload.path).name, bytes_data=BytesIO(f.read())
+                )
+
+
+@dataclass(kw_only=True)
+class UploadedFile:
+    name: str
+    file_id: int
+
+
+class UploadFailed(Exception):
+    pass
+
+
+class FileUploader:
+    _auth_details: AuthDetails
+    _base_url: str
+
+    def __init__(self: Self, base_url: str, auth_details: AuthDetails) -> None:
+        self._base_url = base_url
+        self._auth_details = auth_details
+
+    async def _upload_file(self: Self, file_upload: FileUpload) -> UploadedFile:
+        creation_url = f"{self._base_url}/api/external/file_upload/files"
+        auth = aiohttp.BasicAuth(
+            self._auth_details.api_id, self._auth_details.api_secret_key
+        )
+        async with (
+            aiohttp.ClientSession(
+                auth=auth, headers={"Origin": self._base_url}
+            ) as session,
+        ):
+            with file_upload_data(file_upload) as file_bytes:
+                location = await aiotus.upload(
+                    creation_url,
+                    file_bytes.bytes_data,
+                    {"filename": file_bytes.name.encode()},
+                    client_session=session,
+                    chunksize=_CHUNK_SIZE,
+                )
+                if location is None:
+                    raise UploadFailed(f"Failed to upload: {file_bytes.name}")
+                return UploadedFile(
+                    name=file_bytes.name, file_id=int(location.path.split("/")[-1])
+                )
+
+    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

@@ -0,0 +1,22 @@
+import base64
+import json
+import typing
+from dataclasses import dataclass
+from enum import StrEnum
+from urllib.parse import urljoin
+
+import aiohttp
+import requests
+
+from pkgs.argument_parser import CachedParser
+from pkgs.serialization_util import serialize_for_api
+from uncountable.types.client_base import APIRequest, ClientMethods
+
+
+@dataclass(kw_only=True)
+class AuthDetailsApiKey:
+    api_id: str
+    api_secret_key: str
+
+
+AuthDetails = AuthDetailsApiKey

uncountable/types/__init__.py

@@ -17,6 +17,8 @@ from .api.recipes import create_recipe as create_recipe_t
 from .api.recipe_links import create_recipe_link as create_recipe_link_t
 from .api.recipes import create_recipes as create_recipes_t
 from . import curves as curves_t
+from .api.recipes import disassociate_recipe_as_input as disassociate_recipe_as_input_t
+from .api.recipes import edit_recipe_inputs as edit_recipe_inputs_t
 from . import entity as entity_t
 from .api.batch import execute_batch as execute_batch_t
 from .api.batch import execute_batch_load_async as execute_batch_load_async_t
@@ -47,21 +49,28 @@ from .api.entity import list_entities as list_entities_t
 from .api.id_source import list_id_source as list_id_source_t
 from .api.id_source import match_id_source as match_id_source_t
 from . import outputs as outputs_t
+from . import permissions as permissions_t
 from . import phases as phases_t
+from . import post_base as post_base_t
 from . import recipe_identifiers as recipe_identifiers_t
+from . import recipe_inputs as recipe_inputs_t
 from . import recipe_links as recipe_links_t
 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 .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
 from .api.triggers import run_trigger as run_trigger_t
+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.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
+from .api.recipes import set_recipe_tags as set_recipe_tags_t
 from .api.entity import set_values as set_values_t
+from .api.entity import transition_entity_phase as transition_entity_phase_t
 from . import units as units_t
 from . import users as users_t
 from . import workflows as workflows_t
@@ -82,6 +91,8 @@ __all__: list[str] = [
     "create_recipe_link_t",
     "create_recipes_t",
     "curves_t",
+    "disassociate_recipe_as_input_t",
+    "edit_recipe_inputs_t",
     "entity_t",
     "execute_batch_t",
     "execute_batch_load_async_t",
@@ -112,21 +123,28 @@ __all__: list[str] = [
     "list_id_source_t",
     "match_id_source_t",
     "outputs_t",
+    "permissions_t",
     "phases_t",
+    "post_base_t",
     "recipe_identifiers_t",
+    "recipe_inputs_t",
     "recipe_links_t",
     "recipe_metadata_t",
     "recipe_output_metadata_t",
     "recipe_tags_t",
+    "recipe_workflow_steps_t",
     "resolve_entity_ids_t",
     "resolve_output_conditions_t",
     "response_t",
     "run_trigger_t",
+    "set_core_permissions_t",
     "set_input_attribute_values_t",
     "set_recipe_inputs_t",
     "set_recipe_metadata_t",
     "set_recipe_outputs_t",
+    "set_recipe_tags_t",
     "set_values_t",
+    "transition_entity_phase_t",
     "units_t",
     "users_t",
     "workflows_t",

uncountable/types/api/entity/create_entities.py

@@ -34,7 +34,7 @@ class EntityToCreate:
 @dataclass(kw_only=True)
 class Arguments:
     definition_id: base_t.ObjectId
-    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS]]
+    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK]]
     entities_to_create: list[EntityToCreate]
 
 

uncountable/types/api/entity/create_entity.py

@@ -40,7 +40,7 @@ class EntityFieldInitialValue:
 @dataclass(kw_only=True)
 class Arguments:
     definition_id: base_t.ObjectId
-    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS]]
+    entity_type: typing.Union[typing.Literal[entity_t.EntityType.LAB_REQUEST], typing.Literal[entity_t.EntityType.APPROVAL], typing.Literal[entity_t.EntityType.CUSTOM_ENTITY], typing.Literal[entity_t.EntityType.INVENTORY_AMOUNT], typing.Literal[entity_t.EntityType.TASK], typing.Literal[entity_t.EntityType.PROJECT], typing.Literal[entity_t.EntityType.EQUIPMENT], typing.Literal[entity_t.EntityType.INV_LOCAL_LOCATIONS], typing.Literal[entity_t.EntityType.FIELD_OPTION_SET], typing.Literal[entity_t.EntityType.WEBHOOK]]
     field_values: typing.Optional[typing.Optional[list[field_values_t.FieldRefNameValue]]] = None
 
 

uncountable/types/api/entity/transition_entity_phase.py

@@ -0,0 +1,66 @@
+# 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 pkgs.serialization import serial_class
+from ... import entity as entity_t
+from ... import identifier as identifier_t
+from ... import response as response_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+    "TransitionIdentifier",
+    "TransitionIdentifierPhases",
+    "TransitionIdentifierTransition",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/entity/transition_entity_phase"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class TransitionIdentifierPhases:
+    type: typing.Literal["phases"] = "phases"
+    phase_from_key: identifier_t.IdentifierKey
+    phase_to_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class TransitionIdentifierTransition:
+    type: typing.Literal["transition"] = "transition"
+    transition_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+TransitionIdentifier = typing.Union[TransitionIdentifierPhases, TransitionIdentifierTransition]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    entity: entity_t.Entity
+    transition: TransitionIdentifier
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data(response_t.Response):
+    pass
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/permissions/__init__.py

@@ -0,0 +1 @@
+# DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/permissions/set_core_permissions.py

@@ -0,0 +1,89 @@
+# 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 pkgs.serialization import serial_class
+from ... import identifier as identifier_t
+from ... import permissions as permissions_t
+from ... import post_base as post_base_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+    "PermissionsScope",
+    "PermissionsScopeAllMaterialFamilies",
+    "PermissionsScopeMaterialFamily",
+    "PermissionsScopeProject",
+    "PermissionsScopeRecipe",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/permissions/external_set_core_permissions"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class PermissionsScopeProject:
+    type: typing.Literal["project"] = "project"
+    project_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class PermissionsScopeRecipe:
+    type: typing.Literal["recipe"] = "recipe"
+    recipe_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class PermissionsScopeMaterialFamily:
+    type: typing.Literal["material_family"] = "material_family"
+    material_family_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@serial_class(
+    parse_require={"type"},
+)
+@dataclass(kw_only=True)
+class PermissionsScopeAllMaterialFamilies:
+    type: typing.Literal["all_material_families"] = "all_material_families"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+PermissionsScope = typing.Union[PermissionsScopeProject, PermissionsScopeRecipe, PermissionsScopeMaterialFamily, PermissionsScopeAllMaterialFamilies]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    scope: PermissionsScope
+    permissions_types: list[permissions_t.CorePermissionType]
+    update_type: post_base_t.UpdateType
+    user_group_ids: typing.Optional[list[int]] = None
+    user_ids: typing.Optional[list[int]] = None
+
+
+# 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

@@ -8,7 +8,7 @@ import typing  # noqa: F401
 import datetime  # noqa: F401
 from decimal import Decimal  # noqa: F401
 from dataclasses import dataclass
-from ... import base as base_t
+from ... import async_batch as async_batch_t
 from ... import identifier as identifier_t
 
 __all__: list[str] = [
@@ -26,10 +26,11 @@ ENDPOINT_PATH = "api/external/recipes/associate_recipe_as_input"
 @dataclass(kw_only=True)
 class Arguments:
     recipe_key: identifier_t.IdentifierKey
+    input_key: typing.Optional[identifier_t.IdentifierKey] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
-class Data:
-    result_id: base_t.ObjectId
+class Data(async_batch_t.AsyncBatchActionReturn):
+    pass
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/recipes/create_recipe.py

@@ -29,10 +29,10 @@ ENDPOINT_PATH = "api/external/recipes/create_recipe"
 class Arguments:
     material_family_id: base_t.ObjectId
     workflow_id: base_t.ObjectId
-    identifiers: recipe_identifiers_t.RecipeIdentifiers
     name: typing.Optional[str] = None
     workflow_variant_id: typing.Optional[typing.Optional[base_t.ObjectId]] = None
     recipe_metadata: typing.Optional[list[recipe_metadata_t.MetadataValue]] = None
+    identifiers: typing.Optional[recipe_identifiers_t.RecipeIdentifiers] = None
     definition_key: typing.Optional[identifier_t.IdentifierKey] = None
 
 

uncountable/types/api/recipes/disassociate_recipe_as_input.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 async_batch as async_batch_t
+from ... import identifier as identifier_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/recipes/disassociate_recipe_as_input"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    recipe_key: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data(async_batch_t.AsyncBatchActionReturn):
+    pass
+# DO NOT MODIFY -- This file is generated by type_spec