refactor github api

objaverse_xl/github.py

@@ -131,7 +131,7 @@ class GitHubDownloader(ObjaverseSource):
         handle_missing_object: Optional[Callable],
         handle_new_object: Optional[Callable],
         commit_hash: Optional[str],
-    ) -> List[Dict[str, str]]:
+    ) -> Dict[str, Optional[str]]:
         """Process a single repo.
 
         Args:
@@ -144,12 +144,13 @@ class GitHubDownloader(ObjaverseSource):
             {and the rest of the args are the same as download_objects}
 
         Returns:
-            List[Dict[str, str]]: List of dictionaries with the keys "fileIdentifier"
-                and "sha256" for each downloaded object.
+            Dict[str, Optional[str]]: A dictionary that maps from the "fileIdentifier" to the
+                path of the downloaded object.
         """
         # NOTE: assuming that the user has already checked that the repo doesn't exist,
         org, repo = repo_id.split("/")
 
+        out = {}
         with tempfile.TemporaryDirectory() as temp_dir:
             # clone the repo to a temp directory
             target_directory = os.path.join(temp_dir, repo)
@@ -165,7 +166,7 @@ class GitHubDownloader(ObjaverseSource):
                             sha256=sha256,
                             metadata=dict(github_organization=org, github_repo=repo),
                         )
-                return []
+                return {}
 
             # use the commit hash if specified
             repo_commit_hash = self._get_commit_hash_from_local_git_dir(
@@ -225,6 +226,7 @@ class GitHubDownloader(ObjaverseSource):
 
                 # handle the object under different conditions
                 if github_url in expected_objects:
+                    out[github_url] = file[len(target_directory) + 1 :]
                     if expected_objects[github_url] == file_hash:
                         if handle_found_object is not None:
                             handle_found_object(
@@ -265,8 +267,12 @@ class GitHubDownloader(ObjaverseSource):
             # remove the .git directory
             shutil.rmtree(os.path.join(target_directory, ".git"))
 
-            if save_repo_format is not None:
-                logger.debug(f"Saving as {save_repo_format}")
+            if save_repo_format is None:
+                # remove the relative path, since it's not downloaded
+                for file_identifier in out:
+                    out[file_identifier] = None
+            else:
+                logger.debug(f"Saving {org}/{repo} as {save_repo_format}")
                 # save the repo to a zip file
                 if save_repo_format == "zip":
                     shutil.make_archive(target_directory, "zip", target_directory)
@@ -295,10 +301,20 @@ class GitHubDownloader(ObjaverseSource):
                         os.path.join(temp_dir, f"{repo}.{save_repo_format}"),
                         os.path.join(dirname, f"{repo}.{save_repo_format}"),
                     )
+
+                    for file_identifier in out:
+                        out[file_identifier] = os.path.join(
+                            dirname, f"{repo}.{save_repo_format}", out[file_identifier]
+                        )
                 else:
                     # move the repo to the correct location (with put)
                     fs.put(target_directory, dirname, recursive=True)
 
+                    for file_identifier in out:
+                        out[file_identifier] = os.path.join(
+                            dirname, repo, out[file_identifier]
+                        )
+
         # get each object that was missing from the expected objects
         if handle_missing_object is not None:
             obtained_urls = {x["fileIdentifier"] for x in file_hashes}
@@ -310,7 +326,7 @@ class GitHubDownloader(ObjaverseSource):
                         metadata=dict(github_organization=org, github_repo=repo),
                     )
 
-        return file_hashes
+        return out
 
     def _list_files(self, root_dir: str) -> List[str]:
         return [
@@ -344,7 +360,7 @@ class GitHubDownloader(ObjaverseSource):
         commit_hash = result.stdout.strip().decode("utf-8")
         return commit_hash
 
-    def _parallel_process_repo(self, args) -> List[Dict[str, str]]:
+    def _parallel_process_repo(self, args) -> Dict[str, Optional[str]]:
         """Helper function to process a repo in parallel.
 
         Note: This function is used to parallelize the processing of repos. It is not
@@ -354,8 +370,8 @@ class GitHubDownloader(ObjaverseSource):
             args (Tuple): Tuple of arguments to pass to _process_repo.
 
         Returns:
-            List[Dict[str, str]]: List of dictionaries with the keys "fileIdentifier"
-                and "sha256" for each downloaded object.
+            Dict[str, Optional[str]]: A dictionary that maps from the "fileIdentifier"
+                to the path of the downloaded object.
         """
 
         (
@@ -391,7 +407,7 @@ class GitHubDownloader(ObjaverseSource):
     def download_objects(
         self,
         objects: pd.DataFrame,
-        download_dir: str = "~/.objaverse",
+        download_dir: Optional[str] = "~/.objaverse",
         processes: Optional[int] = None,
         handle_found_object: Optional[Callable] = None,
         handle_modified_object: Optional[Callable] = None,
@@ -400,15 +416,17 @@ class GitHubDownloader(ObjaverseSource):
         save_repo_format: Optional[Literal["zip", "tar", "tar.gz", "files"]] = None,
         handle_new_object: Optional[Callable] = None,
         **kwargs,
-    ) -> List[Dict[str, str]]:
+    ) -> Dict[str, Optional[str]]:
         """Download the specified GitHub objects.
 
         Args:
             objects (pd.DataFrame): GitHub objects to download. Must have columns for
                 the object "fileIdentifier" and "sha256". Use the `get_annotations`
                 function to get the metadata.
-            download_dir (str, optional): Directory to download the GitHub objects to.
-                Supports all file systems supported by fsspec. Defaults to
+            download_dir (Optional[str], optional): Directory to download the GitHub
+                objects to. Supports all file systems supported by fsspec. If None, the
+                repository will not be saved (note that save_repo_format must also be
+                None in this case, otherwise a ValueError is raised). Defaults to
                 "~/.objaverse".
             processes (Optional[int], optional): Number of processes to use for
                 downloading.  If None, will use the number of CPUs on the machine.
@@ -467,12 +485,23 @@ class GitHubDownloader(ObjaverseSource):
                     GitHub organization and repo names.
                 Return is not used. Defaults to None.
 
+        Raises:
+            ValueError: If download_dir is None and save_repo_format is not None.
+                Otherwise, we don't know where to save the repo!
+
         Returns:
-            List[Dict[str, str]]: List of dictionaries with the keys "fileIdentifier"
-                and "sha256" for each downloaded object.
+            Dict[str, Optional[str]]: A dictionary that maps from the "fileIdentifier" to the
+                path of the downloaded object.
         """
         if processes is None:
             processes = multiprocessing.cpu_count()
+        if download_dir is None:
+            if save_repo_format is not None:
+                raise ValueError(
+                    f"If {save_repo_format=} is not None, {download_dir=} must be specified."
+                )
+            # path doesn't matter if we're not saving the repo
+            download_dir = "~/.objaverse"
 
         base_download_dir = os.path.join(download_dir, "github")
         fs, path = fsspec.core.url_to_fs(base_download_dir)
@@ -558,7 +587,12 @@ class GitHubDownloader(ObjaverseSource):
                 tqdm(
                     pool.imap_unordered(self._parallel_process_repo, all_args),
                     total=len(all_args),
+                    desc="Downloading repositories",
                 )
             )
-        out_list = [item for sublist in out for item in sublist]
-        return out_list
+
+        out_dict = {}
+        for x in out:
+            out_dict.update(x)
+
+        return out_dict