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

{UncountablePythonSDK-0.0.22.dist-info → UncountablePythonSDK-0.0.24.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.22
+Version: 0.0.24
 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.22.dist-info → UncountablePythonSDK-0.0.24.dist-info}/RECORD

@@ -35,16 +35,16 @@ pkgs/strenum_compat/__init__.py,sha256=wXRFeNvBm8RU6dy1PFJ5sRLgUIEeH_DVR95Sv5qpG
 pkgs/strenum_compat/strenum_compat.py,sha256=uOUAgpYTjHs1MX8dG81jRlyTkt3KNbkV_25zp7xTX2s,36
 pkgs/type_spec/__init__.py,sha256=h5DmJTca4QVV10sZR1x0-MlkZfuGYDfapR3zHvXfzto,19
 pkgs/type_spec/__main__.py,sha256=5bJaX9Y_-FavP0qwzhk-z-V97UY7uaezJTa1zhO_HHQ,1048
-pkgs/type_spec/builder.py,sha256=kLiTjVVbtctRfSStI15IZYbyQ4n2KPmvtJIWbizux40,43002
+pkgs/type_spec/builder.py,sha256=9fEcZkasqovH8W4PtQvXtPu4psS_a-HAyu6Wsfk5L8w,43041
 pkgs/type_spec/config.py,sha256=INfEiDcUsZFUKasHprsE6i33siPB0RnfmTKOsWcGnQ8,5043
-pkgs/type_spec/emit_io_ts.py,sha256=gCEfS81w_ifqjLVJ3_cpy9Gq03o6H5nEsh35WAkqGGE,5606
-pkgs/type_spec/emit_open_api.py,sha256=xy-nXjkqAZMDd-0qU5eDubRz1Hf8IwZSZj5bZyPSvX4,23328
+pkgs/type_spec/emit_io_ts.py,sha256=Ghd8XYqyNYldHQDepwa9GLfHXcoi48ztBw84K28ETic,5707
+pkgs/type_spec/emit_open_api.py,sha256=RJzzOZ7Ti1PNTPn42ZGW7OA6L9KRQhKOTw4elXzJKpE,23524
 pkgs/type_spec/emit_open_api_util.py,sha256=F6qouGVm2-WGYkoubbBtRu00V4e30bWJ0fDBhigBEfg,2248
-pkgs/type_spec/emit_python.py,sha256=hj_5RUnJzjI6W9SmOh8ZUJTWB6F7PB1UFsg3OGSXZg0,42416
-pkgs/type_spec/emit_typescript.py,sha256=KOCcPuwSLRSt3pIp06Nq9exledq-kWtrA4RnUpeGMi8,17505
+pkgs/type_spec/emit_python.py,sha256=aGPnp86DZN0N7c5eiBHVAT_smDf1uCLmRldDhxmWx9g,42673
+pkgs/type_spec/emit_typescript.py,sha256=4hpCJwiDf-v8LJaNFVfFtf8zvtG73YNPFwwa_5NuffI,17729
 pkgs/type_spec/emit_typescript_util.py,sha256=93FzJnpYse4PKFzgdw4DGV4zFTi5tF4WR-CIi7cW498,873
 pkgs/type_spec/load_types.py,sha256=xEHwdB_miR3vNs161Oy1luafE0VC-yk9-utAyCJmbEo,3629
-pkgs/type_spec/open_api_util.py,sha256=TFbK2bkYT6S4qPQGO3_G2mfVgtNB26d31kwaHQ9y99E,6730
+pkgs/type_spec/open_api_util.py,sha256=IGh-_snGPST_P_8FdYtO8MTEa9PUxRW6Rzg9X9EgQik,7114
 pkgs/type_spec/test.py,sha256=4ueujBq-pEgnX3Z69HyPmD-bullFXmpixcpVzfOkhP4,489
 pkgs/type_spec/util.py,sha256=6m6MPfY-SwjyZf2FWQKclswWB5o7gcdd-3tdpViPYOQ,4844
 pkgs/type_spec/actions_registry/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -85,12 +85,13 @@ type_spec/external/api/project/get_projects.yaml,sha256=pQXGGPHenmFWYUuzEmZ-ORf0
 type_spec/external/api/project/get_projects_data.yaml,sha256=8xQoyL8HlAropfZPYYcQ-W4fO4yuqueAWTKxRzTXAa0,1981
 type_spec/external/api/recipe_links/create_recipe_link.yaml,sha256=7b2p7Ei4LnQXqccHsOVAfYyNK4WXm0n1IqxPG-qQDh0,941
 type_spec/external/api/recipe_metadata/get_recipe_metadata_data.yaml,sha256=mJs82Ci8XSp2ng0W9MKqoeYwIjjgaVYmC5MWFmWFkR8,1759
+type_spec/external/api/recipes/archive_recipes.yaml,sha256=Oe-NIFwERiG1DwgzsWj3ouKVdnRDTelrgqE5b9Bt_vQ,515
 type_spec/external/api/recipes/associate_recipe_as_input.yaml,sha256=7t0jto37RyLjl63-GK3mLC2uFiX1gd8vPwTwnobxkeI,654
 type_spec/external/api/recipes/associate_recipe_as_lot.yaml,sha256=8wzeJg5njt4qG2kavA6Jpo9PkWE6rIbuA4IPNdhcwEg,605
 type_spec/external/api/recipes/create_recipe.yaml,sha256=mGLyKJI3pN_7nU4rcSqCO3WjuKhO_odZ2pewVgYcMUU,1322
 type_spec/external/api/recipes/create_recipes.yaml,sha256=eXMlXRpB5TFt1mUTECBa4aAIG3KrxYT2mJ5vxmZ9Q3A,1503
 type_spec/external/api/recipes/disassociate_recipe_as_input.yaml,sha256=qTKQCNBNwLnbr22DQVLA6b80BdBhwnDbX1c4KoCKUm8,477
-type_spec/external/api/recipes/edit_recipe_inputs.yaml,sha256=mmRcep8It4UIUmABtLKxwH5fuax_9yb0vvF8_6ROLjY,2591
+type_spec/external/api/recipes/edit_recipe_inputs.yaml,sha256=ljewBw77ucvl_m_KWmSJp-nVQGvVG6cb7xVOgPIlueU,2573
 type_spec/external/api/recipes/get_curve.yaml,sha256=zQpPwOYqojY-YwmTjbqoGtUxpYm3vne2sYpglWbPnpw,779
 type_spec/external/api/recipes/get_recipe_calculations.yaml,sha256=ZE7PzfWrjS7TiO4q7iyCwEj5In8GwO6fFIYGqUlTEXo,1240
 type_spec/external/api/recipes/get_recipe_links.yaml,sha256=Vwm0OVWl3VvDaI7chY_oZQqD8xZ1u09iFWKkZKn1ITo,766
@@ -120,13 +121,13 @@ uncountable/integration/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJ
 uncountable/integration/db/connect.py,sha256=iI9e8a2hfbFP-dvH0MGLsrG-RpM0dHKCL-oCLkah9hs,181
 uncountable/integration/executors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uncountable/integration/executors/script_executor.py,sha256=6oMPAFe0PUdqt76e8jMi4vXszGVsVHLULob7Qbl3o38,816
-uncountable/types/__init__.py,sha256=fTNNsvFFkjp4acdBA8eS00OZVnDo_Zn7aRwPs8SFnrs,6024
-uncountable/types/async_batch.py,sha256=FtIoDCeyt9rF5hknQs6Sw-vjiYBMJbe1re0-4bk_6VY,1578
+uncountable/types/__init__.py,sha256=6XYh9ACSJRnbbTGfpQ69bLFfwyBiCG1ZlHqSAOugTG8,6111
+uncountable/types/async_batch.py,sha256=aWiul1fK3-cXaCESUUJ_92FF-NuuwxSjn9n3jC9vY5o,1618
 uncountable/types/async_batch_processor.py,sha256=YksvTyJaZ3rqpZx4UXofUf7XU1Br4aNBNPZXB3LLtkA,5940
 uncountable/types/base.py,sha256=w3BRf8SAvYPlKrcJtJcQ_WhCU3A9zy0VuRTRWRFKVUA,2709
 uncountable/types/calculations.py,sha256=16J-KKMp-I8ZQUkYNmKCHfAn6DGb99cFinALcDIdGHY,562
 uncountable/types/chemical_structure.py,sha256=zQKl53DGtQQONIUHFXuwjWLQaG7FPZY7x6SBSOzkGV0,758
-uncountable/types/client_base.py,sha256=eAgmDRoHhpsswgqI1q8-eg8joya7qaaFJKH1fyE50PE,46075
+uncountable/types/client_base.py,sha256=EIsd-OoOglTX2tVgbWDosPlq7hAkB_Nlacr_e8epjb4,47949
 uncountable/types/curves.py,sha256=qYyRntMmFNonEwTrGhquMLbgMqjyP1moQflNTP0FMec,1308
 uncountable/types/entity.py,sha256=NjMZrqBwQ7sZe_oUuJqy9IEG7dWZmFMkQQXJ0_odcnA,11637
 uncountable/types/experiment_groups.py,sha256=ZBEk06F4n98Jz3oEA09WaDmw5rqPs7iVAm_Ysr4gc_o,599
@@ -190,6 +191,7 @@ uncountable/types/api/recipe_links/create_recipe_link.py,sha256=1Ok6XMGFKBIPV-uR
 uncountable/types/api/recipe_metadata/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
 uncountable/types/api/recipe_metadata/get_recipe_metadata_data.py,sha256=el6Pn5XqExX66ZEEHM8CHPxnyXSMZPdfdvLBz86sAVY,1267
 uncountable/types/api/recipes/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
+uncountable/types/api/recipes/archive_recipes.py,sha256=XFCqBa90bG4Tpxu6fhUqzl7PWlY35bbzOmJf5EOviRM,852
 uncountable/types/api/recipes/associate_recipe_as_input.py,sha256=88a2lirEgrodyyE6og0oYtkGAWih2uJCZRmy45kTBow,976
 uncountable/types/api/recipes/associate_recipe_as_lot.py,sha256=bTYjbnY3B7GKz4MV4UGn7vPjaqMkAfUTio8872d4iws,955
 uncountable/types/api/recipes/create_recipe.py,sha256=Ni00efkcPkQ3WTIgDHzkfu1qoc52ReV9VT0wwwPOT4g,1364
@@ -208,7 +210,7 @@ uncountable/types/api/recipes/set_recipe_outputs.py,sha256=QYq39TNchQ80ET1C77OE9
 uncountable/types/api/recipes/set_recipe_tags.py,sha256=U710hgq9-t6QZGRB-ZGHskpt4iXwYEjIRb67eh3P518,2453
 uncountable/types/api/triggers/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
 uncountable/types/api/triggers/run_trigger.py,sha256=9m9M8-nlGB_sAU2Qm2lWugp4h4Osqj6QpjNfU8osd1U,901
-UncountablePythonSDK-0.0.22.dist-info/METADATA,sha256=o1sddgkTqesJ-3NQ_fm1xSgW1vj8bV-PAXnFW7g6-Hs,1613
-UncountablePythonSDK-0.0.22.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-UncountablePythonSDK-0.0.22.dist-info/top_level.txt,sha256=HaMiBnH1wA7SG9-RVHIJPBH3l8X5gee2jUf-77Nz-Dk,41
-UncountablePythonSDK-0.0.22.dist-info/RECORD,,
+UncountablePythonSDK-0.0.24.dist-info/METADATA,sha256=3xzubcqtwZH0Z5jnBD1q_8eU5UyYnNiXiS_RnBAm4Xo,1613
+UncountablePythonSDK-0.0.24.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+UncountablePythonSDK-0.0.24.dist-info/top_level.txt,sha256=HaMiBnH1wA7SG9-RVHIJPBH3l8X5gee2jUf-77Nz-Dk,41
+UncountablePythonSDK-0.0.24.dist-info/RECORD,,

pkgs/type_spec/builder.py

@@ -86,6 +86,7 @@ class BaseTypeName(StrEnum):
     s_optional = "Optional"
     s_string = "String"
     s_tuple = "Tuple"
+    s_readonly_array = "ReadonlyArray"
     s_union = "Union"
 
     # For a root class that defines properties

pkgs/type_spec/emit_io_ts.py

@@ -118,7 +118,10 @@ def refer_to_io_ts(
     stype: builder.SpecType,
 ) -> str:
     if isinstance(stype, builder.SpecTypeInstance):
-        if stype.defn_type.name == builder.BaseTypeName.s_list:
+        if (
+            stype.defn_type.name == builder.BaseTypeName.s_list
+            or stype.defn_type.name == builder.BaseTypeName.s_readonly_array
+        ):
             spec = refer_to_io_ts(ctx, stype.parameters[0])
             return f"IO.array({spec})"
         if stype.defn_type.name == builder.BaseTypeName.s_union:

pkgs/type_spec/emit_open_api.py

@@ -634,6 +634,10 @@ def open_api_type(
                 [open_api_type(ctx, p, config=config) for p in stype.parameters],
                 description="TupleType",
             )
+        if stype.defn_type.name == builder.BaseTypeName.s_readonly_array:
+            return OpenAPIArrayType(
+                open_api_type(ctx, stype.parameters[0], config=config)
+            )
 
         # TODO: generics are not supported by OpenAPI
         # map to Free-Form Object and add description

pkgs/type_spec/emit_python.py

@@ -819,6 +819,7 @@ base_name_map = {
     builder.BaseTypeName.s_opaque_key: "OpaqueKey",
     builder.BaseTypeName.s_string: "str",
     builder.BaseTypeName.s_tuple: "tuple",
+    builder.BaseTypeName.s_readonly_array: "tuple",
     builder.BaseTypeName.s_union: "typing.Union",
     builder.BaseTypeName.s_literal: "typing.Literal",
 }
@@ -827,6 +828,11 @@ base_name_map = {
 def refer_to(ctx: TrackingContext, stype: builder.SpecType) -> str:
     if isinstance(stype, builder.SpecTypeInstance):
         params = ", ".join([refer_to(ctx, p) for p in stype.parameters])
+
+        if stype.defn_type.is_base_type(builder.BaseTypeName.s_readonly_array):
+            assert len(stype.parameters) == 1, "Read Only Array takes one parameter"
+            params = f"{params}, ..."
+
         return f"{refer_to(ctx, stype.defn_type)}[{params}]"
 
     if isinstance(stype, builder.SpecTypeLiteralWrapper):

pkgs/type_spec/emit_typescript.py

@@ -394,6 +394,9 @@ def refer_to_impl(
         if stype.defn_type.name == builder.BaseTypeName.s_list:
             spec, multi = refer_to_impl(ctx, stype.parameters[0])
             return f"({spec})[]" if multi else f"{spec}[]", False
+        if stype.defn_type.name == builder.BaseTypeName.s_readonly_array:
+            spec, multi = refer_to_impl(ctx, stype.parameters[0])
+            return f"readonly ({spec})[]" if multi else f"readonly {spec}[]", False
         if stype.defn_type.name == builder.BaseTypeName.s_union:
             return f'({" | ".join([refer_to(ctx, p) for p in stype.parameters])})', False
         if stype.defn_type.name == builder.BaseTypeName.s_literal:

pkgs/type_spec/open_api_util.py

@@ -174,6 +174,18 @@ class OpenAPIObjectType(OpenAPIType):
 
         return {"description": desc}
 
+    def _emit_property(
+        self, property_name: str, property_type: OpenAPIType
+    ) -> dict[str, object]:
+        property_info = {
+            **property_type.asdict(),
+        }
+        property_description = self._emit_property_desc(property_name)
+        if "$ref" in property_info and "description" in property_description:
+            return {"allOf": [property_info, property_description]}
+
+        return property_info | property_description
+
     def asdict(self) -> dict[str, object]:
         return self.add_addl_info({
             "type": "object",
@@ -183,10 +195,7 @@ class OpenAPIObjectType(OpenAPIType):
                 if not property_type.nullable
             ],
             "properties": {
-                property_name: {
-                    **property_type.asdict(),
-                }
-                | self._emit_property_desc(property_name)
+                property_name: self._emit_property(property_name, property_type)
                 for property_name, property_type in self.properties.items()
             },
         })

type_spec/external/api/recipes/archive_recipes.yaml

@@ -0,0 +1,20 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/recipes/archive
+    function: main.site.app.external.recipes.archive_recipes.archive_recipes
+    desc: Archive the provided recipes and their children
+
+Arguments:
+    type: Object
+    properties:
+        recipes:
+            type: List<identifier.IdentifierKey>
+            desc: Identifier for the recipe
+        reason?:
+            type: String
+            desc: This reason will be written to the audit log archive entry
+
+
+Data:
+  type: Object

type_spec/external/api/recipes/edit_recipe_inputs.yaml

@@ -1,6 +1,5 @@
 $endpoint:
     is_sdk: true
-    is_beta: true
     async_batch_path: edit_recipe_inputs
     method: post
     path: ${external}/recipes/edit_recipe_inputs

uncountable/types/__init__.py

@@ -3,6 +3,7 @@
 # ruff: noqa: E402
 # fmt: off
 # isort: skip_file
+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
 from . import async_batch as async_batch_t
@@ -77,6 +78,7 @@ from . import workflows as workflows_t
 
 
 __all__: list[str] = [
+    "archive_recipes_t",
     "associate_recipe_as_input_t",
     "associate_recipe_as_lot_t",
     "async_batch_t",

uncountable/types/api/recipes/archive_recipes.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/archive"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    recipes: list[identifier_t.IdentifierKey]
+    reason: typing.Optional[str] = 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/async_batch.py

@@ -26,6 +26,7 @@ class AsyncBatchRequestPath(StrEnum):
     SET_RECIPE_METADATA = "recipes/set_recipe_metadata"
     SET_RECIPE_TAGS = "recipes/set_recipe_tags"
     EDIT_RECIPE_INPUTS = "recipes/edit_recipe_inputs"
+    ARCHIVE_RECIPES = "recipes/archive"
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/client_base.py

@@ -9,6 +9,7 @@ import typing  # noqa: F401
 import datetime  # noqa: F401
 from decimal import Decimal  # noqa: F401
 from pkgs.serialization import OpaqueKey
+import uncountable.types.api.recipes.archive_recipes as archive_recipes_t
 import uncountable.types.api.recipes.associate_recipe_as_input as associate_recipe_as_input_t
 import uncountable.types.api.recipes.associate_recipe_as_lot as associate_recipe_as_lot_t
 from uncountable.types import async_batch as async_batch_t
@@ -21,6 +22,7 @@ import uncountable.types.api.recipes.create_recipe as create_recipe_t
 import uncountable.types.api.recipe_links.create_recipe_link as create_recipe_link_t
 import uncountable.types.api.recipes.create_recipes as create_recipes_t
 import uncountable.types.api.recipes.disassociate_recipe_as_input as disassociate_recipe_as_input_t
+import uncountable.types.api.recipes.edit_recipe_inputs as edit_recipe_inputs_t
 from uncountable.types import entity as entity_t
 import uncountable.types.api.batch.execute_batch as execute_batch_t
 import uncountable.types.api.batch.execute_batch_load_async as execute_batch_load_async_t
@@ -51,6 +53,7 @@ from uncountable.types import post_base as post_base_t
 from uncountable.types import recipe_identifiers as recipe_identifiers_t
 from uncountable.types import recipe_links as recipe_links_t
 from uncountable.types import recipe_metadata as recipe_metadata_t
+from uncountable.types import recipe_workflow_steps as recipe_workflow_steps_t
 import uncountable.types.api.entity.resolve_entity_ids as resolve_entity_ids_t
 import uncountable.types.api.outputs.resolve_output_conditions as resolve_output_conditions_t
 import uncountable.types.api.triggers.run_trigger as run_trigger_t
@@ -81,6 +84,28 @@ class ClientMethods(ABC):
     def do_request(self, *, api_request: APIRequest, return_type: type[DT]) -> DT:
         ...
 
+    def archive_recipes(
+        self,
+        *,
+        recipes: list[identifier_t.IdentifierKey],
+        reason: typing.Optional[str] = None,
+    ) -> archive_recipes_t.Data:
+        """Archive the provided recipes and their children
+
+        :param recipes: Identifier for the recipe
+        :param reason: This reason will be written to the audit log archive entry
+        """
+        args = archive_recipes_t.Arguments(
+            recipes=recipes,
+            reason=reason,
+        )
+        api_request = APIRequest(
+            method=archive_recipes_t.ENDPOINT_METHOD,
+            endpoint=archive_recipes_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=archive_recipes_t.Data)
+
     def associate_recipe_as_input(
         self,
         *,
@@ -319,6 +344,29 @@ class ClientMethods(ABC):
         )
         return self.do_request(api_request=api_request, return_type=disassociate_recipe_as_input_t.Data)
 
+    def edit_recipe_inputs(
+        self,
+        *,
+        recipe_key: identifier_t.IdentifierKey,
+        recipe_workflow_step_identifier: recipe_workflow_steps_t.RecipeWorkflowStepIdentifier,
+        edits: list[edit_recipe_inputs_t.RecipeInputEdit],
+    ) -> edit_recipe_inputs_t.Data:
+        """Clear, update, or add inputs on a recipe
+
+        :param recipe_key: Identifier for the recipe
+        """
+        args = edit_recipe_inputs_t.Arguments(
+            recipe_key=recipe_key,
+            recipe_workflow_step_identifier=recipe_workflow_step_identifier,
+            edits=edits,
+        )
+        api_request = APIRequest(
+            method=edit_recipe_inputs_t.ENDPOINT_METHOD,
+            endpoint=edit_recipe_inputs_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=edit_recipe_inputs_t.Data)
+
     def execute_batch(
         self,
         *,