UncountablePythonSDK 0.0.6__tar.gz → 0.0.7__tar.gz

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/PKG-INFO

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

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

@@ -82,6 +82,9 @@ uncountable/core/client.py
 uncountable/types/__init__.py
 uncountable/types/base.py
 uncountable/types/client_base.py
+uncountable/types/entity.py
+uncountable/types/field_values.py
+uncountable/types/recipe_links.py
 uncountable/types/api/__init__.py
 uncountable/types/api/batch/__init__.py
 uncountable/types/api/batch/execute_batch.py

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/pkgs/type_spec/builder.py

@@ -949,52 +949,6 @@ class SpecNamespace:
                 )
             self.types[name] = spec_type
 
-    def _validate_external_type_impl(
-        self, stype: SpecType, rec_stack: list[SpecType]
-    ) -> bool:
-        if stype in rec_stack[:-1]:
-            # recursive type definition ignore this instance
-            return True
-
-        if isinstance(stype, SpecTypeDefn):
-            if stype.is_base or stype.is_predefined:
-                # predefined and base types are always allowed
-                return True
-
-            if stype.namespace != self:
-                # deny access to outside namespaces
-                return False
-
-        if isinstance(stype, SpecTypeDefnExternal):
-            # external type definitions not support for external endpoints
-            return False
-
-        # check that referenced types themselves are allowed
-        for child_type in stype.get_referenced_types():
-            if not self._validate_external_type_wrap(child_type, rec_stack):
-                return False
-
-        return True
-
-    def _print_external_type_stack(self, rec_stack: list[SpecType]) -> None:
-        print(" -> ".join([str(x) for x in rec_stack]))
-
-    def _validate_external_type_wrap(
-        self, stype: SpecType, rec_stack: list[SpecType]
-    ) -> bool:
-        rec_stack.append(stype)
-        if not self._validate_external_type_impl(stype, rec_stack):
-            return False
-        rec_stack.pop()
-        return True
-
-    def _validate_external_type(self, stype: SpecType) -> bool:
-        rec_stack: list[SpecType] = []
-        if not self._validate_external_type_wrap(stype, rec_stack):
-            self._print_external_type_stack(rec_stack)
-            return False
-        return True
-
     def process(self, builder: SpecBuilder, data: RawDict) -> None:
         """
         Complete the definition of each type.
@@ -1023,21 +977,6 @@ class SpecNamespace:
 
             builder.pop_where()
 
-        # validate external endpoints
-        if self.endpoint is not None and self.endpoint.is_external:
-            # external endpoints are only allowed to reference types defined in the same namespace
-            for name, defn in self.types.items():
-                builder.push_where(name)
-
-                if not self._validate_external_type(defn):
-                    print(builder.where)
-                    print(
-                        f"Type '{name}' of external endpoint declaration references internal type definition!"
-                    )
-                    raise BuilderException()
-
-                builder.pop_where()
-
         builder.pop_where()
 
 

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/pkgs/type_spec/config.py

@@ -74,6 +74,9 @@ class PythonConfig(BaseLanguageConfig):
 class OpenAPIConfig(BaseLanguageConfig):
     types_output: str  # The folder to put generated openapi api yaml
     description: str  # Description of api documentation
+    static_url_path: (
+        str  # the base path where the generated yaml are hosted, e.g. /static/docs
+    )
     server_url: str | None = None
 
     def __post_init__(self: Self) -> None:

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/pkgs/type_spec/emit_open_api.py

@@ -97,9 +97,6 @@ def emit_open_api(builder: builder.SpecBuilder, *, config: OpenAPIConfig) -> Non
     )
 
     for namespace in sorted(builder.namespaces.values(), key=lambda ns: ns.name):
-        if namespace.endpoint is None:
-            continue
-
         ctx = EmitOpenAPIContext(namespace=namespace)
 
         if ctx.namespace.name == "base":
@@ -111,7 +108,7 @@ def emit_open_api(builder: builder.SpecBuilder, *, config: OpenAPIConfig) -> Non
             gctx,
             ctx,
             namespace=namespace,
-            types_output=config.types_output,
+            config=config,
         )
 
     _rewrite_with_notice(
@@ -149,10 +146,10 @@ def _emit_namespace(
     ctx: EmitOpenAPIContext,
     namespace: builder.SpecNamespace,
     *,
-    types_output: str,
+    config: OpenAPIConfig,
 ) -> None:
     for stype in namespace.types.values():
-        _emit_type(ctx, stype)
+        _emit_type(ctx, stype, config=config)
 
     if namespace.endpoint is not None:
         _emit_endpoint(gctx, ctx, namespace, namespace.endpoint)
@@ -218,12 +215,17 @@ def _emit_namespace(
         },
     )
 
-    path = f"{types_output}/common/{'/'.join(namespace.path)}.yaml"
+    path = f"{config.types_output}/common/{'/'.join(namespace.path)}.yaml"
     oa_namespace = {"components": oa_components}
     _rewrite_with_notice(path, yaml.dump(oa_namespace, sort_keys=False))
 
 
-def _emit_type(ctx: EmitOpenAPIContext, stype: builder.SpecType) -> None:
+def _emit_type(
+    ctx: EmitOpenAPIContext,
+    stype: builder.SpecType,
+    *,
+    config: OpenAPIConfig,
+) -> None:
     if not isinstance(stype, builder.SpecTypeDefn):
         return
     if stype.is_base or stype.is_predefined:
@@ -239,7 +241,7 @@ def _emit_type(ctx: EmitOpenAPIContext, stype: builder.SpecType) -> None:
 
     assert stype.is_exported, "expecting exported names"
     if isinstance(stype, builder.SpecTypeDefnAlias):
-        ctx.types[stype.name] = open_api_type(ctx, stype.alias)
+        ctx.types[stype.name] = open_api_type(ctx, stype.alias, config=config)
         return
 
     if isinstance(stype, builder.SpecTypeDefnStringEnum):
@@ -259,14 +261,14 @@ def _emit_type(ctx: EmitOpenAPIContext, stype: builder.SpecType) -> None:
         return
     elif stype.properties is None:
         # TODO: check if these are actually equivalent
-        ctx.types[stype.name] = open_api_type(ctx, stype.base)
+        ctx.types[stype.name] = open_api_type(ctx, stype.base, config=config)
         return
     else:
         properties: dict[str, OpenAPIType] = dict()
         property_desc: dict[str, str] = dict()
 
         for prop in stype.properties.values():
-            ref_type = open_api_type(ctx, prop.spec_type)
+            ref_type = open_api_type(ctx, prop.spec_type, config=config)
             prop_name = ts_name(prop.name, prop.name_case or stype.name_case)
             if prop.desc:
                 property_desc[prop_name] = prop.desc
@@ -294,7 +296,10 @@ def _emit_type(ctx: EmitOpenAPIContext, stype: builder.SpecType) -> None:
 
     if not stype.base.is_base:
         # support inheritance via allOf
-        final_type = OpenAPIIntersectionType([open_api_type(ctx, stype.base), final_type])
+        final_type = OpenAPIIntersectionType([
+            open_api_type(ctx, stype.base, config=config),
+            final_type,
+        ])
 
     ctx.types[stype.name] = final_type
 
@@ -398,31 +403,37 @@ def _emit_value(stype: builder.SpecType, value: object) -> str:
         raise Exception("invalid constant type", value, stype)
 
 
-def open_api_type(ctx: EmitOpenAPIContext, stype: builder.SpecType) -> OpenAPIType:
+def open_api_type(
+    ctx: EmitOpenAPIContext,
+    stype: builder.SpecType,
+    *,
+    config: OpenAPIConfig,
+) -> OpenAPIType:
     if isinstance(stype, builder.SpecTypeInstance):
         if stype.defn_type.name == builder.BaseTypeName.s_list:
-            return OpenAPIArrayType(open_api_type(ctx, stype.parameters[0]))
+            return OpenAPIArrayType(
+                open_api_type(ctx, stype.parameters[0], config=config)
+            )
         if stype.defn_type.name == builder.BaseTypeName.s_union:
-            return OpenAPIUnionType([open_api_type(ctx, p) for p in stype.parameters])
+            return OpenAPIUnionType([
+                open_api_type(ctx, p, config=config) for p in stype.parameters
+            ])
         if stype.defn_type.name == builder.BaseTypeName.s_literal:
             # IMPROVE relax the string constraint for literals (for now treat as string)
             parts = []
             for parameter in stype.parameters:
                 assert isinstance(parameter, builder.SpecTypeLiteralWrapper)
-                param_type = open_api_type(ctx, parameter)
-
-                assert isinstance(param_type, OpenAPIEnumType)
-                parts.extend(param_type.options)
+                parts.append(parameter.value)
 
             return OpenAPIEnumType([str(x) for x in parts])
         if stype.defn_type.name == builder.BaseTypeName.s_optional:
-            ref_type = open_api_type(ctx, stype.parameters[0])
+            ref_type = open_api_type(ctx, stype.parameters[0], config=config)
             ref_type.nullable = True
             return ref_type
         if stype.defn_type.name == builder.BaseTypeName.s_tuple:
             # IMPROVE potentially handle tuples better: for now map tupples to arrays of those types
             return OpenAPIArrayType(
-                [open_api_type(ctx, p) for p in stype.parameters],
+                [open_api_type(ctx, p, config=config) for p in stype.parameters],
                 description="TupleType",
             )
 
@@ -449,5 +460,5 @@ def open_api_type(ctx: EmitOpenAPIContext, stype: builder.SpecType) -> OpenAPITy
     ctx.namespaces.add(stype.namespace)
     # external namespace resolution
     return OpenAPIRefType(
-        source=f"{resolve_namespace_ref(ctx, stype.namespace)}/{stype.name}"
+        source=f"{resolve_namespace_ref(ctx, stype.namespace, config=config)}/{stype.name}"
     )

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/pkgs/type_spec/emit_open_api_util.py

@@ -9,6 +9,7 @@ from dataclasses import dataclass, field
 from typing import TypeAlias
 
 from . import builder
+from .config import OpenAPIConfig
 from .open_api_util import OpenAPIType
 
 MODIFY_NOTICE = "# DO NOT MODIFY -- This file is generated by type_spec"
@@ -74,9 +75,12 @@ class EmitOpenAPIContext:
 
 
 def resolve_namespace_ref(
-    ctx: EmitOpenAPIContext, namespace: builder.SpecNamespace
+    ctx: EmitOpenAPIContext,
+    namespace: builder.SpecNamespace,
+    *,
+    config: OpenAPIConfig,
 ) -> str:
     # TODO: Handle namespaces not in root directory
     if len(ctx.namespace.path) == 1:
         return f"{namespace.name}.yaml#/components/schema"
-    return f"/static/apidocs/common/{namespace.name}.yaml#/components/schema"
+    return f"{config.static_url_path}/common/{namespace.name}.yaml#/components/schema"

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/pkgs/type_spec/emit_python.py

@@ -372,11 +372,12 @@ def _emit_endpoint_invocation_function(
         arguments_type.properties is not None
         and len(arguments_type.properties.values()) > 0
     )
-
+    assert endpoint.function is not None
+    function_name = endpoint.function.split(".")[-1]
     ctx.out.write("\n")
     ctx.out.write(
         f"""
-    def {endpoint.path_basename}(
+    def {function_name}(
         self,\n"""
     )
     if has_arguments:

UncountablePythonSDK-0.0.7/type_spec/external/api/entity/create_entities.yaml

@@ -0,0 +1,33 @@
+$endpoint:
+    is_sdk: true
+    method: post
+    path: ${external}/entity/external_create_entities
+    function: main.site.app.external.entity.create_entities.create_entities
+    desc: "Creates new Uncountable entities"
+
+
+EntityToCreate:
+    type: Object
+    properties:
+        field_values?:
+            type: Optional<List<field_values.FieldRefNameValue>>
+
+Arguments:
+    type: Object
+    properties:
+        definition_id:
+            type: Integer
+            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>>
+            desc: "The type of the entities to create"
+        entities_to_create:
+            type: List<EntityToCreate>
+            desc: "A list of the entities to create"
+
+Data:
+    type: Object
+    properties:
+        entities:
+            type: List<entity.Entity>
+            desc: The entities created

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/type_spec/external/api/entity/create_entity.yaml

@@ -26,24 +26,14 @@ Arguments:
             type: Integer
             desc: "Definition id of the entity to create"
         entity_type:
-            type: Union<Literal<'lab_request'>, Literal<'approval'>, Literal<'custom_entity'>, Literal<'task'>, Literal<'project'>>
+            type: Union<Literal<entity.EntityType.lab_request>, Literal<entity.EntityType.approval>, Literal<entity.EntityType.custom_entity>, Literal<entity.EntityType.task>, Literal<entity.EntityType.project>>
             desc: "The type of the entities requested"
         field_values?:
-            type: Optional<List<EntityFieldInitialValue>>
-
-Entity:
-    type: Object
-    properties:
-        id:
-            type: Integer
-            desc: "A unique identifier for the entity.  Used in conjunction with entity type"
-        type:
-            type: String
-            desc: "The type of entity"
+            type: Optional<List<field_values.FieldRefNameValue>>
 
 Data:
     type: Object
     properties:
         entity:
-            type: Entity
+            type: entity.Entity
             desc: The entity created

UncountablePythonSDK-0.0.7/type_spec/external/api/recipes/get_recipe_links.yaml

@@ -0,0 +1,26 @@
+$endpoint:
+    is_sdk: true
+    method: get
+    path: ${external}/recipes/external_get_recipe_links
+    function: main.site.app.external.recipes.get_recipe_links.get_recipe_links
+    desc: "Gets the links for the passed recipes"
+
+Arguments:
+    type: Object
+    properties:
+        recipe_ids:
+            type: List<Integer>
+            desc: "Ids of the Recipes to retrieve links for"
+        depth:
+            type: Integer
+            desc: "How many layers deep to look for links"
+            default: 1
+        link_types:
+            type: Optional<List<recipe_links.RecipeLinkType>>
+            desc: "Optional filter to only desired link types"
+
+Data:
+    type: Object
+    properties:
+        recipe_links:
+            type: List<recipe_links.RecipeLink>

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/uncountable/types/__init__.py

@@ -8,7 +8,9 @@ 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 entity as entity_t
 from .api.batch import execute_batch as execute_batch_t
+from . import field_values as field_values_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
@@ -26,6 +28,7 @@ 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 .api.entity import list_entities as list_entities_t
+from . import recipe_links as recipe_links_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 .api.inputs import set_input_attribute_values as set_input_attribute_values_t
@@ -40,7 +43,9 @@ __all__: list[str] = [
     "create_entity_t",
     "create_inputs_t",
     "create_recipes_t",
+    "entity_t",
     "execute_batch_t",
+    "field_values_t",
     "get_curve_t",
     "get_entities_data_t",
     "get_input_data_t",
@@ -58,6 +63,7 @@ __all__: list[str] = [
     "get_recipe_output_metadata_t",
     "get_recipes_data_t",
     "list_entities_t",
+    "recipe_links_t",
     "resolve_entity_ids_t",
     "resolve_output_conditions_t",
     "set_input_attribute_values_t",

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/uncountable/types/api/entity/create_entities.py

@@ -8,16 +8,14 @@ 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",
-    "EntityFieldInitialValue",
     "EntityToCreate",
 ]
 
@@ -25,40 +23,22 @@ ENDPOINT_METHOD = "POST"
 ENDPOINT_PATH = "api/external/entity/external_create_entities"
 
 
-# DO NOT MODIFY -- This file is generated by type_spec
-@serial_class(
-    unconverted_values={"value"},
-)
-@dataclass(kw_only=True)
-class EntityFieldInitialValue:
-    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 EntityToCreate:
-    field_values: typing.Optional[typing.Optional[list[EntityFieldInitialValue]]] = None
+    field_values: typing.Optional[typing.Optional[list[field_values_t.FieldRefNameValue]]] = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Arguments:
     definition_id: int
-    entity_type: typing.Union[typing.Literal["lab_request"], typing.Literal["approval"], typing.Literal["custom_entity"], typing.Literal["task"], typing.Literal["project"]]
+    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]
 
 
-# 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 Data:
-    entities: list[Entity]
+    entities: list[entity_t.Entity]
 # DO NOT MODIFY -- This file is generated by type_spec

{UncountablePythonSDK-0.0.6 → UncountablePythonSDK-0.0.7}/uncountable/types/api/entity/create_entity.py

@@ -10,13 +10,14 @@ 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",
     "EntityFieldInitialValue",
 ]
 
@@ -39,19 +40,12 @@ class EntityFieldInitialValue:
 @dataclass(kw_only=True)
 class Arguments:
     definition_id: int
-    entity_type: typing.Union[typing.Literal["lab_request"], typing.Literal["approval"], typing.Literal["custom_entity"], typing.Literal["task"], typing.Literal["project"]]
-    field_values: typing.Optional[typing.Optional[list[EntityFieldInitialValue]]] = None
-
-
-# DO NOT MODIFY -- This file is generated by type_spec
-@dataclass(kw_only=True)
-class Entity:
-    id: int
-    type: str
+    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
 
 
 # DO NOT MODIFY -- This file is generated by type_spec
 @dataclass(kw_only=True)
 class Data:
-    entity: Entity
+    entity: entity_t.Entity
 # DO NOT MODIFY -- This file is generated by type_spec

UncountablePythonSDK-0.0.7/uncountable/types/api/recipes/get_recipe_links.py

@@ -0,0 +1,36 @@
+# 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 recipe_links as recipe_links_t
+
+__all__: list[str] = [
+    "Arguments",
+    "Data",
+    "ENDPOINT_METHOD",
+    "ENDPOINT_PATH",
+]
+
+ENDPOINT_METHOD = "GET"
+ENDPOINT_PATH = "api/external/recipes/external_get_recipe_links"
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Arguments:
+    recipe_ids: list[int]
+    depth: int = 1
+    link_types: typing.Optional[list[recipe_links_t.RecipeLinkType]]
+
+
+# DO NOT MODIFY -- This file is generated by type_spec
+@dataclass(kw_only=True)
+class Data:
+    recipe_links: list[recipe_links_t.RecipeLink]
+# DO NOT MODIFY -- This file is generated by type_spec