update thingiverse with abstract class

objaverse_xl/thingiverse.py

@@ -4,7 +4,10 @@ import multiprocessing
 import os
 import time
 from multiprocessing import Pool
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Dict, Optional, Tuple, Callable
+import tempfile
+from objaverse_xl.utils import get_file_hash
+from objaverse_xl.abstract import ObjaverseSource
 
 import fsspec
 import pandas as pd
@@ -13,217 +16,361 @@ from loguru import logger
 from tqdm import tqdm
 
 
-def _get_response_with_retries(
-    url: str, max_retries: int = 3, retry_delay: int = 5
-) -> Optional[requests.models.Response]:
-    """Get a response from a URL with retries.
-
-    Args:
-        url (str): The URL to get a response from.
-        max_retries (int, optional): The maximum number of retries. Defaults to 3.
-        retry_delay (int, optional): The delay between retries in seconds. Defaults to 5.
-
-    Returns:
-        Optional[requests.models.Response]: The response from the URL. If there was an error, returns None.
-    """
-
-    for i in range(max_retries):
-        try:
-            response = requests.get(url, stream=True)
-            # if successful, break out of loop
-            if response.status_code not in {200, 404}:
-                time.sleep(retry_delay)
-                continue
-            break
-        except ConnectionError:
-            if i < max_retries - 1:  # i.e. not on the last try
-                time.sleep(retry_delay)
-    else:
-        return None
-
-    return response
-
-
-def _download_item(item: Dict[str, str], download_dir: str) -> Optional[str]:
-    """Download the given item.
-
-    Args:
-        item (Dict[str, str]): The item to download. It should be a dictionary with the
-            keys "thingId" and "fileId".
-        download_dir (str, optional): The directory to save the files to. Supports all
-            file systems supported by fsspec.
-
-    Returns:
-        Optional[str]: The path to the downloaded file. If there was an error or 404,
-            returns None.
-    """
-    file_id = item["fileId"]
-    thing_id = item["thingId"]
-
-    url = f"https://www.thingiverse.com/download:{file_id}"
-    response = _get_response_with_retries(url)
-
-    if response is None:
-        logger.error(f"{file_id=} Could not get response from {url}")
-        return None
-
-    # Check if the request was successful
-    if response.status_code == 404:
-        logger.error(f"{file_id=} (404) Could not find file with ID")
-        return None
-
-    file_path = os.path.join(download_dir, f"thing-{thing_id}-file-{file_id}.stl")
-    fs, path = fsspec.core.url_to_fs(file_path)
-
-    with fs.open(path, "wb") as file:
-        file.write(response.content)
-
-    return file_path
-
-
-def _parallel_download_item(args) -> Tuple[Any, Optional[str]]:
-    item, download_dir = args
-    download_path = _download_item(item=item, download_dir=download_dir)
-    return item, download_path
-
-
-def download_thingiverse_objects(
-    file_ids: Optional[List[str]] = None,
-    processes: Optional[int] = None,
-    download_dir: str = "~/.objaverse",
-) -> List[Dict[str, str]]:
-    """Download the objects from the given list of things and files.
-
-    Args:
-        file_ids (Optional[List[str]]): The list of file IDs to download. If None,
-            downloads all files. Defaults to None.
-        processes (int, optional): The number of processes to use. If None, maps to
-            use all available CPUs using multiprocessing.cpu_count(). Defaults to None.
-        download_dir (str, optional): The directory to save the files to. Supports all
-            file systems supported by fsspec. Defaults to "~/.objaverse-xl".
-
-    Returns:
-        List[Dict[str, str]]: The list of things and files that were downloaded. Each
-            item in the list is a dictionary with the keys "thingId", "fileId",
-            "filePath", and everything else from the annotations. If the file was
-            not successfully downloaded, the item will not appear in the list.
-    """
-    if processes is None:
-        processes = multiprocessing.cpu_count()
-
-    # get the records of the specified fileIds
-    df = load_annotations(download_dir=download_dir)
-    if file_ids is not None:
-        file_ids_set = set(file_ids)
-        df = df[df["fileId"].isin(file_ids_set)]
-    things_and_files = df.to_dict(orient="records")
-
-    # create the download directory
-    download_dir = os.path.join(download_dir, "thingiverse")
-    fs, path = fsspec.core.url_to_fs(download_dir)
-    fs.makedirs(path, exist_ok=True)
-
-    # check to filter out files that already exist
-    existing_files = fs.glob(os.path.join(download_dir, "*.stl"), refresh=True)
-    existing_file_ids = {
-        os.path.basename(file).split(".")[0].split("-")[-1] for file in existing_files
-    }
-
-    # filter out existing files
-    items_to_download = []
-    already_downloaded_count = 0
-    out = []
-    for item in things_and_files:
-        if item["fileId"] in existing_file_ids:
-            already_downloaded_count += 1
-            out.append(
-                {
-                    "filePath": os.path.join(
-                        download_dir,
-                        f"thing-{item['thingId']}-file-{item['fileId']}.stl",
-                    ),
-                    **item,
-                }
+class ThingiverseDownloader(ObjaverseSource):
+    """Script to download objects from Thingiverse."""
+
+    def load_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
+        """Load the annotations from the given directory.
+
+        Args:
+            download_dir (str, optional): The directory to load the annotations from.
+                Supports all file systems supported by fsspec. Defaults to
+                "~/.objaverse".
+
+        Returns:
+            pd.DataFrame: The annotations, which includes the columns "thingId", "fileId",
+                "filename", and "license".
+        """
+        remote_url = "https://huggingface.co/datasets/allenai/objaverse-xl/resolve/main/thingiverse/thingiverse-objects.parquet"
+        download_path = os.path.join(
+            download_dir, "thingiverse", "thingiverse-objects.parquet"
+        )
+        fs, path = fsspec.core.url_to_fs(download_path)
+
+        if not fs.exists(path):
+            fs.makedirs(os.path.dirname(path), exist_ok=True)
+            logger.info(f"Downloading {remote_url} to {download_path}")
+            response = requests.get(remote_url)
+            response.raise_for_status()
+            with fs.open(path, "wb") as file:
+                file.write(response.content)
+
+        # read the file with pandas and fsspec
+        with fs.open(download_path, "rb") as f:
+            annotations_df = pd.read_parquet(f)
+
+        return annotations_df
+
+    def _get_response_with_retries(
+        self, url: str, max_retries: int = 3, retry_delay: int = 5
+    ) -> Optional[requests.models.Response]:
+        """Get a response from a URL with retries.
+
+        Args:
+            url (str): The URL to get a response from.
+            max_retries (int, optional): The maximum number of retries. Defaults to 3.
+            retry_delay (int, optional): The delay between retries in seconds. Defaults to 5.
+
+        Returns:
+            Optional[requests.models.Response]: The response from the URL. If there was an error, returns None.
+        """
+
+        for i in range(max_retries):
+            try:
+                response = requests.get(url, stream=True)
+                # if successful, break out of loop
+                if response.status_code not in {200, 404}:
+                    time.sleep(retry_delay)
+                    continue
+                break
+            except ConnectionError:
+                if i < max_retries - 1:  # i.e. not on the last try
+                    time.sleep(retry_delay)
+        else:
+            return None
+
+        return response
+
+    def _download_item(
+        self,
+        thingi_file_id: str,
+        thingi_thing_id: str,
+        file_identifier: str,
+        download_dir: Optional[str],
+        expected_sha256: str,
+        handle_found_object: Optional[Callable],
+        handle_modified_object: Optional[Callable],
+        handle_missing_object: Optional[Callable],
+    ) -> Tuple[str, Optional[str]]:
+        """Download the given item.
+
+        Args:
+            thingi_file_id (str): The Thingiverse file ID of the object.
+            thingi_thing_id (str): The Thingiverse thing ID of the object.
+            file_identifier (str): File identifier of the Thingiverse object.
+            download_dir (Optional[str]): Directory to download the Smithsonian Object
+                to. Supports all file systems supported by fsspec. If None, the
+                Smithsonian Object will be deleted after it is downloaded and processed
+                with the handler functions.
+            expected_sha256 (str): The expected SHA256 of the contents of the downloaded
+                object.
+            handle_found_object (Optional[Callable]): Called when an object is
+                successfully found and downloaded. Here, the object has the same sha256
+                as the one that was downloaded with Objaverse-XL. If None, the object
+                will be downloaded, but nothing will be done with it. Args for the
+                function include:
+                - local_path (str): Local path to the downloaded 3D object.
+                - file_identifier (str): File identifier of the 3D object.
+                - sha256 (str): SHA256 of the contents of the 3D object.
+                - metadata (Dict[str, Any]): Metadata about the 3D object, including the
+                    GitHub organization and repo names.
+                Return is not used.
+            handle_modified_object (Optional[Callable]): Called when a modified object
+                is found and downloaded. Here, the object is successfully downloaded,
+                but it has a different sha256 than the one that was downloaded with
+                Objaverse-XL. This is not expected to happen very often, because the
+                same commit hash is used for each repo. If None, the object will be
+                downloaded, but nothing will be done with it. Args for the function
+                include:
+                - local_path (str): Local path to the downloaded 3D object.
+                - file_identifier (str): File identifier of the 3D object.
+                - new_sha256 (str): SHA256 of the contents of the newly downloaded 3D
+                    object.
+                - old_sha256 (str): Expected SHA256 of the contents of the 3D object as
+                    it was when it was downloaded with Objaverse-XL.
+                - metadata (Dict[str, Any]): Metadata about the 3D object, including the
+                    GitHub organization and repo names.
+                Return is not used.
+            handle_missing_object (Optional[Callable]): Called when an object that is in
+                Objaverse-XL is not found. Here, it is likely that the repository was
+                deleted or renamed. If None, nothing will be done with the missing
+                object. Args for the function include:
+                - file_identifier (str): File identifier of the 3D object.
+                - sha256 (str): SHA256 of the contents of the original 3D object.
+                - metadata (Dict[str, Any]): Metadata about the 3D object, including the
+                    GitHub organization and repo names.
+                Return is not used.
+
+
+        Returns:
+            Optional[str]: The path to the downloaded file. If there was an error or 404,
+                returns None.
+        """
+        url = f"https://www.thingiverse.com/download:{thingi_file_id}"
+        response = self._get_response_with_retries(url)
+        filename = f"thing-{thingi_thing_id}-file-{thingi_file_id}.stl"
+
+        if response is None:
+            logger.warning(
+                f"Thingiverse file ID {thingi_file_id} could not get response from {url}"
+            )
+            # NOTE: the object is probably not missing, but the request failed
+            return file_identifier, None
+
+        # Check if the request was successful
+        if response.status_code == 404:
+            logger.warning(
+                f"Thingiverse file ID {thingi_file_id} (404) could not find file"
+            )
+            if handle_missing_object is not None:
+                handle_missing_object(
+                    file_identifier=file_identifier, sha256=expected_sha256, metadata={}
+                )
+            return file_identifier, None
+
+        with tempfile.TemporaryDirectory() as temp_dir:
+            temp_path = os.path.join(temp_dir, filename)
+            temp_path_tmp = temp_path + ".tmp"
+
+            with open(temp_path_tmp, "wb") as file:
+                for chunk in response.iter_content(chunk_size=8192):
+                    file.write(chunk)
+
+            # rename to temp_path
+            os.rename(temp_path_tmp, temp_path)
+
+            # check the sha256
+            sha256 = get_file_hash(temp_path)
+
+            if sha256 == expected_sha256:
+                if handle_found_object is not None:
+                    handle_found_object(
+                        local_path=temp_path,
+                        file_identifier=file_identifier,
+                        sha256=sha256,
+                        metadata={},
+                    )
+            else:
+                if handle_modified_object is not None:
+                    handle_modified_object(
+                        local_path=temp_path,
+                        file_identifier=file_identifier,
+                        new_sha256=sha256,
+                        old_sha256=expected_sha256,
+                        metadata={},
+                    )
+
+            if download_dir is not None:
+                filename = os.path.join(download_dir, filename)
+                fs, path = fsspec.core.url_to_fs(filename)
+                fs.makedirs(os.path.dirname(path), exist_ok=True)
+                fs.put(temp_path, path)
+            else:
+                path = None
+
+        return file_identifier, path
+
+    def _parallel_download_item(self, args):
+        return self._download_item(*args)
+
+    def get_file_id_from_file_identifier(self, file_identifier: str) -> str:
+        """Get the thingiverse file ID from the Objaverse-XL file identifier.
+
+        Args:
+            file_identifier (str): The Objaverse-XL file identifier.
+
+        Returns:
+            str: The Thingiverse file ID.
+        """
+        return file_identifier.split("fileId=")[-1]
+
+    def get_thing_id_from_file_identifier(self, file_identifier: str) -> str:
+        """Get the thingiverse thing ID from the Objaverse-XL file identifier.
+
+        Args:
+            file_identifier (str): The Objaverse-XL file identifier.
+
+        Returns:
+            str: The Thingiverse thing ID.
+        """
+        return file_identifier.split("/")[-2].split(":")[1]
+
+    def download_objects(
+        self,
+        objects: pd.DataFrame,
+        processes: Optional[int] = None,
+        download_dir: Optional[str] = "~/.objaverse",
+        handle_found_object: Optional[Callable] = None,
+        handle_modified_object: Optional[Callable] = None,
+        handle_missing_object: Optional[Callable] = None,
+    ) -> Dict[str, str]:
+        """Download the objects from the given list of things and files.
+
+        Args:
+            file_ids (Optional[List[str]]): The list of file IDs to download. If None,
+                downloads all files. Defaults to None.
+            processes (int, optional): The number of processes to use. If None, maps to
+                use all available CPUs using multiprocessing.cpu_count(). Defaults to None.
+            download_dir (str, optional): The directory to save the files to. Supports all
+                file systems supported by fsspec. Defaults to "~/.objaverse-xl".
+            handle_found_object (Optional[Callable], optional): Called when an object is
+                successfully found and downloaded. Here, the object has the same sha256
+                as the one that was downloaded with Objaverse-XL. If None, the object
+                will be downloaded, but nothing will be done with it. Args for the
+                function include:
+                - local_path (str): Local path to the downloaded 3D object.
+                - file_identifier (str): File identifier of the 3D object.
+                - sha256 (str): SHA256 of the contents of the 3D object.
+                - metadata (Dict[Hashable, Any]): Metadata about the 3D object,
+                    including the GitHub organization and repo names.
+                Return is not used. Defaults to None.
+            handle_modified_object (Optional[Callable], optional): Called when a
+                modified object is found and downloaded. Here, the object is
+                successfully downloaded, but it has a different sha256 than the one that
+                was downloaded with Objaverse-XL. This is not expected to happen very
+                often, because the same commit hash is used for each repo. If None, the
+                object will be downloaded, but nothing will be done with it. Args for
+                the function include:
+                - local_path (str): Local path to the downloaded 3D object.
+                - file_identifier (str): File identifier of the 3D object.
+                - new_sha256 (str): SHA256 of the contents of the newly downloaded 3D
+                    object.
+                - old_sha256 (str): Expected SHA256 of the contents of the 3D object as
+                    it was when it was downloaded with Objaverse-XL.
+                - metadata (Dict[Hashable, Any]): Metadata about the 3D object, which is
+                    particular to the souce.
+                Return is not used. Defaults to None.
+            handle_missing_object (Optional[Callable], optional): Called when an object
+                that is in Objaverse-XL is not found. Here, it is likely that the
+                repository was deleted or renamed. If None, nothing will be done with
+                the missing object.
+                Args for the function include:
+                - file_identifier (str): File identifier of the 3D object.
+                - sha256 (str): SHA256 of the contents of the original 3D object.
+                - metadata (Dict[Hashable, Any]): Metadata about the 3D object, which is
+                    particular to the source.
+                Return is not used. Defaults to None.
+
+        Returns:
+            Dict[str, str]: A dictionary mapping from the fileIdentifier to the path of
+                the downloaded file.
+        """
+        if processes is None:
+            processes = multiprocessing.cpu_count()
+
+        objects = objects.copy()
+        objects["thingiFileId"] = objects["fileIdentifier"].apply(
+            self.get_file_id_from_file_identifier
+        )
+        objects["thingiThingId"] = objects["fileIdentifier"].apply(
+            self.get_thing_id_from_file_identifier
+        )
+
+        # create the download directory
+        out = {}
+        if download_dir is not None:
+            download_dir = os.path.join(download_dir, "thingiverse")
+            fs, path = fsspec.core.url_to_fs(download_dir)
+            fs.makedirs(path, exist_ok=True)
+
+            # check to filter out files that already exist
+            existing_files = fs.glob(os.path.join(download_dir, "*.stl"), refresh=True)
+            existing_file_ids = {
+                os.path.basename(file).split(".")[0].split("-")[-1]
+                for file in existing_files
+            }
+
+            # filter out existing files
+            items_to_download = []
+            already_downloaded_count = 0
+            for _, item in objects.iterrows():
+                if item["thingiFileId"] in existing_file_ids:
+                    already_downloaded_count += 1
+                    out[item["fileIdentifier"]] = os.path.join(
+                        os.path.expanduser(download_dir),
+                        f"thing-{item['thingiThingId']}-file-{item['thingiFileId']}.stl",
+                    )
+                else:
+                    items_to_download.append(item)
+
+            logger.info(
+                f"Found {already_downloaded_count} Thingiverse objects downloaded"
             )
         else:
-            items_to_download.append(item)
+            items_to_download = [item for _, item in objects.iterrows()]
 
-    logger.info(f"Found {already_downloaded_count} Thingiverse objects downloaded")
-    logger.info(
-        f"Downloading {len(items_to_download)} Thingiverse objects with {processes=}"
-    )
-    if len(items_to_download) == 0:
-        return out
+        logger.info(
+            f"Downloading {len(items_to_download)} Thingiverse objects with {processes=}"
+        )
+        if len(items_to_download) == 0:
+            return out
+
+        # download the files
+        args = [
+            (
+                item["thingiFileId"],
+                item["thingiThingId"],
+                item["fileIdentifier"],
+                download_dir,
+                item["sha256"],
+                handle_found_object,
+                handle_modified_object,
+                handle_missing_object,
+            )
+            for item in items_to_download
+        ]
 
-    # download the files
-    if processes == 1:
-        for item in tqdm(items_to_download):
-            file_path = _download_item(item=item, download_dir=download_dir)
-            if file_path is not None:
-                out.append(
-                    {
-                        "filePath": file_path,
-                        **item,
-                    }
-                )
-    else:
-        args = [(item, download_dir) for item in items_to_download]
         with Pool(processes=processes) as pool:
-            items_and_file_paths = list(
+            results = list(
                 tqdm(
-                    pool.imap(_parallel_download_item, args),
+                    pool.imap_unordered(self._parallel_download_item, args),
                     total=len(args),
                     desc="Downloading Thingiverse Objects",
                 )
             )
-        out.extend(
-            [
-                {
-                    "filePath": file_path,
-                    **item,
-                }
-                for item, file_path in items_and_file_paths
-                if file_path is not None
-            ]
-        )
-    return out
-
-
-def load_annotations(download_dir: str = "~/.objaverse") -> pd.DataFrame:
-    """Load the annotations from the given directory.
-
-    Args:
-        download_dir (str, optional): The directory to load the annotations from.
-            Supports all file systems supported by fsspec. Defaults to
-            "~/.objaverse".
-
-    Returns:
-        pd.DataFrame: The annotations, which includes the columns "thingId", "fileId",
-            "filename", and "license".
-    """
-    remote_url = "https://huggingface.co/datasets/allenai/objaverse-xl/resolve/main/thingiverse/thingiverse-objects.parquet"
-    download_path = os.path.join(
-        download_dir, "thingiverse", "thingiverse-objects.parquet"
-    )
-    fs, path = fsspec.core.url_to_fs(download_path)
-
-    if not fs.exists(path):
-        fs.makedirs(os.path.dirname(path), exist_ok=True)
-        logger.info(f"Downloading {remote_url} to {download_path}")
-        response = requests.get(remote_url)
-        response.raise_for_status()
-        with fs.open(path, "wb") as file:
-            file.write(response.content)
-
-    # read the file with pandas and fsspec
-    with fs.open(download_path, "rb") as f:
-        annotations_df = pd.read_parquet(f)
-
-    return annotations_df
-
-
-# if __name__ == "__main__":
-#     # example usage
-#     annotations = load_annotations()
-#     file_ids = annotations.head(n=100)["fileId"].tolist()
-#     download_thingiverse_objects(file_ids=file_ids, processes=5)
+
+        for file_identifier, download_path in results:
+            if download_path is not None:
+                out[file_identifier] = download_path
+
+        return out