dataroom-client 1.0.1.post14.dev0__tar.gz → 1.0.1.post62.dev0__tar.gz

{dataroom_client-1.0.1.post14.dev0 → dataroom_client-1.0.1.post62.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dataroom-client
-Version: 1.0.1.post14.dev0
+Version: 1.0.1.post62.dev0
 Summary: A python client to interface with the Dataroom backend API
 Author: Ales Kocjancic
 Author-email: hi@ales.io
@@ -38,5 +38,5 @@ For more examples see [client_example.ipynb](./notebooks/client_example.ipynb).
 
 # Developing
 
-Check out the `dataroom` repo and follow the instructions in the README.
+Follow the instructions in the main [README](../README.md).
 

{dataroom_client-1.0.1.post14.dev0 → dataroom_client-1.0.1.post62.dev0}/README.md

@@ -23,4 +23,4 @@ For more examples see [client_example.ipynb](./notebooks/client_example.ipynb).
 
 # Developing
 
-Check out the `dataroom` repo and follow the instructions in the README.
+Follow the instructions in the main [README](../README.md).

{dataroom_client-1.0.1.post14.dev0 → dataroom_client-1.0.1.post62.dev0}/dataroom_client/client.py

@@ -1,4 +1,8 @@
 import asyncio
+import functools
+import inspect
+import threading
+import atexit
 from datetime import datetime
 import json as json_module
 import logging
@@ -87,6 +91,7 @@ class ImageUpdate(TypedDict, total=False):
     tags: Optional[List[str]]
     coca_embedding: Optional[str]
     related_images: Optional[dict[str, str]]
+    datasets: Optional[list[str]]
 
 
 class ImageCreate(TypedDict, total=False):
@@ -97,6 +102,7 @@ class ImageCreate(TypedDict, total=False):
     attributes: Optional[dict]
     tags: Optional[list[str]]
     related_images: Optional[dict[str, str]]
+    datasets: Optional[list[str]]
 
 
 def arg_deprecation_msg(arg_name, msg=''):
@@ -305,6 +311,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
         headers = {}
         if cache_ttl:
@@ -368,6 +379,11 @@ class DataRoomClient:
                     "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
                     "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
                     "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+                    "datasets": ",".join(datasets) if datasets else None,
+                    "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+                    "datasets__all": ",".join(datasets__all) if datasets__all else None,
+                    "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+                    "datasets__empty": datasets__empty,
                 }
             ),
             headers=headers,
@@ -427,6 +443,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
         headers = {}
         if cache_ttl:
@@ -490,6 +511,11 @@ class DataRoomClient:
                     "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
                     "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
                     "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+                    "datasets": ",".join(datasets) if datasets else None,
+                    "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+                    "datasets__all": ",".join(datasets__all) if datasets__all else None,
+                    "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+                    "datasets__empty": datasets__empty,
                 }
             ),
             headers=headers,
@@ -550,6 +576,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
         """
         Get a list of random images.
@@ -621,6 +652,11 @@ class DataRoomClient:
                     "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
                     "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
                     "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+                    "datasets": ",".join(datasets) if datasets else None,
+                    "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+                    "datasets__all": ",".join(datasets__all) if datasets__all else None,
+                    "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+                    "datasets__empty": datasets__empty,
                 }
             ),
             headers=headers,
@@ -672,6 +708,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
 
         if source is not None:
@@ -725,6 +766,11 @@ class DataRoomClient:
                     "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
                     "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
                     "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+                    "datasets": ",".join(datasets) if datasets else None,
+                    "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+                    "datasets__all": ",".join(datasets__all) if datasets__all else None,
+                    "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+                    "datasets__empty": datasets__empty,
                 }
             ),
         )
@@ -759,6 +805,7 @@ class DataRoomClient:
         attributes: dict = None,
         tags: list[str] = None,
         related_images: dict[str, str] | None = None,
+        datasets: list[str] = None,
     ):
         if not image_file and not image_url:
             raise DataRoomError('Please provide either an "image_file" or "image_url" field')
@@ -777,6 +824,7 @@ class DataRoomClient:
                 "attributes": attributes,
                 "tags": tags,
                 "related_images": related_images,
+                "datasets": datasets,
             }
         )
 
@@ -836,6 +884,7 @@ class DataRoomClient:
                 "attributes": image.get('attributes'),
                 "tags": image.get('tags'),
                 "related_images": image.get('related_images'),
+                "datasets": image.get('datasets'),
             })
             files.append((
                 f"json_{i}",
@@ -853,9 +902,15 @@ class DataRoomClient:
         tags: list[str] = None,
         coca_embedding: str = None,
         related_images: dict[str, str] | None = None,
+        datasets: list[str] = None,
     ):
         """
-        Update the image, overwriting the tags and merging attributes, latents and related_images.
+        Update the image:
+         * overwrite tags
+         * merge attributes
+         * merge latents
+         * merge related_images
+         * merge datasets
         """
 
         if coca_embedding:
@@ -895,6 +950,7 @@ class DataRoomClient:
                 "tags": tags,
                 "coca_embedding": coca_embedding,
                 "related_images": related_images,
+                "datasets": datasets,
             })
             files.append((
                 "json",
@@ -911,6 +967,7 @@ class DataRoomClient:
                     "tags": tags,
                     "coca_embedding": coca_embedding,
                     "related_images": related_images,
+                    "datasets": datasets,
                 }),
             )
 
@@ -919,7 +976,12 @@ class DataRoomClient:
         images: List[ImageUpdate],
     ):
         """
-        Bulk update images, overwriting the tags and merging attributes, latents and related_images.
+        Bulk update images:
+         * overwrite tags
+         * merge attributes
+         * merge latents
+         * merge related_images
+         * merge datasets
         """
         for image in images:
             if 'id' not in image:
@@ -929,6 +991,7 @@ class DataRoomClient:
             image.setdefault('tags', None)
             image.setdefault('coca_embedding', None)
             image.setdefault('related_images', None)
+            image.setdefault('datasets', None)
         
         return await self._make_request(
             url=f"images/bulk_update/",
@@ -941,6 +1004,7 @@ class DataRoomClient:
                     "tags": image['tags'],
                     "coca_embedding": image['coca_embedding'],
                     "related_images": image['related_images'],
+                    "datasets": image['datasets'],
                 })
                 for image in images
             ],
@@ -1064,6 +1128,11 @@ class DataRoomClient:
         date_updated__gte: datetime = None,
         date_updated__lt: datetime = None,
         date_updated__lte: datetime = None,
+        datasets: list = None,
+        datasets__ne: list = None,
+        datasets__all: list = None,
+        datasets__ne_all: list = None,
+        datasets__empty: bool = None,
     ):
         search_args = {
             'image_id': image_id, 'image_file': image_file, 'image_vector': image_vector, 'image_text': image_text,
@@ -1118,6 +1187,11 @@ class DataRoomClient:
             "date_updated__gte": date_updated__gte.isoformat() if date_updated__gte else None,
             "date_updated__lt": date_updated__lt.isoformat() if date_updated__lt else None,
             "date_updated__lte": date_updated__lte.isoformat() if date_updated__lte else None,
+            "datasets": ",".join(datasets) if datasets else None,
+            "datasets__ne": ",".join(datasets__ne) if datasets__ne else None,
+            "datasets__all": ",".join(datasets__all) if datasets__all else None,
+            "datasets__ne_all": ",".join(datasets__ne_all) if datasets__ne_all else None,
+            "datasets__empty": datasets__empty,
         })
 
         if image_file:
@@ -1312,135 +1386,170 @@ class DataRoomClient:
             },
         )
 
+    # -------------------- Dataset API methods --------------------
 
-class DataRoomClientSync:
-    """
-    The official client of the DataRoom API using synchronous method and requests.
-    """
-
-    def __init__(self, api_key=None, api_url=None):
-        """
-        @param api_key: API key for DataRoom API
-        @param api_url: URL of the DataRoom backend API
-        """
-        self.api_key = api_key or os.environ.get("DATAROOM_API_KEY")
-        self.api_url = (
-            api_url
-            or os.environ.get("DATAROOM_API_URL")
+    async def get_datasets(self, slug: str = None, limit: int = 1000):
+        return await self._make_paginated_request(
+            url=f"datasets/",
+            params=self._dict_filter_none({
+                "slug": slug,
+            }),
+            limit=limit,
         )
-        if not self.api_url:
-            raise DataRoomError("DataRoom api_url is not set")
-        self._async_client = DataRoomClient(api_key=api_key, api_url=api_url)
-
-    # -------------------- Private methods --------------------
-
-    @classmethod
-    def _run_sync(cls, coro):
-        try:
-            # Check if there's an existing running event loop
-            loop = asyncio.get_running_loop()
-        except RuntimeError:
-            # No running event loop, create a new one
-            return asyncio.run(coro)
-        else:
-            # A running event loop exists, use run_until_complete
-            return loop.run_until_complete(coro)
 
-    def _make_request(self, *args, **kwargs):
-        return self._run_sync(self._async_client._make_request(*args, **kwargs))
-
-    def _make_paginated_request(self, *args, **kwargs):
-        return self._run_sync(
-            self._async_client._make_paginated_request(*args, **kwargs)
+    async def get_dataset(self, slug_version: str):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/",
         )
 
-    # -------------------- Utils --------------------
-
-    @classmethod
-    def download_image_from_url(cls, *args, **kwargs) -> DataRoomFile:
-        return cls._run_sync(DataRoomClient.download_image_from_url(*args, **kwargs))
-
-    # -------------------- Image API methods --------------------
-
-    def get_images(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_images(*args, **kwargs))
-
-    def get_images_iter(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_images_iter(*args, **kwargs))
+    async def create_dataset(self, name: str, slug: str, description: str = None):
+        return await self._make_request(
+            url=f"datasets/",
+            method="POST",
+            json={
+                "name": name,
+                "slug": slug,
+                "description": description if description else "",
+            },
+        )
     
-    def get_random_images(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_random_images(*args, **kwargs))
-
-    def count_images(self, *args, **kwargs):
-        return self._run_sync(self._async_client.count_images(*args, **kwargs))
-
-    def get_image(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_image(*args, **kwargs))
-
-    def create_image(self, *args, **kwargs):
-        return self._run_sync(self._async_client.create_image(*args, **kwargs))
-
-    def create_images(self, *args, **kwargs):
-        return self._run_sync(self._async_client.create_images(*args, **kwargs))
-
-    def delete_image(self, *args, **kwargs):
-        return self._run_sync(self._async_client.delete_image(*args, **kwargs))
+    async def freeze_dataset(self, slug_version: str):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/freeze/",
+            method="POST",
+        )
+    
+    async def unfreeze_dataset(self, slug_version: str):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/unfreeze/",
+            method="POST",
+        )
 
-    def get_image_audit_logs(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_image_audit_logs(*args, **kwargs))
+    async def dataset_add_images(self, slug_version: str, image_ids: List[str]):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/images/",
+            method="POST",
+            json={
+                "image_ids": image_ids,
+            },
+        )
 
-    def get_image_similarity(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_image_similarity(*args, **kwargs))
+    async def dataset_remove_images(self, slug_version: str, image_ids: List[str]):
+        return await self._make_request(
+            url=f"datasets/{slug_version}/images/",
+            method="DELETE",
+            json={
+                "image_ids": image_ids,
+            },
+        )
 
-    def get_related_images(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_related_images(*args, **kwargs))
 
-    def get_similar_images(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_similar_images(*args, **kwargs))
 
-    def set_image_latent(self, *args, **kwargs):
-        return self._run_sync(self._async_client.set_image_latent(*args, **kwargs))
+class AsyncRunner:
+    """
+    Manages a single, shared event loop in a background thread
+    to run async functions from a synchronous context using classmethods.
 
-    def delete_image_latent(self, *args, **kwargs):
-        return self._run_sync(self._async_client.delete_image_latent(*args, **kwargs))
+    The shutdown method is automatically registered to be called on exit.
+    """
+    _loop: asyncio.AbstractEventLoop | None = None
+    _thread: threading.Thread | None = None
+    _lock = threading.Lock() # To ensure thread-safe initialization
 
-    def update_image(self,*args, **kwargs):
-        return self._run_sync(self._async_client.update_image(*args, **kwargs))
+    @classmethod
+    def _initialize(cls):
+        """Initializes the background event loop and thread if not already done."""
+        with cls._lock:
+            if cls._thread is not None:
+                return
+
+            cls._loop = asyncio.new_event_loop()
+            cls._thread = threading.Thread(
+                target=cls._loop.run_forever,
+                daemon=True,
+                name="ClassAsyncRunnerThread"
+            )
+            cls._thread.start()
+            # Register the shutdown method to be called when the program exits.
+            # This is done here to ensure it's only registered once.
+            atexit.register(cls.shutdown)
+            logger.debug("Initialized ClassAsyncRunner background thread")
 
-    def update_images(self,*args, **kwargs):
-        return self._run_sync(self._async_client.update_images(*args, **kwargs))
+    @classmethod
+    def run(cls, coro):
+        """
+        Runs a coroutine on the shared background event loop and returns the result.
+        Initializes the loop on the first call.
+        """
+        if cls._thread is None:
+            cls._initialize()
 
-    def add_image_attributes(self, *args, **kwargs):
-        return self._run_sync(self._async_client.add_image_attributes(*args, **kwargs))
+        future = asyncio.run_coroutine_threadsafe(coro, cls._loop)
+        return future.result()
 
-    def add_image_attributes_in_bulk(self, *args, **kwargs):
-        return self._run_sync(self._async_client.add_image_attributes_in_bulk(*args, **kwargs))
+    @classmethod
+    def shutdown(cls):
+        """
+        Cleanly stops the shared event loop.
+        This is registered with atexit and called automatically.
+        """
+        # The check for cls._loop is important because atexit might call this
+        # even if the runner was never initialized.
+        if cls._loop and cls._loop.is_running():
+            logger.debug("Shutting down ClassAsyncRunner background thread...")
+            cls._loop.call_soon_threadsafe(cls._loop.stop)
+            # It's good practice to have a timeout on join
+            cls._thread.join(timeout=5) 
+            cls._loop.close()
+            logger.debug("ClassAsyncRunner has been shut down.")
+        
+        cls._loop = None
+        cls._thread = None
 
-    def set_image_coca_embedding(self, *args, **kwargs):
-        return self._run_sync(self._async_client.set_image_coca_embedding(*args, **kwargs))
-    
-    def aggregate_images(self, *args, **kwargs):
-        return self._run_sync(self._async_client.aggregate_images(*args, **kwargs))
 
-    def bucket_images(self, *args, **kwargs):
-        return self._run_sync(self._async_client.bucket_images(*args, **kwargs))
+class DataRoomClientSync:
+    """
+    The official client of the DataRoom API using synchronous method and requests.
+    """
 
-    # -------------------- Tag API methods --------------------
+    def __init__(self, api_key=None, api_url=None, timeout=120):
+        """
+        @param api_key: API key for DataRoom API
+        @param api_url: URL of the DataRoom backend API
+        """
+        self.api_key = api_key or os.environ.get("DATAROOM_API_KEY")
+        self.api_url = (
+            api_url
+            or os.environ.get("DATAROOM_API_URL")
+        )
+        if not self.api_url:
+            raise DataRoomError("DataRoom api_url is not set")
+        self._async_client = DataRoomClient(api_key=self.api_key, api_url=self.api_url, timeout=timeout)
 
-    def create_tag(self, *args, **kwargs):
-        return self._run_sync(self._async_client.create_tag(*args, **kwargs))
+    def __getattr__(self, name):
+        """
+        Dynamically create sync methods for all methods of the async client.
+        """
+        attr = getattr(self._async_client, name)
 
-    def get_tag(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_tag(*args, **kwargs))
+        if not callable(attr):
+            return attr
 
-    def get_tags(self, *args, **kwargs):
-        return self._run_sync(self._async_client.get_tags(*args, **kwargs))
+        @functools.wraps(attr)
+        def sync_wrapper(*args, **kwargs):
+            result = attr(*args, **kwargs)
+            if inspect.isawaitable(result):
+                return AsyncRunner.run(result)
+            return result
 
-    def tag_images(self, *args, **kwargs):
-        return self._run_sync(self._async_client.tag_images(*args, **kwargs))
+        return sync_wrapper
 
+    def __dir__(self) -> List[str]:
+        """
+        Provide a list of attributes for introspection and autocompletion in tools like IPython.
+        """
+        return sorted(list(set(super().__dir__()) | set(dir(self._async_client))))
 
-for method_name in dir(DataRoomClient):
-    if not method_name.startswith("_"):
-        if not hasattr(DataRoomClientSync, method_name):
-            logger.warning(f"Missing implementation: DataRoomClientSync.{method_name}")
+    @classmethod
+    def download_image_from_url(cls, *args, **kwargs) -> DataRoomFile:
+        return AsyncRunner.run(DataRoomClient.download_image_from_url(*args, **kwargs))

{dataroom_client-1.0.1.post14.dev0 → dataroom_client-1.0.1.post62.dev0}/pyproject.toml

@@ -6,7 +6,7 @@ authors = [
 ]
 readme = "README.md"
 dynamic = []
-version = "1.0.1.post14.dev0"
+version = "1.0.1.post62.dev0"
 
 [tool.poetry]