install ABC written

invokeai/backend/model_manager/model_install.py

@@ -36,20 +36,17 @@ The following exceptions may be raised:
   DuplicateModelException
   UnknownModelTypeException
 """
+from abc import ABC, abstractmethod
 from pathlib import Path
 from typing import Optional, List
 from invokeai.app.services.config import InvokeAIAppConfig
 from invokeai.backend.util.logging import InvokeAILogger
-from .storage import ModelConfigStore
+from .storage import ModelConfigStore, UnknownModelException
 
+class ModelInstallBase(ABC):
+    """Abstract base class for InvokeAI model installation"""
 
-class ModelInstall(object):
-    """Model installer class handles installation from a local path."""
-
-    _config: InvokeAIAppConfig
-    _logger: InvokeAILogger
-    _store: ModelConfigStore
-
+    @abstractmethod
     def __init__(self,
                  store: Optional[ModelConfigStore] = None,
                  config: Optional[InvokeAIAppConfig] = None,
@@ -65,6 +62,104 @@ class ModelInstall(object):
         :param logger: Optional InvokeAILogger. If None passed,
         uses the system-wide default logger.
         """
+        pass
+
+    @abstractmethod
+    def register(self, model_path: Path) -> str:
+        """
+        Probe and register the model at model_path.
+
+        :param model_path: Filesystem Path to the model.
+        :returns id: The string ID of the registered model.
+        """
+        pass
+
+    @abstractmethod
+    def install(self, model_path: Path) -> str:
+        """
+        Probe, register and install the model in the models directory.
+
+        This involves moving the model from its current location into
+        the models directory handled by InvokeAI.
+
+        :param model_path: Filesystem Path to the model.
+        :returns id: The string ID of the installed model.
+        """
+        pass
+
+    @abstractmethod
+    def forget(self, id: str):
+        """
+        Unregister the model identified by id.
+
+        This removes the model from the registry without
+        deleting the underlying model from disk.
+
+        :param id: The string ID of the model to forget.
+        :raises UnknownModelException: In the event the ID is unknown.
+        """
+        pass
+
+    @abstractmethod
+    def delete(self, id: str) -> str:
+        """
+        Unregister and delete the model identified by id.
+
+        This removes the model from the registry and
+        deletes the underlying model from disk.
+
+        :param id: The string ID of the model to forget.
+        :raises UnknownModelException: In the event the ID is unknown.
+        :raises OSError: In the event the model cannot be deleted from disk.
+        """
+        pass
+
+    @abstractmethod
+    def scan_directory(self, scan_dir: Path, install: bool = False) -> List[str]:
+        """
+        Recursively scan directory for new models and register or install them.
+
+        :param scan_dir: Path to the directory to scan.
+        :param install: Install if True, otherwise register in place.
+        :returns list of IDs: Returns list of IDs of models registered/installed
+        """
+        pass
+
+    @abstractmethod
+    def garbage_collect(self) -> List[str]:
+        """
+        Unregister any models whose paths are no longer valid.
+
+        This checks each registered model's path. Models with paths that are
+        no longer found on disk will be unregistered.
+
+        :return List[str]: Return the list of model IDs that were unregistered.
+        """
+        pass
+
+    @abstractmethod
+    def hash(self, model_path: Path) -> str:
+        """
+        Compute and return the fast hash of the model.
+
+        :param model_path: Path to the model on disk.
+        :return str: FastHash of the model for use as an ID.
+        """
+        pass
+
+
+class ModelInstall(ModelInstallBase):
+    """Model installer class handles installation from a local path."""
+
+    _config: InvokeAIAppConfig
+    _logger: InvokeAILogger
+    _store: ModelConfigStore
+
+    def __init__(self,  
+                 store: Optional[ModelConfigStore] = None,
+                 config: Optional[InvokeAIAppConfig] = None,
+                 logger: Optional[InvokeAILogger] = None
+                 ):                                             # noqa D107 - use base class docstrings
         self._config = config or InvokeAIAppConfig.get_config()
         self._logger = logger or InvokeAILogger.getLogger()
         if store is None:
@@ -72,35 +167,23 @@ class ModelInstall(object):
             store = ModelConfigStoreYAML(config.model_conf_path)
         self._store = store
 
-
-    def register(self, model_path: Path) -> str:
-        """Probe and register the model at model_path."""
+    def register(self, model_path: Path) -> str:  # noqa D102
         pass
 
-    def install(self, model_path: Path) -> str:
-        """Probe, register and Install the model in the models directory."""
+    def install(self, model_path: Path) -> str:    # noqa D102
         pass
 
-    def forget(self, id: str) -> str:
-        """Unregister the model identified by id."""
+    def forget(self, id: str) -> str:    # noqa D102
         pass
 
-    def delete(self, id: str) -> str:
-        """
-        Unregister and delete the model identified by id.
-        Note that this deletes the model unconditionally.
-        """
+    def delete(self, id: str) -> str:    # noqa D102
         pass
 
-    def scan_directory(self, scan_dir: Path, install: bool=False) -> List[str]:
-        """Scan directory for new models and register or install them."""
+    def scan_directory(self, scan_dir: Path, install: bool = False) -> List[str]:     # noqa D102
         pass
 
-    def garbage_collect(self):
-        """Unregister any models whose paths are no longer valid."""
+    def garbage_collect(self) -> List[str]:      # noqa D102
         pass
 
-    def hash(self, model_path: Path) -> str:
-        """Compute the fast hash of the model."""
+    def hash(self, model_path: Path) -> str:     # noqa D102
         pass
-