use fsspec to download objects

objaverse_xl/__init__.py

@@ -5,6 +5,7 @@ from functools import partial
 from multiprocessing import Pool
 from typing import Dict, List, Optional
 
+import fsspec
 import pandas as pd
 import requests
 from loguru import logger
@@ -31,7 +32,8 @@ def load_smithsonian_metadata(
 
     Args:
         download_dir (str, optional): Directory to download the parquet metadata file.
-            Defaults to "~/.objaverse-xl".
+            Supports all file systems supported by fsspec. Defaults to
+            "~/.objaverse-xl".
 
     Returns:
         pd.DataFrame: Smithsonian Object Metadata dataset as a Pandas DataFrame with
@@ -39,16 +41,22 @@ def load_smithsonian_metadata(
             "license". The quality is always Medium and the file_type is always glb.
     """
     dirname = os.path.expanduser(os.path.join(download_dir, "smithsonian"))
-    os.makedirs(dirname, exist_ok=True)
     filename = os.path.join(dirname, "object-metadata.parquet")
+    fs, path = fsspec.core.url_to_fs(filename)
+    if fs.protocol == "file":
+        os.makedirs(dirname, exist_ok=True)
+
+    if fs.exists(filename):
+        df = pd.read_parquet(filename)
+        return df
+    else:
+        url = "https://huggingface.co/datasets/allenai/objaverse-xl/resolve/main/smithsonian/object-metadata.parquet"
+        response = requests.get(url)
+        response.raise_for_status()
+        with fs.open(filename, "wb") as file:
+            file.write(response.content)
+        df = pd.read_parquet(filename)
 
-    url = "https://huggingface.co/datasets/allenai/objaverse-xl/resolve/main/smithsonian/object-metadata.parquet"
-    response = requests.get(url)
-    response.raise_for_status()
-    with open(filename, "wb") as file:
-        file.write(response.content)
-
-    df = pd.read_parquet(filename)
     df["uid"] = df["url"].apply(get_uid_from_str)
     df["license"] = "CC0"
     return df
@@ -60,7 +68,8 @@ def download_smithsonian_object(url: str, download_dir: str = "~/.objaverse-xl")
     Args:
         url (str): URL to download the Smithsonian Object from.
         download_dir (str, optional): Directory to download the Smithsonian Object to.
-            Defaults to "~/.objaverse-xl".
+            Supports all file systems supported by fsspec. Defaults to
+            "~/.objaverse-xl".
 
     Returns:
         str: Path to the downloaded Smithsonian Object.
@@ -68,21 +77,27 @@ def download_smithsonian_object(url: str, download_dir: str = "~/.objaverse-xl")
     uid = get_uid_from_str(url)
 
     dirname = os.path.expanduser(os.path.join(download_dir, "smithsonian", "objects"))
-    os.makedirs(dirname, exist_ok=True)
     filename = os.path.join(dirname, f"{uid}.glb")
+    fs, path = fsspec.core.url_to_fs(filename)
+    if fs.protocol == "file":
+        os.makedirs(dirname, exist_ok=True)
+
+    if not fs.exists(filename):
+        tmp_path = os.path.join(dirname, f"{uid}.glb.tmp")
+        response = requests.get(url)
+
+        # check if the path is valid
+        if response.status_code == 404:
+            logger.warning(f"404 for {url}")
+            return None
 
-    if os.path.exists(filename):
-        return filename
+        # write to tmp path
+        with fs.open(tmp_path, "wb") as file:
+            for chunk in response.iter_content(chunk_size=8192):
+                file.write(chunk)
 
-    tmp_path = os.path.join(dirname, f"{uid}.glb.tmp")
-    response = requests.get(url)
-    if response.status_code == 404:
-        logger.warning(f"404 for {url}")
-        return None
-    with open(tmp_path, "wb") as file:
-        for chunk in response.iter_content(chunk_size=8192):
-            file.write(chunk)
-    os.rename(tmp_path, filename)
+        # rename to final path
+        fs.rename(tmp_path, filename)
 
     return filename
 
@@ -99,9 +114,11 @@ def download_smithsonian_objects(
             from. If None, all Smithsonian Objects will be downloaded. Defaults to None.
         processes (Optional[int], optional): Number of processes to use for downloading
             the Smithsonian Objects. If None, the number of processes will be set to the
-            number of CPUs on the machine (multiprocessing.cpu_count()). Defaults to None.
+            number of CPUs on the machine (multiprocessing.cpu_count()). Defaults to
+            None.
         download_dir (str, optional): Directory to download the Smithsonian Objects to.
-            Defaults to "~/.objaverse-xl".
+            Supports all file systems supported by fsspec. Defaults to
+            "~/.objaverse-xl".
 
     Returns:
         List[Dict[str, str]]: List of dictionaries with keys "download_path" and "url"

requirements.txt

@@ -2,4 +2,5 @@ requests
 pandas
 pyarrow
 tqdm
-loguru
+loguru
+fsspec==2022.11.0