UncountablePythonSDK 0.0.184__py3-none-any.whl → 0.0.185__py3-none-any.whl

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

@@ -0,0 +1,44 @@
+import json
+
+from uncountable.integration.http_server import (
+    GenericHttpRequest,
+    GenericHttpResponse,
+    HttpException,
+)
+from uncountable.integration.job import CustomHttpJob, register_job
+from uncountable.types import job_definition_t
+
+_EXPECTED_USER_ID = 1
+
+
+@register_job
+class HttpGetExample(CustomHttpJob):
+    @staticmethod
+    def validate_request(
+        *,
+        request: GenericHttpRequest,
+        job_definition: job_definition_t.HttpJobDefinitionBase,  # ruff:ignore[unused-static-method-argument]
+        profile_meta: job_definition_t.ProfileMetadata,
+    ) -> None:
+        if (
+            CustomHttpJob.get_validated_oauth_request_user_id(
+                request=request, profile_metadata=profile_meta
+            )
+            != _EXPECTED_USER_ID
+        ):
+            raise HttpException(
+                message="unauthorized; invalid oauth token", error_code=401
+            )
+
+    @staticmethod
+    def handle_request(
+        *,
+        request: GenericHttpRequest,
+        job_definition: job_definition_t.HttpJobDefinitionBase,  # ruff:ignore[unused-static-method-argument]
+        profile_meta: job_definition_t.ProfileMetadata,  # ruff:ignore[unused-static-method-argument]
+    ) -> GenericHttpResponse:
+        return GenericHttpResponse(
+            response=json.dumps(request.query_params),
+            status_code=200,
+            headers={"Content-Type": "application/json"},
+        )

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

@@ -74,6 +74,13 @@ jobs:
     executor:
       type: script
       import_path: example_http
+  - id: example_http_get
+    type: custom_http
+    name: Custom HTTP GET
+    http_method: get
+    executor:
+      type: script
+      import_path: example_http_get
   - id: example_runsheet_wh
     type: webhook
     name: Runsheet Webhook

pkgs/serialization_util/serialization_helpers.py

@@ -210,8 +210,7 @@ def serialize_for_api(obj: Any) -> JsonValue:
         serialization_type == SerializationType.UNKNOWN
     ):  # performance optimization to not do function lookup
         return obj  # type: ignore
-    r = _CONVERSION_SERIALIZATION_FUNCS[serialization_type](obj)
-    return r
+    return _CONVERSION_SERIALIZATION_FUNCS[serialization_type](obj)
 
 
 _SERIALIZATION_FUNCS_DICT: dict[

uncountable/integration/http_server/types.py

@@ -68,6 +68,7 @@ class HttpException(Exception):
 class GenericHttpRequest:
     body_base64: str
     headers: dict[str, str]
+    query_params: dict[str, list[str]]
 
     @functools.cached_property
     def body_bytes(self) -> bytes:

uncountable/integration/webhook_server/entrypoint.py

@@ -1,4 +1,5 @@
 import base64
+from typing import assert_never
 
 import flask
 from flask.typing import ResponseReturnValue
@@ -16,12 +17,31 @@ from uncountable.types import job_definition_t
 
 app = flask.Flask(__name__)
 
+HttpJobDefinition = (
+    job_definition_t.CustomHttpJobDefinition
+    | job_definition_t.WebhookJobDefinition
+    | job_definition_t.UncountableWebhookJobDefinition
+)
+
+
+def _resolve_route_http_method(job: HttpJobDefinition) -> job_definition_t.HttpMethod:
+    match job:
+        case job_definition_t.CustomHttpJobDefinition():
+            return job.http_method
+        case (
+            job_definition_t.WebhookJobDefinition()
+            | job_definition_t.UncountableWebhookJobDefinition()
+        ):
+            return job_definition_t.HttpMethod.POST
+        case _:
+            assert_never(job)
+
 
 def register_route(
     *,
     server_logger: Logger,
     profile_meta: job_definition_t.ProfileMetadata,
-    job: job_definition_t.HttpJobDefinitionBase,
+    job: HttpJobDefinition,
 ) -> None:
     route = f"/{profile_meta.name}/{job.id}"
     log_attributes = {
@@ -56,6 +76,7 @@ def register_route(
                 http_request = GenericHttpRequest(
                     body_base64=base64.b64encode(flask.request.get_data()).decode(),
                     headers=dict(flask.request.headers),
+                    query_params=flask.request.args.to_dict(flat=False),
                 )
                 job_instance.validate_request(
                     request=http_request, job_definition=job, profile_meta=profile_meta
@@ -88,7 +109,7 @@ def register_route(
         route,
         endpoint=f"handle_request_{job.id}",
         view_func=handle_request,
-        methods=["POST"],
+        methods=[_resolve_route_http_method(job).value.upper()],
     )
 
     server_logger.log_debug(
@@ -103,10 +124,21 @@ def main() -> None:
     for profile_metadata in profiles:
         server_logger = Logger(get_current_span())
         for job in profile_metadata.jobs:
-            if isinstance(job, job_definition_t.HttpJobDefinitionBase):
-                register_route(
-                    server_logger=server_logger, profile_meta=profile_metadata, job=job
-                )
+            match job:
+                case job_definition_t.CronJobDefinition():
+                    continue
+                case (
+                    job_definition_t.CustomHttpJobDefinition()
+                    | job_definition_t.WebhookJobDefinition()
+                    | job_definition_t.UncountableWebhookJobDefinition()
+                ):
+                    register_route(
+                        server_logger=server_logger,
+                        profile_meta=profile_metadata,
+                        job=job,
+                    )
+                case _:
+                    assert_never(job)
 
 
 main()

uncountable/types/api/files/download_file.py

@@ -30,7 +30,7 @@ __all__: list[str] = [
 
 ENDPOINT_METHOD = "GET"
 ENDPOINT_PATH = "api/external/files/download_file"
-ENDPOINT_DESCRIPTION = "Download an attachment field value from an entity (e.g. a file attached to a form field) by entity + field reference, or download a text document by its ID. When querying by entity field, if the field contains a single file it is returned directly (X-File-Download-Type: raw); if multiple files are attached, they are bundled into a ZIP archive (X-File-Download-Type: archive). For downloading the binary file stored on a recipe output of type image or file, use recipes/external_download_recipe_output_file instead."
+ENDPOINT_DESCRIPTION = "Download an attachment field value from an entity (e.g. a file attached to a form field) by entity + field reference, or download a text document by its ID. When querying by entity field, if the field contains a single file it is returned directly (X-File-Download-Type: raw); if multiple files are attached, they are bundled into a ZIP archive (X-File-Download-Type: archive). For downloading the binary file stored on a recipe output of type image or file, use recipes/external_download_recipe_output_file instead. A file that has not cleared virus scanning is not returned: a file still being scanned responds with HTTP 422 indicating the scan is in progress, and a file that failed the scan responds with HTTP 422 indicating a security-scan failure."
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/job_definition.py

@@ -4,6 +4,7 @@
 # DO NOT MODIFY -- This file is generated by type_spec
 # Kept only for SDK backwards compatibility
 from .job_definition_t import JobDefinitionType as JobDefinitionType
+from .job_definition_t import HttpMethod as HttpMethod
 from .job_definition_t import JobExecutorType as JobExecutorType
 from .job_definition_t import GenericUploadDataSourceType as GenericUploadDataSourceType
 from .job_definition_t import JobExecutorBase as JobExecutorBase

uncountable/types/job_definition_t.py

@@ -27,6 +27,7 @@ __all__: list[str] = [
     "GenericUploadDataSourceSFTP",
     "GenericUploadDataSourceType",
     "HttpJobDefinitionBase",
+    "HttpMethod",
     "JobDefinition",
     "JobDefinitionBase",
     "JobDefinitionType",
@@ -53,6 +54,12 @@ class JobDefinitionType(StrEnum):
     CUSTOM_HTTP = "custom_http"
 
 
+# DO NOT MODIFY -- This file is generated by type_spec
+class HttpMethod(StrEnum):
+    GET = "get"
+    POST = "post"
+
+
 # DO NOT MODIFY -- This file is generated by type_spec
 class JobExecutorType(StrEnum):
     SCRIPT = "script"
@@ -224,6 +231,7 @@ class HttpJobDefinitionBase(JobDefinitionBase):
 @dataclasses.dataclass(slots=True, kw_only=True)
 class CustomHttpJobDefinition(HttpJobDefinitionBase):
     type: typing.Literal[JobDefinitionType.CUSTOM_HTTP] = JobDefinitionType.CUSTOM_HTTP
+    http_method: HttpMethod = HttpMethod.POST
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

{uncountablepythonsdk-0.0.184.dist-info → uncountablepythonsdk-0.0.185.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.184
+Version: 0.0.185
 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.184.dist-info → uncountablepythonsdk-0.0.185.dist-info}/RECORD

@@ -37,12 +37,13 @@ examples/integration-server/pyproject.toml,sha256=CxNt8vQ17Po7h4fOXT8jtbrFJosxBV
 examples/integration-server/jobs/materials_auto/concurrent_cron.py,sha256=xsK3H9ZEaniedC2nJUB0rqOcFI8y-ojfl_nLSJb9AMM,312
 examples/integration-server/jobs/materials_auto/example_cron.py,sha256=y1nAtGwbPJfIrfQsrHVmJLAHmQtCEHIy1g-0PjeXx04,735
 examples/integration-server/jobs/materials_auto/example_http.py,sha256=hA--iNztlTwLaEBzlmoRZ6-hRTUExUUqLV0-ipU7_mo,1560
+examples/integration-server/jobs/materials_auto/example_http_get.py,sha256=_MyrwSBVCbDbb0VEmCpXpHIJzKC8NnEwjAXpQFiotyM,1438
 examples/integration-server/jobs/materials_auto/example_instrument.py,sha256=XWy1mCvDwL_Yfl3psFkD1ZX3K2vDQxPXgcMIABB5bLQ,3351
 examples/integration-server/jobs/materials_auto/example_parse.py,sha256=Z3iqAUdI5ya07VS3XayjK8brKuAyaqXlImJMJIUHz_4,8660
 examples/integration-server/jobs/materials_auto/example_predictions.py,sha256=5fO4rqRa80_968A1uVZn2TlMOUib54A8rumGW02sIMM,2112
 examples/integration-server/jobs/materials_auto/example_runsheet_wh.py,sha256=7FWDz3QpueVcf83fPrwGSqxs9pX06iKcQFte_vz3dC8,2944
 examples/integration-server/jobs/materials_auto/example_wh.py,sha256=PN-skP27yJwDZboWk5g5EZEc3AKfVayQLfnopjsDKJc,659
-examples/integration-server/jobs/materials_auto/profile.yaml,sha256=N9kX-xczfgBSqnfY5qsxmjxXkBXLhMnZU1TOMWI1hfg,2587
+examples/integration-server/jobs/materials_auto/profile.yaml,sha256=qEgEunAcmuIIVsGCvNZ1sFJPfrefonN5r9BLTt5DIFg,2750
 pkgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pkgs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pkgs/argument_parser/__init__.py,sha256=cEEOAQS8UJ4Kbuo0oCVAHHhkbYCfrH6cUTTt2Mq3PmI,1445
@@ -81,7 +82,7 @@ pkgs/serialization_util/__init__.py,sha256=DEMIjEmOVZHuSwsxI9uUs3CNDSztNgcpOp35D
 pkgs/serialization_util/_get_type_for_serialization.py,sha256=dW5_W9MFd6wgWfW5qlWork-GBb-QFLtiOZkjk2Zqn2M,1177
 pkgs/serialization_util/convert_to_snakecase.py,sha256=VeI7d6JMexvfveZBZE4brMTyW4I9BEdl38bioQn8M6g,759
 pkgs/serialization_util/dataclasses.py,sha256=ErjxC60hnn_2XpQM-OyQBsVOaTz8JaHB--g4CjwoTK4,417
-pkgs/serialization_util/serialization_helpers.py,sha256=v8omOQ2BRZZCzMeUwu29fCEqx0UNDJ_iNbqpW4oHk84,7804
+pkgs/serialization_util/serialization_helpers.py,sha256=UhekzGUcscopGTknPeb-_XM19u17jLBmbqhrpqNjkcg,7794
 pkgs/strenum_compat/__init__.py,sha256=Bq1kcPIQsXRiLUGWc63QGnVa5BlhvuFWpMMvdNcHy00,76
 pkgs/strenum_compat/strenum_compat.py,sha256=uOUAgpYTjHs1MX8dG81jRlyTkt3KNbkV_25zp7xTX2s,36
 pkgs/type_spec/__init__.py,sha256=h5DmJTca4QVV10sZR1x0-MlkZfuGYDfapR3zHvXfzto,19
@@ -151,7 +152,7 @@ uncountable/integration/executors/executors.py,sha256=E3a0_yrQesfigDzjhUAwD7-l-o
 uncountable/integration/executors/generic_upload_executor.py,sha256=MuNzrMnAaj6PBhrfTKX6e6vyQhwoDeBrYLz96ai653k,12149
 uncountable/integration/executors/script_executor.py,sha256=hKq09fOG89OAZ1Iq7wm2OgpUz1bh7DIYdZ2yn6ySr10,881
 uncountable/integration/http_server/__init__.py,sha256=ld7hD3wOGwAbnVRBrkTUCP5zNG-kptMd4wGJyQvUWVc,170
-uncountable/integration/http_server/types.py,sha256=9Hnt_rvrhGh0MCj1O2k2KHF81U85jURUnG6vt0boPDk,2425
+uncountable/integration/http_server/types.py,sha256=yrpSEPz7mS8xfNHCsYtDD3OIgZpu1dsND4pRELxFI6A,2464
 uncountable/integration/queue_runner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uncountable/integration/queue_runner/job_process.py,sha256=OONJ7aLsE80qIJ2ABLY3HYyKI7VdpBjI_pPQ3GCC13U,2586
 uncountable/integration/queue_runner/job_runner.py,sha256=Yh9hYfEYOya3BR6ypsal3LKPKrrEb4VQwfGuh4qyU2w,6115
@@ -180,7 +181,7 @@ uncountable/integration/queue_runner/datastore/model.py,sha256=06_fGS0QTALEA_381
 uncountable/integration/secret_retrieval/__init__.py,sha256=sisf8cxCYcJmCXCKjEPoT2xIxm1j-Ru9iTfMVxH6NM0,171
 uncountable/integration/secret_retrieval/basic_secret.py,sha256=PfpeaEDwdi8nFlHUJnzCob9GYgGG5O_3mmcaxPPY6zI,3272
 uncountable/integration/secret_retrieval/retrieve_secret.py,sha256=c0VkCvppWKXwgxdblQuj2WhRaEGBPa7vLDoS6mlNOAQ,3919
-uncountable/integration/webhook_server/entrypoint.py,sha256=_1360zLIvEVQVf8ToyK-E2fnaszGKs2HcxcZjNraADc,4268
+uncountable/integration/webhook_server/entrypoint.py,sha256=e7aYLsp5ht8Bzmj522_-5xSEm9zyHw-NGvggYCWClDE,5399
 uncountable/types/__init__.py,sha256=7fIYhDsz995jFGK7wBXIVMzIxUJbltUmdqm9U6HA_QQ,14367
 uncountable/types/async_batch.py,sha256=yCCWrrLQfxXVqZp-KskxLBNkNmuELdz4PJjx8ULppgs,662
 uncountable/types/async_batch_processor.py,sha256=6Z1qx_H9IqLqp0rzpCtrRvw0DqQ2O5ctkEnw0yNVaV8,48727
@@ -232,8 +233,8 @@ uncountable/types/integration_session.py,sha256=MVTtZa04INF4L8PxPjqz3l1Lse6Hze3I
 uncountable/types/integration_session_t.py,sha256=Nnes-u2RzvZYsybQsNhtBfbA3d2W_nuDjAS_mU6L6yM,1801
 uncountable/types/integrations.py,sha256=0fOhtbLIOl9w1GP9J3PTagRU8mjOKV48JNLLH3SJQP0,472
 uncountable/types/integrations_t.py,sha256=ZWwEP13mIkSiljSHN2p05XCwRgT2bdADs-8hiVQTs3I,1752
-uncountable/types/job_definition.py,sha256=aiaoOPgQNK1sn6sNVXzGi5NLwHfz6aHZfDSrvC9M2LE,1901
-uncountable/types/job_definition_t.py,sha256=IRMG_xRRH9lsn_BgAZOj2elRMTZ1gzWYKUlTFXGydYE,9650
+uncountable/types/job_definition.py,sha256=s6hjlxlJgAyD9aDjV0EdAMc0zW91XCD8h7VBX9I9bIE,1956
+uncountable/types/job_definition_t.py,sha256=bGBvhDi0CIRmeKC5jGw5bb-LDBG53czZaZlYbgo5tuQ,9832
 uncountable/types/listing.py,sha256=U-0-opI0Wgxzmwp4y0qhyT26aK_BjaqdlFVpjud-ryk,2838
 uncountable/types/listing_t.py,sha256=z0hpUlburpIrVA5KcO1TRjkyAGGuAHvpHt5Fo6cAqIc,17521
 uncountable/types/ml_reports.py,sha256=qhZ36pbFLOcoET3D_K2DiNx59bjp8WyurbCrWPsZTrM,757
@@ -338,7 +339,7 @@ uncountable/types/api/file_folders/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHk
 uncountable/types/api/file_folders/add_file_to_folder.py,sha256=0CnGFFSKyLsN6bOOYieh0Esiqq5XgQWA83bUn1jWXwY,1534
 uncountable/types/api/file_folders/modify_file_system.py,sha256=tXjHwtR7hUudCiwtcM2lHXVc4sgCI_R3-w6SWWwpCTU,2950
 uncountable/types/api/files/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
-uncountable/types/api/files/download_file.py,sha256=Ou2fcfuyuuJeXL-brOpzEJfWqAcEFuUPRSHvx_ZU4nM,3746
+uncountable/types/api/files/download_file.py,sha256=w_GNviiXHqrnFU2pbriy6sl5i415JA0TFzXeJB_o00A,3983
 uncountable/types/api/id_source/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
 uncountable/types/api/id_source/list_id_source.py,sha256=tvrFKTynmfcLekUJnYSxSQi5V0N68ULjtn6xx0RmKec,1585
 uncountable/types/api/id_source/match_id_source.py,sha256=xnKnhHQBYipJmMxfH-7MHyNM6QOTrkSApuN9oAlk2PA,1560
@@ -433,7 +434,7 @@ uncountable/types/api/uploader/complete_async_parse.py,sha256=Os1HAubxTlbut6Gylj
 uncountable/types/api/uploader/invoke_uploader.py,sha256=QU1KmAFgGHSWskZEKfaAww8rCj-hVNP0i4kMQE3x3Fc,1822
 uncountable/types/api/user/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
 uncountable/types/api/user/get_current_user_info.py,sha256=BT7bGp5SOHz3XdKWhhdZ6acnInafT2PgdJ-H4YH3W7c,1181
-uncountablepythonsdk-0.0.184.dist-info/METADATA,sha256=mC6m3lEpjQAUsOqEx1Vcc7aoLKXtvnvRXmSUTJpJ1Rg,2211
-uncountablepythonsdk-0.0.184.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-uncountablepythonsdk-0.0.184.dist-info/top_level.txt,sha256=1UVGjAU-6hJY9qw2iJ7nCBeEwZ793AEN5ZfKX9A1uj4,31
-uncountablepythonsdk-0.0.184.dist-info/RECORD,,
+uncountablepythonsdk-0.0.185.dist-info/METADATA,sha256=E0K3f473FaOotwX30VtrvhiIc-YIbHCdyS2TyY2-pVY,2211
+uncountablepythonsdk-0.0.185.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+uncountablepythonsdk-0.0.185.dist-info/top_level.txt,sha256=1UVGjAU-6hJY9qw2iJ7nCBeEwZ793AEN5ZfKX9A1uj4,31
+uncountablepythonsdk-0.0.185.dist-info/RECORD,,