fix linter errors

objaverse_xl/abstract.py

@@ -1,3 +1,5 @@
+"""Abstract class for Objaverse-XL sources."""
+
 from abc import ABC, abstractmethod
 from typing import Callable, Dict, Optional
 
@@ -5,6 +7,8 @@ import pandas as pd
 
 
 class ObjaverseSource(ABC):
+    """Abstract class for Objaverse-XL sources."""
+
     @abstractmethod
     def get_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
         """Loads the 3D object metadata as a Pandas DataFrame.

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],
-    ) -> Dict[str, Optional[str]]:
+    ) -> Dict[str, str]:
         """Process a single repo.
 
         Args:
@@ -144,8 +144,8 @@ class GitHubDownloader(ObjaverseSource):
             {and the rest of the args are the same as download_objects}
 
         Returns:
-            Dict[str, Optional[str]]: A dictionary that maps from the "fileIdentifier" to the
-                path of the downloaded object.
+            Dict[str, 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("/")
@@ -268,9 +268,8 @@ class GitHubDownloader(ObjaverseSource):
             shutil.rmtree(os.path.join(target_directory, ".git"))
 
             if save_repo_format is None:
-                # remove the relative path, since it's not downloaded
-                for file_identifier in out:
-                    out[file_identifier] = None
+                # remove the paths, since it's not downloaded
+                out = {}
             else:
                 logger.debug(f"Saving {org}/{repo} as {save_repo_format}")
                 # save the repo to a zip file
@@ -302,7 +301,7 @@ class GitHubDownloader(ObjaverseSource):
                         os.path.join(dirname, f"{repo}.{save_repo_format}"),
                     )
 
-                    for file_identifier in out:
+                    for file_identifier in out.copy():
                         out[file_identifier] = os.path.join(
                             dirname, f"{repo}.{save_repo_format}", out[file_identifier]
                         )
@@ -310,7 +309,7 @@ class GitHubDownloader(ObjaverseSource):
                     # move the repo to the correct location (with put)
                     fs.put(target_directory, dirname, recursive=True)
 
-                    for file_identifier in out:
+                    for file_identifier in out.copy():
                         out[file_identifier] = os.path.join(
                             dirname, repo, out[file_identifier]
                         )
@@ -360,7 +359,7 @@ class GitHubDownloader(ObjaverseSource):
         commit_hash = result.stdout.strip().decode("utf-8")
         return commit_hash
 
-    def _parallel_process_repo(self, args) -> Dict[str, Optional[str]]:
+    def _parallel_process_repo(self, args) -> Dict[str, str]:
         """Helper function to process a repo in parallel.
 
         Note: This function is used to parallelize the processing of repos. It is not
@@ -370,8 +369,8 @@ class GitHubDownloader(ObjaverseSource):
             args (Tuple): Tuple of arguments to pass to _process_repo.
 
         Returns:
-            Dict[str, Optional[str]]: A dictionary that maps from the "fileIdentifier"
-                to the path of the downloaded object.
+            Dict[str, str]: A dictionary that maps from the "fileIdentifier" to the path
+                of the downloaded object.
         """
 
         (
@@ -412,11 +411,8 @@ class GitHubDownloader(ObjaverseSource):
         handle_found_object: Optional[Callable] = None,
         handle_modified_object: Optional[Callable] = None,
         handle_missing_object: Optional[Callable] = None,
-        *,
-        save_repo_format: Optional[Literal["zip", "tar", "tar.gz", "files"]] = None,
-        handle_new_object: Optional[Callable] = None,
         **kwargs,
-    ) -> Dict[str, Optional[str]]:
+    ) -> Dict[str, str]:
         """Download the specified GitHub objects.
 
         Args:
@@ -490,9 +486,12 @@ class GitHubDownloader(ObjaverseSource):
                 Otherwise, we don't know where to save the repo!
 
         Returns:
-            Dict[str, Optional[str]]: A dictionary that maps from the "fileIdentifier" to the
-                path of the downloaded object.
+            Dict[str, str]: A dictionary that maps from the "fileIdentifier" to the path
+                of the downloaded object.
         """
+        save_repo_format = kwargs.get("save_repo_format", None)
+        handle_new_object = kwargs.get("handle_new_object", None)
+
         if processes is None:
             processes = multiprocessing.cpu_count()
         if download_dir is None:

objaverse_xl/objaverse_v1.py

@@ -189,7 +189,6 @@ class SketchfabDownloader(ObjaverseSource):
         expected_sha256: str,
         handle_found_object: Optional[Callable] = None,
         handle_modified_object: Optional[Callable] = None,
-        handle_missing_object: Optional[Callable] = None,
     ) -> Tuple[str, Optional[str]]:
         """Download the object for the given uid.
 
@@ -412,7 +411,7 @@ class SketchfabDownloader(ObjaverseSource):
                         handle_missing_object(
                             file_identifier=item["fileIdentifier"],
                             sha256=item["sha256"],
-                            metadata=dict(),
+                            metadata={},
                         )
                     continue
                 objects_to_download.append(
@@ -456,7 +455,7 @@ class SketchfabDownloader(ObjaverseSource):
                         handle_missing_object(
                             file_identifier=item["fileIdentifier"],
                             sha256=item["sha256"],
-                            metadata=dict(),
+                            metadata={},
                         )
                     continue
                 objects_to_download.append(
@@ -479,7 +478,6 @@ class SketchfabDownloader(ObjaverseSource):
                 sha256,
                 handle_found_object,
                 handle_modified_object,
-                handle_missing_object,
             )
             for file_identifier, hf_object_path, sha256 in objects_to_download
         ]

objaverse_xl/objaverse_xl_downloader.py

@@ -59,12 +59,12 @@ class ObjaverseXLDownloader(ObjaverseSource):
             objects (pd.DataFrame): Objects to download. Must have columns for
                 the object "fileIdentifier" and "sha256". Use the `get_annotations`
                 function to get the metadata.
-            processes (Optional[int], optional): Number of processes to use for
-                downloading.  If None, will use the number of CPUs on the machine.
-                Defaults to None.
             download_dir (str, optional): Directory to download the objects to.
                 Supports all file systems supported by fsspec. 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.
+                Defaults to None.
             save_repo_format (Optional[Literal["zip", "tar", "tar.gz", "files"]],
                 optional): Format to save the repository. If None, the repository will
                 not be saved. If "files" is specified, each file will be saved

objaverse_xl/thingiverse.py

@@ -239,11 +239,12 @@ class ThingiverseDownloader(ObjaverseSource):
     def download_objects(
         self,
         objects: pd.DataFrame,
-        processes: Optional[int] = None,
         download_dir: Optional[str] = "~/.objaverse",
+        processes: Optional[int] = None,
         handle_found_object: Optional[Callable] = None,
         handle_modified_object: Optional[Callable] = None,
         handle_missing_object: Optional[Callable] = None,
+        **kwargs,
     ) -> Dict[str, str]:
         """Download the objects from the given list of things and files.
 
@@ -251,10 +252,11 @@ class ThingiverseDownloader(ObjaverseSource):
             objects (pd.DataFrame): Thingiverse 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): The directory to save the files to. Supports
+                all file systems supported by fsspec. Defaults to "~/.objaverse-xl".
             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".
+                use all available CPUs using multiprocessing.cpu_count(). Defaults to
+                None.
             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

tests/test_api.py

@@ -224,7 +224,7 @@ def test_github_handle_found_object():
         commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
     )
 
-    assert len(out) == 3
+    assert len(out) == 0
     assert len(found_objects) == 3
     assert len(missing_objects) == 0
     assert len(new_objects) == 0
@@ -302,7 +302,7 @@ def test_github_handle_modified_object():
         commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
     )
 
-    assert len(out) == 3
+    assert len(out) == 0
     assert len(found_objects) == 2
     assert len(missing_objects) == 0
     assert len(new_objects) == 0
@@ -381,7 +381,7 @@ def test_github_handle_missing_object():
         commit_hash="6928b08a2501aa7a4a4aabac1f888b66e7782056",
     )
 
-    assert len(out) == 3
+    assert len(out) == 0
     assert len(found_objects) == 3
     assert len(missing_objects) == 1
     assert len(new_objects) == 0