UncountablePythonSDK 0.0.82__py3-none-any.whl → 0.0.132__py3-none-any.whl

examples/integration-server/jobs/materials_auto/example_parse.py

@@ -0,0 +1,140 @@
+from dataclasses import dataclass
+from decimal import Decimal
+
+from uncountable.integration.job import JobArguments, WebhookJob, register_job
+from uncountable.types import (
+    base_t,
+    entity_t,
+    generic_upload_t,
+    identifier_t,
+    job_definition_t,
+    notifications_t,
+    uploader_t,
+)
+
+
+@dataclass(kw_only=True)
+class ParsePayload:
+    async_job_id: base_t.ObjectId
+
+
+@register_job
+class ParseExample(WebhookJob[ParsePayload]):
+    def run(
+        self, args: JobArguments, payload: ParsePayload
+    ) -> job_definition_t.JobResult:
+        user_id: base_t.ObjectId | None = None
+        recipe_id: base_t.ObjectId | None = None
+        file_name: str | None = None
+        data = args.client.get_entities_data(
+            entity_ids=[payload.async_job_id], entity_type=entity_t.EntityType.ASYNC_JOB
+        )
+        for field_value in data.entity_details[0].field_values:
+            if field_value.field_ref_name == "core_async_job_jobData":
+                assert isinstance(field_value.value, dict)
+                assert isinstance(field_value.value["user_id"], int)
+                user_id = field_value.value["user_id"]
+            elif (
+                field_value.field_ref_name
+                == "unc_async_job_custom_parser_recipe_ids_in_view"
+            ):
+                if field_value.value is None:
+                    continue
+                assert isinstance(field_value.value, list)
+                if len(field_value.value) > 0:
+                    assert isinstance(field_value.value[0], int)
+                    recipe_id = field_value.value[0]
+            elif field_value.field_ref_name == "unc_async_job_custom_parser_input_file":
+                assert isinstance(field_value.value, list)
+                assert len(field_value.value) == 1
+                assert isinstance(field_value.value[0], dict)
+                assert isinstance(field_value.value[0]["name"], str)
+                file_name = field_value.value[0]["name"]
+
+        assert user_id is not None
+        assert file_name is not None
+
+        dummy_parsed_file_data: list[uploader_t.ParsedFileData] = [
+            uploader_t.ParsedFileData(
+                file_name=file_name,
+                file_structures=[
+                    uploader_t.DataChannel(
+                        type=uploader_t.StructureElementType.CHANNEL,
+                        channel=uploader_t.TextChannelData(
+                            name="column1",
+                            type=uploader_t.ChannelType.TEXT_CHANNEL,
+                            data=[
+                                uploader_t.StringValue(value="value1"),
+                                uploader_t.StringValue(value="value4"),
+                                uploader_t.StringValue(value="value7"),
+                            ],
+                        ),
+                    ),
+                    uploader_t.DataChannel(
+                        type=uploader_t.StructureElementType.CHANNEL,
+                        channel=uploader_t.TextChannelData(
+                            name="column2",
+                            type=uploader_t.ChannelType.TEXT_CHANNEL,
+                            data=[
+                                uploader_t.StringValue(value="value2"),
+                                uploader_t.StringValue(value="value5"),
+                                uploader_t.StringValue(value="value8"),
+                            ],
+                        ),
+                    ),
+                    uploader_t.DataChannel(
+                        type=uploader_t.StructureElementType.CHANNEL,
+                        channel=uploader_t.TextChannelData(
+                            name="column3",
+                            type=uploader_t.ChannelType.TEXT_CHANNEL,
+                            data=[
+                                uploader_t.StringValue(value="value3"),
+                                uploader_t.StringValue(value="value6"),
+                                uploader_t.StringValue(value="value9"),
+                            ],
+                        ),
+                    ),
+                    uploader_t.HeaderEntry(
+                        type=uploader_t.StructureElementType.HEADER,
+                        value=uploader_t.TextHeaderData(
+                            name="file_source",
+                            type=uploader_t.HeaderType.TEXT_HEADER,
+                            data=uploader_t.StringValue(value="my_file_to_upload.xlsx"),
+                        ),
+                    ),
+                    uploader_t.HeaderEntry(
+                        type=uploader_t.StructureElementType.HEADER,
+                        value=uploader_t.NumericHeaderData(
+                            name="file structure number",
+                            data=uploader_t.DecimalValue(value=Decimal(99)),
+                        ),
+                    ),
+                ],
+            )
+        ]
+
+        complete_async_parse_req = args.batch_processor.complete_async_parse(
+            parsed_file_data=dummy_parsed_file_data,
+            async_job_key=identifier_t.IdentifierKeyId(id=payload.async_job_id),
+            upload_destination=generic_upload_t.UploadDestinationRecipe(
+                recipe_key=identifier_t.IdentifierKeyId(id=recipe_id or 1)
+            ),
+        )
+
+        args.batch_processor.push_notification(
+            depends_on=[complete_async_parse_req.batch_reference],
+            notification_targets=[
+                notifications_t.NotificationTargetUser(
+                    user_key=identifier_t.IdentifierKeyId(id=user_id)
+                )
+            ],
+            subject="Upload complete",
+            message="Your file has been uploaded",
+            display_notice=True,
+        )
+
+        return job_definition_t.JobResult(success=True)
+
+    @property
+    def webhook_payload_type(self) -> type:
+        return ParsePayload

examples/integration-server/jobs/materials_auto/example_predictions.py

@@ -0,0 +1,61 @@
+import random
+from dataclasses import dataclass
+from datetime import UTC, datetime
+from decimal import Decimal
+
+from uncountable.integration.job import JobArguments, WebhookJob, register_job
+from uncountable.types import (
+    base_t,
+    identifier_t,
+    job_definition_t,
+    recipe_links_t,
+    set_recipe_outputs_t,
+)
+
+
+@dataclass(kw_only=True)
+class PredictionsPayload:
+    output_id: base_t.ObjectId
+    recipe_ids: list[base_t.ObjectId]
+
+
+@register_job
+class PredictionsExample(WebhookJob[PredictionsPayload]):
+    def run(
+        self, args: JobArguments, payload: PredictionsPayload
+    ) -> job_definition_t.JobResult:
+        recipe_data = args.client.get_recipes_data(recipe_ids=payload.recipe_ids)
+        formatted_datetime = datetime.now(UTC).strftime("%Y-%m-%d %H:%M:%S")
+
+        for recipe in recipe_data.recipes:
+            test_sample_name = f"Predictions Model ({formatted_datetime})"
+            created_recipe_id = args.client.create_recipe(
+                name=test_sample_name,
+                material_family_id=1,
+                workflow_id=1,
+                definition_key=identifier_t.IdentifierKeyRefName(
+                    ref_name="unc_test_sample"
+                ),
+            ).result_id
+            args.client.set_recipe_outputs(
+                output_data=[
+                    set_recipe_outputs_t.RecipeOutputValue(
+                        recipe_id=created_recipe_id,
+                        output_id=payload.output_id,
+                        experiment_num=1,
+                        value_numeric=Decimal(random.random() * 10),
+                    )
+                ]
+            )
+            args.client.create_recipe_link(
+                recipe_from_key=identifier_t.IdentifierKeyId(id=recipe.recipe_id),
+                recipe_to_key=identifier_t.IdentifierKeyId(id=created_recipe_id),
+                link_type=recipe_links_t.RecipeLinkType.CHILD,
+                name=test_sample_name,
+            )
+
+        return job_definition_t.JobResult(success=True)
+
+    @property
+    def webhook_payload_type(self) -> type:
+        return PredictionsPayload

examples/integration-server/jobs/materials_auto/example_runsheet_wh.py

@@ -0,0 +1,39 @@
+from io import BytesIO
+
+from uncountable.core.file_upload import DataFileUpload, FileUpload
+from uncountable.integration.job import JobArguments, RunsheetWebhookJob, register_job
+from uncountable.types import (
+    download_file_t,
+    entity_t,
+    identifier_t,
+    webhook_job_t,
+)
+
+
+@register_job
+class StandardRunsheetGenerator(RunsheetWebhookJob):
+    def build_runsheet(
+        self,
+        *,
+        args: JobArguments,
+        payload: webhook_job_t.RunsheetWebhookPayload,
+    ) -> FileUpload:
+        args.logger.log_info("Retrieving pre-exported runsheet file from async job")
+
+        file_query = download_file_t.FileDownloadQueryEntityField(
+            entity=entity_t.EntityIdentifier(
+                type=entity_t.EntityType.ASYNC_JOB,
+                identifier_key=identifier_t.IdentifierKeyId(id=payload.async_job_id),
+            ),
+            field_key=identifier_t.IdentifierKeyRefName(
+                ref_name="unc_async_job_export_runsheet_recipe_export"
+            ),
+        )
+
+        downloaded_files = args.client.download_files(file_query=file_query)
+
+        file_data = downloaded_files[0].data.read()
+        return DataFileUpload(
+            data=BytesIO(file_data),
+            name=downloaded_files[0].name,
+        )

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

@@ -1,15 +1,23 @@
-import typing
+from dataclasses import dataclass
 
 from uncountable.integration.job import JobArguments, WebhookJob, register_job
-from uncountable.types.job_definition_t import JobResult
+from uncountable.types import job_definition_t
 
 
-@register_job
-class WebhookExample(WebhookJob):
-    @property
-    def payload_type(self) -> typing.Any:
-        return super().payload_type
+@dataclass(kw_only=True)
+class ExampleWebhookPayload:
+    id: int
+    message: str
+
 
-    def run(self, args: JobArguments, payload: typing.Any) -> JobResult:
+@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 JobResult(success=True)
+        return job_definition_t.JobResult(success=True)
+
+    @property
+    def webhook_payload_type(self) -> type:
+        return ExampleWebhookPayload

examples/integration-server/jobs/materials_auto/profile.yaml

@@ -22,6 +22,25 @@ jobs:
         - admin:
           type: ref_name
           ref_name: admin
+  - id: concurrent_cron_1
+    enabled: true
+    type: cron
+    name: MyConcurrentCron - 1
+    cron_spec: "* * * * *"
+    executor:
+      type: script
+      import_path: concurrent_cron
+    subqueue_name: subqueue_1
+  - id: concurrent_cron_2
+    enabled: true
+    type: cron
+    name: MyConcurrentCron - 2
+    cron_spec: "* * * * *"
+    executor:
+      type: script
+      import_path: concurrent_cron
+    subqueue_name: subqueue_2
+
 
   - id: example_wh1
     type: webhook
@@ -41,3 +60,45 @@ jobs:
     executor:
       type: script
       import_path: example_wh
+  - id: example_http
+    type: custom_http
+    name: Custom HTTP
+    executor:
+      type: script
+      import_path: example_http
+  - id: example_runsheet_wh
+    type: webhook
+    name: Runsheet Webhook
+    signature_key_secret:
+      type: env
+      env_key: WH_RUNSHEET_SIGNATURE_KEY
+    executor:
+      type: script
+      import_path: example_runsheet_wh
+  - id: example_instrument
+    type: webhook
+    name: Webhook Instrument Connection
+    signature_key_secret:
+      type: env
+      env_key: WH_INSTRUMENT_SIGNATURE_KEY
+    executor:
+      type: script
+      import_path: example_instrument
+  - id: example_predictions
+    type: webhook
+    name: Webook Predictions
+    signature_key_secret:
+      type: env
+      env_key: WH_PREDICTIONS_SIGNATURE_KEY
+    executor:
+      type: script
+      import_path: example_predictions
+  - id: example_parse
+    type: webhook
+    name: Webhook Parse
+    signature_key_secret:
+      type: env
+      env_key: WH_PARSE_SIGNATURE_KEY
+    executor:
+      type: script
+      import_path: example_parse

examples/integration-server/pyproject.toml

@@ -9,14 +9,16 @@ dependencies = [
   "ruff == 0.*",
   "openpyxl == 3.*",
   "more_itertools == 10.*",
-  "types-paramiko ==3.5.0.20240918",
+  "types-paramiko ==4.0.0.20250822",
   "types-openpyxl == 3.*",
   "types-pysftp == 0.*",
-  "types-pytz == 2024.*",
+  "types-pytz ==2025.*",
   "types-requests == 2.*",
   "types-simplejson == 3.*",
   "pandas-stubs",
-  "xlrd == 2.*"
+  "xlrd == 2.*",
+  "msgspec == 0.19.*",
+  "websockets==15.0.1",
 ]
 
 [tool.mypy]
@@ -113,7 +115,6 @@ lint.ignore = [
     "PD010", # .pivottable.  Should add
     "PD011", # use .to_numpy.  Skip
     "PD015", # use .merge.  Should add
-    "PD901", # avoid generic df name.  Skip
     "PERF203", # avoid try except in loop. Skip
     "PERF401", # use list comprehension. Skip
     "PERF402", # use list.copy.  Skip
@@ -173,9 +174,9 @@ lint.ignore = [
     "SLOT000", # subclass of string should define slot.  should add
     "T201", # print.  skip
     "T203", # pprint.  skip
-    "TCH001", # move application import into type checking.  skip
-    "TCH002", # move third party import into type checking.  consider
-    "TCH003", # move library into type checking lbock.  consider
+    "TC001", # move application import into type checking.  skip
+    "TC002", # move third party import into type checking.  consider
+    "TC003", # move library into type checking lbock.  consider
     "TD",  # todo comments.  skip
     "TID252", # eliminate relative imports from parents.  skip
     "TRY002", # create your own exception. skip
@@ -193,11 +194,10 @@ lint.ignore = [
     "RUF022",  # __all__ is not sorted.  skip due to isort complication
     "UP017", # use datetime.UTC, TODO add back in
     "UP035", # replacing List with list, TODO add back in
-    "UP038", # isinstance X | Y instead of (X, Y), TODO add back in
     # ## FROM RUFF UPGRADE
     "PLC2701",  # private name imports.  should add
     "PLR1702",  # too many nested blocks -- add with config.  skip
-    "RUF025",  # unnecessary dict comprehension.  skip
+    "C420",  # unnecessary dict comprehension.  skip
     "SIM113",  # index variable should use enumerate.  should add.
     "PLR0914"  # too many local variables.  configure below.  should add with config
 ]
@@ -212,6 +212,7 @@ exclude = [
 
 [tool.ruff.lint.isort]
 split-on-trailing-comma = true
+known-first-party = ["pkgs"]
 
 [tool.ruff.lint.mccabe]
 max-complexity = 130 # goal would be to bring this down to ~50 or so
@@ -221,4 +222,3 @@ max-locals=50
 
 [tool.setuptools]
 py-modules = []
-

examples/oauth.py

@@ -0,0 +1,7 @@
+from uncountable.core.client import Client
+from uncountable.core.types import AuthDetailsOAuth
+
+client = Client(
+    base_url="https://app.uncountable.com",
+    auth_details=AuthDetailsOAuth(refresh_token="x"),
+)

examples/set_recipe_metadata_file.py

@@ -18,7 +18,7 @@ client = Client(
 )
 uploaded_file = client.upload_files(
     file_uploads=[
-        MediaFileUpload(path="/home/logan/Downloads/my_file_to_upload.csv"),
+        MediaFileUpload(path="Downloads/my_file_to_upload.csv"),
     ]
 )[0]
 

examples/upload_files.py

@@ -12,8 +12,7 @@ client = Client(
 )
 uploaded = client.upload_files(
     file_uploads=[
-        MediaFileUpload(path="/my/file/path.doc"),
-        MediaFileUpload(path="/my/file/path2.doc"),
+        MediaFileUpload(path="Downloads/file"),
     ]
 )
 pprint(uploaded)

pkgs/argument_parser/__init__.py

@@ -1,7 +1,15 @@
+from ._is_enum import is_string_enum_class as is_string_enum_class
 from .argument_parser import CachedParser as CachedParser
+from .argument_parser import ParserBase as ParserBase
+from .argument_parser import ParserError as ParserError
+from .argument_parser import ParserExtraFieldsError as ParserExtraFieldsError
 from .argument_parser import ParserFunction as ParserFunction
 from .argument_parser import ParserOptions as ParserOptions
+from .argument_parser import SourceEncoding as SourceEncoding
 from .argument_parser import build_parser as build_parser
+from .argument_parser import is_missing as is_missing
+from .argument_parser import is_optional as is_optional
+from .argument_parser import is_union as is_union
 from .case_convert import camel_to_snake_case as camel_to_snake_case
 from .case_convert import kebab_to_pascal_case as kebab_to_pascal_case
 from .case_convert import snake_to_camel_case as snake_to_camel_case

pkgs/argument_parser/_is_namedtuple.py

@@ -5,6 +5,9 @@ def is_namedtuple_type(x: Any) -> bool:
     if not hasattr(x, "__annotations__"):
         return False
 
+    if not hasattr(x, "__bases__"):
+        return False
+
     b = x.__bases__
     if len(b) != 1 or b[0] is not tuple:
         return False