entitysdk 0.3.0__tar.gz → 0.3.2__tar.gz

{entitysdk-0.3.0/src/entitysdk.egg-info → entitysdk-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: entitysdk
-Version: 0.3.0
+Version: 0.3.2
 Summary: Python library for interacting with the entitycore service
 Author-email: Open Brain Institute <info@openbraininstitute.org>
 Maintainer-email: Open Brain Institute <info@openbraininstitute.org>
@@ -58,9 +58,7 @@ token = get_token(environment="staging")
 
 ```python
 from uuid import UUID
-from entitysdk.client import Client
-from entitysdk.common import ProjectContext
-from entitysdk.models.morphology import ReconstructionMorphology
+from entitysdk import Client, ProjectContext, models
 
 # Initialize client
 client = Client(
@@ -73,7 +71,7 @@ client = Client(
 
 # Search for morphologies
 iterator = client.search_entity(
-    entity_type=ReconstructionMorphology,
+    entity_type=models.ReconstructionMorphology,
     query={"mtype__pref_label": "L5_TPC:A"},
     token=token,
     limit=1,
@@ -83,7 +81,7 @@ morphology = next(iterator)
 # Upload an asset
 client.upload_file(
     entity_id=morphology.id,
-    entity_type=ReconstructionMorphology,
+    entity_type=models.ReconstructionMorphology,
     file_path="path/to/file.swc",
     file_content_type="application/swc",
     token="your-token"
@@ -99,7 +97,7 @@ client.upload_file(
 Example configuration:
 ```python
 from uuid import UUID
-from entitysdk.common import ProjectContext
+from entitysdk import ProjectContext
 
 project_context = ProjectContext(
     project_id=UUID("12345678-1234-1234-1234-123456789012"),

{entitysdk-0.3.0 → entitysdk-0.3.2}/README.md

@@ -37,9 +37,7 @@ token = get_token(environment="staging")
 
 ```python
 from uuid import UUID
-from entitysdk.client import Client
-from entitysdk.common import ProjectContext
-from entitysdk.models.morphology import ReconstructionMorphology
+from entitysdk import Client, ProjectContext, models
 
 # Initialize client
 client = Client(
@@ -52,7 +50,7 @@ client = Client(
 
 # Search for morphologies
 iterator = client.search_entity(
-    entity_type=ReconstructionMorphology,
+    entity_type=models.ReconstructionMorphology,
     query={"mtype__pref_label": "L5_TPC:A"},
     token=token,
     limit=1,
@@ -62,7 +60,7 @@ morphology = next(iterator)
 # Upload an asset
 client.upload_file(
     entity_id=morphology.id,
-    entity_type=ReconstructionMorphology,
+    entity_type=models.ReconstructionMorphology,
     file_path="path/to/file.swc",
     file_content_type="application/swc",
     token="your-token"
@@ -78,7 +76,7 @@ client.upload_file(
 Example configuration:
 ```python
 from uuid import UUID
-from entitysdk.common import ProjectContext
+from entitysdk import ProjectContext
 
 project_context = ProjectContext(
     project_id=UUID("12345678-1234-1234-1234-123456789012"),

{entitysdk-0.3.0 → entitysdk-0.3.2}/examples/02_morphology.ipynb

@@ -302,19 +302,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "for asset in fetched.assets:\n",
-    "    if asset.content_type == \"application/swc\":\n",
-    "        client.download_file(\n",
-    "            entity_id=fetched.id,\n",
-    "            entity_type=type(fetched),\n",
-    "            asset_id=asset.id,\n",
-    "            output_path=\"./my-file.h5\",\n",
-    "            token=token,\n",
-    "        )\n",
-    "        content = client.download_content(\n",
-    "            entity_id=fetched.id, entity_type=type(fetched), asset_id=asset.id, token=token\n",
-    "        )\n",
-    "        break\n",
+    "downloaded_asset = client.download_assets(\n",
+    "    fetched.assets,\n",
+    "    selection={\"content_type\": \"application/swc\"},\n",
+    "    output_path=\"./my-file.h5\",\n",
+    "    token=token,\n",
+    ").one()\n",
+    "\n",
+    "content = client.download_content(\n",
+    "    entity_id=fetched.id, entity_type=type(fetched), asset_id=downloaded_asset.id, token=token\n",
+    ")\n",
     "\n",
     "print(content)\n",
     "print(Path(\"my-file.h5\").read_text())"

entitysdk-0.3.2/src/entitysdk/__init__.py

@@ -0,0 +1,6 @@
+"""entitysdk."""
+
+from entitysdk.client import Client
+from entitysdk.common import ProjectContext
+
+__all__ = ["Client", "ProjectContext"]

{entitysdk-0.3.0 → entitysdk-0.3.2}/src/entitysdk/client.py

@@ -3,6 +3,7 @@
 import io
 import os
 from pathlib import Path
+from typing import Any, cast
 
 import httpx
 
@@ -11,7 +12,9 @@ from entitysdk.common import ProjectContext
 from entitysdk.exception import EntitySDKError
 from entitysdk.models.asset import Asset, LocalAssetMetadata
 from entitysdk.models.core import Identifiable
+from entitysdk.models.entity import Entity
 from entitysdk.result import IteratorResult
+from entitysdk.schemas.asset import DownloadedAsset
 from entitysdk.token_manager import TokenManager
 from entitysdk.types import ID, DeploymentEnvironment
 from entitysdk.util import (
@@ -19,6 +22,7 @@ from entitysdk.util import (
     create_intermediate_directories,
     validate_filename_extension_consistency,
 )
+from entitysdk.utils.asset import filter_assets
 
 
 class Client:
@@ -103,7 +107,6 @@ class Client:
         entity_id: ID,
         *,
         entity_type: type[Identifiable],
-        with_assets: bool = True,
         project_context: ProjectContext | None = None,
         token: str | None = None,
     ) -> Identifiable:
@@ -126,28 +129,13 @@ class Client:
         )
         token = self._get_token(override_token=token)
         context = self._optional_user_context(override_context=project_context)
-        entity = core.get_entity(
+        return core.get_entity(
             url=url,
             token=token,
             entity_type=entity_type,
             project_context=context,
             http_client=self._http_client,
         )
-        if with_assets and "assets" in entity_type.model_fields:
-            url = route.get_assets_endpoint(
-                api_url=self.api_url,
-                entity_type=entity_type,
-                entity_id=entity_id,
-            )
-            assets = core.get_entity_assets(
-                url=url,
-                token=token,
-                project_context=context,
-                http_client=self._http_client,
-            )
-            entity = entity.evolve(assets=assets)
-
-        return entity
 
     def search_entity(
         self,
@@ -361,7 +349,7 @@ class Client:
         output_path: os.PathLike,
         project_context: ProjectContext | None = None,
         token: str | None = None,
-    ) -> None:
+    ) -> Path:
         """Download asset file to a file path.
 
         Args:
@@ -371,6 +359,9 @@ class Client:
             output_path: Either be a file path to write the file to or an output directory.
             project_context: Optional project context.
             token: Authorization access token.
+
+        Returns:
+            Output file path.
         """
         asset_endpoint = route.get_assets_endpoint(
             api_url=self.api_url,
@@ -402,6 +393,60 @@ class Client:
             http_client=self._http_client,
         )
 
+    def download_assets(
+        self,
+        entity_or_id: Entity | tuple[ID, type[Entity]],
+        *,
+        selection: dict[str, Any] | None = None,
+        output_path: Path,
+        project_context: ProjectContext | None = None,
+        token: str | None = None,
+    ) -> IteratorResult:
+        """Download assets."""
+
+        def _download_entity_asset(asset):
+            if asset.is_directory:
+                raise NotImplementedError("Downloading asset directories is not supported yet.")
+            else:
+                path = self.download_file(
+                    entity_id=entity.id,
+                    entity_type=type(entity),
+                    asset_id=asset.id,
+                    output_path=output_path,
+                    project_context=context,
+                    token=token,
+                )
+
+            return DownloadedAsset(
+                asset=asset,
+                output_path=path,
+            )
+
+        token = self._get_token(override_token=token)
+        context = self._optional_user_context(override_context=project_context)
+        if isinstance(entity_or_id, tuple):
+            entity_id, entity_type = entity_or_id
+            entity = self.get_entity(
+                entity_id=entity_id,
+                entity_type=entity_type,
+                project_context=context,
+                token=token,
+            )
+        else:
+            entity = entity_or_id
+
+        if not issubclass(type(entity), Entity):
+            raise EntitySDKError(f"Type {type(entity)} has no assets.")
+
+        # make mypy happy as it doesn't get the correct type :(
+        entity = cast(Entity, entity)
+
+        if not entity.assets:
+            raise EntitySDKError(f"Entity {entity.id} ({entity.name}) has no assets.")
+
+        assets = filter_assets(entity.assets, selection) if selection else entity.assets
+        return IteratorResult(map(_download_entity_asset, assets))
+
     def delete_asset(
         self,
         *,

{entitysdk-0.3.0 → entitysdk-0.3.2}/src/entitysdk/core.py

@@ -76,34 +76,6 @@ def get_entity(
     return serdes.deserialize_entity(response.json(), entity_type)
 
 
-def get_entity_assets(
-    url: str,
-    *,
-    project_context: ProjectContext | None = None,
-    token: str,
-    http_client: httpx.Client | None = None,
-) -> list[Asset]:
-    """Get entity assets.
-
-    Args:
-        url: URL of the resource.
-        project_context: Project context.
-        token: Authorization access token.
-        http_client: HTTP client.
-
-    Returns:
-        List of assets.
-    """
-    response = make_db_api_request(
-        url=url,
-        method="GET",
-        project_context=project_context,
-        token=token,
-        http_client=http_client,
-    )
-    return [serdes.deserialize_entity(asset, Asset) for asset in response.json()["data"]]
-
-
 def register_entity(
     url: str,
     *,
@@ -211,7 +183,7 @@ def download_asset_file(
     project_context: ProjectContext | None = None,
     token: str,
     http_client: httpx.Client | None = None,
-) -> None:
+) -> Path:
     """Download asset file to a file path.
 
     Args:
@@ -220,6 +192,9 @@ def download_asset_file(
         project_context: Project context.
         token: Authorization access token.
         http_client: HTTP client.
+
+    Returns:
+        Output file path.
     """
     bytes_content = download_asset_content(
         url=url,
@@ -228,6 +203,7 @@ def download_asset_file(
         http_client=http_client,
     )
     output_path.write_bytes(bytes_content)
+    return output_path
 
 
 def download_asset_content(

{entitysdk-0.3.0 → entitysdk-0.3.2}/src/entitysdk/mixin.py

@@ -8,4 +8,4 @@ from entitysdk.models.asset import Asset
 class HasAssets(BaseModel):
     """Mixin class for entities that have assets."""
 
-    assets: list[Asset] | None = None
+    assets: list[Asset] = []

{entitysdk-0.3.0 → entitysdk-0.3.2}/src/entitysdk/models/asset.py

@@ -56,9 +56,9 @@ class Asset(Identifiable):
         ),
     ] = None
     meta: Annotated[
-        dict | None,
+        dict,
         Field(description="Asset json metadata."),
-    ] = None
+    ] = {}
 
 
 class LocalAssetMetadata(BaseModel):

{entitysdk-0.3.0 → entitysdk-0.3.2}/src/entitysdk/models/mtype.py

@@ -25,4 +25,4 @@ class MTypeClass(Identifiable):
     alt_label: Annotated[
         str | None,
         Field(description="The alternative label of th mtype class."),
-    ]
+    ] = None

entitysdk-0.3.2/src/entitysdk/schemas/__init__.py

@@ -0,0 +1 @@
+"""Local to entitysdk schemas."""

entitysdk-0.3.2/src/entitysdk/schemas/asset.py

@@ -0,0 +1,13 @@
+"""Asset related schemas."""
+
+from pathlib import Path
+
+from entitysdk.models.asset import Asset
+from entitysdk.schemas.base import Schema
+
+
+class DownloadedAsset(Schema):
+    """Downloaded asset."""
+
+    asset: Asset
+    output_path: Path

entitysdk-0.3.2/src/entitysdk/schemas/base.py

@@ -0,0 +1,13 @@
+"""Base schema model."""
+
+from pydantic import BaseModel, ConfigDict
+
+
+class Schema(BaseModel):
+    """Base model."""
+
+    model_config = ConfigDict(
+        frozen=True,
+        from_attributes=True,
+        extra="forbid",
+    )

entitysdk-0.3.2/src/entitysdk/utils/__init__.py

@@ -0,0 +1 @@
+"""Utilities."""

entitysdk-0.3.2/src/entitysdk/utils/asset.py

@@ -0,0 +1,31 @@
+"""Asset related utitilies."""
+
+from typing import Any
+
+from entitysdk.exception import EntitySDKError
+from entitysdk.models.asset import Asset
+
+
+def filter_assets(assets: list[Asset], selection: dict[str, Any]) -> list[Asset]:
+    """Filter assets according to selection dictionary."""
+    if not assets:
+        return []
+
+    if not selection:
+        return assets
+
+    if not selection.keys() <= Asset.model_fields.keys():
+        raise EntitySDKError(
+            "Selection keys are not matching asset metadata keys.\n"
+            f"Selection: {sorted(selection.keys())}\n"
+            f"Available: {sorted(Asset.model_fields.keys())}"
+        )
+
+    def _selection_predicate(asset: Asset) -> bool:
+        attributes = vars(asset)
+        for key, value in selection.items():
+            if attributes[key] != value:
+                return False
+        return True
+
+    return [asset for asset in assets if _selection_predicate(asset)]

{entitysdk-0.3.0 → entitysdk-0.3.2/src/entitysdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: entitysdk
-Version: 0.3.0
+Version: 0.3.2
 Summary: Python library for interacting with the entitycore service
 Author-email: Open Brain Institute <info@openbraininstitute.org>
 Maintainer-email: Open Brain Institute <info@openbraininstitute.org>
@@ -58,9 +58,7 @@ token = get_token(environment="staging")
 
 ```python
 from uuid import UUID
-from entitysdk.client import Client
-from entitysdk.common import ProjectContext
-from entitysdk.models.morphology import ReconstructionMorphology
+from entitysdk import Client, ProjectContext, models
 
 # Initialize client
 client = Client(
@@ -73,7 +71,7 @@ client = Client(
 
 # Search for morphologies
 iterator = client.search_entity(
-    entity_type=ReconstructionMorphology,
+    entity_type=models.ReconstructionMorphology,
     query={"mtype__pref_label": "L5_TPC:A"},
     token=token,
     limit=1,
@@ -83,7 +81,7 @@ morphology = next(iterator)
 # Upload an asset
 client.upload_file(
     entity_id=morphology.id,
-    entity_type=ReconstructionMorphology,
+    entity_type=models.ReconstructionMorphology,
     file_path="path/to/file.swc",
     file_content_type="application/swc",
     token="your-token"
@@ -99,7 +97,7 @@ client.upload_file(
 Example configuration:
 ```python
 from uuid import UUID
-from entitysdk.common import ProjectContext
+from entitysdk import ProjectContext
 
 project_context = ProjectContext(
     project_id=UUID("12345678-1234-1234-1234-123456789012"),

{entitysdk-0.3.0 → entitysdk-0.3.2}/src/entitysdk.egg-info/SOURCES.txt

@@ -50,6 +50,11 @@ src/entitysdk/models/response.py
 src/entitysdk/models/subject.py
 src/entitysdk/models/taxonomy.py
 src/entitysdk/models/validation_result.py
+src/entitysdk/schemas/__init__.py
+src/entitysdk/schemas/asset.py
+src/entitysdk/schemas/base.py
+src/entitysdk/utils/__init__.py
+src/entitysdk/utils/asset.py
 tests/__init__.py
 tests/integration/__init__.py
 tests/integration/conftest.py
@@ -82,4 +87,5 @@ tests/unit/models/data/electrical_cell_recording.json
 tests/unit/models/data/ion_channel_model.json
 tests/unit/models/data/memodel_calibration_result.json
 tests/unit/models/data/reconstruction_morphology.json
-tests/unit/models/data/validation_result.json
+tests/unit/models/data/validation_result.json
+tests/unit/utils/test_asset.py

{entitysdk-0.3.0 → entitysdk-0.3.2}/tests/unit/models/data/electrical_cell_recording.json

@@ -38,7 +38,8 @@
       "update_date": "2025-05-17T15:43:33.885603Z",
       "name": "Rattus norvegicus",
       "taxonomy_id": "NCBITaxon:10116"
-    }
+    },
+    "assets": []
   },
   "brain_region": {
     "creation_date": "2025-05-17T15:41:56.308111Z",
@@ -98,7 +99,8 @@
       "description": "",
       "injection_type": "current_clamp",
       "shape": "step",
-      "authorized_public": false
+      "authorized_public": false,
+      "assets": []
     },
     {
       "type": "electrical_recording_stimulus",
@@ -109,7 +111,8 @@
       "description": "",
       "injection_type": "current_clamp",
       "shape": "step",
-      "authorized_public": false
+      "authorized_public": false,
+      "assets": []
     },
     {
       "type": "electrical_recording_stimulus",
@@ -120,7 +123,8 @@
       "description": "",
       "injection_type": "current_clamp",
       "shape": "step",
-      "authorized_public": false
+      "authorized_public": false,
+      "assets": []
     }
   ]
 }

{entitysdk-0.3.0 → entitysdk-0.3.2}/tests/unit/models/data/memodel_calibration_result.json

@@ -4,5 +4,6 @@
     "holding_current" : 0.0,
     "threshold_current" : 0.06554153953301577,
     "rin" : 100.03205800593804,
-    "calibrated_entity_id" : "54004e96-cef0-4f1c-8c89-d9cdf7b94e43"
-}
+    "calibrated_entity_id" : "54004e96-cef0-4f1c-8c89-d9cdf7b94e43",
+    "assets": []
+}

{entitysdk-0.3.0 → entitysdk-0.3.2}/tests/unit/models/data/validation_result.json

@@ -3,5 +3,6 @@
 	"id" : "6fa52c8b-e9df-4f10-bdee-07c9af59a5ba",
 	"passed" : true,
 	"name" : "Simulatable Neuron Spiking Validation",
-	"validated_entity_id" : "54004e96-cef0-4f1c-8c89-d9cdf7b94e43"
-}
+	"validated_entity_id" : "54004e96-cef0-4f1c-8c89-d9cdf7b94e43",
+    "assets": []
+}

{entitysdk-0.3.0 → entitysdk-0.3.2}/tests/unit/models/test_electrical_cell_recording.py

@@ -28,7 +28,6 @@ def test_read(client, httpx_mock, auth_token, json_data):
         entity_id=MOCK_UUID,
         entity_type=Model,
         token=auth_token,
-        with_assets=False,
     )
     assert entity.model_dump(mode="json", exclude_none=True) == json_data
 

{entitysdk-0.3.0 → entitysdk-0.3.2}/tests/unit/models/test_ion_channel_model.py

@@ -26,7 +26,6 @@ def test_read_ion_channel_model(client, httpx_mock, auth_token, json_ion_channel
         entity_id=MOCK_UUID,
         entity_type=IonChannelModel,
         token=auth_token,
-        with_assets=False,
     )
     assert entity.model_dump(mode="json") == json_ion_channel_expanded | {"legacy_id": None}
 

{entitysdk-0.3.0 → entitysdk-0.3.2}/tests/unit/models/test_memodel_calibration_result.py

@@ -28,7 +28,6 @@ def test_read(client, httpx_mock, auth_token, json_data):
         entity_id=MOCK_UUID,
         entity_type=Model,
         token=auth_token,
-        with_assets=False,
     )
     assert entity.model_dump(mode="json", exclude_none=True) == json_data
 

{entitysdk-0.3.0 → entitysdk-0.3.2}/tests/unit/models/test_morphology.py

@@ -28,7 +28,6 @@ def test_read_reconstruction_morphology(client, httpx_mock, auth_token, json_mor
         entity_id=MOCK_UUID,
         entity_type=ReconstructionMorphology,
         token=auth_token,
-        with_assets=False,
     )
     assert entity.model_dump(mode="json") == json_morphology_expanded | {"legacy_id": None}
 

{entitysdk-0.3.0 → entitysdk-0.3.2}/tests/unit/models/test_validation_result.py

@@ -28,7 +28,6 @@ def test_read(client, httpx_mock, auth_token, json_data):
         entity_id=MOCK_UUID,
         entity_type=Model,
         token=auth_token,
-        with_assets=False,
     )
     assert entity.model_dump(mode="json", exclude_none=True) == json_data
 

{entitysdk-0.3.0 → entitysdk-0.3.2}/tests/unit/test_client.py

@@ -9,6 +9,7 @@ import pytest
 from entitysdk.client import Client
 from entitysdk.config import settings
 from entitysdk.exception import EntitySDKError
+from entitysdk.models import Asset, MTypeClass
 from entitysdk.models.core import Identifiable
 from entitysdk.models.entity import Entity
 from entitysdk.types import DeploymentEnvironment
@@ -134,6 +135,13 @@ def test_client_nupdate(mocked_route, client, httpx_mock, auth_token):
     assert res.name == new_name
 
 
+def _mock_entity_response(entity_id):
+    return {
+        "id": str(entity_id),
+        "description": "my-entity",
+    }
+
+
 def _mock_asset_response(asset_id):
     return {
         "id": str(asset_id),
@@ -423,32 +431,28 @@ def test_client_get(
     asset_id1 = uuid.uuid4()
     asset_id2 = uuid.uuid4()
 
-    class EntityWithAssets(Entity):
-        """Entity plus assets."""
-
     mock_route.return_value = "entity"
 
     httpx_mock.add_response(
         method="GET",
         url=f"{api_url}/entity/{entity_id}",
         match_headers=request_headers,
-        json={"id": str(entity_id), "name": "foo", "description": "bar", "type": "entity"},
-    )
-    httpx_mock.add_response(
-        method="GET",
-        url=f"{api_url}/entity/{entity_id}/assets",
-        match_headers=request_headers,
         json={
-            "data": [_mock_asset_response(asset_id1), _mock_asset_response(asset_id2)],
-            "pagination": {"page": 1, "page_size": 10, "total_items": 2},
+            "id": str(entity_id),
+            "name": "foo",
+            "description": "bar",
+            "type": "entity",
+            "assets": [
+                _mock_asset_response(asset_id1),
+                _mock_asset_response(asset_id2),
+            ],
         },
     )
 
     res = client.get_entity(
         entity_id=str(entity_id),
-        entity_type=EntityWithAssets,
+        entity_type=Entity,
         token=auth_token,
-        with_assets=True,
     )
     assert res.id == entity_id
     assert len(res.assets) == 2
@@ -547,3 +551,166 @@ def test_client_update_asset(
 
     assert res.id == asset_id
     assert res.status == "created"
+
+
+def test_client_download_assets(
+    tmp_path, api_url, client, project_context, auth_token, request_headers, httpx_mock
+):
+    entity_id = uuid.uuid4()
+    asset1_id = uuid.uuid4()
+    asset2_id = uuid.uuid4()
+
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{api_url}/entity/{entity_id}",
+        match_headers=request_headers,
+        json=_mock_entity_response(entity_id)
+        | {
+            "assets": [
+                _mock_asset_response(asset1_id)
+                | {"path": "foo/bar/bar.h5", "content_type": "application/hdf5"},
+                _mock_asset_response(asset2_id)
+                | {"path": "foo/bar/bar.swc", "content_type": "application/swc"},
+            ]
+        },
+    )
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{api_url}/entity/{entity_id}/assets/{asset2_id}",
+        match_headers=request_headers,
+        json=_mock_asset_response(asset2_id)
+        | {"path": "foo/bar/bar.swc", "content_type": "application/swc"},
+    )
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{api_url}/entity/{entity_id}/assets/{asset2_id}/download",
+        match_headers=request_headers,
+        content=b"bar",
+    )
+
+    res = client.download_assets(
+        (entity_id, Entity),
+        selection={"content_type": "application/swc"},
+        output_path=tmp_path,
+        project_context=project_context,
+        token=auth_token,
+    ).one()
+
+    assert res.asset.path == "foo/bar/bar.swc"
+    assert res.output_path == tmp_path / "foo/bar/bar.swc"
+    assert res.output_path.read_bytes() == b"bar"
+
+
+def test_client_download_assets__no_assets_raise(
+    tmp_path, api_url, client, project_context, auth_token, request_headers, httpx_mock
+):
+    entity_id = uuid.uuid4()
+
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{api_url}/entity/{entity_id}",
+        match_headers=request_headers,
+        json=_mock_entity_response(entity_id) | {"assets": []},
+    )
+
+    with pytest.raises(EntitySDKError, match="has no assets"):
+        client.download_assets(
+            (entity_id, Entity),
+            selection={"content_type": "application/swc"},
+            output_path=tmp_path,
+            project_context=project_context,
+            token=auth_token,
+        ).one()
+
+
+def test_client_download_assets__non_entity(
+    tmp_path, api_url, client, project_context, auth_token, request_headers, httpx_mock
+):
+    entity_id = uuid.uuid4()
+
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{api_url}/mtype/{entity_id}",
+        match_headers=request_headers,
+        json=_mock_entity_response(entity_id) | {"pref_label": "foo", "definition": "bar"},
+    )
+
+    with pytest.raises(EntitySDKError, match="has no assets"):
+        client.download_assets(
+            (entity_id, MTypeClass),
+            selection={"content_type": "application/swc"},
+            output_path=tmp_path,
+            project_context=project_context,
+            token=auth_token,
+        ).one()
+
+
+def test_client_download_assets__directory_not_supported(
+    tmp_path, api_url, client, project_context, auth_token, request_headers, httpx_mock
+):
+    entity_id = uuid.uuid4()
+    asset_id = uuid.uuid4()
+
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{api_url}/entity/{entity_id}",
+        match_headers=request_headers,
+        json=_mock_entity_response(entity_id)
+        | {"assets": [_mock_asset_response(asset_id) | {"is_directory": True}]},
+    )
+
+    with pytest.raises(
+        NotImplementedError, match="Downloading asset directories is not supported yet."
+    ):
+        client.download_assets(
+            (entity_id, Entity),
+            output_path=tmp_path,
+            project_context=project_context,
+            token=auth_token,
+        ).one()
+
+
+def test_client_download_assets__entity(
+    tmp_path, api_url, client, project_context, auth_token, request_headers, httpx_mock
+):
+    entity_id = uuid.uuid4()
+    asset_id = uuid.uuid4()
+
+    entity = Entity(
+        id=entity_id,
+        name="foo",
+        description="bar",
+        assets=[
+            Asset(
+                id=asset_id,
+                path="foo.json",
+                full_path="/foo/asset1",
+                is_directory=False,
+                content_type="application/json",
+                size=1,
+            ),
+        ],
+    )
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{api_url}/entity/{entity_id}/assets/{asset_id}",
+        match_headers=request_headers,
+        json=_mock_asset_response(asset_id)
+        | {"path": "foo.json", "content_type": "application/json"},
+    )
+    httpx_mock.add_response(
+        method="GET",
+        url=f"{api_url}/entity/{entity_id}/assets/{asset_id}/download",
+        match_headers=request_headers,
+        content=b"bar",
+    )
+
+    res = client.download_assets(
+        entity,
+        selection={"content_type": "application/json"},
+        output_path=tmp_path,
+        project_context=project_context,
+        token=auth_token,
+    ).all()
+
+    assert len(res) == 1

entitysdk-0.3.2/tests/unit/utils/test_asset.py

@@ -0,0 +1,78 @@
+import pytest
+
+from entitysdk.exception import EntitySDKError
+from entitysdk.models import Asset
+from entitysdk.utils import asset as test_module
+
+
+@pytest.fixture
+def assets():
+    return [
+        Asset(
+            path="foo/asset1",
+            full_path="/foo/asset1",
+            is_directory=False,
+            content_type="application/json",
+            size=1,
+        ),
+        Asset(
+            path="foo/asset2",
+            full_path="/foo/asset2",
+            is_directory=False,
+            content_type="application/csv",
+            size=1,
+        ),
+        Asset(
+            path="foo/asset3",
+            full_path="/foo/asset3",
+            is_directory=False,
+            content_type="application/csv",
+            size=1,
+        ),
+    ]
+
+
+def test_filter_assets__none(assets):
+    res = test_module.filter_assets(assets, selection={"content_type": "application/swc"})
+    assert res == []
+
+
+def test_filter_assets__one(assets):
+    res = test_module.filter_assets(assets, selection={"content_type": "application/json"})
+    assert len(res) == 1
+    assert res[0].path == "foo/asset1"
+
+
+def test_filter_assets__multiple_matches(assets):
+    res = test_module.filter_assets(assets, selection={"content_type": "application/csv"})
+    assert len(res) == 2
+    assert res[0].path == "foo/asset2"
+    assert res[1].path == "foo/asset3"
+
+
+def test_filter_assets__empty_assets():
+    res = test_module.filter_assets([], selection={"content_type": "application/csv"})
+    assert res == []
+
+
+def test_filter_assets__multiple_selections(assets):
+    res = test_module.filter_assets(
+        assets, selection={"content_type": "application/csv", "size": 1, "path": "foo/asset2"}
+    )
+    assert len(res) == 1
+    assert res[0].path == "foo/asset2"
+
+
+def test_filter_assets__empty_selection(assets):
+    res = test_module.filter_assets(assets, selection={})
+    assert res == assets
+
+
+def test_filter_assets__invalid_keys(assets):
+    with pytest.raises(EntitySDKError, match="Selection keys are not matching asset metadata keys"):
+        test_module.filter_assets(assets, selection={"foo": "bar"})
+
+    with pytest.raises(EntitySDKError, match="Selection keys are not matching asset metadata keys"):
+        test_module.filter_assets(
+            assets, selection={"content_type": "application/json", "foo": "bar"}
+        )

entitysdk-0.3.0/src/entitysdk/__init__.py

@@ -1 +0,0 @@
-"""entitysdk."""