Upload catalog.py with huggingface_hub

catalog.py

@@ -1,6 +1,8 @@
+import logging
 import os
 import re
 from pathlib import Path
+from typing import Optional
 
 import requests
 
@@ -34,16 +36,19 @@ class LocalCatalog(Catalog):
     location: str = default_catalog_path
 
     def path(self, artifact_identifier: str):
-        assert artifact_identifier.strip(), "artifact_identifier should not be an empty string."
+        assert (
+            artifact_identifier.strip()
+        ), "artifact_identifier should not be an empty string."
         parts = artifact_identifier.split(COLLECTION_SEPARATOR)
         parts[-1] = parts[-1] + ".json"
         return os.path.join(self.location, *parts)
 
     def load(self, artifact_identifier: str):
-        assert artifact_identifier in self, "Artifact with name {} does not exist".format(artifact_identifier)
+        assert (
+            artifact_identifier in self
+        ), f"Artifact with name {artifact_identifier} does not exist"
         path = self.path(artifact_identifier)
-        artifact_instance = Artifact.load(path)
-        return artifact_instance
+        return Artifact.load(path)
 
     def __getitem__(self, name) -> Artifact:
         return self.load(name)
@@ -56,8 +61,16 @@ class LocalCatalog(Catalog):
             return False
         return os.path.exists(path) and os.path.isfile(path)
 
-    def save_artifact(self, artifact: Artifact, artifact_identifier: str, overwrite: bool = False):
-        assert isinstance(artifact, Artifact), f"Input artifact must be an instance of Artifact, got {type(artifact)}"
+    def save_artifact(
+        self,
+        artifact: Artifact,
+        artifact_identifier: str,
+        overwrite: bool = False,
+        verbose: bool = True,
+    ):
+        assert isinstance(
+            artifact, Artifact
+        ), f"Input artifact must be an instance of Artifact, got {type(artifact)}"
         if not overwrite:
             assert (
                 artifact_identifier not in self
@@ -65,7 +78,8 @@ class LocalCatalog(Catalog):
         path = self.path(artifact_identifier)
         os.makedirs(Path(path).parent.absolute(), exist_ok=True)
         artifact.save(path)
-        print(f"Artifact {artifact_identifier} saved to {path}")
+        if verbose:
+            logging.info(f"Artifact {artifact_identifier} saved to {path}")
 
 
 class EnvironmentLocalCatalog(LocalCatalog):
@@ -97,16 +111,23 @@ class GithubCatalog(LocalCatalog):
 def verify_legal_catalog_name(name):
     assert re.match(
         r"^[\w" + COLLECTION_SEPARATOR + "]+$", name
-    ), 'Catalog name should be alphanumeric, ":" should specify dirs (instead of "/").'
+    ), f'Artifict name ("{name}") should be alphanumeric. Use "." for nesting (e.g. myfolder.my_artifact)'
 
 
 def add_to_catalog(
-    artifact: Artifact, name: str, catalog: Catalog = None, overwrite: bool = False, catalog_path: str = None
+    artifact: Artifact,
+    name: str,
+    catalog: Catalog = None,
+    overwrite: bool = False,
+    catalog_path: Optional[str] = None,
+    verbose=True,
 ):
     if catalog is None:
         if catalog_path is None:
             catalog_path = default_catalog_path
         catalog = LocalCatalog(location=catalog_path)
     verify_legal_catalog_name(name)
-    catalog.save_artifact(artifact, name, overwrite=overwrite)  # remove collection (its actually the dir).
+    catalog.save_artifact(
+        artifact, name, overwrite=overwrite, verbose=verbose
+    )  # remove collection (its actually the dir).
     # verify name