albert 1.9.6__tar.gz → 1.10.0rc1__tar.gz

{albert-1.9.6 → albert-1.10.0rc1}/.circleci/config.yml

@@ -12,6 +12,29 @@ commands:
           command: curl -LsSf https://astral.sh/uv/install.sh | sh
 
 jobs:
+  snyk_app_scan:
+    executor:
+      name: python/default
+      tag: "3.10.15"
+    steps:
+      - checkout
+      - add_ssh_keys:
+          fingerprints:
+            - "SHA256:8xP/cfKKsXJOx9XDojfxU3nx9NRtDCEVSVm0uL6qL5I"
+      - install_uv
+      - run:
+          name: Export dependencies
+          command: |
+            uv sync
+            uv export > requirements_lock.txt
+            uv pip compile requirements_lock.txt > requirements.txt
+            uv pip install --system -r requirements.txt
+      - snyk/scan:
+          fail-on-issues: true
+          monitor-on-build: true
+          severity-threshold: high
+          token-variable: SNYK_TOKEN
+
   test:
     executor:
       name: python/default
@@ -136,6 +159,9 @@ jobs:
 workflows:
   main:
     jobs:
+      - snyk_app_scan:
+          name: Snyk App Scan
+          context: dev
       - test:
           name: Test
           context: dev

{albert-1.9.6 → albert-1.10.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: albert
-Version: 1.9.6
+Version: 1.10.0rc1
 Summary: The official Python SDK for the Albert Invent platform.
 Project-URL: Homepage, https://www.albertinvent.com/
 Project-URL: Documentation, https://docs.developer.albertinvent.com/albert-python
@@ -220,6 +220,7 @@ Requires-Dist: pandas<3,>=2.2.2
 Requires-Dist: pydantic[email]<3,>=2.8.2
 Requires-Dist: pyjwt<3,>=2.10.0
 Requires-Dist: requests<3,>=2.32.3
+Requires-Dist: tenacity>=8.2.3
 Description-Content-Type: text/markdown
 
 # Albert Python SDK

{albert-1.9.6 → albert-1.10.0rc1}/mkdocs.yml

@@ -123,7 +123,6 @@ nav:
       - Configuration: configuration.md
       - Migration Guide: migration.md
       - Contributing: CONTRIBUTING.md
-      - Changelog: CHANGELOG.md
   - SDK Reference:
       - Clients:
           - Albert Client: albert.md

{albert-1.9.6 → albert-1.10.0rc1}/pyproject.toml

@@ -23,6 +23,7 @@ dependencies = [
     "pandas>=2.2.2,<3",
     "pydantic[email]>=2.8.2,<3",
     "pyjwt>=2.10.0,<3",
+    "tenacity>=8.2.3",
 ]
 
 [dependency-groups]

{albert-1.9.6 → albert-1.10.0rc1}/src/albert/__init__.py

@@ -4,4 +4,4 @@ from albert.core.auth.sso import AlbertSSOClient
 
 __all__ = ["Albert", "AlbertClientCredentials", "AlbertSSOClient"]
 
-__version__ = "1.9.6"
+__version__ = "1.10.0rc1"

{albert-1.9.6 → albert-1.10.0rc1}/src/albert/collections/attachments.py

@@ -9,7 +9,7 @@ from pydantic import validate_call
 from albert.collections.base import BaseCollection
 from albert.collections.files import FileCollection
 from albert.collections.notes import NotesCollection
-from albert.core.shared.identifiers import AttachmentId, InventoryId
+from albert.core.shared.identifiers import AttachmentId, DataColumnId, InventoryId
 from albert.core.shared.types import MetadataItem
 from albert.resources.attachments import Attachment, AttachmentCategory
 from albert.resources.files import FileCategory, FileNamespace
@@ -49,7 +49,9 @@ class AttachmentCollection(BaseCollection):
         response = self.session.get(url=f"{self.base_path}/{id}")
         return Attachment(**response.json())
 
-    def get_by_parent_ids(self, *, parent_ids: list[str]) -> dict[str, list[Attachment]]:
+    def get_by_parent_ids(
+        self, *, parent_ids: list[str], data_column_ids: list[DataColumnId] | None = None
+    ) -> dict[str, list[Attachment]]:
         """Retrieves attachments by their parent IDs.
 
         Note: This method returns a dictionary where the keys are parent IDs
@@ -69,7 +71,10 @@ class AttachmentCollection(BaseCollection):
         dict[str, list[Attachment]]
             A dictionary mapping parent IDs to lists of Attachment objects associated with each parent ID.
         """
-        response = self.session.get(url=f"{self.base_path}/parents", params={"id": parent_ids})
+        response = self.session.get(
+            url=f"{self.base_path}/parents",
+            params={"id": parent_ids, "dataColumnId": data_column_ids},
+        )
         response_data = response.json()
         return {
             parent["parentId"]: [
@@ -125,7 +130,12 @@ class AttachmentCollection(BaseCollection):
         self.session.delete(f"{self.base_path}/{id}")
 
     def upload_and_attach_file_as_note(
-        self, parent_id: str, file_data: IO, note_text: str = "", file_name: str = ""
+        self,
+        parent_id: str,
+        file_data: IO,
+        note_text: str = "",
+        file_name: str = "",
+        upload_key: str | None = None,
     ) -> Note:
         """Uploads a file and attaches it to a new note. A user can be tagged in the note_text string by using f-string and the User.to_note_mention() method.
         This allows for easy tagging and referencing of users within notes. example: f"Hello {tagged_user.to_note_mention()}!"
@@ -140,24 +150,31 @@ class AttachmentCollection(BaseCollection):
             Any additional text to add to the note, by default ""
         file_name : str, optional
             The name of the file, by default ""
+        upload_key : str | None, optional
+            Override the storage key used when signing and uploading the file.
+            Defaults to the provided ``file_name``.
 
         Returns
         -------
         Note
             The created note.
         """
-        file_type = mimetypes.guess_type(file_name)[0]
+        upload_name = upload_key or file_name
+        if not upload_name:
+            raise ValueError("A file name or upload key must be provided for attachment upload.")
+
+        file_type = mimetypes.guess_type(file_name or upload_name)[0]
         file_collection = self._get_file_collection()
         note_collection = self._get_note_collection()
 
         file_collection.sign_and_upload_file(
             data=file_data,
-            name=file_name,
+            name=upload_name,
             namespace=FileNamespace.RESULT.value,
             content_type=file_type,
         )
         file_info = file_collection.get_by_name(
-            name=file_name, namespace=FileNamespace.RESULT.value
+            name=upload_name, namespace=FileNamespace.RESULT.value
         )
         note = Note(
             parent_id=parent_id,
@@ -166,7 +183,7 @@ class AttachmentCollection(BaseCollection):
         registered_note = note_collection.create(note=note)
         self.attach_file_to_note(
             note_id=registered_note.id,
-            file_name=file_name,
+            file_name=file_name or Path(upload_name).name,
             file_key=file_info.name,
         )
         return note_collection.get_by_id(id=registered_note.id)

{albert-1.9.6 → albert-1.10.0rc1}/src/albert/collections/custom_templates.py

@@ -1,7 +1,5 @@
 from collections.abc import Iterator
 
-from pydantic import validate_call
-
 from albert.collections.base import BaseCollection
 from albert.core.logging import logger
 from albert.core.pagination import AlbertPaginator
@@ -30,7 +28,6 @@ class CustomTemplatesCollection(BaseCollection):
         super().__init__(session=session)
         self.base_path = f"/api/{CustomTemplatesCollection._api_version}/customtemplates"
 
-    @validate_call
     def get_by_id(self, *, id: CustomTemplateId) -> CustomTemplate:
         """Get a Custom Template by ID
 

{albert-1.9.6 → albert-1.10.0rc1}/src/albert/collections/data_templates.py

@@ -1,14 +1,17 @@
 from collections.abc import Iterator
 from itertools import islice
+from pathlib import Path
 
 from pydantic import Field, validate_call
 
+from albert.collections.attachments import AttachmentCollection
 from albert.collections.base import BaseCollection
+from albert.collections.files import FileCollection
 from albert.core.logging import logger
 from albert.core.pagination import AlbertPaginator
 from albert.core.session import AlbertSession
 from albert.core.shared.enums import OrderBy, PaginationMode
-from albert.core.shared.identifiers import DataTemplateId, UserId
+from albert.core.shared.identifiers import AttachmentId, DataColumnId, DataTemplateId, UserId
 from albert.core.shared.models.patch import (
     GeneralPatchDatum,
     GeneralPatchPayload,
@@ -23,7 +26,19 @@ from albert.resources.data_templates import (
     ParameterValue,
 )
 from albert.resources.parameter_groups import DataType, EnumValidationValue, ValueValidation
+from albert.resources.tasks import ImportMode
 from albert.utils._patch import generate_data_template_patches
+from albert.utils.data_template import (
+    build_curve_import_patch_payload,
+    create_curve_import_job,
+    derive_curve_csv_mapping,
+    exec_curve_script,
+    get_script_attachment,
+    get_target_data_column,
+    prepare_curve_input_attachment,
+    validate_data_column_type,
+)
+from albert.utils.tasks import CSV_EXTENSIONS, fetch_csv_table_rows
 
 
 class DCPatchDatum(PGPatchPayload):
@@ -83,6 +98,158 @@ class DataTemplateCollection(BaseCollection):
             return self.add_parameters(data_template_id=dt.id, parameters=parameter_values)
 
     @validate_call
+    def import_curve_data(
+        self,
+        *,
+        data_template_id: DataTemplateId,
+        data_column_id: DataColumnId | None = None,
+        data_column_name: str | None = None,
+        mode: ImportMode = ImportMode.CSV,
+        field_mapping: dict[str, str] | None = None,
+        file_path: str | Path | None = None,
+        attachment_id: AttachmentId | None = None,
+    ) -> DataTemplate:
+        """Import curve data in a data template column.
+
+        Parameters
+        ----------
+        data_template_id : DataTemplateId
+            Target data template Id.
+        data_column_id : DataColumnId | None, optional
+            Specific data column to upload the curve data to. Provide exactly one of ``data_column_id`` or
+            ``data_column_name``.
+        data_column_name : str | None, optional
+            Case-insensitive data column display name. Provide exactly one of the column
+            identifier or name.
+        mode : ImportMode, optional
+            Import mode. ``ImportMode.SCRIPT`` runs the attached automation script and requires
+            a script attachment on the data template; ``ImportMode.CSV`` ingests the
+            uploaded CSV directly. Defaults to ``ImportMode.CSV``.
+        field_mapping : dict[str, str] | None, optional
+            Optional manual mapping from CSV headers to curve result column names on the target column. Example: ``{"visc": "Viscosity"}`` maps the
+            "visc" CSV header to the "Viscosity" curve result column. Mappings are matched
+            case-insensitively and override auto-detection. In ``ImportMode.SCRIPT`` this applies to the headers emitted by the script before ingestion.
+        attachment_id : AttachmentId | None, optional
+            Existing attachment to use. Exactly one of ``attachment_id`` or ``file_path`` must be provided.
+        file_path : str | Path | None, optional
+            Local file to upload and attach to a new note on the data template. Exactly one of
+            ``attachment_id`` or ``file_path`` must be provided.
+        Returns
+        -------
+        DataTemplate
+            The data template refreshed after the curve import job completes.
+
+        Examples
+        --------
+        !!! example "Import curve data from a CSV file"
+            ```python
+            dt = client.data_templates.import_curve_data(
+                data_template_id="DT123",
+                data_column_name="APHA Color",
+                mode=ImportMode.CSV,
+                file_path="path/to/curve.csv",
+                field_mapping={"visc": "Viscosity"},
+            )
+            ```
+        """
+        data_template = self.get_by_id(id=data_template_id)
+        target_column = get_target_data_column(
+            data_template=data_template,
+            data_template_id=data_template_id,
+            data_column_id=data_column_id,
+            data_column_name=data_column_name,
+        )
+        validate_data_column_type(target_column=target_column)
+        column_id = target_column.data_column_id
+        attachment_collection = AttachmentCollection(session=self.session)
+
+        script_attachment_signed_url: str | None = None
+
+        if mode is ImportMode.SCRIPT:
+            script_attachment, script_extensions = get_script_attachment(
+                attachment_collection=attachment_collection,
+                data_template_id=data_template_id,
+                column_id=column_id,
+            )
+            if not script_extensions:
+                raise ValueError("Script attachment must define allowed extensions.")
+            script_attachment_signed_url = script_attachment.signed_url
+            allowed_extensions = set(script_extensions)
+        else:
+            allowed_extensions = set(CSV_EXTENSIONS)
+        raw_attachment = prepare_curve_input_attachment(
+            attachment_collection=attachment_collection,
+            data_template_id=data_template_id,
+            column_id=column_id,
+            allowed_extensions=allowed_extensions,
+            file_path=file_path,
+            attachment_id=attachment_id,
+            require_signed_url=mode is ImportMode.SCRIPT,
+        )
+        raw_key = raw_attachment.key
+        if raw_attachment.id is None:
+            raise ValueError("Curve input attachment did not return an identifier.")
+        resolved_attachment_id = AttachmentId(raw_attachment.id)
+
+        processed_input_key: str = raw_key
+        column_headers: dict[str, str] = {}
+
+        if mode is ImportMode.SCRIPT:
+            file_collection = FileCollection(session=self.session)
+            processed_input_key, column_headers = exec_curve_script(
+                session=self.session,
+                api_version=self._api_version,
+                data_template_id=data_template_id,
+                column_id=column_id,
+                raw_attachment=raw_attachment,
+                file_collection=file_collection,
+                script_attachment_signed_url=script_attachment_signed_url,
+            )
+        else:
+            table_rows = fetch_csv_table_rows(
+                session=self.session,
+                attachment_id=resolved_attachment_id,
+                headers_only=True,
+            )
+            header_row = table_rows[0]
+            if not isinstance(header_row, dict):
+                raise ValueError("Unexpected CSV header format returned by preview endpoint.")
+            column_headers = {
+                key: value
+                for key, value in header_row.items()
+                if isinstance(key, str) and isinstance(value, str) and value
+            }
+
+        csv_mapping = derive_curve_csv_mapping(
+            target_column=target_column,
+            column_headers=column_headers,
+            field_mapping=field_mapping,
+        )
+
+        job_id, partition_uuid, s3_output_key = create_curve_import_job(
+            session=self.session,
+            data_template_id=data_template_id,
+            column_id=column_id,
+            csv_mapping=csv_mapping,
+            raw_attachment=raw_attachment,
+            processed_input_key=processed_input_key,
+        )
+
+        patch_payload = build_curve_import_patch_payload(
+            target_column=target_column,
+            job_id=job_id,
+            csv_mapping=csv_mapping,
+            raw_attachment=raw_attachment,
+            partition_uuid=partition_uuid,
+            s3_output_key=s3_output_key,
+        )
+        self.session.patch(
+            f"{self.base_path}/{data_template_id}",
+            json=patch_payload.model_dump(by_alias=True, mode="json", exclude_none=True),
+        )
+
+        return self.get_by_id(id=data_template_id)
+
     def _add_param_enums(
         self,
         *,
@@ -196,7 +363,6 @@ class DataTemplateCollection(BaseCollection):
         response = self.session.get(f"{self.base_path}/{id}")
         return DataTemplate(**response.json())
 
-    @validate_call
     def get_by_ids(self, *, ids: list[DataTemplateId]) -> list[DataTemplate]:
         """Get a list of data templates by their IDs.
 
@@ -236,7 +402,6 @@ class DataTemplateCollection(BaseCollection):
                 return t.hydrate()
         return None
 
-    @validate_call
     def add_data_columns(
         self, *, data_template_id: DataTemplateId, data_columns: list[DataColumnValue]
     ) -> DataTemplate:
@@ -280,7 +445,6 @@ class DataTemplateCollection(BaseCollection):
         )
         return self.get_by_id(id=data_template_id)
 
-    @validate_call
     def add_parameters(
         self, *, data_template_id: DataTemplateId, parameters: list[ParameterValue]
     ) -> DataTemplate:
@@ -559,7 +723,6 @@ class DataTemplateCollection(BaseCollection):
             )
         return self.get_by_id(id=data_template.id)
 
-    @validate_call
     def delete(self, *, id: DataTemplateId) -> None:
         """Deletes a data template by its ID.
 

{albert-1.9.6 → albert-1.10.0rc1}/src/albert/collections/entity_types.py

@@ -1,7 +1,5 @@
 from collections.abc import Iterator
 
-from pydantic import validate_call
-
 from albert.collections.base import BaseCollection
 from albert.core.pagination import AlbertPaginator, PaginationMode
 from albert.core.session import AlbertSession
@@ -43,7 +41,6 @@ class EntityTypeCollection(BaseCollection):
         super().__init__(session=session)
         self.base_path = f"/api/{EntityTypeCollection._api_version}/entitytypes"
 
-    @validate_call
     def get_by_id(self, *, id: EntityTypeId) -> EntityType:
         """Get an entity type by its ID.
         Parameters
@@ -118,14 +115,8 @@ class EntityTypeCollection(BaseCollection):
                 PatchDatum(
                     operation=PatchOperation.UPDATE,
                     attribute="customFields",
-                    new_value=[
-                        x.model_dump(by_alias=True, exclude_none=True)
-                        for x in updated.custom_fields
-                    ],
-                    old_value=[
-                        x.model_dump(by_alias=True, exclude_none=True)
-                        for x in existing.custom_fields
-                    ],
+                    new_value=[x.model_dump(by_alias=True) for x in updated.custom_fields],
+                    old_value=[x.model_dump(by_alias=True) for x in existing.custom_fields],
                 )
             )
         if updated.custom_fields is not None and existing.custom_fields is None:
@@ -133,10 +124,7 @@ class EntityTypeCollection(BaseCollection):
                 PatchDatum(
                     operation=PatchOperation.ADD,
                     attribute="customFields",
-                    new_value=[
-                        x.model_dump(by_alias=True, exclude_none=True)
-                        for x in updated.custom_fields
-                    ],
+                    new_value=[x.model_dump(by_alias=True) for x in updated.custom_fields],
                 )
             )
 
@@ -206,7 +194,6 @@ class EntityTypeCollection(BaseCollection):
 
         return patches
 
-    @validate_call
     def delete(self, *, id: EntityTypeId) -> None:
         """Delete an entity type.
         Parameters
@@ -216,7 +203,6 @@ class EntityTypeCollection(BaseCollection):
         """
         self.session.delete(f"{self.base_path}/{id}")
 
-    @validate_call
     def get_rules(self, *, id: EntityTypeId) -> list[EntityTypeRule]:
         """Get the rules for an entity type.
         Parameters
@@ -227,7 +213,6 @@ class EntityTypeCollection(BaseCollection):
         response = self.session.get(f"{self.base_path}/rules/{id}")
         return [EntityTypeRule(**rule) for rule in response.json()]
 
-    @validate_call
     def set_rules(self, *, id: EntityTypeId, rules: list[EntityTypeRule]) -> list[EntityTypeRule]:
         """Create or update the rules for an entity type.
         Parameters
@@ -247,7 +232,6 @@ class EntityTypeCollection(BaseCollection):
         )
         return [EntityTypeRule(**rule) for rule in response.json()]
 
-    @validate_call
     def delete_rules(self, *, id: EntityTypeId) -> None:
         """Delete the rules for an entity type.
         Parameters
@@ -270,12 +254,12 @@ class EntityTypeCollection(BaseCollection):
         ----------
         service : EntityServiceType | None, optional
             The service type the entity type is associated with, by default None
-        limit : int, optional
-            Maximum number of results to return, by default 100
         start_key : str | None, optional
             Key to start pagination from, by default None
         order : OrderBy | None, optional
             Sort order (ascending/descending), by default None
+        max_items : int | None, optional
+            Maximum number of items to return, by default None
         Yields
         ------
         Iterator[EntityType]

{albert-1.9.6 → albert-1.10.0rc1}/src/albert/collections/parameters.py

@@ -98,7 +98,6 @@ class ParameterCollection(BaseCollection):
         url = f"{self.base_path}/{id}"
         self.session.delete(url)
 
-    @validate_call
     def get_all(
         self,
         *,

{albert-1.9.6 → albert-1.10.0rc1}/src/albert/collections/property_data.py

@@ -7,7 +7,6 @@ import pandas as pd
 from pydantic import validate_call
 
 from albert.collections.base import BaseCollection
-from albert.collections.tasks import TaskCollection
 from albert.core.logging import logger
 from albert.core.pagination import AlbertPaginator
 from albert.core.session import AlbertSession
@@ -65,6 +64,8 @@ class PropertyDataCollection(BaseCollection):
 
     @validate_call
     def _get_task_from_id(self, *, id: TaskId) -> PropertyTask:
+        from albert.collections.tasks import TaskCollection
+
         return TaskCollection(session=self.session).get_by_id(id=id)
 
     @validate_call
@@ -309,7 +310,6 @@ class PropertyDataCollection(BaseCollection):
             )
         return all_info
 
-    @validate_call
     def _resolve_return_scope(
         self,
         *,
@@ -553,7 +553,6 @@ class PropertyDataCollection(BaseCollection):
                 lot_id=lot_id,
             )
 
-    @validate_call
     def bulk_load_task_properties(
         self,
         *,
@@ -677,7 +676,6 @@ class PropertyDataCollection(BaseCollection):
             return_scope=return_scope,
         )
 
-    @validate_call
     def bulk_delete_task_data(
         self,
         *,

{albert-1.9.6 → albert-1.10.0rc1}/src/albert/collections/reports.py

@@ -1,7 +1,5 @@
 from typing import Any
 
-from pydantic import validate_call
-
 from albert.collections.base import BaseCollection
 from albert.core.session import AlbertSession
 from albert.core.shared.identifiers import ReportId
@@ -138,7 +136,6 @@ class ReportCollection(BaseCollection):
             input_data=input_data,
         )
 
-    @validate_call
     def get_full_report(self, *, report_id: ReportId) -> FullAnalyticalReport:
         """Get a full analytical report by its ID.
 
@@ -195,7 +192,6 @@ class ReportCollection(BaseCollection):
         response = self.session.post(path, json=report_data)
         return FullAnalyticalReport(**response.json())
 
-    @validate_call
     def delete(self, *, id: ReportId) -> None:
         """Delete a report.