UncountablePythonSDK 0.0.7__py3-none-any.whl → 0.0.9__py3-none-any.whl

uncountable/integration/types.py

@@ -0,0 +1,89 @@
+# TODO: move to type spec
+
+
+from dataclasses import dataclass
+from enum import StrEnum
+from typing import Literal
+
+
+class JobDefinitionType(StrEnum):
+    CRON = "cron"
+    # also imagine other job types like webhook-triggered or sftp-triggered,
+    # manual, etc
+
+
+class JobExecutorType(StrEnum):
+    SCRIPT = "script"
+    # also imagine builtin executors like 'sftp_sync'
+
+
+class AuthRetrievalType(StrEnum):
+    ENV = "env"
+    # also imagine secrets manager, keyvault, etc
+
+
+@dataclass
+class JobExecutorBase:
+    type: JobExecutorType
+
+
+@dataclass
+class JobExecutorScript(JobExecutorBase):
+    type: Literal[JobExecutorType.SCRIPT]
+    import_path: str
+
+
+JobExecutor = JobExecutorScript
+
+
+@dataclass
+class JobDefinitionBase:
+    id: str
+    name: str
+
+
+@dataclass
+class CronJobDefinition(JobDefinitionBase):
+    type: Literal[JobDefinitionType.CRON]
+    cron_spec: str
+    # Here we assert that the executor has to be a script, but we could add
+    # other builtin executor types that cron jobs can support later
+    executor: JobExecutorScript
+
+
+JobDefinition = CronJobDefinition
+
+
+@dataclass
+class AuthRetrievalBase:
+    type: AuthRetrievalType
+
+
+@dataclass
+class AuthRetrievalEnv:
+    # We don't really need any extra info here, we can enforce that the auth
+    # keys are named like UNC_PROFILE_{profile name}_API_SECRET_KEY. For
+    # supporting pulling secrets from secrets manager etc it will be nice to
+    # use dataclass properties to get the secret name, region etc.
+    type: Literal[AuthRetrievalType.ENV]
+
+
+AuthRetrieval = AuthRetrievalEnv
+
+
+@dataclass
+class ProfileDefinition:
+    # profile name (expected to be something like customer_name) will be
+    # obtained from the folder name instead of specified here. Forces jobs to
+    # be organized nicely in folders that separate their identities.
+    auth_retrieval: AuthRetrieval
+    base_url: str
+    jobs: list[JobDefinition]
+
+
+@dataclass
+class ProfileMetadata:
+    # supplied by inspecting the folder name that the profile is in
+    name: str
+    base_url: str
+    auth_retrieval: AuthRetrieval

uncountable/types/__init__.py

@@ -4,13 +4,17 @@
 # fmt: off
 # isort: skip_file
 from . import base as base_t
+from . import calculations as calculations_t
 from .api.entity import create_entities as create_entities_t
 from .api.entity import create_entity as create_entity_t
 from .api.inputs import create_inputs as create_inputs_t
 from .api.recipes import create_recipes as create_recipes_t
+from . import curves as curves_t
 from . import entity as entity_t
 from .api.batch import execute_batch as execute_batch_t
+from . import experiment_groups as experiment_groups_t
 from . import field_values as field_values_t
+from . import fields as fields_t
 from .api.recipes import get_curve as get_curve_t
 from .api.entity import get_entities_data as get_entities_data_t
 from .api.inputs import get_input_data as get_input_data_t
@@ -27,25 +31,40 @@ from .api.recipe_metadata import get_recipe_metadata_data as get_recipe_metadata
 from .api.recipes import get_recipe_names as get_recipe_names_t
 from .api.recipes import get_recipe_output_metadata as get_recipe_output_metadata_t
 from .api.recipes import get_recipes_data as get_recipes_data_t
+from . import input_attributes as input_attributes_t
+from . import inputs as inputs_t
 from .api.entity import list_entities as list_entities_t
+from . import outputs as outputs_t
+from . import phases as phases_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 .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.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_outputs as set_recipe_outputs_t
 from .api.entity import set_values as set_values_t
+from . import units as units_t
+from . import users as users_t
+from . import workflows as workflows_t
 
 
 __all__: list[str] = [
     "base_t",
+    "calculations_t",
     "create_entities_t",
     "create_entity_t",
     "create_inputs_t",
     "create_recipes_t",
+    "curves_t",
     "entity_t",
     "execute_batch_t",
+    "experiment_groups_t",
     "field_values_t",
+    "fields_t",
     "get_curve_t",
     "get_entities_data_t",
     "get_input_data_t",
@@ -62,12 +81,23 @@ __all__: list[str] = [
     "get_recipe_names_t",
     "get_recipe_output_metadata_t",
     "get_recipes_data_t",
+    "input_attributes_t",
+    "inputs_t",
     "list_entities_t",
+    "outputs_t",
+    "phases_t",
     "recipe_links_t",
+    "recipe_metadata_t",
+    "recipe_output_metadata_t",
+    "recipe_tags_t",
     "resolve_entity_ids_t",
     "resolve_output_conditions_t",
+    "response_t",
     "set_input_attribute_values_t",
     "set_recipe_inputs_t",
     "set_recipe_outputs_t",
     "set_values_t",
+    "units_t",
+    "users_t",
+    "workflows_t",
 ]

uncountable/types/api/entity/create_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 ... import base as base_t
 from ... import entity as entity_t
 from ... import field_values as field_values_t
 
@@ -32,7 +33,7 @@ class EntityToCreate:
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    definition_id: int
+    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]]
     entities_to_create: list[EntityToCreate]
 

uncountable/types/api/entity/create_entity.py

@@ -39,7 +39,7 @@ class EntityFieldInitialValue:
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    definition_id: int
+    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]]
     field_values: typing.Optional[typing.Optional[list[field_values_t.FieldRefNameValue]]] = None
 

uncountable/types/api/entity/get_entities_data.py

@@ -8,17 +8,16 @@ 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 base as base_t
+from ... import entity as entity_t
+from ... import field_values as field_values_t
 
 __all__: list[str] = [
     "Arguments",
     "Data",
     "ENDPOINT_METHOD",
     "ENDPOINT_PATH",
-    "Entity",
     "EntityDetails",
-    "EntityFieldValue",
 ]
 
 ENDPOINT_METHOD = "GET"
@@ -28,34 +27,15 @@ ENDPOINT_PATH = "api/external/entity/external_get_entities_data"
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    entity_ids: list[int]
-    entity_type: str
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    unconverted_values={"value"},
-)
-@dataclass(kw_only=True)
-class EntityFieldValue:
-    field_id: int
-    field_ref_name: str
-    row_index: typing.Optional[int]
-    value: base_t.JsonValue
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@dataclass(kw_only=True)
-class Entity:
-    id: int
-    type: str
+    entity_ids: list[base_t.ObjectId]
+    entity_type: entity_t.EntityType
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class EntityDetails:
-    entity: Entity
-    field_values: list[EntityFieldValue]
+    entity: entity_t.Entity
+    field_values: list[field_values_t.FieldRefIdNameValue]
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/entity/list_entities.py

@@ -10,6 +10,7 @@ from decimal import Decimal  # noqa: F401
 from dataclasses import dataclass
 from pkgs.serialization import OpaqueKey
 from ... import base as base_t
+from ... import entity as entity_t
 
 __all__: list[str] = [
     "Arguments",
@@ -17,7 +18,6 @@ __all__: list[str] = [
     "Data",
     "ENDPOINT_METHOD",
     "ENDPOINT_PATH",
-    "Entity",
     "EntityResult",
 ]
 
@@ -28,24 +28,17 @@ ENDPOINT_PATH = "api/external/entity/external_list_entities"
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    entity_type: str
+    entity_type: entity_t.EntityType
     config_reference: str
-    offset: typing.Optional[int]
-    limit: typing.Optional[int]
     attributes: typing.Optional[dict[OpaqueKey, base_t.JsonValue]] = None
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@dataclass(kw_only=True)
-class Entity:
-    id: int
-    type: str
+    offset: typing.Optional[typing.Optional[int]] = None
+    limit: typing.Optional[typing.Optional[int]] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class EntityResult:
-    entity: Entity
+    entity: entity_t.Entity
     column_values: list[base_t.JsonValue]
 
 

uncountable/types/api/entity/resolve_entity_ids.py

@@ -8,6 +8,8 @@ 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 entity as entity_t
 
 __all__: list[str] = [
     "Arguments",
@@ -24,8 +26,8 @@ ENDPOINT_PATH = "api/external/entity/external_resolve_entity_ids"
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    entity_ids: list[typing.Union[str, int]]
-    entity_type: str
+    entity_ids: list[typing.Union[str, base_t.ObjectId]]
+    entity_type: entity_t.EntityType
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/entity/set_values.py

@@ -8,52 +8,30 @@ 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 base as base_t
+from ... import entity as entity_t
+from ... import field_values as field_values_t
+from ... import response as response_t
 
 __all__: list[str] = [
     "Arguments",
     "Data",
     "ENDPOINT_METHOD",
     "ENDPOINT_PATH",
-    "Entity",
-    "EntityFieldValues",
 ]
 
 ENDPOINT_METHOD = "POST"
 ENDPOINT_PATH = "api/external/entity/external_set_values"
 
 
-# DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    unconverted_values={"value"},
-)
-@dataclass(kw_only=True)
-class EntityFieldValues:
-    field_ref_name: str
-    value: base_t.JsonValue
-    row_index: typing.Optional[typing.Optional[int]] = None
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@dataclass(kw_only=True)
-class Entity:
-    id: int
-    type: str
-
-
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    entity: Entity
-    values: list[EntityFieldValues]
+    entity: entity_t.Entity
+    values: list[field_values_t.ArgumentValueRefName]
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    parse_require={"status"},
-)
 @dataclass(kw_only=True)
-class Data:
-    status: typing.Literal["ok"] = "ok"
+class Data(response_t.Response):
+    pass
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/input_groups/get_input_group_names.py

@@ -8,6 +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
 
 __all__: list[str] = [
     "Arguments",
@@ -24,13 +25,13 @@ ENDPOINT_PATH = "api/external/input_groups/external_get_input_group_names"
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    material_family_id: int
+    material_family_id: base_t.ObjectId
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class SimpleInputGroup:
-    input_group_id: int
+    input_group_id: base_t.ObjectId
     name: str
 
 

uncountable/types/api/inputs/create_inputs.py

@@ -8,15 +8,15 @@ 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 base as base_t
+from ... import input_attributes as input_attributes_t
+from ... import inputs as inputs_t
 
 __all__: list[str] = [
     "Arguments",
     "Data",
     "ENDPOINT_METHOD",
     "ENDPOINT_PATH",
-    "InputAttributeValue",
     "InputSimple",
     "InputToCreate",
 ]
@@ -35,29 +35,17 @@ class Arguments:
 @dataclass(kw_only=True)
 class InputToCreate:
     name: str
-    material_family_ids: list[int]
-    quantity_type: typing.Union[typing.Literal["numeric"], typing.Literal["text"]]
-    type: typing.Union[typing.Literal["ingredient"], typing.Literal["process_parameter"]]
-    attributes: typing.Optional[list[InputAttributeValue]] = None
-    category_id: typing.Optional[int] = None
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    unconverted_values={"quantity_json"},
-    to_string_values={"quantity_dec"},
-)
-@dataclass(kw_only=True)
-class InputAttributeValue:
-    attribute_id: int
-    quantity_dec: typing.Optional[Decimal] = None
-    quantity_json: typing.Optional[base_t.JsonValue] = None
+    material_family_ids: list[base_t.ObjectId]
+    quantity_type: typing.Union[typing.Literal[inputs_t.IngredientQuantityType.NUMERIC], typing.Literal[inputs_t.IngredientQuantityType.TEXT]]
+    type: typing.Union[typing.Literal[inputs_t.IngredientType.INGREDIENT], typing.Literal[inputs_t.IngredientType.PROCESS_PARAMETER]]
+    attributes: typing.Optional[list[input_attributes_t.InputAttributeValue]] = None
+    category_id: typing.Optional[base_t.ObjectId] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class InputSimple:
-    input_id: int
+    input_id: base_t.ObjectId
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/inputs/get_input_data.py

@@ -8,8 +8,8 @@ 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 base as base_t
+from ... import input_attributes as input_attributes_t
 
 __all__: list[str] = [
     "Arguments",
@@ -17,7 +17,6 @@ __all__: list[str] = [
     "ENDPOINT_METHOD",
     "ENDPOINT_PATH",
     "FullInput",
-    "InputAttrVal",
     "SimpleInputAttr",
     "SimpleInputGlobalCategory",
     "SimpleInputSubcategory",
@@ -30,29 +29,17 @@ ENDPOINT_PATH = "api/external/inputs/external_get_input_data"
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    material_family_id: int
-    input_ids: typing.Optional[list[int]]
-    offset: typing.Optional[int]
+    material_family_id: base_t.ObjectId
+    input_ids: typing.Optional[list[base_t.ObjectId]]
     is_parameter: typing.Optional[bool]
-    limit: typing.Optional[int]
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    unconverted_values={"quantity_json"},
-    to_string_values={"quantity_dec"},
-)
-@dataclass(kw_only=True)
-class InputAttrVal:
-    attribute_id: int
-    quantity_dec: Decimal
-    quantity_json: base_t.JsonValue
+    offset: typing.Optional[typing.Optional[int]] = None
+    limit: typing.Optional[typing.Optional[int]] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class SimpleInputAttr:
-    attribute_id: int
+    attribute_id: base_t.ObjectId
     name: str
     quantity_type: str
 
@@ -60,27 +47,27 @@ class SimpleInputAttr:
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class SimpleInputGlobalCategory:
-    category_id: int
+    category_id: base_t.ObjectId
     name: str
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class SimpleInputSubcategory:
-    subcategory_id: int
+    subcategory_id: base_t.ObjectId
     name: str
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class FullInput:
-    input_id: int
+    input_id: base_t.ObjectId
     name: str
     quantity_type: str
     is_parameter: bool
-    attributes: list[InputAttrVal]
-    global_category_id: int
-    subcategory_ids: list[int]
+    attributes: list[input_attributes_t.InputAttributeValue]
+    global_category_id: typing.Optional[base_t.ObjectId]
+    subcategory_ids: list[base_t.ObjectId]
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/api/inputs/get_input_names.py

@@ -8,6 +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
 
 __all__: list[str] = [
     "Arguments",
@@ -24,16 +25,16 @@ ENDPOINT_PATH = "api/external/inputs/external_get_input_names"
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    material_family_id: int
-    offset: typing.Optional[int]
+    material_family_id: base_t.ObjectId
     is_parameter: typing.Optional[bool]
-    limit: typing.Optional[int]
+    offset: typing.Optional[typing.Optional[int]] = None
+    limit: typing.Optional[typing.Optional[int]] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class InputWithName:
-    input_id: int
+    input_id: base_t.ObjectId
     name: str
 
 

uncountable/types/api/inputs/get_inputs_data.py

@@ -8,8 +8,8 @@ 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 base as base_t
+from ... import input_attributes as input_attributes_t
 
 __all__: list[str] = [
     "Arguments",
@@ -17,7 +17,6 @@ __all__: list[str] = [
     "Data",
     "ENDPOINT_METHOD",
     "ENDPOINT_PATH",
-    "InputAttributeValue",
     "InputCategory",
     "InputDetails",
     "InputTag",
@@ -30,52 +29,40 @@ ENDPOINT_PATH = "api/external/inputs/external_get_inputs_data"
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
-    input_ids: list[int]
+    input_ids: list[base_t.ObjectId]
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class AttributeDetails:
-    attribute_id: int
+    attribute_id: base_t.ObjectId
     name: str
     quantity_type: str
 
 
-# DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    unconverted_values={"quantity_json"},
-    to_string_values={"quantity_dec"},
-)
-@dataclass(kw_only=True)
-class InputAttributeValue:
-    attribute_id: int
-    quantity_dec: Decimal
-    quantity_json: base_t.JsonValue
-
-
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class InputTag:
-    tag_id: int
+    tag_id: base_t.ObjectId
     tag_name: str
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class InputCategory:
-    material_family_id: int
-    category_id: int
+    material_family_id: base_t.ObjectId
+    category_id: base_t.ObjectId
     category_name: str
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class InputDetails:
-    input_id: int
+    input_id: base_t.ObjectId
     name: str
     quantity_type: str
     type: str
-    attributes: list[InputAttributeValue]
+    attributes: list[input_attributes_t.InputAttributeValue]
     categories: list[InputCategory]
     tags: list[InputTag]
 

uncountable/types/api/inputs/set_input_attribute_values.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 response as response_t
 
 __all__: list[str] = [
     "Arguments",
@@ -36,17 +37,14 @@ class Arguments:
 )
 @dataclass(kw_only=True)
 class InputAttributeValue:
-    input_id: int
-    attribute_id: int
+    input_id: base_t.ObjectId
+    attribute_id: base_t.ObjectId
     quantity_dec: typing.Optional[Decimal] = None
     quantity_json: typing.Optional[base_t.JsonValue] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    parse_require={"status"},
-)
 @dataclass(kw_only=True)
-class Data:
-    status: typing.Literal["ok"] = "ok"
+class Data(response_t.Response):
+    pass
 # DO NOT MODIFY -- This file is generated by type_spec