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

pkgs/type_spec/type_info/emit_type_info.py

@@ -23,7 +23,7 @@ def type_path_of(stype: builder.SpecType) -> object:  # NamePath
     extended scopes, generics, and enum literal values.
     - Scoped Type: [ (namespace-string)..., type-string ]
     - Instance Type: [ "$instance", Scoped-Type-Base, [TypePath-Parameters...] ]
-    - Literal Type: [ "$literal", [ "$value", value ]... ]
+    - Literal Type: [ "$literal", [ "$value", value, value-type-string ]... ]
 
     @return (string-specific, multiple-types)
     """
@@ -34,11 +34,15 @@ def type_path_of(stype: builder.SpecType) -> object:  # NamePath
 
     if isinstance(stype, builder.SpecTypeInstance):
         if stype.defn_type.name == builder.BaseTypeName.s_literal:
-            parts: list[str | list[str | bool]] = ["$literal"]
+            parts: list[object] = ["$literal"]
             for parameter in stype.parameters:
                 assert isinstance(parameter, builder.SpecTypeLiteralWrapper)
                 # This allows expansion to enum literal values later
-                parts.append(["$value", parameter.value])
+                parts.append([
+                    "$value",
+                    parameter.value,
+                    type_path_of(parameter.value_type),
+                ])
             return parts
 
         return [
@@ -148,6 +152,114 @@ def _build_map_all(build: builder.SpecBuilder) -> MapAll:
     return map_all
 
 
+@dataclasses.dataclass(kw_only=True)
+class InheritablePropertyParts:
+    """This uses only the "soft" information for now, things that aren't relevant
+    to the language emitted types. There are some fields that should be inherited
+    at that level, but that needs to be done in builder. When that is done, the
+    "label" and "desc" could probably be removed from this list."""
+
+    label: Optional[str] = None
+    desc: Optional[str] = None
+    ext_info: Optional[data_t.ExtInfo] = None
+
+
+def _extract_inheritable_property_parts(
+    stype: builder.SpecTypeDefnObject,
+    prop: builder.SpecProperty,
+) -> InheritablePropertyParts:
+    if not stype.is_base and isinstance(stype.base, builder.SpecTypeDefn):
+        base_prop = (stype.base.properties or {}).get(prop.name)
+        if base_prop is None:
+            base_parts = InheritablePropertyParts()
+        else:
+            base_parts = _extract_inheritable_property_parts(stype.base, base_prop)
+            # Layout should not be inherited, as it'd end up hiding properties in the derived type
+            if base_parts.ext_info is not None:
+                base_parts.ext_info.layout = None
+    else:
+        base_parts = InheritablePropertyParts()
+
+    label = prop.label or base_parts.label
+    desc = prop.desc or base_parts.desc
+    local_ext_info = _parse_ext_info(prop.ext_info)
+    if local_ext_info is None:
+        ext_info = base_parts.ext_info
+    elif base_parts.ext_info is None:
+        ext_info = local_ext_info
+    else:
+        ext_info = data_t.ExtInfo(
+            **(local_ext_info.__dict__ | base_parts.ext_info.__dict__)
+        )
+
+    return InheritablePropertyParts(label=label, desc=desc, ext_info=ext_info)
+
+
+ExtInfoLayout = dict[str, set[str]]
+ALL_FIELDS_GROUP = "*all_fields"
+
+
+def _extract_and_validate_layout(
+    stype: builder.SpecTypeDefnObject,
+    ext_info: data_t.ExtInfo,
+    base_layout: ExtInfoLayout | None,
+) -> ExtInfoLayout:
+    """
+    Produce a map of groups to fields, for validation.
+    """
+    if ext_info.layout is None:
+        return {}
+    assert stype.properties is not None
+
+    all_fields_group: set[str] = set()
+    layout: ExtInfoLayout = {ALL_FIELDS_GROUP: all_fields_group}
+
+    for group in ext_info.layout.groups:
+        fields = set(group.fields or [])
+        for field in fields:
+            assert field in stype.properties, f"layout-refers-to-missing-field:{field}"
+
+        local_ref_name = None
+        if group.ref_name is not None:
+            assert (
+                base_layout is None or base_layout.get(group.ref_name) is None
+            ), f"group-name-duplicate-in-base:{group.ref_name}"
+            local_ref_name = group.ref_name
+
+        if group.extends:
+            assert base_layout is not None, "missing-base-layout"
+            base_group = base_layout.get(group.extends)
+            assert base_group is not None, f"missing-base-group:{group.extends}"
+            fields.update(base_group)
+            local_ref_name = group.extends
+
+        assert local_ref_name not in layout, f"duplicate-group:{local_ref_name}"
+        if local_ref_name is not None:
+            layout[local_ref_name] = fields
+        all_fields_group.update(fields)
+
+    for group_ref_name in base_layout or {}:
+        assert group_ref_name in layout, f"missing-base-group:{group_ref_name}"
+
+    for prop_ref_name in stype.properties:
+        assert prop_ref_name in all_fields_group, f"layout-missing-field:{prop_ref_name}"
+
+    return layout
+
+
+def _validate_type_ext_info(stype: builder.SpecTypeDefnObject) -> ExtInfoLayout | None:
+    ext_info = _parse_ext_info(stype.ext_info)
+    if ext_info is None:
+        return None
+
+    if not stype.is_base and isinstance(stype.base, builder.SpecTypeDefnObject):
+        base_layout = _validate_type_ext_info(stype.base)
+    else:
+        base_layout = None
+
+    return _extract_and_validate_layout(stype, ext_info, base_layout)
+
+
 def _build_map_type(
     build: builder.SpecBuilder, stype: builder.SpecTypeDefn
 ) -> MapType | None:
@@ -158,6 +270,8 @@ def _build_map_type(
         and not stype.is_base
         and stype.base is not None
     ):
+        _validate_type_ext_info(stype)
+
         properties: dict[str, MapProperty] = {}
         map_type = MapTypeObject(
             type_name=stype.name,
@@ -170,14 +284,17 @@ def _build_map_type(
 
         if stype.properties is not None:
             for prop in stype.properties.values():
+                parts = _extract_inheritable_property_parts(stype, prop)
+                # Propertis can't have layouts
+                assert parts.ext_info is None or parts.ext_info.layout is None
                 map_property = MapProperty(
                     type_name=prop.name,
-                    label=prop.label,
+                    label=parts.label,
                     api_name=ts_name(prop.name, prop.name_case),
                     extant=prop.extant,
                     type_path=type_path_of(prop.spec_type),
-                    ext_info=_convert_ext_info(prop.ext_info),
-                    desc=prop.desc,
+                    ext_info=serialize_for_api(parts.ext_info),
+                    desc=parts.desc,
                     default=prop.default,
                 )
                 map_type.properties[prop.name] = map_property
@@ -211,7 +328,7 @@ def _build_map_type(
     return None
 
 
-def _convert_ext_info(in_ext: Any) -> Optional[PureJsonValue]:
+def _parse_ext_info(in_ext: Any) -> Optional[data_t.ExtInfo]:
     if in_ext is None:
         return None
     assert isinstance(in_ext, dict)
@@ -229,6 +346,10 @@ def _convert_ext_info(in_ext: Any) -> Optional[PureJsonValue]:
             df["result_type"] = serialize_for_storage(converted)
             mod_ext["data_format"] = df
 
-    parsed = ext_info_parser.parse_storage(mod_ext)
+    return ext_info_parser.parse_storage(mod_ext)
+
+
+def _convert_ext_info(in_ext: Any) -> Optional[PureJsonValue]:
     # we need to convert this to API storage since it'll be used as-is in the UI
+    parsed = _parse_ext_info(in_ext)
     return cast(PureJsonValue, serialize_for_api(parsed))

type_spec/external/api/entity/create_entities.yaml

@@ -19,7 +19,19 @@ Arguments:
             type: ObjectId
             desc: "Definition id for the entities to create"
         entity_type:
-            type: Union<Literal<entity.EntityType.lab_request>, Literal<entity.EntityType.approval>, Literal<entity.EntityType.custom_entity>, Literal<entity.EntityType.task>, Literal<entity.EntityType.project>, Literal<entity.EntityType.equipment>, Literal<entity.EntityType.inv_local_locations>>
+            type: |
+                Union<
+                    Literal<entity.EntityType.lab_request>,
+                    Literal<entity.EntityType.approval>,
+                    Literal<entity.EntityType.custom_entity>,
+                    Literal<entity.EntityType.inventory_amount>,
+                    Literal<entity.EntityType.task>,
+                    Literal<entity.EntityType.project>,
+                    Literal<entity.EntityType.equipment>,
+                    Literal<entity.EntityType.inv_local_locations>,
+                    Literal<entity.EntityType.field_option_set>,
+                    Literal<entity.EntityType.webhook>
+                >
             desc: "The type of the entities to create"
         entities_to_create:
             type: List<EntityToCreate>

type_spec/external/api/entity/create_entity.yaml

@@ -26,7 +26,19 @@ Arguments:
             type: ObjectId
             desc: "Definition id of the entity to create"
         entity_type:
-            type: Union<Literal<entity.EntityType.lab_request>, Literal<entity.EntityType.approval>, Literal<entity.EntityType.custom_entity>, Literal<entity.EntityType.task>, Literal<entity.EntityType.project>, Literal<entity.EntityType.equipment>, Literal<entity.EntityType.inv_local_locations>>
+            type: |
+                Union<
+                    Literal<entity.EntityType.lab_request>,
+                    Literal<entity.EntityType.approval>,
+                    Literal<entity.EntityType.custom_entity>,
+                    Literal<entity.EntityType.inventory_amount>,
+                    Literal<entity.EntityType.task>,
+                    Literal<entity.EntityType.project>,
+                    Literal<entity.EntityType.equipment>,
+                    Literal<entity.EntityType.inv_local_locations>,
+                    Literal<entity.EntityType.field_option_set>,
+                    Literal<entity.EntityType.webhook>
+                >
             desc: "The type of the entities requested"
         field_values?:
             type: Optional<List<field_values.FieldRefNameValue>>

type_spec/external/api/entity/transition_entity_phase.yaml

@@ -0,0 +1,44 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/entity/transition_entity_phase
+    function: main.site.app.external.entity.transition_entity_phase.transition_entity_phase
+    desc: "Transitions an entity from one phase to another"
+
+
+TransitionIdentifierPhases:
+    type: Object
+    properties:
+        type:
+            type: Literal<'phases'>
+        phase_from_key:
+            type: identifier.IdentifierKey
+        phase_to_key:
+            type: identifier.IdentifierKey
+
+TransitionIdentifierTransition:
+    type: Object
+    properties:
+        type:
+            type: Literal<'transition'>
+        transition_key:
+            type: identifier.IdentifierKey
+
+
+TransitionIdentifier:
+    type: Alias
+    alias: |
+        Union<TransitionIdentifierPhases, TransitionIdentifierTransition>
+
+
+Arguments:
+    type: Object
+    properties:
+        entity:
+            type: entity.Entity
+        transition:
+            type: TransitionIdentifier
+
+Data:
+    type: response.Response
+    properties:

type_spec/external/api/permissions/set_core_permissions.yaml

@@ -0,0 +1,69 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/permissions/external_set_core_permissions
+    function: main.site.app.external.permissions.set_core_permissions.set_core_permissions
+    desc: "Sets recipe related permissions"
+
+
+PermissionsScopeProject:
+  type: Object
+  properties:
+      type:
+          type: Literal<'project'>
+      project_key:
+          type: identifier.IdentifierKey
+
+PermissionsScopeRecipe:
+  type: Object
+  properties:
+    type:
+        type: Literal<'recipe'>
+    recipe_key:
+        type: identifier.IdentifierKey
+
+PermissionsScopeMaterialFamily:
+  type: Object
+  properties:
+    type:
+        type: Literal<'material_family'>
+    material_family_key:
+        type: identifier.IdentifierKey
+
+PermissionsScopeAllMaterialFamilies:
+  type: Object
+  properties:
+    type:
+        type: Literal<'all_material_families'>
+
+
+PermissionsScope:
+  type: Alias
+  alias: |
+    Union<
+      PermissionsScopeProject,
+      PermissionsScopeRecipe,
+      PermissionsScopeMaterialFamily,
+      PermissionsScopeAllMaterialFamilies
+    >
+
+Arguments:
+    type: Object
+    properties:
+        scope:
+            type: PermissionsScope
+            desc: Scope of permissions to change
+        user_group_ids?:
+            type: List<Integer>
+            desc: User group ids to grant permission to
+        user_ids?:
+            type: List<Integer>
+            desc: User ids to grant permission to
+        permissions_types:
+            type: List<permissions.CorePermissionType>
+        update_type:
+            type: post_base.UpdateType
+            desc: The type of update to perform
+
+Data:
+  type: Object

type_spec/external/api/recipes/associate_recipe_as_input.yaml

@@ -11,9 +11,9 @@ Arguments:
         recipe_key:
             type: identifier.IdentifierKey
             desc: "Identifier for the recipe"
+        input_key?:
+            type: identifier.IdentifierKey
+            desc: "Identifier for an input to use for the association.  Optionally supplied.  If not supplied, one is created"
 
 Data:
-  type: Object
-  properties:
-    result_id:
-      type: ObjectId
+  type: async_batch.AsyncBatchActionReturn

type_spec/external/api/recipes/create_recipe.yaml

@@ -1,5 +1,6 @@
 $endpoint:
     is_sdk: true
+    async_batch_path: create_recipe
     method: post
     path: ${external}/recipes/create_recipe
     function: main.site.app.external.recipes.create_recipe.create_recipe
@@ -24,7 +25,7 @@ Arguments:
         recipe_metadata?:
             type: List<recipe_metadata.MetadataValue>
             desc: Metadata values to populate the recipe with
-        identifiers:
+        identifiers?:
             type: recipe_identifiers.RecipeIdentifiers
             desc: A recipe won't be created if it matches the identifier.  An identifier must be unique in the schema
         definition_key?:

type_spec/external/api/recipes/disassociate_recipe_as_input.yaml

@@ -0,0 +1,16 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/recipes/disassociate_recipe_as_input
+    function: main.site.app.external.recipes.disassociate_recipe_as_input.disassociate_recipe_as_input
+    desc: Remove any association between a recipe and ingredients
+
+Arguments:
+    type: Object
+    properties:
+        recipe_key:
+            type: identifier.IdentifierKey
+            desc: "Identifier for the recipe"
+
+Data:
+  type: async_batch.AsyncBatchActionReturn

type_spec/external/api/recipes/edit_recipe_inputs.yaml

@@ -0,0 +1,86 @@
+$endpoint:
+    is_sdk: true
+    is_beta: true
+    async_batch_path: edit_recipe_inputs
+    method: post
+    path: ${external}/recipes/edit_recipe_inputs
+    function: main.site.app.external.recipes.edit_recipe_inputs.edit_recipe_inputs
+    desc: Clear, update, or add inputs on a recipe
+
+RecipeInputEditType:
+    type: StringEnum
+    values:
+        - clear_inputs
+        - upsert_input
+        - add_input
+
+RecipeInputEditBase:
+    type: Object
+    properties:
+        type:
+            type: RecipeInputEditType
+
+RecipeInputEditClearInputs:
+    type: RecipeInputEditBase
+    desc: "Clears all inputs and steps from recipe workflow step to start from scratch"
+    properties:
+        type:
+            type: Literal<RecipeInputEditType.clear_inputs>
+
+RecipeInputEditInputBase:
+    type: RecipeInputEditBase
+    properties:
+        ingredient_key:
+            type: identifier.IdentifierKey
+        quantity_basis:
+            type: recipe_inputs.QuantityBasis
+            desc: "The basis to set for this edit.  Normally this should be mass for ingredients and arbitrary for process parameters"
+            default: mass
+        input_value_type:
+            type: recipe_inputs.InputValueType
+            default: value
+        value_numeric?:
+            type: Decimal
+        value_str?:
+            type: String
+        calculation_key?:
+            type: identifier.IdentifierKey
+            desc: The basis calculation to set
+
+RecipeInputEditUpsertInput:
+    type: RecipeInputEditInputBase
+    desc: "If the input is already present in the recipe, modifies it otherwise adds a new one"
+    properties:
+        type:
+            type: Literal<RecipeInputEditType.upsert_input>
+        clear_first:
+            type: Boolean
+            desc: whether to clear the current value first or modify in place
+
+RecipeInputEditAddInput:
+    type: RecipeInputEditInputBase
+    desc: "Add the input into the recipe.  If it's already present and the recipe is not a mixorder, this call will fail"
+    properties:
+        type:
+            type: Literal<RecipeInputEditType.add_input>
+
+
+RecipeInputEdit:
+    type: Alias
+    alias: Union<RecipeInputEditClearInputs, RecipeInputEditUpsertInput, RecipeInputEditAddInput>
+    discriminator: type
+
+Arguments:
+    type: Object
+    properties:
+        recipe_key:
+            type: identifier.IdentifierKey
+            desc: "Identifier for the recipe"
+        recipe_workflow_step_identifier:
+            type: recipe_workflow_steps.RecipeWorkflowStepIdentifier
+        edits:
+            type: List<RecipeInputEdit>
+
+Data:
+  type: Object
+  properties:

type_spec/external/api/recipes/get_curve.yaml

@@ -7,9 +7,12 @@ $endpoint:
 Arguments:
     type: Object
     properties:
-        recipe_output_id:
+        recipe_output_id?:
             type: ObjectId
             desc: "The recipe output ID to fetch the curve for. This must be a curve recipe output. Recipe Outputs can be found from external_get_recipes_data"
+        recipe_input_id?:
+            type: ObjectId
+            desc: "The recipe input ID to fetch the curve for. This must be a curve recipe input. Recipe Inputs can be found from external_get_recipes_data"
 
 Data:
     type: Object

type_spec/external/api/recipes/get_recipes_data.yaml

@@ -77,6 +77,9 @@ SimpleOutputCondition:
 RecipeInput:
     type: Object
     properties:
+        id:
+            type: ObjectId
+            desc: "The globally unique id for the recipe input"
         input_id:
             type: ObjectId
             desc: "The globally unique ID for the input, allowing for cross reference elsewhere"
@@ -92,6 +95,9 @@ RecipeInput:
         quantity_json:
             type: JsonValue
             desc: "The quantity of the input if it is not numeric or recipe type. If this is filled in, quantity_dec will not be filled in"
+        curve_id:
+            type: Optional<ObjectId>
+            desc: "The id of the curve associated with the input if the input is of curve type."
         actual_quantity_dec:
             type: Decimal
             desc: "The actual quantity of the input if it is numeric or recipe type. If this is filled in, actual_quantity_json will not be filled in"

type_spec/external/api/recipes/set_recipe_metadata.yaml

@@ -1,5 +1,6 @@
 $endpoint:
     is_sdk: true
+    async_batch_path: set_recipe_metadata
     method: post
     path: ${external}/recipes/set_recipe_metadata
     function: main.site.app.external.recipes.set_recipe_metadata.set_recipe_metadata

type_spec/external/api/recipes/set_recipe_tags.yaml

@@ -0,0 +1,62 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/recipes/set_recipe_tags
+    function: main.site.app.external.recipes.set_recipe_tags.set_recipe_tags
+    desc: Modifies recipes tags for a recipe
+
+RecipeTagUpdateType:
+    type: StringEnum
+    values:
+        - append
+        - override
+        - remove
+
+RecipeTagUpdateBase:
+    type: Object
+    properties:
+        type:
+            type: RecipeTagUpdateType
+
+RecipeTagAppend:
+    type: RecipeTagUpdateBase
+    properties:
+        type:
+            type: Literal<RecipeTagUpdateType.append>
+        recipe_tag_ids:
+            type: List<ObjectId>
+
+RecipeTagRemove:
+    type: RecipeTagUpdateBase
+    properties:
+        type:
+            type: Literal<RecipeTagUpdateType.remove>
+        recipe_tag_ids:
+            type: List<ObjectId>
+
+RecipeTagOverride:
+    type: RecipeTagUpdateBase
+    properties:
+        type:
+            type: Literal<RecipeTagUpdateType.override>
+        recipe_tag_ids:
+            type: List<ObjectId>
+
+
+RecipeTagUpdate:
+    type: Alias
+    alias: Union<RecipeTagAppend, RecipeTagRemove, RecipeTagOverride>
+
+
+Arguments:
+    type: Object
+    properties:
+        recipe_key:
+            type: identifier.IdentifierKey
+            desc: Identifier for the recipe
+        recipe_tag_update:
+            type: RecipeTagUpdate
+            desc: The update to perform on the recipe tags
+
+Data:
+  type: Object

uncountable/core/__init__.py

@@ -1,3 +1,5 @@
 from .client import AuthDetailsApiKey, Client
+from .file_upload import MediaFileUpload, UploadedFile
+from .async_batch import AsyncBatchProcessor
 
-__all__: list[str] = ["AuthDetailsApiKey", "Client"]
+__all__: list[str] = ["AuthDetailsApiKey", "AsyncBatchProcessor", "Client", "MediaFileUpload", "UploadedFile"]

uncountable/core/async_batch.py

@@ -0,0 +1,22 @@
+from uncountable.core.client import Client
+from uncountable.types.async_batch import AsyncBatchRequest
+from uncountable.types.async_batch_processor import AsyncBatchProcessorBase
+from uncountable.types import async_batch_t, base_t
+
+
+class AsyncBatchProcessor(AsyncBatchProcessorBase):
+    _client: Client
+    _queue: list[AsyncBatchRequest]
+
+    def __init__(self, *, client: Client) -> None:
+        super().__init__()
+        self._client = client
+        self._queue = []
+
+    def _enqueue(self, req: async_batch_t.AsyncBatchRequest) -> None:
+        self._queue.append(req)
+
+    def send(self) -> base_t.ObjectId:
+        job_id = self._client.execute_batch_load_async(requests=self._queue).job_id
+        self._queue = []
+        return job_id