update tests with new api

Makefile

@@ -20,7 +20,7 @@ format: ## [Local development] Auto-format python code using black, don't includ
 	python -m black scripts --exclude scripts/rendering/blender-3.2.2-linux-x64/
 
 test: ## [Local development] Run unit tests
-	python -m pytest -x -s -v tests
+	JUPYTER_PLATFORM_DIRS=1 python -m pytest -x -s -v tests
 
 .PHONY: help
 

objaverse_xl/github.py

@@ -141,7 +141,7 @@ class GitHubDownloader(ObjaverseSource):
             expected_objects (Dict[str, str]): Dictionary of objects that one expects to
                 find in the repo. Keys are the "fileIdentifier" (i.e., the GitHub URL in
                 this case) and values are the "sha256" of the objects.
-            {and the rest of the args are the same as download_github_objects}
+            {and the rest of the args are the same as download_objects}
 
         Returns:
             List[Dict[str, str]]: List of dictionaries with the keys "fileIdentifier"

tests/test_api.py

@@ -4,10 +4,11 @@ import shutil
 import fsspec
 import pandas as pd
 
-from objaverse_xl.github import _process_repo, download_github_objects
+from objaverse_xl.github import GitHubDownloader
 
 
 def test_github_process_repo():
+    github_downloader = GitHubDownloader()
     download_dir = "~/.objaverse-tests"
     base_download_dir = os.path.join(download_dir, "github")
     fs, path = fsspec.core.url_to_fs(base_download_dir)
@@ -15,7 +16,7 @@ def test_github_process_repo():
 
     for save_repo_format in ["tar", "tar.gz", "zip", "files"]:
         # shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-        out = _process_repo(
+        out = github_downloader._process_repo(
             repo_id="mattdeitke/objaverse-xl-test-files",
             fs=fs,
             base_dir=path,
@@ -37,7 +38,7 @@ def test_github_process_repo():
             "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
         ]:
             assert sha256 in sha256s, f"{sha256=} not in {sha256s=}"
-        github_urls = [x["githubUrl"] for x in out]
+        github_urls = [x["fileIdentifier"] for x in out]
         for github_url in [
             "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx",
             "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb",
@@ -64,54 +65,50 @@ def test_github_process_repo():
 
 
 def test_github_handle_new_object():
+    github_downloader = GitHubDownloader()
     found_objects = []
     handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: found_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     missing_objects = []
     handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
+        lambda file_identifier, sha256, metadata: missing_objects.append(
             dict(
-                github_url=github_url,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     new_objects = []
     handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: new_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
+    handle_modified_object = lambda local_path, file_identifier, new_sha256, old_sha256, metadata: modified_objects.append(
+        dict(
+            local_path=local_path,
+            file_identifier=file_identifier,
+            new_sha256=new_sha256,
+            old_sha256=old_sha256,
+            metadata=metadata,
         )
     )
 
@@ -121,7 +118,7 @@ def test_github_handle_new_object():
     fs.makedirs(path, exist_ok=True)
 
     shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
+    out = github_downloader._process_repo(
         repo_id="mattdeitke/objaverse-xl-test-files",
         fs=fs,
         base_dir=path,
@@ -142,54 +139,50 @@ def test_github_handle_new_object():
 
 
 def test_github_handle_found_object():
+    github_downloader = GitHubDownloader()
     found_objects = []
     handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: found_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     missing_objects = []
     handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
+        lambda file_identifier, sha256, metadata: missing_objects.append(
             dict(
-                github_url=github_url,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     new_objects = []
     handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: new_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
+    handle_modified_object = lambda local_path, file_identifier, new_sha256, old_sha256, metadata: modified_objects.append(
+        dict(
+            local_path=local_path,
+            file_identifier=file_identifier,
+            new_sha256=new_sha256,
+            old_sha256=old_sha256,
+            metadata=metadata,
         )
     )
 
@@ -199,7 +192,7 @@ def test_github_handle_found_object():
     fs.makedirs(path, exist_ok=True)
 
     shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
+    out = github_downloader._process_repo(
         repo_id="mattdeitke/objaverse-xl-test-files",
         fs=fs,
         base_dir=path,
@@ -224,54 +217,50 @@ def test_github_handle_found_object():
 
 
 def test_github_handle_modified_object():
+    github_downloader = GitHubDownloader()
     found_objects = []
     handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: found_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     missing_objects = []
     handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
+        lambda file_identifier, sha256, metadata: missing_objects.append(
             dict(
-                github_url=github_url,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     new_objects = []
     handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: new_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
+    handle_modified_object = lambda local_path, file_identifier, new_sha256, old_sha256, metadata: modified_objects.append(
+        dict(
+            local_path=local_path,
+            file_identifier=file_identifier,
+            new_sha256=new_sha256,
+            old_sha256=old_sha256,
+            metadata=metadata,
         )
     )
 
@@ -281,7 +270,7 @@ def test_github_handle_modified_object():
     fs.makedirs(path, exist_ok=True)
 
     shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
+    out = github_downloader._process_repo(
         repo_id="mattdeitke/objaverse-xl-test-files",
         fs=fs,
         base_dir=path,
@@ -306,54 +295,50 @@ def test_github_handle_modified_object():
 
 
 def test_github_handle_missing_object():
+    github_downloader = GitHubDownloader()
     found_objects = []
     handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: found_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     missing_objects = []
     handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
+        lambda file_identifier, sha256, metadata: missing_objects.append(
             dict(
-                github_url=github_url,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     new_objects = []
     handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: new_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
+    handle_modified_object = lambda local_path, file_identifier, new_sha256, old_sha256, metadata: modified_objects.append(
+        dict(
+            local_path=local_path,
+            file_identifier=file_identifier,
+            new_sha256=new_sha256,
+            old_sha256=old_sha256,
+            metadata=metadata,
         )
     )
 
@@ -363,7 +348,7 @@ def test_github_handle_missing_object():
     fs.makedirs(path, exist_ok=True)
 
     shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
+    out = github_downloader._process_repo(
         repo_id="mattdeitke/objaverse-xl-test-files",
         fs=fs,
         base_dir=path,
@@ -389,54 +374,50 @@ def test_github_handle_missing_object():
 
 
 def test_github_handle_missing_object_2():
+    github_downloader = GitHubDownloader()
     found_objects = []
     handle_found_object = (
-        lambda file, github_url, sha256, repo, organization: found_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: found_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     missing_objects = []
     handle_missing_object = (
-        lambda github_url, sha256, repo, organization: missing_objects.append(
+        lambda file_identifier, sha256, metadata: missing_objects.append(
             dict(
-                github_url=github_url,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     new_objects = []
     handle_new_object = (
-        lambda file, github_url, sha256, repo, organization: new_objects.append(
+        lambda local_path, file_identifier, sha256, metadata: new_objects.append(
             dict(
-                file=file,
-                github_url=github_url,
+                local_path=local_path,
+                file_identifier=file_identifier,
                 sha256=sha256,
-                repo=repo,
-                organization=organization,
+                metadata=metadata,
             )
         )
     )
 
     modified_objects = []
-    handle_modified_object = (
-        lambda file, github_url, sha256, repo, organization: modified_objects.append(
-            dict(
-                file=file,
-                github_url=github_url,
-                sha256=sha256,
-                repo=repo,
-                organization=organization,
-            )
+    handle_modified_object = lambda local_path, file_identifier, new_sha256, old_sha256, metadata: modified_objects.append(
+        dict(
+            local_path=local_path,
+            file_identifier=file_identifier,
+            new_sha256=new_sha256,
+            old_sha256=old_sha256,
+            metadata=metadata,
         )
     )
 
@@ -446,7 +427,7 @@ def test_github_handle_missing_object_2():
     fs.makedirs(path, exist_ok=True)
 
     shutil.rmtree(os.path.join(path, "repos"), ignore_errors=True)
-    out = _process_repo(
+    out = github_downloader._process_repo(
         repo_id="mattdeitke/objaverse-xl-test-files-does-not-exist",
         fs=fs,
         base_dir=path,
@@ -472,20 +453,21 @@ def test_github_handle_missing_object_2():
 
 
 def test_github_download_cache():
+    github_downloader = GitHubDownloader()
     objects = pd.DataFrame(
         [
             {
-                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx",
+                "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx",
                 "license": None,
                 "sha256": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
             },
             {
-                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb",
+                "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb",
                 "license": None,
                 "sha256": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
             },
             {
-                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj",
+                "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj",
                 "license": None,
                 "sha256": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
             },
@@ -497,7 +479,7 @@ def test_github_download_cache():
         repos_dir = "~/.objaverse-tests/github/repos"
         shutil.rmtree(os.path.expanduser(repos_dir), ignore_errors=True)
 
-        out = download_github_objects(
+        out = github_downloader.download_objects(
             objects=objects,
             processes=1,
             download_dir="~/.objaverse-tests",
@@ -505,7 +487,7 @@ def test_github_download_cache():
         )
         assert len(out) == 3
 
-        out = download_github_objects(
+        out = github_downloader.download_objects(
             objects=objects,
             processes=1,
             download_dir="~/.objaverse-tests",