UncountablePythonSDK 0.0.35__tar.gz → 0.0.36__tar.gz

{uncountablepythonsdk-0.0.35/UncountablePythonSDK.egg-info → uncountablepythonsdk-0.0.36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.35
+Version: 0.0.36
 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.35 → uncountablepythonsdk-0.0.36/UncountablePythonSDK.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.35
+Version: 0.0.36
 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.35 → uncountablepythonsdk-0.0.36}/UncountablePythonSDK.egg-info/SOURCES.txt

@@ -191,5 +191,6 @@ uncountable/types/api/recipes/set_recipe_output_annotations.py
 uncountable/types/api/recipes/set_recipe_outputs.py
 uncountable/types/api/recipes/set_recipe_tags.py
 uncountable/types/api/recipes/unarchive_recipes.py
+uncountable/types/api/recipes/unlock_recipes.py
 uncountable/types/api/triggers/__init__.py
 uncountable/types/api/triggers/run_trigger.py

{uncountablepythonsdk-0.0.35 → uncountablepythonsdk-0.0.36}/pkgs/type_spec/builder.py

@@ -18,6 +18,17 @@ from .util import parse_type_str, unused
 RawDict = dict[Any, Any]
 
 
+class StabilityLevel(StrEnum):
+    """These are currently used for open api,
+    see: https://github.com/Tufin/oasdiff/blob/main/docs/STABILITY.md
+    """
+
+    draft = "draft"
+    alpha = "alpha"
+    beta = "beta"
+    stable = "stable"
+
+
 class PropertyExtant(StrEnum):
     required = "required"
     optional = "optional"
@@ -791,6 +802,7 @@ class SpecEndpoint:
     data_loader: bool
     is_sdk: bool
     is_beta: bool
+    stability_level: StabilityLevel | None
     # Don't emit TypeScript endpoint code
     suppress_ts: bool
     function: Optional[str]
@@ -816,6 +828,7 @@ class SpecEndpoint:
                 "data_loader",
                 "is_sdk",
                 "is_beta",
+                "stability_level",
                 "async_batch_path",
                 "function",
                 "suppress_ts",
@@ -857,6 +870,14 @@ class SpecEndpoint:
         assert isinstance(is_beta, bool)
         self.is_beta = is_beta
 
+        stability_level_raw = data.get("stability_level")
+        assert stability_level_raw is None or isinstance(stability_level_raw, str)
+        self.stability_level = (
+            StabilityLevel(stability_level_raw)
+            if stability_level_raw is not None
+            else None
+        )
+
         async_batch_path = data.get("async_batch_path")
         if async_batch_path is not None:
             assert isinstance(async_batch_path, str)

{uncountablepythonsdk-0.0.35 → uncountablepythonsdk-0.0.36}/pkgs/type_spec/emit_open_api.py

@@ -23,6 +23,7 @@ from .emit_open_api_util import (
     EmitOpenAPIGuide,
     EmitOpenAPIPath,
     EmitOpenAPIServer,
+    EmitOpenAPIStabilityLevel,
     EmitOpenAPITag,
     GlobalContextInfo,
     TagGroupToNamedTags,
@@ -256,6 +257,14 @@ def _emit_is_beta(is_beta: bool) -> DictApiSchema:
     return {}
 
 
+def _emit_stability_level(
+    stability_level: EmitOpenAPIStabilityLevel | None,
+) -> DictApiSchema:
+    if stability_level is not None:
+        return {"x-stability-level": str(stability_level)}
+    return {}
+
+
 def _emit_endpoint_request_body(
     endpoint: EmitOpenAPIEndpoint,
     arguments_type: OpenAPIType | None,
@@ -349,6 +358,7 @@ def _emit_namespace(
             }
             | _emit_endpoint_description(endpoint.description, ctx.endpoint.guides)
             | _emit_is_beta(endpoint.is_beta)
+            | _emit_stability_level(endpoint.stability_level)
             | _emit_endpoint_parameters(endpoint, argument_type, ctx.endpoint.examples)
             | _emit_endpoint_request_body(endpoint, argument_type, ctx.endpoint.examples)
             | {
@@ -564,6 +574,7 @@ def _emit_endpoint(
         summary=f"{'/'.join(namespace.path[path_cutoff:])}",
         description=description,
         is_beta=namespace.endpoint.is_beta,
+        stability_level=namespace.endpoint.stability_level,
         examples=[
             EmitOpenAPIEndpointExample(
                 ref_name=f"ex_{i}",

{uncountablepythonsdk-0.0.35 → uncountablepythonsdk-0.0.36}/pkgs/type_spec/emit_open_api_util.py

@@ -72,6 +72,9 @@ class EmitOpenAPIEndpointExample:
     data: dict[str, object]
 
 
+EmitOpenAPIStabilityLevel = builder.StabilityLevel
+
+
 @dataclass
 class EmitOpenAPIEndpoint:
     method: str
@@ -79,6 +82,7 @@ class EmitOpenAPIEndpoint:
     summary: str
     description: str
     is_beta: bool
+    stability_level: EmitOpenAPIStabilityLevel | None
     examples: list[EmitOpenAPIEndpointExample]
     guides: list[EmitOpenAPIGuide]
 

{uncountablepythonsdk-0.0.35 → uncountablepythonsdk-0.0.36}/uncountable/types/__init__.py

@@ -84,6 +84,7 @@ from .api.entity import transition_entity_phase as transition_entity_phase_t
 from .api.recipes import unarchive_recipes as unarchive_recipes_t
 from . import units as units_t
 from .api.entity import unlock_entity as unlock_entity_t
+from .api.recipes import unlock_recipes as unlock_recipes_t
 from .api.material_families import update_entity_material_families as update_entity_material_families_t
 from .api.field_options import upsert_field_options as upsert_field_options_t
 from . import users as users_t
@@ -172,6 +173,7 @@ __all__: list[str] = [
     "unarchive_recipes_t",
     "units_t",
     "unlock_entity_t",
+    "unlock_recipes_t",
     "update_entity_material_families_t",
     "upsert_field_options_t",
     "users_t",

uncountablepythonsdk-0.0.36/uncountable/types/api/recipes/lock_recipes.py

@@ -0,0 +1,53 @@
+# 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",
+    "RecipeLockBase",
+    "RecipeLockType",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/recipes/lock_recipes"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class RecipeLockType(StrEnum):
+    ALL = "all"
+    INPUTS_ONLY = "inputs_only"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class RecipeLockBase:
+    recipe: identifier_t.IdentifierKey
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    type: RecipeLockType = RecipeLockType.ALL
+    recipes: list[identifier_t.IdentifierKey]
+    globally_removable: bool
+    lock_samples: typing.Optional[bool] = None
+    comments: 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

uncountablepythonsdk-0.0.36/uncountable/types/api/recipes/unlock_recipes.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",
+    "RecipeUnlockType",
+]
+
+ENDPOINT_METHOD = "POST"
+ENDPOINT_PATH = "api/external/recipes/unlock_recipes"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+class RecipeUnlockType(StrEnum):
+    STANDARD = "standard"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    type: RecipeUnlockType = RecipeUnlockType.STANDARD
+    recipes: list[identifier_t.IdentifierKey]
+    unlock_samples: typing.Optional[bool] = 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

{uncountablepythonsdk-0.0.35 → uncountablepythonsdk-0.0.36}/uncountable/types/async_batch.py

@@ -27,6 +27,8 @@ class AsyncBatchRequestPath(StrEnum):
     SET_RECIPE_TAGS = "recipes/set_recipe_tags"
     EDIT_RECIPE_INPUTS = "recipes/edit_recipe_inputs"
     ARCHIVE_RECIPES = "recipes/archive"
+    LOCK_RECIPES = "recipes/lock_recipes"
+    UNLOCK_RECIPES = "recipes/unlock_recipes"
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

{uncountablepythonsdk-0.0.35 → uncountablepythonsdk-0.0.36}/uncountable/types/client_base.py

@@ -75,6 +75,7 @@ import uncountable.types.api.entity.set_values as set_values_t
 import uncountable.types.api.entity.transition_entity_phase as transition_entity_phase_t
 import uncountable.types.api.recipes.unarchive_recipes as unarchive_recipes_t
 import uncountable.types.api.entity.unlock_entity as unlock_entity_t
+import uncountable.types.api.recipes.unlock_recipes as unlock_recipes_t
 import uncountable.types.api.material_families.update_entity_material_families as update_entity_material_families_t
 import uncountable.types.api.field_options.upsert_field_options as upsert_field_options_t
 from abc import ABC, abstractmethod
@@ -911,14 +912,29 @@ class ClientMethods(ABC):
     def lock_recipes(
         self,
         *,
-        locks: list[lock_recipes_t.RecipeLock],
+        type: lock_recipes_t.RecipeLockType = lock_recipes_t.RecipeLockType.ALL,
+        recipes: list[identifier_t.IdentifierKey],
+        globally_removable: bool,
+        lock_samples: typing.Optional[bool] = None,
+        comments: typing.Optional[str] = None,
     ) -> lock_recipes_t.Data:
         """Lock experiments. Experiments will require unlocking to be editable. Edits to the experiments are blocked while they are locked.
 
-        :param locks: The recipe locks to apply, a maximum of 100 can be sent
+        :param type: The type of lock to set.
+    All = both inputs and measurements are locked.
+    Inputs Only = only inputs are locked from editing.
+
+        :param recipes: The recipes to lock, a maximum of 100 can be sent
+        :param globally_removable: If true any user can unlock the experiment. If false the locking user is the only user that can unlock.
+        :param lock_samples: Should associated experiment test samples also be locked.
+        :param comments: Optional comment describing the purpose of locking
         """
         args = lock_recipes_t.Arguments(
-            locks=locks,
+            type=type,
+            recipes=recipes,
+            globally_removable=globally_removable,
+            lock_samples=lock_samples,
+            comments=comments,
         )
         api_request = APIRequest(
             method=lock_recipes_t.ENDPOINT_METHOD,
@@ -1333,6 +1349,31 @@ class ClientMethods(ABC):
         )
         return self.do_request(api_request=api_request, return_type=unlock_entity_t.Data)
 
+    def unlock_recipes(
+        self,
+        *,
+        type: unlock_recipes_t.RecipeUnlockType = unlock_recipes_t.RecipeUnlockType.STANDARD,
+        recipes: list[identifier_t.IdentifierKey],
+        unlock_samples: typing.Optional[bool] = None,
+    ) -> unlock_recipes_t.Data:
+        """Unlock experiments. Experiments will edtiable after unlocking if they are currently locked.
+
+        :param type: The method to unlock recipes. Default is standard.
+        :param recipes: The recipes to unlock, a maximum of 100 can be sent
+        :param unlock_samples: Should associated experiment test samples also be unlocked.
+        """
+        args = unlock_recipes_t.Arguments(
+            type=type,
+            recipes=recipes,
+            unlock_samples=unlock_samples,
+        )
+        api_request = APIRequest(
+            method=unlock_recipes_t.ENDPOINT_METHOD,
+            endpoint=unlock_recipes_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=unlock_recipes_t.Data)
+
     def update_entity_material_families(
         self,
         *,

uncountablepythonsdk-0.0.35/uncountable/types/api/recipes/lock_recipes.py

@@ -1,89 +0,0 @@
-# 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 pkgs.serialization import serial_class
-from pkgs.serialization import serial_union_annotation
-from ... import identifier as identifier_t
-
-__all__: list[str] = [
-    "Arguments",
-    "Data",
-    "ENDPOINT_METHOD",
-    "ENDPOINT_PATH",
-    "RecipeLock",
-    "RecipeLockAll",
-    "RecipeLockBase",
-    "RecipeLockInputs",
-    "RecipeLockType",
-]
-
-ENDPOINT_METHOD = "POST"
-ENDPOINT_PATH = "api/external/recipes/lock_recipes"
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-class RecipeLockType(StrEnum):
-    ALL = "all"
-    INPUTS_ONLY = "inputs_only"
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@dataclass(kw_only=True)
-class RecipeLockBase:
-    recipe: identifier_t.IdentifierKey
-    globally_removable: bool
-    type: RecipeLockType
-    lock_samples: typing.Optional[bool] = None
-    comments: typing.Optional[str] = None
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    parse_require={"type"},
-)
-@dataclass(kw_only=True)
-class RecipeLockAll(RecipeLockBase):
-    type: typing.Literal[RecipeLockType.ALL] = RecipeLockType.ALL
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    parse_require={"type"},
-)
-@dataclass(kw_only=True)
-class RecipeLockInputs(RecipeLockBase):
-    type: typing.Literal[RecipeLockType.INPUTS_ONLY] = RecipeLockType.INPUTS_ONLY
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-RecipeLock = typing.Annotated[
-    typing.Union[RecipeLockAll, RecipeLockInputs],
-    serial_union_annotation(
-        discriminator="type",
-        discriminator_map={
-            "all": RecipeLockAll,
-            "inputs_only": RecipeLockInputs,
-        },
-    ),
-]
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@dataclass(kw_only=True)
-class Arguments:
-    locks: list[RecipeLock]
-
-
-# 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