metadata_generator: protocols to better type repository abstractions...

lib/galaxy/tool_shed/galaxy_install/metadata/installed_repository_metadata_manager.py

@@ -125,6 +125,7 @@ class InstalledRepositoryMetadataManager(GalaxyMetadataGenerator):
     def reset_all_metadata_on_installed_repository(self):
         """Reset all metadata on a single tool shed repository installed into a Galaxy instance."""
         if self.relative_install_dir:
+            assert self.repository
             original_metadata_dict = self.repository.metadata_
             self.generate_metadata_for_changeset_revision()
             if self.metadata_dict != original_metadata_dict:
@@ -140,7 +141,9 @@ class InstalledRepositoryMetadataManager(GalaxyMetadataGenerator):
             else:
                 log.debug(f"Metadata did not need to be reset on repository {self.repository.name}.")
         else:
-            log.debug(f"Error locating installation directory for repository {self.repository.name}.")
+            log.debug(
+                f"Error locating installation directory for repository {self.repository and self.repository.name}."
+            )
 
     def reset_metadata_on_selected_repositories(self, user, **kwd):
         """
@@ -208,6 +211,7 @@ class InstalledRepositoryMetadataManager(GalaxyMetadataGenerator):
         A tool shed repository is being updated so change the shed_tool_conf file.  Parse the config
         file to generate the entire list of config_elems instead of using the in-memory list.
         """
+        assert self.repository
         shed_conf_dict = self.shed_config_dict or self.repository.get_shed_config_dict(self.app)
         shed_tool_conf = shed_conf_dict["config_filename"]
         tool_path = shed_conf_dict["tool_path"]

lib/galaxy/tool_shed/metadata/metadata_generator.py

@@ -10,8 +10,10 @@ from typing import (
 )
 
 from sqlalchemy import and_
+from typing_extensions import Protocol
 
 from galaxy import util
+from galaxy.model.tool_shed_install import ToolShedRepository
 from galaxy.structured_app import MinimalManagerApp
 from galaxy.tool_shed.repository_type import (
     REPOSITORY_DEPENDENCY_DEFINITION_FILENAME,
@@ -56,8 +58,20 @@ NOT_TOOL_CONFIGS = [
 ]
 
 
+class RepositoryProtocol(Protocol):
+    def repo_path(self, app) -> Optional[str]:
+        ...
+
+
+class ToolShedRepositoryProtocol(RepositoryProtocol):
+
+    def tip(self) -> str:
+        ...
+
+
 class BaseMetadataGenerator:
     app: MinimalManagerApp
+    repository: Optional[RepositoryProtocol]
     invalid_file_tups: List[InvalidFileT]
     changeset_revision: Optional[str]
     repository_clone_url: Optional[str]
@@ -78,12 +92,13 @@ class BaseMetadataGenerator:
         """
         if data_manager_config_filename is None:
             return metadata_dict
+        assert self.repository
         repo_path = self.repository.repo_path(self.app)
-        try:
+        if hasattr(self.repository, "repo_files_directory"):
             # Galaxy Side.
-            repo_files_directory = self.repository.repo_files_directory(self.app)
+            repo_files_directory = self.repository.repo_files_directory(self.app)  # type: ignore[attr-defined]
             repo_dir = repo_files_directory
-        except AttributeError:
+        else:
             # Tool Shed side.
             repo_files_directory = repo_path
         relative_data_manager_dir = util.relpath(os.path.split(data_manager_config_filename)[0], repo_dir)
@@ -830,6 +845,8 @@ class BaseMetadataGenerator:
 class GalaxyMetadataGenerator(BaseMetadataGenerator):
     """A MetadataGenerator building on Galaxy's app and repository constructs."""
 
+    repository: Optional[ToolShedRepository]
+
     def __init__(
         self,
         app: MinimalManagerApp,
@@ -996,11 +1013,12 @@ class GalaxyMetadataGenerator(BaseMetadataGenerator):
 
 class ToolShedMetadataGenerator(BaseMetadataGenerator):
     """A MetadataGenerator building on ToolShed's app and repository constructs."""
+    repository: Optional[ToolShedRepositoryProtocol]
 
     def __init__(
         self,
         app: MinimalManagerApp,
-        repository=None,
+        repository: Optional[ToolShedRepositoryProtocol] = None,
         changeset_revision: Optional[str] = None,
         repository_clone_url: Optional[str] = None,
         shed_config_dict: Optional[Dict[str, Any]] = None,