datamint 2.3.1__py3-none-any.whl → 2.3.3__py3-none-any.whl

datamint/entities/resource.py

@@ -1,19 +1,33 @@
 """Resource entity module for DataMint API."""
 
 from datetime import datetime
-from typing import Optional, Any
+from typing import TYPE_CHECKING, Optional, Any, Sequence
 import logging
+
 from .base_entity import BaseEntity, MISSING_FIELD
-from pydantic import Field
+from .cache_manager import CacheManager
+from pydantic import PrivateAttr
+from datamint.api.dto import AnnotationType
+import webbrowser
+from datamint.types import ImagingData
+
+if TYPE_CHECKING:
+    from datamint.api.endpoints.resources_api import ResourcesApi
+    from .project import Project
+    from .annotation import Annotation
 
 logger = logging.getLogger(__name__)
 
+
+_IMAGE_CACHEKEY = "image_data"
+
+
 class Resource(BaseEntity):
     """Represents a DataMint resource with all its properties and metadata.
-    
+
     This class models a resource entity from the DataMint API, containing
     information about uploaded files, their metadata, and associated projects.
-    
+
     Attributes:
         id: Unique identifier for the resource
         resource_uri: URI path to access the resource file
@@ -84,42 +98,145 @@ class Resource(BaseEntity):
     categories: Optional[Any] = None  # TODO: Define proper type when spec available
     user_info: Optional[dict] = None
 
+    _api: 'ResourcesApi' = PrivateAttr()
+
+    def __init__(self, **data):
+        """Initialize the resource entity."""
+        super().__init__(**data)
+        self._cache: CacheManager[bytes] = CacheManager[bytes]('resources')
+
+    def fetch_file_data(
+        self,
+        auto_convert: bool = True,
+        save_path: str | None = None,
+        use_cache: bool = False,
+    ) -> bytes | ImagingData:
+        """Get the file data for this resource.
+
+        This method automatically caches the file data locally. On subsequent
+        calls, it checks the server for changes and uses cached data if unchanged.
+
+        Args:
+            use_cache: If True, uses cached data when available and valid
+            auto_convert: If True, automatically converts to appropriate format (pydicom.Dataset, PIL Image, etc.)
+            save_path: Optional path to save the file locally
+
+        Returns:
+            File data (format depends on auto_convert and file type)
+        """
+        # Version info for cache validation
+        version_info = self._generate_version_info()
+
+        # Try to get from cache
+        img_data = None
+        if use_cache:
+            img_data = self._cache.get(self.id, _IMAGE_CACHEKEY, version_info)
+            if img_data is not None:
+                logger.debug(f"Using cached image data for resource {self.id}")
+
+        if img_data is None:
+            # Fetch from server using download_resource_file
+            logger.debug(f"Fetching image data from server for resource {self.id}")
+            img_data = self._api.download_resource_file(
+                self,
+                save_path=save_path,
+                auto_convert=False
+            )
+            # Cache the data
+            if use_cache:
+                self._cache.set(self.id, _IMAGE_CACHEKEY, img_data, version_info)
+
+        if auto_convert:
+            try:
+                mimetype, ext = self._api._determine_mimetype(img_data, self)
+                img_data = self._api.convert_format(img_data,
+                                                    mimetype=mimetype,
+                                                    file_path=save_path)
+            except Exception as e:
+                logger.error(f"Failed to auto-convert resource {self.id}: {e}")
+
+        return img_data
+
+    def _generate_version_info(self) -> dict:
+        """Helper to generate version info for caching."""
+        return {
+            'created_at': self.created_at,
+            'deleted_at': self.deleted_at,
+            'size': self.size,
+        }
+
+    def _save_into_cache(self, data: bytes) -> None:
+        """Helper to save raw data into cache."""
+        version_info = self._generate_version_info()
+        self._cache.set(self.id, _IMAGE_CACHEKEY, data, version_info)
+
+    def fetch_annotations(
+        self,
+        annotation_type: AnnotationType | str | None = None
+    ) -> Sequence['Annotation']:
+        """Get annotations associated with this resource."""
+
+        annotations = self._api.get_annotations(self)
+
+        if annotation_type:
+            annotation_type = AnnotationType(annotation_type)
+            annotations = [a for a in annotations if a.annotation_type == annotation_type]
+        return annotations
+
+    # def get_projects(
+    #     self,
+    # ) -> Sequence['Project']:
+    #     """Get all projects this resource belongs to.
+
+    #     Returns:
+    #         List of Project instances
+    #     """
+    #     return self._api.get_projects(self)
+
+        
+    def invalidate_cache(self) -> None:
+        """Invalidate cached data for this resource.
+        """
+        # Invalidate all
+        self._cache.invalidate(self.id)
+        logger.debug(f"Invalidated all cache for resource {self.id}")
+
     @property
     def size_mb(self) -> float:
         """Get file size in megabytes.
-        
+
         Returns:
             File size in MB rounded to 2 decimal places
         """
         return round(self.size / (1024 * 1024), 2)
-    
+
     def is_dicom(self) -> bool:
         """Check if the resource is a DICOM file.
-        
+
         Returns:
             True if the resource is a DICOM file, False otherwise
         """
         return self.mimetype == 'application/dicom' or self.storage == 'DicomResource'
-    
-    def get_project_names(self) -> list[str]:
-        """Get list of project names this resource belongs to.
-        
-        Returns:
-            List of project names
-        """
-        return [proj['name'] for proj in self.projects]
-    
+
+    # def get_project_names(self) -> list[str]:
+    #     """Get list of project names this resource belongs to.
+
+    #     Returns:
+    #         List of project names
+    #     """
+    #     return [proj['name'] for proj in self.projects] if self.projects != MISSING_FIELD else []
+
     def __str__(self) -> str:
         """String representation of the resource.
-        
+
         Returns:
             Human-readable string describing the resource
         """
         return f"Resource(id='{self.id}', filename='{self.filename}', size={self.size_mb}MB)"
-    
+
     def __repr__(self) -> str:
         """Detailed string representation of the resource.
-        
+
         Returns:
             Detailed string representation for debugging
         """
@@ -128,3 +245,13 @@ class Resource(BaseEntity):
             f"modality='{self.modality}', status='{self.status}', "
             f"published={self.published})"
         )
+    
+    @property
+    def url(self) -> str:
+        """Get the URL to access this resource in the DataMint web application."""
+        base_url = self._api.config.web_app_url
+        return f'{base_url}/resource/{self.id}'
+
+    def show(self) -> None:
+        """Open the resource in the default web browser."""
+        webbrowser.open(self.url)

datamint/types.py

@@ -0,0 +1,17 @@
+from typing import TypeAlias, TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    import pydicom.dataset
+    from PIL import Image
+    import cv2
+    from nibabel.filebasedimages import FileBasedImage as nib_FileBasedImage
+
+# Type alias for imaging formats
+ImagingData: TypeAlias = (
+    Union[
+        'pydicom.dataset.Dataset',
+        'Image.Image',
+        'cv2.VideoCapture',
+        'nib_FileBasedImage'
+    ]
+)

{datamint-2.3.1.dist-info → datamint-2.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datamint
-Version: 2.3.1
+Version: 2.3.3
 Summary: A library for interacting with the Datamint API, designed for efficient data management, processing and Deep Learning workflows.
 Requires-Python: >=3.10
 Classifier: Programming Language :: Python :: 3
@@ -15,6 +15,7 @@ Requires-Dist: Deprecated (>=1.2.0)
 Requires-Dist: aiohttp (>=3.0.0,<4.0.0)
 Requires-Dist: aioresponses (>=0.7.8,<0.8.0) ; extra == "dev"
 Requires-Dist: albumentations (>=2.0.0)
+Requires-Dist: backports-strenum ; python_version < "3.11"
 Requires-Dist: datamintapi (==0.0.*)
 Requires-Dist: httpx
 Requires-Dist: humanize (>=4.0.0,<5.0.0)

{datamint-2.3.1.dist-info → datamint-2.3.3.dist-info}/RECORD

@@ -1,39 +1,41 @@
 datamint/__init__.py,sha256=ucsnxrYClh6pdy7psRJXWam_9rjAQB4NXzvy7xLovmo,824
 datamint/api/__init__.py,sha256=7QYkmDBXbKh8-zchV7k6Lpolaw6h-IK6ezfXROIWh2A,43
-datamint/api/base_api.py,sha256=Iu9oJEZ8YlIF5xcbH_M0Lkb7t9ZDNFLzjJp9bPDHW1c,16628
-datamint/api/client.py,sha256=qL6kW1lUma98LieDEkhRdJAGRcsEFlaBSg2oQ3ZePYY,3466
-datamint/api/dto/__init__.py,sha256=KOSNl1axDDE5eBt68MmsgkyE0Ds_1DDzWUg73iyoWvc,281
-datamint/api/endpoints/__init__.py,sha256=uN2EYxSL6T5O5poVmQs8CQpyy3_MZzHfNyniORcvKUc,454
-datamint/api/endpoints/annotations_api.py,sha256=jhaWkLd01zKw-lVQYhBX288o9Ew2lQ-jmRP-0fz2fx0,48185
+datamint/api/base_api.py,sha256=UmNEgcFt1czkqyVCM3t5P9UvA1F9AEZITPqdakojvJs,18810
+datamint/api/client.py,sha256=ndKSj2QnveRNOtaQhE9qM4tCGtgrTxfInDy9FhdReCo,3922
+datamint/api/dto/__init__.py,sha256=fUi901Zs-q5XHyWwZ4dMi2fEO8-CUEVEdYbpd17lahc,416
+datamint/api/endpoints/__init__.py,sha256=wi4liAb5-wOohwyzKUD6TxHGeZmUPaZerFUGa2IUju4,529
+datamint/api/endpoints/annotations_api.py,sha256=B21oGgNXO7xoir3ynNvhnbo1JyRvWZ9sbsc7VVjghhM,49713
+datamint/api/endpoints/annotationsets_api.py,sha256=NIsPIjGGptiUBxHft-EhOMRG-DsQAthheVqd7ph0id4,409
 datamint/api/endpoints/channels_api.py,sha256=oQqxSw9DJzAqtVQI7-tc1llTdnsm-URx8jwtXNXnhio,867
 datamint/api/endpoints/datasetsinfo_api.py,sha256=WdzrUzK63w9gvAP6U--P65FbD-3X-jm9TPCcYnRNjas,597
 datamint/api/endpoints/models_api.py,sha256=tbVuajc-mCsIp5AKSCoq3uQRDWgKnJaIA6tf_ck8-XY,1502
-datamint/api/endpoints/projects_api.py,sha256=9tYIQsnMFOGTXrsoizweoWNqNue5907nbI6G9PAcYcA,7784
-datamint/api/endpoints/resources_api.py,sha256=Hd8sObIarvAdATS6qmAvT9EdXzPfruyMHnlGXcYkeMg,48320
+datamint/api/endpoints/projects_api.py,sha256=C5IqKXaYRrg5LDBjIRSo4NBCvbN2619X3SSgKqGe8pc,7929
+datamint/api/endpoints/resources_api.py,sha256=Ez-mGYElCpwHZ8T8NlqXH188mCFBZGfs8b320xa43tc,50142
 datamint/api/endpoints/users_api.py,sha256=pnkuTZ1B9Y0FtwwvXO8J64e02RSkRxnBmTl9UGSuC5I,1186
-datamint/api/entity_base_api.py,sha256=gPE28bwv7B6JngMk9szD2XwaVhB8OwB1HJjaMYD354k,12935
+datamint/api/entity_base_api.py,sha256=-8SIt4M8P9G2b8SQznuWpFuFE8zEQjQxkRkw0s_w0Y4,11692
 datamint/apihandler/annotation_api_handler.py,sha256=W3vV4z3BqX1OQe1r7zr8dI-IVu4zUDxED4QttdiWV-E,57098
 datamint/apihandler/api_handler.py,sha256=mL0gMaWePYa7zwkw92E-VMK2WjpcPt7au0KqnmsWSYw,439
 datamint/apihandler/base_api_handler.py,sha256=Hqt3oUvXfEqF25DJkk0WOWAtNLnKaZRGtnCchKFA1ag,11669
 datamint/apihandler/dto/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datamint/apihandler/dto/annotation_dto.py,sha256=KUeHbxLYols16q-ANNxC48eH4EA8Tc-nKmW_8xrqhy4,7119
+datamint/apihandler/dto/annotation_dto.py,sha256=8gcTFsvbXQQU4QjdW6lcUI_De1fyNyF49_a2uIyBOpg,7220
 datamint/apihandler/exp_api_handler.py,sha256=hFUgUgBc5rL7odK7gTW3MnrvMY1pVfJUpUdzRNobMQE,6226
 datamint/apihandler/root_api_handler.py,sha256=jBof_XPTeq4o41CW-l-I5GHQKVa76kaX75RovS_qAM4,63384
 datamint/client_cmd_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 datamint/client_cmd_tools/datamint_config.py,sha256=MpR5UHv_xpElOOYyEESBkDg2n3JjP_PNLI2jqmZgYQ8,16222
 datamint/client_cmd_tools/datamint_upload.py,sha256=rZEqBRZZDBFSlwMvIg_DbipqgBtQD31v7DC1C6tysqA,36058
-datamint/configs.py,sha256=Bdp6NydYwyCJ2dk19_gf_o3M2ZyQOmMHpLi8wEWNHUk,1426
+datamint/configs.py,sha256=ArVD5QxuohLcM6NB0dMxcEfrD1-x5lPRDLcBdY8jhMU,1625
 datamint/dataset/__init__.py,sha256=4PlUKSvVhdfQvvuq8jQXrkdqnot-iTTizM3aM1vgSwg,47
 datamint/dataset/annotation.py,sha256=qN1IMjdfLD2ceQ6va3l76jOXA8Vb_c-eBk1oWQu6hW0,7994
-datamint/dataset/base_dataset.py,sha256=Za41Qf76nm3GmY7iA9mba_FGzzwF3gxqAwu4eY0_5b4,49479
-datamint/dataset/dataset.py,sha256=Oj_Xr6MaCdO2Nq16fFE345qoKMWaTzKk6M1G6ajSXMo,28959
-datamint/entities/__init__.py,sha256=tbHE7rZb0R9Hm-Dc8VWEq3PlRl7BYOzffumrV0ZdsMs,444
-datamint/entities/annotation.py,sha256=ochAEh_JqxAe_FyYTNUfPT47KiIAG7CkBTim52bu7M8,6636
-datamint/entities/base_entity.py,sha256=DniakCgJ-gV7Hz8VKQA_dRYTp4DU5rcjLBVOuD1aZuA,1902
+datamint/dataset/base_dataset.py,sha256=2m_5nBayFCzXSjuPLb6mM9NLQ43wIUqeFUfm-6WVg_U,49827
+datamint/dataset/dataset.py,sha256=c0887PcI6fEWG3FjM3gz_EYb9maH8v4ormZhm7vf4gE,28929
+datamint/entities/__init__.py,sha256=ePkFeNATE5tJ9Lulsn2VTGWBJGwPtoRT1zsfbg1bkPw,504
+datamint/entities/annotation.py,sha256=4qsm3yO8bTgu5SNxY91P0LGXx3d7mxF1OGWpMNir1CA,8956
+datamint/entities/base_entity.py,sha256=QX381VdnrisQeQKg2kkHNDUvczYm03VsDHlHZQXr78U,3307
+datamint/entities/cache_manager.py,sha256=ZN5_HeyM6c0ocWFsJuJEF4CkuOHr6RPErwhZNYYq7WU,10282
 datamint/entities/channel.py,sha256=9fl22eSx_ng98NosfQGs18cdaRdbeC3wXL61KhSg4Zo,1601
-datamint/entities/datasetinfo.py,sha256=O73Aq0tLflQomFzseful8a_cXqKdO9w2yP0p3zBcA-s,489
-datamint/entities/project.py,sha256=FNweb1Q0ZQkWfbyijoV-UyqUXthzookdcyO-ophAl0U,2676
-datamint/entities/resource.py,sha256=7YCVihswd-bH-2AH4aMPIddt5ejwRqRFQAszI_sTWaU,4882
+datamint/entities/datasetinfo.py,sha256=yeGy5CVxqc7h0SFBJROr0UObeIMkOVZKwrOBsZ-iCEg,4151
+datamint/entities/project.py,sha256=QQXBOe6FzupPrCunBcqOlY6d3uqxvnYvGeCq8hZy_U8,4192
+datamint/entities/resource.py,sha256=Ai36-dJ9PhrRYho8QLRnySfsAPWPW8QpKMiVra_jCgA,9316
 datamint/entities/user.py,sha256=MREHDOsV9NOBEbXqiQ2ww6DmetN07CELId-ZQVpZCb8,620
 datamint/examples/__init__.py,sha256=zcYnd5nLVme9GCTPYH-1JpGo8xXK2WEYvhzcy_2alZc,39
 datamint/examples/example_projects.py,sha256=sU-Gxy7PPqA0WUfN-ZmXV-0YnwrnzpJ79lMXTJp2DzU,2804
@@ -42,10 +44,11 @@ datamint/experiment/__init__.py,sha256=5qQOMzoG17DEd1YnTF-vS0qiM-DGdbNh42EUo91CR
 datamint/experiment/_patcher.py,sha256=ZgbezoevAYhJsbiJTvWPALGTcUiMT371xddcTllt3H4,23296
 datamint/experiment/experiment.py,sha256=aHK9dRFdQTi569xgUg1KqlCZLHZpDmSH3g3ndPIZvXw,44546
 datamint/logging.yaml,sha256=tOMxtc2UmwlIMTK6ljtnBwTco1PNrPeq3mx2iMuSbiw,482
+datamint/types.py,sha256=2OaY5QJvQIJKxyMNJYzxBksKCa9ZS2gb_ayJrByvu2Y,410
 datamint/utils/logging_utils.py,sha256=9pRoaPrWu2jOdDCiAoUsjEdP5ZwaealWL3hjUqFvx9g,4022
 datamint/utils/torchmetrics.py,sha256=lwU0nOtsSWfebyp7dvjlAggaqXtj5ohSEUXOg3L0hJE,2837
 datamint/utils/visualization.py,sha256=yaUVAOHar59VrGUjpAWv5eVvQSfztFG0eP9p5Vt3l-M,4470
-datamint-2.3.1.dist-info/METADATA,sha256=m77em4ywu5yOsk2pZV6dqnNo21UsxSaadPQPo2tNLSY,4203
-datamint-2.3.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-datamint-2.3.1.dist-info/entry_points.txt,sha256=mn5H6jPjO-rY0W0CAZ6Z_KKWhMLvyVaSpoqk77jlTI4,145
-datamint-2.3.1.dist-info/RECORD,,
+datamint-2.3.3.dist-info/METADATA,sha256=Cl4QTN2lWp65r0Sot2NP-n5h0A-1B-PqH0l_gT94XUY,4262
+datamint-2.3.3.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+datamint-2.3.3.dist-info/entry_points.txt,sha256=mn5H6jPjO-rY0W0CAZ6Z_KKWhMLvyVaSpoqk77jlTI4,145
+datamint-2.3.3.dist-info/RECORD,,