refactor: breaking up the console interface

Author: benfdking

sqlmesh/core/console.py

@@ -91,7 +91,92 @@ def show_linter_violations(
         """Prints all linter violations depending on their severity"""
 
 
-class Console(LinterConsole, abc.ABC):
+class ExporterConsole(abc.ABC):
+    @abc.abstractmethod
+    def start_state_export(
+        self,
+        output_file: Path,
+        gateway: t.Optional[str] = None,
+        state_connection_config: t.Optional[ConnectionConfig] = None,
+        environment_names: t.Optional[t.List[str]] = None,
+        local_only: bool = False,
+        confirm: bool = True,
+    ) -> bool:
+        """State a state export"""
+
+    @abc.abstractmethod
+    def update_state_export_progress(
+        self,
+        version_count: t.Optional[int] = None,
+        versions_complete: bool = False,
+        snapshot_count: t.Optional[int] = None,
+        snapshots_complete: bool = False,
+        environment_count: t.Optional[int] = None,
+        environments_complete: bool = False,
+    ) -> None:
+        """Update the state export progress"""
+
+    @abc.abstractmethod
+    def stop_state_export(self, success: bool, output_file: Path) -> None:
+        """Finish a state export"""
+
+
+class StateImporterConsole(abc.ABC):
+    @abc.abstractmethod
+    def start_state_import(
+        self,
+        input_file: Path,
+        gateway: str,
+        state_connection_config: ConnectionConfig,
+        clear: bool = False,
+        confirm: bool = True,
+    ) -> bool:
+        """Start a state import"""
+
+    @abc.abstractmethod
+    def update_state_import_progress(
+        self,
+        timestamp: t.Optional[str] = None,
+        state_file_version: t.Optional[int] = None,
+        versions: t.Optional[Versions] = None,
+        snapshot_count: t.Optional[int] = None,
+        snapshots_complete: bool = False,
+        environment_count: t.Optional[int] = None,
+        environments_complete: bool = False,
+    ) -> None:
+        """Update the state import process"""
+
+    @abc.abstractmethod
+    def stop_state_import(self, success: bool, input_file: Path) -> None:
+        """Finish a state import"""
+
+
+class JanitorConsole(abc.ABC):
+    @abc.abstractmethod
+    def start_cleanup(self, ignore_ttl: bool) -> bool:
+        """Start a janitor / snapshot cleanup run.
+
+        Args:
+            ignore_ttl: Indicates that the user wants to ignore the snapshot TTL and clean up everything not promoted to an environment
+
+        Returns:
+            Whether or not the cleanup run should proceed
+        """
+
+    @abc.abstractmethod
+    def update_cleanup_progress(self, object_name: str) -> None:
+        """Update the snapshot cleanup progress."""
+
+    @abc.abstractmethod
+    def stop_cleanup(self, success: bool = True) -> None:
+        """Indicates the janitor / snapshot cleanup run has ended
+
+        Args:
+            success: Whether or not the cleanup completed successfully
+        """
+
+
+class Console(LinterConsole, ExporterConsole, StateImporterConsole, JanitorConsole, abc.ABC):
     """Abstract base class for defining classes used for displaying information to the user and also interact
     with them when their input is needed."""
 
@@ -151,29 +236,6 @@ def update_creation_progress(self, snapshot: SnapshotInfoLike) -> None:
     def stop_creation_progress(self, success: bool = True) -> None:
         """Stop the snapshot creation progress."""
 
-    @abc.abstractmethod
-    def start_cleanup(self, ignore_ttl: bool) -> bool:
-        """Start a janitor / snapshot cleanup run.
-
-        Args:
-            ignore_ttl: Indicates that the user wants to ignore the snapshot TTL and clean up everything not promoted to an environment
-
-        Returns:
-            Whether or not the cleanup run should proceed
-        """
-
-    @abc.abstractmethod
-    def update_cleanup_progress(self, object_name: str) -> None:
-        """Update the snapshot cleanup progress."""
-
-    @abc.abstractmethod
-    def stop_cleanup(self, success: bool = True) -> None:
-        """Indicates the janitor / snapshot cleanup run has ended
-
-        Args:
-            success: Whether or not the cleanup completed successfully
-        """
-
     @abc.abstractmethod
     def start_promotion_progress(
         self,
@@ -219,62 +281,6 @@ def update_env_migration_progress(self, num_tasks: int) -> None:
     def stop_env_migration_progress(self, success: bool = True) -> None:
         """Stop the environment migration progress."""
 
-    @abc.abstractmethod
-    def start_state_export(
-        self,
-        output_file: Path,
-        gateway: t.Optional[str] = None,
-        state_connection_config: t.Optional[ConnectionConfig] = None,
-        environment_names: t.Optional[t.List[str]] = None,
-        local_only: bool = False,
-        confirm: bool = True,
-    ) -> bool:
-        """State a state export"""
-
-    @abc.abstractmethod
-    def update_state_export_progress(
-        self,
-        version_count: t.Optional[int] = None,
-        versions_complete: bool = False,
-        snapshot_count: t.Optional[int] = None,
-        snapshots_complete: bool = False,
-        environment_count: t.Optional[int] = None,
-        environments_complete: bool = False,
-    ) -> None:
-        """Update the state export progress"""
-
-    @abc.abstractmethod
-    def stop_state_export(self, success: bool, output_file: Path) -> None:
-        """Finish a state export"""
-
-    @abc.abstractmethod
-    def start_state_import(
-        self,
-        input_file: Path,
-        gateway: str,
-        state_connection_config: ConnectionConfig,
-        clear: bool = False,
-        confirm: bool = True,
-    ) -> bool:
-        """Start a state import"""
-
-    @abc.abstractmethod
-    def update_state_import_progress(
-        self,
-        timestamp: t.Optional[str] = None,
-        state_file_version: t.Optional[int] = None,
-        versions: t.Optional[Versions] = None,
-        snapshot_count: t.Optional[int] = None,
-        snapshots_complete: bool = False,
-        environment_count: t.Optional[int] = None,
-        environments_complete: bool = False,
-    ) -> None:
-        """Update the state import process"""
-
-    @abc.abstractmethod
-    def stop_state_import(self, success: bool, input_file: Path) -> None:
-        """Finish a state import"""
-
     @abc.abstractmethod
     def show_model_difference_summary(
         self,
@@ -390,10 +396,6 @@ def show_row_diff(
     def print_environments(self, environments_summary: t.Dict[str, int]) -> None:
         """Prints all environment names along with expiry datetime."""
 
-    @abc.abstractmethod
-    def print_connection_config(self, config: ConnectionConfig, title: str = "Connection") -> None:
-        """Print connection config information"""
-
     def _limit_model_names(self, tree: Tree, verbosity: Verbosity = Verbosity.DEFAULT) -> Tree:
         """Trim long indirectly modified model lists below threshold."""
         modified_length = len(tree.children)