UncountablePythonSDK 0.0.7__py3-none-any.whl → 0.0.92__py3-none-any.whl

examples/create_entity.py

@@ -1,18 +1,23 @@
-from uncountable.client import HTTPRequestsClient, AuthDetailsApiKey
-from uncountable.types.api import external_create_entities
+from uncountable.core import AuthDetailsOAuth, Client
+from uncountable.core.client import ClientConfig
+from uncountable.types import (
+    entity_t,
+    field_values_t,
+)
 
-
-if __name__ == "__main__":
-    client = HTTPRequestsClient(
-        "https://app.uncountable.com", AuthDetailsApiKey(api_id="X", api_secret_key="X")
-    )
-    connection = client.connect()
-    entities = connection.external_create_entities(
-        external_create_entities.Arguments(
-            definition_id=1,
-            entity_type="lab_request",
-            entities_to_create=[
-                external_create_entities.EntityToCreate(field_values=None)
-            ],
-        )
-    )
+client = Client(
+    base_url="https://app.uncountable.com",
+    auth_details=AuthDetailsOAuth(refresh_token="x"),
+    config=ClientConfig(allow_insecure_tls=False),
+)
+entities = client.create_entity(
+    definition_id=24,
+    entity_type=entity_t.EntityType.LAB_REQUEST,
+    field_values=[
+        field_values_t.FieldRefNameValue(
+            field_ref_name="name", value="SDK Lab Request"
+        ),
+        field_values_t.FieldRefNameValue(field_ref_name="materialFamilyId", value=1),
+    ],
+)
+print(entities)

examples/download_files.py

@@ -0,0 +1,26 @@
+import os
+from pprint import pprint
+
+from uncountable.core import AuthDetailsApiKey, Client
+from uncountable.types import download_file_t, entity_t, identifier_t
+
+client = Client(
+    base_url="http://localhost:5000",
+    auth_details=AuthDetailsApiKey(
+        api_id=os.environ["UNC_API_ID"],
+        api_secret_key=os.environ["UNC_API_SECRET_KEY"],
+    ),
+)
+
+file_query = download_file_t.FileDownloadQueryEntityField(
+    entity=entity_t.EntityIdentifier(
+        type=entity_t.EntityType.LAB_REQUEST,
+        identifier_key=identifier_t.IdentifierKeyId(id=2375),
+    ),
+    field_key=identifier_t.IdentifierKeyRefName(ref_name="attachments"),
+)
+
+downloaded = client.download_files(
+    file_query=file_query,
+)
+pprint(downloaded)

examples/edit_recipe_inputs.py

@@ -0,0 +1,50 @@
+import os
+from decimal import Decimal
+
+from uncountable.core import AsyncBatchProcessor, AuthDetailsApiKey, Client
+from uncountable.types import (
+    edit_recipe_inputs_t,
+    recipe_workflow_steps_t,
+)
+from uncountable.types.identifier import IdentifierKeyBatchReference, IdentifierKeyId
+from uncountable.types.recipe_identifiers import (
+    RecipeIdentifiers,
+)
+from uncountable.types.recipe_inputs import QuantityBasis
+
+client = Client(
+    base_url=os.environ["UNC_BASE_URL"],
+    auth_details=AuthDetailsApiKey(
+        api_id=os.environ["UNC_API_ID"], api_secret_key=os.environ["UNC_API_SECRET_KEY"]
+    ),
+)
+batch_loader = AsyncBatchProcessor(client=client)
+recipe_identifiers: RecipeIdentifiers = []
+req = batch_loader.create_recipe(
+    material_family_id=1, workflow_id=1, identifiers=recipe_identifiers
+)
+created_recipe_reference = req.batch_reference
+edits: list[edit_recipe_inputs_t.RecipeInputEdit] = []
+edits.append(
+    edit_recipe_inputs_t.RecipeInputEditAddInput(
+        quantity_basis=QuantityBasis.MASS,
+        ingredient_key=IdentifierKeyId(id=1),
+        value_numeric=Decimal("56.7"),
+    )
+)
+edits.append(
+    edit_recipe_inputs_t.RecipeInputEditChangeBasisViewed(
+        quantity_basis=QuantityBasis.VOLUME, ingredient_key=IdentifierKeyId(id=1)
+    )
+)
+edits.append(
+    edit_recipe_inputs_t.RecipeInputEditAddInstructions(
+        instructions="Mix for 3 minutes"
+    )
+)
+batch_loader.edit_recipe_inputs(
+    recipe_key=IdentifierKeyBatchReference(reference=created_recipe_reference),
+    edits=edits,
+    recipe_workflow_step_identifier=recipe_workflow_steps_t.RecipeWorkflowStepIdentifierDefault(),
+)
+job_id = batch_loader.send()

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

@@ -0,0 +1,18 @@
+from uncountable.integration.job import CronJob, JobArguments, register_job
+from uncountable.types import entity_t
+from uncountable.types.job_definition_t import JobResult
+
+
+@register_job
+class MyCronJob(CronJob):
+    def run(self, args: JobArguments) -> JobResult:
+        matfam = args.client.get_entities_data(
+            entity_ids=[1],
+            entity_type=entity_t.EntityType.MATERIAL_FAMILY,
+        ).entity_details[0]
+        name = None
+        for field_val in matfam.field_values:
+            if field_val.field_ref_name == "name":
+                name = field_val.value
+        args.logger.log_info(f"material family found with name: {name}")
+        return JobResult(success=True)

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

@@ -0,0 +1,15 @@
+import typing
+
+from uncountable.integration.job import JobArguments, WebhookJob, register_job
+from uncountable.types.job_definition_t import JobResult
+
+
+@register_job
+class WebhookExample(WebhookJob):
+    @property
+    def payload_type(self) -> typing.Any:
+        return super().payload_type
+
+    def run(self, args: JobArguments, payload: typing.Any) -> JobResult:
+        args.logger.log_info(f"webhook invoked with payload: {payload}")
+        return JobResult(success=True)

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

@@ -0,0 +1,43 @@
+base_url: http://host.docker.internal:5000
+auth_retrieval:
+  type: basic
+  api_id_secret:
+    type: env
+    env_key: API_ID
+  api_key_secret:
+    type: env
+    env_key: API_SECRET_KEY
+jobs:
+  - id: example_cron
+    enabled: true
+    type: cron
+    name: MyCron - Example
+    cron_spec: "* * * * *"
+    executor:
+      type: script
+      import_path: example_cron
+    logging_settings:
+      enabled: true
+      share_with_user_groups:
+        - admin:
+          type: ref_name
+          ref_name: admin
+
+  - id: example_wh1
+    type: webhook
+    name: Webhook 1
+    signature_key_secret:
+      type: env
+      env_key: WH1_SIGNATURE_KEY
+    executor:
+      type: script
+      import_path: example_wh
+  - id: example_wh2
+    type: webhook
+    name: Webhook 2
+    signature_key_secret:
+      type: env
+      env_key: WH2_SIGNATURE_KEY
+    executor:
+      type: script
+      import_path: example_wh

examples/integration-server/pyproject.toml

@@ -0,0 +1,224 @@
+[project]
+# begin_project_name
+# DO NOT MODIFY
+name = "integration-server-testing"
+# end_project_name
+dynamic = ["version"]
+dependencies = [
+  "mypy == 1.*",
+  "ruff == 0.*",
+  "openpyxl == 3.*",
+  "more_itertools == 10.*",
+  "types-paramiko ==3.5.0.20240918",
+  "types-openpyxl == 3.*",
+  "types-pysftp == 0.*",
+  "types-pytz == 2024.*",
+  "types-requests == 2.*",
+  "types-simplejson == 3.*",
+  "pandas-stubs",
+  "xlrd == 2.*"
+]
+
+[tool.mypy]
+strict = true
+show_error_codes = true
+check_untyped_defs = true
+disallow_any_generics = false
+disallow_incomplete_defs = true
+disallow_subclassing_any = false
+disallow_untyped_calls = false
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+implicit_reexport = true
+no_implicit_optional = true
+no_implicit_reexport = true
+strict_equality = true
+warn_redundant_casts = true
+warn_unused_ignores = false
+warn_no_return = true
+warn_return_any = true
+local_partial_types = true
+warn_unreachable = false
+warn_unused_configs = true
+exclude = [
+    "env"
+]
+
+[tool.ruff]
+preview = true
+lint.select = ['ALL']
+lint.ignore = [
+    "A001", # Variable shadows python built-in. Nice to have
+    "A002", # Variable shadows python built-in. Nice to have
+    "A003", # Class attribute shadows python built-in. Nice to have
+    "ANN",  # Missing type annotations. Skip in favor of mypy
+    "ARG",  # Unused arguments. Skip
+    "B006", # Do not use mutable data structures for argument defaults. Priority.
+    "B023", # Function doesn't bind loop variable.  Priority
+    "B904", # Exception handling raise from.  Skip
+    "BLE", # Blind exception.  Should Add
+    "C401", # Unecessary generator.  Skip
+    "C403", # Unnecessary list comprehension.  Skip
+    "C405", # Unnecessary list. rewrite as set.  Skip
+    "C408", # Unnecessary dict call.  Skip
+    "C416", # Unnecessary list comprehension.  Skip
+    "C417", # Unnecessary use of map.  Should Add
+    "COM812", # Trailing comma.  Too opinionated.  Skip
+    "CPY", # Copyright notices.  Skip
+    "D",  # Docstrings.  Skip
+    "DOC", # Docstrings.  Skip
+    "DTZ001",  # Missing tzinfo.  Should add
+    "DTZ002",  # Use of today instead of now.  Should add
+    "DTZ003",  # Use of utcnow not allowed.  Should add
+    "DTZ004",  # Use of utcfrom timestamp not allowed.  Should add
+    "DTZ005",  # now without tz not allowed.  Should add
+    "DTZ006",  # use of from timestamp without tz not allowed.  Should add
+    "DTZ007",  # replace timezone after strptime.  Should add
+    "DTZ011",  # Use of today not allowed.  Should add
+    "E501",  # Line length.  Skip
+    "EM101", # exception must not use a string literal.  skip
+    "EM102", # exception must not use an f string.  skip
+    "EM103", # exception must not use a format string. skip
+    "ERA", # Rules around commented code.  Skip
+    "EXE002", # Executable files need shebang.  Skip
+    "F841", # TEMPORARY DISABLE TO CLEAR UP BUILD.  Unused variables.  Prioritize.
+    "FBT001", # boolean positional args.  Skip
+    "FBT002", # boolean default positional.  Skip
+    "FBT003", # boolean positional. Skip
+    "FIX001", # Fixme comment. Skip
+    "FIX002", # todo comment.  Skip
+    "FIX004", # hack comment.  Skip
+    "FLY002", # Use F-String instead of join.  Should Add
+    "FURB101", # replace read function. Skip
+    "FURB103", # opinionated file opening. Skip
+    "FURB113", # extend vs append.  Skip
+    "FURB118", # opinionated rules about lambdas. skip
+    "FURB140", # starmap vs generator.  Skip
+    "G004",  # avoid f strings in log statements.  Should add
+    "INP001", # implicit imports.  use __init__.  Skip
+    "ISC001", # rule conflicts with formatter. Skip
+    "ISC003", # Explicitly concatenated string should be implicitly concatenated. Skip
+    "N801", # class name case. Skip
+    "N802", # function name lower case. Skip
+    "N803", # argument name lower cas. Skip
+    "N804", # cls_ first variable.  Should add
+    "N806", # lower case variable.  Skip
+    "N812", # case consistency on import.  Skip
+    "N815", # mix casing, skip
+    "N817", # don't use acronym.  Should add
+    "N818", # exception override should be named with error. should add
+    "N999", # module naming.  Should add
+    "PD002", # avoid inplace.  Skip
+    "PD004", # .notna.  Should add
+    "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
+    "PERF403", # use dictionary comprehension.  Skip
+    "S307", # avoid eval.  Should add
+    "PGH003", # ignore specific rules.  Skip
+    "PGH004", # ignore specific rules.  Skip
+    "PLC0414", # import alias doesn't rename. Skip
+    "PLC0415", # import at top level.  Skip
+    "PLC1901", # falsy empty string.  Skip
+    "PLR0124", # self comparison.  Skip
+    "PLR0402", # alias import.  Skip
+    "PLR0911", # too many return statements.  Skip
+    "PLR0912", # too many branches.  Skip
+    "PLR0913", # too many arguments.  Skip
+    "PLR0915", # too many statements.  Skip
+    "PLR0916", # too many expressions. Skip
+    "PLR0917", # too many positional arguments.  Skip
+    "PLR1714", # multiple comparisons.  Skip
+    "PLR2004", # magic values.  skip
+    "PLR5501", # use elif instead of else if.  skip
+    "PLR6104", # use augmented assignment.  confuses strings, wait for fix.  skip
+    "PLR6201", # use a set literal for membership test.  skip
+    "PLR6301", # method inference.  skip
+    "PLW0108", # inline lambda.  skip
+    "PLW0120", # else without break. skip
+    "PLW0602", # global withotu assignment.  consider
+    "PLW0603", # discourage global.  skip
+    "PLW1510", # subprocess run without check arg.  skip
+    "PLW1514", # open without encoding. skip
+    "PLW2901", # for loop variable overwritten.  skip
+    "PT001", # change ficture decorator.  should add
+    "PT011", # use more specific raises decorator.  should add
+    "PT018", # break down complex assertsions.  skip
+    "PTH", # enforces new python path library usage.  skip
+    "PYI030", # turn union of literals to just literal with multiple. should add
+    "PYI041", # use float instead of int | float. should remove floats
+    "RET", # enforces return semantics. break up and re-evaluate later
+    "RSE102", # unnecessary parens on exception.  skip.
+    "RUF001", # ambiguous characters.  skip
+    "RUF005", # prefer star to concatenation.  skip
+    "RUF010", # use explicit conversion flag.  skip
+    "RUF012", # type with class var.  should add
+    "RUF015", # prefer next for single element. skip
+    "RUF100", # unused noqa.  should add
+    "S", # should split up
+    "S101", # allow asserts. skip
+    "SIM102", # use single if instead of nested. skip
+    "SIM105", # use exception supress. skip
+    "SIM108", # use ternary.  skip
+    "SIM110", # use any/all.  should add
+    "SIM112", # case of env variable.  skip
+    "SIM114", # combine if branches.  skip
+    "SIM115", # use context handler for files.  should add
+    "SIM117", # use single with.  should add
+    "SLF001", # private member access.  should add
+    "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
+    "TD",  # todo comments.  skip
+    "TID252", # eliminate relative imports from parents.  skip
+    "TRY002", # create your own exception. skip
+    "TRY003", # avoid long messages.  skip
+    "TRY004", # prefer type error.  should add
+    "TRY201", # raise without exception name. consider
+    "TRY300", # move statement to else block.  consider
+    "TRY301", # move raise to inner function. skip
+    "UP007", # use union for type annotations.  should add
+    "UP013", # eliminate typeddict.  should add
+    "UP031", # use format specifiers.  should add
+    "B905", # zip strict. we have a deprecated pattern here, consider
+    "UP036", # outdated version block, consider
+    "RUF007", # prefer itertools.pairwise over zip, consider
+    "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
+    "C420",  # unnecessary dict comprehension.  skip
+    "SIM113",  # index variable should use enumerate.  should add.
+    "PLR0914"  # too many local variables.  configure below.  should add with config
+]
+line-length = 90
+target-version = "py311"
+
+exclude = [
+    'env'
+]
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.ruff.lint.isort]
+split-on-trailing-comma = true
+
+[tool.ruff.lint.mccabe]
+max-complexity = 130 # goal would be to bring this down to ~50 or so
+
+[tool.ruff.lint.pylint]
+max-locals=50
+
+[tool.setuptools]
+py-modules = []
+

examples/invoke_uploader.py

@@ -0,0 +1,26 @@
+import os
+
+from uncountable.core import AuthDetailsApiKey, Client, MediaFileUpload
+from uncountable.types import generic_upload_t
+from uncountable.types.identifier_t import IdentifierKeyId
+
+client = Client(
+    base_url="http://localhost:5000",
+    auth_details=AuthDetailsApiKey(
+        api_id=os.environ["UNC_API_ID"],
+        api_secret_key=os.environ["UNC_API_SECRET_KEY"],
+    ),
+)
+uploaded_file = client.upload_files(
+    file_uploads=[
+        MediaFileUpload(path="~/Downloads/my_file_to_upload.csv"),
+    ]
+)[0]
+
+client.invoke_uploader(
+    file_id=uploaded_file.file_id,
+    uploader_key=IdentifierKeyId(id=48),
+    destination=generic_upload_t.UploadDestinationMaterialFamily(
+        material_family_key=IdentifierKeyId(id=7)
+    ),
+)

examples/set_recipe_metadata_file.py

@@ -0,0 +1,40 @@
+import os
+
+from uncountable.core import (
+    AsyncBatchProcessor,
+    AuthDetailsApiKey,
+    Client,
+    MediaFileUpload,
+)
+from uncountable.types import recipe_metadata_t
+from uncountable.types.identifier_t import IdentifierKeyBatchReference
+
+client = Client(
+    base_url="http://localhost:5000",
+    auth_details=AuthDetailsApiKey(
+        api_id=os.environ["UNC_API_ID"],
+        api_secret_key=os.environ["UNC_API_SECRET_KEY"],
+    ),
+)
+uploaded_file = client.upload_files(
+    file_uploads=[
+        MediaFileUpload(path="Downloads/my_file_to_upload.csv"),
+    ]
+)[0]
+
+batch_processor = AsyncBatchProcessor(client=client)
+
+recipe_batch_identifier = batch_processor.create_recipe(
+    material_family_id=1, workflow_id=1
+).batch_reference
+
+batch_processor.set_recipe_metadata(
+    recipe_key=IdentifierKeyBatchReference(reference=recipe_batch_identifier),
+    recipe_metadata=[
+        recipe_metadata_t.MetadataValue(
+            metadata_id=102, value_file_ids=[uploaded_file.file_id]
+        )
+    ],
+)
+
+batch_processor.send()

examples/set_recipe_output_file_sdk.py

@@ -0,0 +1,26 @@
+import os
+from pathlib import Path
+
+import uncountable.types.api.recipes.set_recipe_output_file as set_recipe_output_file_t
+from uncountable.core import AuthDetailsApiKey, Client, MediaFileUpload
+
+client = Client(
+    base_url="http://localhost:5000",
+    auth_details=AuthDetailsApiKey(
+        api_id=os.environ["UNC_API_ID"],
+        api_secret_key=os.environ["UNC_API_SECRET_KEY"],
+    ),
+)
+uploaded_file = client.upload_files(
+    file_uploads=[
+        MediaFileUpload(
+            path=str((Path.home() / "Downloads" / "my_file_to_upload.csv").absolute())
+        ),
+    ]
+)[0]
+
+client.set_recipe_output_file(
+    output_file_data=set_recipe_output_file_t.RecipeOutputFileValue(
+        recipe_id=58070, output_id=148, file_id=uploaded_file.file_id, experiment_num=1
+    )
+)

examples/upload_files.py

@@ -0,0 +1,18 @@
+import os
+from pprint import pprint
+
+from uncountable.core import AuthDetailsApiKey, Client, MediaFileUpload
+
+client = Client(
+    base_url="http://localhost:5000",
+    auth_details=AuthDetailsApiKey(
+        api_id=os.environ["UNC_API_ID"],
+        api_secret_key=os.environ["UNC_API_SECRET_KEY"],
+    ),
+)
+uploaded = client.upload_files(
+    file_uploads=[
+        MediaFileUpload(path="Downloads/file"),
+    ]
+)
+pprint(uploaded)

pkgs/argument_parser/__init__.py

@@ -1,6 +1,11 @@
 from .argument_parser import CachedParser as CachedParser
+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_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_enum.py

@@ -3,14 +3,9 @@ import typing
 from enum import Enum
 
 
-def is_string_enum_class(object_type: typing.Type[typing.Any]) -> bool:
+def is_string_enum_class(object_type: type[typing.Any]) -> bool:
     return (
         inspect.isclass(object_type)
         and issubclass(object_type, Enum)
         and issubclass(object_type, str)
     )
-
-
-def is_string_enum_instance(obj: typing.Any) -> bool:
-    object_type = type(obj)
-    return is_string_enum_class(object_type)