UncountablePythonSDK 0.0.103__tar.gz → 0.0.105__tar.gz

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/.github/workflows/documentation.yml

@@ -11,6 +11,8 @@ jobs:
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5
+        with:
+          python-version: '3.12'
       - uses: extractions/setup-crate@4993624604c307fbca528d28a3c8b60fa5ecc859 # v1
         with:
           repo: casey/just@0.10
@@ -23,7 +25,7 @@ jobs:
       - name: Install dependencies
         run: |
           # install the dependencies for the package
-          uv pip install --system .
+          uv pip install .
           # install the dependencies for building the sphinx documentation
           just -f docs/justfile docs-setup-python
       - name: Sphinx build

{uncountablepythonsdk-0.0.103/UncountablePythonSDK.egg-info → uncountablepythonsdk-0.0.105}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: UncountablePythonSDK
-Version: 0.0.103
+Version: 0.0.105
 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.103 → uncountablepythonsdk-0.0.105/UncountablePythonSDK.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: UncountablePythonSDK
-Version: 0.0.103
+Version: 0.0.105
 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.103 → uncountablepythonsdk-0.0.105}/docs/requirements.txt

@@ -1,6 +1,6 @@
 furo==2024.8.6
 myst-parser==4.0.0
-sphinx-autoapi==3.4.0
+sphinx-autoapi==3.5.0
 sphinx-copybutton==0.5.2
 Sphinx==8.1.3
 sphinx_design==0.6.1

uncountablepythonsdk-0.0.105/examples/integration-server/jobs/materials_auto/example_wh.py

@@ -0,0 +1,23 @@
+from dataclasses import dataclass
+
+from uncountable.integration.job import JobArguments, WebhookJob, register_job
+from uncountable.types import job_definition_t
+
+
+@dataclass(kw_only=True)
+class ExampleWebhookPayload:
+    id: int
+    message: str
+
+
+@register_job
+class WebhookExample(WebhookJob[ExampleWebhookPayload]):
+    def run(
+        self, args: JobArguments, payload: ExampleWebhookPayload
+    ) -> job_definition_t.JobResult:
+        args.logger.log_info(f"webhook invoked with payload: {payload}")
+        return job_definition_t.JobResult(success=True)
+
+    @property
+    def webhook_payload_type(self) -> type:
+        return ExampleWebhookPayload

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/pkgs/argument_parser/argument_parser.py

@@ -58,7 +58,9 @@ class ParserOptions:
         return self.encoding == SourceEncoding.API
 
     @property
-    def allow_direct_dataclass(self) -> bool:
+    def allow_direct_type(self) -> bool:
+        """This allows parsing from a DB column without having to check whether it's
+        the native format of the type, a JSON column, or a string encoding."""
         return self.encoding == SourceEncoding.STORAGE
 
 
@@ -97,6 +99,22 @@ def is_missing(field_type: typing.Any) -> bool:
     return not (len(args) == 0 or args[0] is not MissingSentryType)
 
 
+def _has_field_default(field: dataclasses.Field[typing.Any]) -> bool:
+    return (
+        field.default != dataclasses.MISSING
+        and not isinstance(field.default, MissingSentryType)
+    ) or field.default_factory != dataclasses.MISSING
+
+
+def _get_field_default(
+    field: dataclasses.Field[typing.Any],
+) -> typing.Any:
+    if field.default != dataclasses.MISSING:
+        return field.default
+    assert field.default_factory != dataclasses.MISSING
+    return field.default_factory()
+
+
 def _invoke_tuple_parsers[T](
     tuple_type: type[T],
     arg_parsers: typing.Sequence[typing.Callable[[typing.Any], object]],
@@ -155,7 +173,7 @@ def _build_parser_discriminated_union[T](
     discriminator_map: dict[str, ParserFunction[T]],
 ) -> ParserFunction[T]:
     def parse(value: typing.Any) -> typing.Any:
-        if context.options.allow_direct_dataclass and dataclasses.is_dataclass(value):
+        if context.options.allow_direct_type and dataclasses.is_dataclass(value):
             discriminant = getattr(value, discriminator)
         else:
             discriminant = value.get(discriminator)
@@ -318,10 +336,22 @@ def _build_parser_inner[T](
         return parse_int
 
     if parsed_type is datetime:
-        return lambda value: dateutil.parser.isoparse(value)  # type:ignore
+
+        def parse_datetime(value: typing.Any) -> T:
+            if context.options.allow_direct_type and isinstance(value, datetime):
+                return value  # type: ignore
+            return dateutil.parser.isoparse(value)  # type:ignore
+
+        return parse_datetime
 
     if parsed_type is date:
-        return lambda value: date.fromisoformat(value)  # type:ignore
+
+        def parse_date(value: typing.Any) -> T:
+            if context.options.allow_direct_type and isinstance(value, date):
+                return value  # type:ignore
+            return date.fromisoformat(value)  # type:ignore
+
+        return parse_date
 
     # MyPy: It's unclear why `parsed_type in (str, OpaqueKey)` is flagged as invalid
     # Thus an or statement is used instead, which isn't flagged as invalid.
@@ -405,7 +435,7 @@ def _build_parser_dataclass[T](
 
     def parse(value: typing.Any) -> typing.Any:
         # Use an exact type match to prevent base/derived class mismatches
-        if context.options.allow_direct_dataclass and type(value) is parsed_type:
+        if context.options.allow_direct_type and type(value) is parsed_type:
             return value
 
         data: dict[typing.Any, typing.Any] = {}
@@ -420,10 +450,8 @@ def _build_parser_dataclass[T](
                 if field_raw_value == dataclasses.MISSING:
                     if serial_class_data.has_parse_require(field.name):
                         raise ValueError("missing-required-field", field.name)
-                    if field.default != dataclasses.MISSING:
-                        field_value = field.default
-                    elif field.default_factory != dataclasses.MISSING:
-                        field_value = field.default_factory()
+                    if _has_field_default(field):
+                        field_value = _get_field_default(field)
                     elif is_missing(field_type):
                         field_value = MissingSentryType()
                     elif is_optional(field_type):
@@ -435,6 +463,13 @@ def _build_parser_dataclass[T](
                         field_value = False
                     else:
                         raise ValueError("missing-value-for-field", field.name)
+                elif (
+                    field_raw_value is None
+                    and not is_optional(field_type)
+                    and _has_field_default(field)
+                    and not serial_class_data.has_parse_require(field.name)
+                ):
+                    field_value = _get_field_default(field)
                 elif serial_class_data.has_unconverted_value(field.name):
                     field_value = field_raw_value
                 else:

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/pkgs/serialization/serial_class.py

@@ -17,6 +17,7 @@ class _SerialClassData(SerialBase):
     to_string_values: set[str] = dataclasses.field(default_factory=set)
     parse_require: set[str] = dataclasses.field(default_factory=set)
     named_type_path: str | None = None
+    explicit_defaults: set[str] = dataclasses.field(default_factory=set)
 
 
 EMPTY_SERIAL_CLASS_DATA = _SerialClassData()
@@ -30,6 +31,7 @@ def serial_class(
     parse_require: set[str] | None = None,
     named_type_path: str | None = None,
     is_dynamic_allowed: bool = False,
+    explicit_defaults: set[str] | None = None,
 ) -> Callable[[ClassT], ClassT]:
     """
     An additional decorator to a dataclass that specifies serialization options.
@@ -52,6 +54,9 @@ def serial_class(
         requiring them for the API input.
     @param named_type_path
         The type_spec type-path to this type. This applies only to named types.
+    @param explicit_defaults
+        Fields that have explicit defaults in the definition. This is useful for
+        falling back onto these defaults when the field is mandatory but receives a null value.
     """
 
     def decorate(orig_class: ClassT) -> ClassT:
@@ -63,6 +68,7 @@ def serial_class(
             named_type_path=named_type_path,
             from_decorator=True,
             is_dynamic_allowed=is_dynamic_allowed,
+            explicit_defaults=explicit_defaults or set(),
         )
         return orig_class
 
@@ -90,6 +96,9 @@ class SerialClassDataInspector(SerialInspector[ClassT]):
     def has_parse_require(self, key: str) -> bool:
         return key in self.current.parse_require
 
+    def has_explicit_default(self, key: str) -> bool:
+        return key in self.current.explicit_defaults
+
 
 def get_merged_serial_class_data(type_class: type[Any]) -> _SerialClassData | None:
     base_class_data = (
@@ -115,6 +124,8 @@ def get_merged_serial_class_data(type_class: type[Any]) -> _SerialClassData | No
                     | curr_base_class_data.to_string_values,
                     parse_require=base_class_data.parse_require
                     | curr_base_class_data.parse_require,
+                    explicit_defaults=base_class_data.explicit_defaults
+                    | curr_base_class_data.explicit_defaults,
                 )
     return base_class_data
 

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/pkgs/type_spec/builder.py

@@ -62,6 +62,7 @@ class SpecProperty:
     # Holds extra information that will be emitted along with type_info. The builder knows nothing
     # about the contents of this information.
     ext_info: Any = None
+    explicit_default: bool = False
 
 
 class NameCase(StrEnum):
@@ -389,6 +390,7 @@ class SpecTypeDefn(SpecType):
             ptype = builder.parse_type(self.namespace, data_type, scope=self)
 
             default_spec = data.get("default", MISSING)
+            explicit_default = default_spec != MISSING
             if default_spec == MISSING:
                 has_default = False
                 default = None
@@ -396,7 +398,10 @@ class SpecTypeDefn(SpecType):
                 has_default = True
                 # IMPROVE: check the type against the ptype
                 default = default_spec
-
+            if extant == PropertyExtant.missing and explicit_default:
+                raise Exception(
+                    f"cannot have extant missing and default for property {name}"
+                )
             parse_require = False
             literal = unwrap_literal_type(ptype)
             if literal is not None:
@@ -419,6 +424,7 @@ class SpecTypeDefn(SpecType):
                 parse_require=parse_require,
                 desc=data.get("desc", None),
                 ext_info=ext_info,
+                explicit_default=explicit_default,
             )
         finally:
             builder.pop_where()

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/pkgs/type_spec/emit_python.py

@@ -697,6 +697,7 @@ class EmittedPropertiesMetadata:
     unconverted_values: set[str]
     to_string_values: set[str]
     parse_require: set[str]
+    explicit_defaults: set[str]
 
 
 def _emit_type_properties(
@@ -728,6 +729,7 @@ def _emit_properties(
     unconverted_values: set[str] = set()
     to_string_values: set[str] = set()
     parse_require: set[str] = set()
+    explicit_defaults: set[str] = set()
 
     if len(properties) > 0:
 
@@ -748,6 +750,9 @@ def _emit_properties(
             if prop.parse_require:
                 parse_require.add(py_name)
 
+            if prop.explicit_default:
+                explicit_defaults.add(py_name)
+
             ref_type = refer_to(ctx, stype)
             default = None
             if prop.extant == builder.PropertyExtant.missing:
@@ -791,6 +796,7 @@ def _emit_properties(
         unconverted_values=unconverted_values,
         to_string_values=to_string_values,
         parse_require=parse_require,
+        explicit_defaults=explicit_defaults,
     )
 
 
@@ -881,6 +887,7 @@ def _emit_type(ctx: Context, stype: builder.SpecType) -> None:
     unconverted_values = emitted_properties_metadata.unconverted_values
     to_string_values = emitted_properties_metadata.to_string_values
     parse_require = emitted_properties_metadata.parse_require
+    explicit_defaults = emitted_properties_metadata.explicit_defaults
 
     _emit_generics(ctx, generics)
 
@@ -902,6 +909,7 @@ def _emit_type(ctx: Context, stype: builder.SpecType) -> None:
     write_values("unconverted_values", unconverted_values)
     write_values("to_string_values", to_string_values)
     write_values("parse_require", parse_require)
+    write_values("explicit_defaults", explicit_defaults)
 
     ctx.out.write(")\n")
 

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/pkgs/type_spec/value_spec/__main__.py

@@ -155,6 +155,7 @@ key_return = "return"
 key_description = "description"
 key_brief = "brief"
 key_name = "name"
+key_draft = "draft"
 
 
 TypeT = TypeVar("TypeT")
@@ -229,6 +230,11 @@ def main() -> None:
 
             brief = get_as(spec, key_brief, str)
             description = get_as(spec, key_description, str)
+            draft = (
+                get_as(spec, key_draft, bool)
+                if spec.get(key_draft) is not None
+                else None
+            )
 
             return_value = get(spec, key_return)
             where.append("return")
@@ -245,6 +251,7 @@ def main() -> None:
                         type=convert_to_value_spec_type(parsed.return_type_path),
                         description=return_description,
                     ),
+                    draft=draft,
                 )
             )
             where.pop()

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/pkgs/type_spec/value_spec/emit_python.py

@@ -164,6 +164,8 @@ def _emit_function(function: value_spec_t.Function, indent: str) -> str:
         f"{sub_indent}description={encode_common_string(function.description)},\n"
     )
     out.write(f"{sub_indent}brief={encode_common_string(function.brief)},\n")
+    if function.draft:
+        out.write(f"{sub_indent}draft={function.draft},\n")
     out.write(
         f"{sub_indent}return_value={_emit_function_return(function.return_value, sub_indent)},\n"
     )

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/integration/job.py

@@ -85,3 +85,9 @@ class WebhookJob[WPT](Job[webhook_job_t.WebhookEventPayload]):
 def register_job(cls: type[Job]) -> type[Job]:
     cls._unc_job_registered = True
     return cls
+
+
+class RunsheetWebhookJob(WebhookJob[webhook_job_t.RunsheetWebhookPayload]):
+    @property
+    def webhook_payload_type(self) -> type:
+        return webhook_job_t.RunsheetWebhookPayload

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/types/api/entity/lookup_entity.py

@@ -13,6 +13,7 @@ from pkgs.serialization import serial_union_annotation
 from ... import async_batch_t
 from ... import base_t
 from ... import entity_t
+from ... import field_values_t
 from ... import identifier_t
 
 __all__: list[str] = [
@@ -49,11 +50,13 @@ class LookupEntityQueryBase:
 @serial_class(
     named_type_path="sdk.api.entity.lookup_entity.LookupFieldArgumentValue",
     unconverted_values={"field_value"},
+    explicit_defaults={"value_resolution"},
 )
 @dataclasses.dataclass(kw_only=True)
 class LookupFieldArgumentValue:
     field_key: identifier_t.IdentifierKey
     field_value: base_t.JsonValue
+    value_resolution: field_values_t.ValueResolution = field_values_t.ValueResolution.DIRECT
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/types/api/recipes/add_time_series_data.py

@@ -45,6 +45,7 @@ class TimeSeriesDatum:
 # DO NOT MODIFY -- This file is generated by type_spec
 @serial_class(
     named_type_path="sdk.api.recipes.add_time_series_data.Arguments",
+    explicit_defaults={"on_conflict"},
 )
 @dataclasses.dataclass(kw_only=True)
 class Arguments:

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/types/api/recipes/edit_recipe_inputs.py

@@ -81,6 +81,7 @@ class RecipeInputEditClearInputs(RecipeInputEditBase):
 @serial_class(
     named_type_path="sdk.api.recipes.edit_recipe_inputs.RecipeInputEditInputBase",
     to_string_values={"value_numeric"},
+    explicit_defaults={"input_value_type", "quantity_basis"},
 )
 @dataclasses.dataclass(kw_only=True)
 class RecipeInputEditInputBase(RecipeInputEditBase):
@@ -196,6 +197,7 @@ class PlaceholderDisplayMode(StrEnum):
 # DO NOT MODIFY -- This file is generated by type_spec
 @serial_class(
     named_type_path="sdk.api.recipes.edit_recipe_inputs.PlaceholderBase",
+    explicit_defaults={"display_mode", "require_for_creation"},
 )
 @dataclasses.dataclass(kw_only=True)
 class PlaceholderBase:

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/types/api/recipes/get_recipe_links.py

@@ -25,6 +25,7 @@ ENDPOINT_PATH = "api/external/recipes/external_get_recipe_links"
 # DO NOT MODIFY -- This file is generated by type_spec
 @serial_class(
     named_type_path="sdk.api.recipes.get_recipe_links.Arguments",
+    explicit_defaults={"depth"},
 )
 @dataclasses.dataclass(kw_only=True)
 class Arguments:

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/types/api/recipes/lock_recipes.py

@@ -42,6 +42,7 @@ class RecipeLockBase:
 # DO NOT MODIFY -- This file is generated by type_spec
 @serial_class(
     named_type_path="sdk.api.recipes.lock_recipes.Arguments",
+    explicit_defaults={"type"},
 )
 @dataclasses.dataclass(kw_only=True)
 class Arguments:

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/types/api/recipes/set_recipe_outputs.py

@@ -48,6 +48,7 @@ class NullBehavior(StrEnum):
 @serial_class(
     named_type_path="sdk.api.recipes.set_recipe_outputs.RecipeOutputValue",
     to_string_values={"value_numeric"},
+    explicit_defaults={"null_behavior"},
 )
 @dataclasses.dataclass(kw_only=True)
 class RecipeOutputValue:

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/types/api/recipes/unlock_recipes.py

@@ -31,6 +31,7 @@ class RecipeUnlockType(StrEnum):
 # DO NOT MODIFY -- This file is generated by type_spec
 @serial_class(
     named_type_path="sdk.api.recipes.unlock_recipes.Arguments",
+    explicit_defaults={"type"},
 )
 @dataclasses.dataclass(kw_only=True)
 class Arguments:

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/types/client_base.py

@@ -57,6 +57,7 @@ import uncountable.types.api.entity.list_entities as list_entities_t
 import uncountable.types.api.id_source.list_id_source as list_id_source_t
 import uncountable.types.api.entity.lock_entity as lock_entity_t
 import uncountable.types.api.recipes.lock_recipes as lock_recipes_t
+import uncountable.types.api.entity.lookup_entity as lookup_entity_t
 import uncountable.types.api.id_source.match_id_source as match_id_source_t
 from uncountable.types import permissions_t
 from uncountable.types import post_base_t
@@ -1127,6 +1128,26 @@ class ClientMethods(ABC):
         )
         return self.do_request(api_request=api_request, return_type=lock_recipes_t.Data)
 
+    def lookup_entity(
+        self,
+        *,
+        entity_type: entity_t.EntityType,
+        query: lookup_entity_t.LookupEntityQuery,
+    ) -> lookup_entity_t.Data:
+        """Look up an entity based on an identifier or field values
+
+        """
+        args = lookup_entity_t.Arguments(
+            entity_type=entity_type,
+            query=query,
+        )
+        api_request = APIRequest(
+            method=lookup_entity_t.ENDPOINT_METHOD,
+            endpoint=lookup_entity_t.ENDPOINT_PATH,
+            args=args,
+        )
+        return self.do_request(api_request=api_request, return_type=lookup_entity_t.Data)
+
     def match_id_source(
         self,
         *,

{uncountablepythonsdk-0.0.103 → uncountablepythonsdk-0.0.105}/uncountable/types/client_config_t.py

@@ -17,6 +17,7 @@ __all__: list[str] = [
 # DO NOT MODIFY -- This file is generated by type_spec
 @serial_class(
     named_type_path="sdk.client_config.ClientConfigOptions",
+    explicit_defaults={"allow_insecure_tls"},
 )
 @dataclasses.dataclass(kw_only=True)
 class ClientConfigOptions: