mtr-cli 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

mtr/cli.py

@@ -15,6 +15,11 @@ defaults:
   # 选项: "rsync" (推荐), "sftp"
   sync: "rsync"
 
+  # 是否尊重 .gitignore 文件（仅 rsync 模式支持）
+  # 设置为 true 时，rsync 会自动读取项目根目录的 .gitignore 并排除匹配的文件
+  # SFTP 模式不支持此选项，如启用会报错
+  respect_gitignore: true
+
   exclude:
     - ".git/"
     - "__pycache__/"
@@ -186,6 +191,9 @@ def cli(server, sync, dry_run, tty, init, enable_log, log_level, log_file, remot
         # Resolve exclude
         exclude = config.global_defaults.get("exclude", []) + server_conf.get("exclude", [])
 
+        # Get respect_gitignore setting
+        respect_gitignore = config.get_respect_gitignore()
+
         # Determine engine
         engine = server_conf.get("sync", config.global_defaults.get("sync", "rsync"))
 
@@ -199,6 +207,7 @@ def cli(server, sync, dry_run, tty, init, enable_log, log_level, log_file, remot
                 password=password,
                 port=port,
                 exclude=exclude,
+                respect_gitignore=respect_gitignore,
             )
         elif engine == "sftp":
             syncer = SftpSyncer(
@@ -210,6 +219,7 @@ def cli(server, sync, dry_run, tty, init, enable_log, log_level, log_file, remot
                 password=password,
                 port=port,
                 exclude=exclude,
+                respect_gitignore=respect_gitignore,
             )
         else:
             click.secho(
@@ -225,11 +235,28 @@ def cli(server, sync, dry_run, tty, init, enable_log, log_level, log_file, remot
                     logger.info(f"[DryRun] Would sync {local_dir} -> {remote_dir}", module="mtr.sync")
                 else:
                     if is_interactive and console:
-                        with console.status("[bold blue]Syncing code...", spinner="dots"):
-                            syncer.sync()
+                        # TTY mode: single line real-time update using Rich Live
+                        from rich.live import Live
+                        from rich.text import Text
+
+                        with Live(Text("Starting sync...", style="blue"), refresh_per_second=10) as live:
+
+                            def show_sync_progress(filename):
+                                # Get relative path for cleaner display
+                                rel_path = os.path.relpath(filename, local_dir)
+                                live.update(Text(f"Syncing: {rel_path}", style="blue"))
+
+                            syncer.sync(show_progress=True, progress_callback=show_sync_progress)
+                            live.update(Text("Sync completed!", style="green"))
                     else:
+                        # no_tty mode: print each file on new line
+                        def show_sync_progress(filename):
+                            rel_path = os.path.relpath(filename, local_dir)
+                            click.echo(f"Syncing: {rel_path}")
+
                         click.secho("Syncing code...", fg="blue")
-                        syncer.sync()
+                        syncer.sync(show_progress=True, progress_callback=show_sync_progress)
+                        click.secho("Sync completed!", fg="green")
                     logger.info(f"Sync completed: {local_dir} -> {remote_dir}", module="mtr.sync")
             except SyncError as e:
                 logger.error(f"Sync failed: {e}", module="mtr.sync")
@@ -260,6 +287,9 @@ def cli(server, sync, dry_run, tty, init, enable_log, log_level, log_file, remot
         # Resolve exclude
         exclude = config.global_defaults.get("exclude", []) + server_conf.get("exclude", [])
 
+        # Get respect_gitignore setting
+        respect_gitignore = config.get_respect_gitignore()
+
         # Determine engine
         engine = server_conf.get("sync", config.global_defaults.get("sync", "rsync"))
 
@@ -273,6 +303,7 @@ def cli(server, sync, dry_run, tty, init, enable_log, log_level, log_file, remot
                 password=password,
                 port=port,
                 exclude=exclude,
+                respect_gitignore=respect_gitignore,
             )
         elif engine == "sftp":
             syncer = SftpSyncer(
@@ -284,6 +315,7 @@ def cli(server, sync, dry_run, tty, init, enable_log, log_level, log_file, remot
                 password=password,
                 port=port,
                 exclude=exclude,
+                respect_gitignore=respect_gitignore,
             )
         else:
             click.secho(
@@ -298,12 +330,27 @@ def cli(server, sync, dry_run, tty, init, enable_log, log_level, log_file, remot
                 logger.info(f"[DryRun] Would download {remote_get_path} -> {local_dest}", module="mtr.sync")
             else:
                 if is_interactive and console:
-                    with console.status(f"[bold blue]Downloading {remote_get_path}...", spinner="dots"):
-                        syncer.download(remote_get_path, local_dest)
+                    # TTY mode: single line real-time update using Rich Live
+                    from rich.live import Live
+                    from rich.text import Text
+
+                    with Live(Text("Starting download...", style="blue"), refresh_per_second=10) as live:
+
+                        def show_download_progress(filename):
+                            live.update(Text(f"Downloading: {filename}", style="blue"))
+
+                        syncer.download(
+                            remote_get_path, local_dest, show_progress=True, progress_callback=show_download_progress
+                        )
+                        live.update(Text("Download completed!", style="green"))
                     console.print(f"✅ [green]Downloaded:[/green] {remote_get_path} -> {local_dest}")
                 else:
+                    # no_tty mode: print each file on new line
+                    def show_download_progress(filename):
+                        click.echo(f"Downloading: {filename}")
+
                     click.secho(f"Downloading {remote_get_path}...", fg="blue")
-                    syncer.download(remote_get_path, local_dest)
+                    syncer.download(remote_get_path, local_dest, show_progress=True, progress_callback=show_download_progress)
                     click.secho(f"Download completed: {local_dest}", fg="green")
                 logger.info(f"Download completed: {remote_get_path} -> {local_dest}", module="mtr.sync")
         except SyncError as e:

mtr/config.py

@@ -19,6 +19,20 @@ class Config:
     server_config: Dict[str, Any]
     global_defaults: Dict[str, Any]
 
+    def get_respect_gitignore(self) -> bool:
+        """Get respect_gitignore setting, default True.
+
+        Priority: server config > global defaults > True (default)
+        """
+        # Check server config first
+        if "respect_gitignore" in self.server_config:
+            return self.server_config["respect_gitignore"]
+        # Then check global defaults
+        if "respect_gitignore" in self.global_defaults:
+            return self.global_defaults["respect_gitignore"]
+        # Default to True
+        return True
+
 
 class ConfigLoader:
     def __init__(self, config_path: Optional[str] = None):

mtr/sync.py

@@ -14,13 +14,14 @@ class SyncError(Exception):
 
 
 class BaseSyncer(ABC):
-    def __init__(self, local_dir: str, remote_dir: str, exclude: List[str]):
+    def __init__(self, local_dir: str, remote_dir: str, exclude: List[str], respect_gitignore: bool = True):
         self.local_dir = local_dir
         self.remote_dir = remote_dir
         self.exclude = exclude
+        self.respect_gitignore = respect_gitignore
 
     @abstractmethod
-    def sync(self):
+    def sync(self, show_progress: bool = False, progress_callback=None):
         pass
 
 
@@ -35,8 +36,9 @@ class SftpSyncer(BaseSyncer):
         password: Optional[str] = None,
         port: int = 22,
         exclude: List[str] = None,
+        respect_gitignore: bool = True,
     ):
-        super().__init__(local_dir, remote_dir, exclude or [])
+        super().__init__(local_dir, remote_dir, exclude or [], respect_gitignore)
         self.host = host
         self.user = user
         self.key_filename = key_filename
@@ -45,6 +47,13 @@ class SftpSyncer(BaseSyncer):
         self.transport = None
         self.sftp = None
 
+        # SFTP mode does not support respect_gitignore
+        if respect_gitignore:
+            raise SyncError(
+                "respect_gitignore is not supported in SFTP mode. "
+                "Please set respect_gitignore to false in your config or use rsync mode."
+            )
+
     def _should_ignore(self, filename: str) -> bool:
         for pattern in self.exclude:
             # Handle directory exclusion (basic)
@@ -110,7 +119,7 @@ class SftpSyncer(BaseSyncer):
                 except OSError:
                     pass  # Already exists maybe
 
-    def sync(self):
+    def sync(self, show_progress: bool = False, progress_callback=None):
         if not self.sftp:
             self._connect()
 
@@ -156,7 +165,9 @@ class SftpSyncer(BaseSyncer):
                     pass  # Does not exist, must upload
 
                 if should_upload:
-                    # print(f"Uploading {local_file} -> {remote_file}")
+                    # Call progress callback if provided
+                    if show_progress and progress_callback:
+                        progress_callback(local_file)
                     self.sftp.put(local_file, remote_file)
                     # Preserve permissions
                     mode = os.stat(local_file).st_mode
@@ -167,7 +178,7 @@ class SftpSyncer(BaseSyncer):
         if self.transport:
             self.transport.close()
 
-    def download(self, remote_path: str, local_path: str):
+    def download(self, remote_path: str, local_path: str, show_progress: bool = False, progress_callback=None):
         """Download file or directory from remote to local."""
         if not self.sftp:
             self._connect()
@@ -185,9 +196,13 @@ class SftpSyncer(BaseSyncer):
                 is_dir = stat.S_ISDIR(remote_stat.st_mode)
 
                 if is_dir:
-                    self._download_dir(remote_path, local_path)
+                    self._download_dir(
+                        remote_path, local_path, show_progress=show_progress, progress_callback=progress_callback
+                    )
                 else:
-                    self._download_file(remote_path, local_path)
+                    self._download_file(
+                        remote_path, local_path, show_progress=show_progress, progress_callback=progress_callback
+                    )
             except FileNotFoundError:
                 raise SyncError(f"Remote path not found: {remote_path}")
             except Exception as e:
@@ -213,17 +228,21 @@ class SftpSyncer(BaseSyncer):
         except FileNotFoundError:
             return True  # Local file doesn't exist, must download
 
-    def _download_file(self, remote_file: str, local_file: str):
+    def _download_file(self, remote_file: str, local_file: str, show_progress: bool = False, progress_callback=None):
         """Download a single file with incremental check."""
         if not self._should_download_file(remote_file, local_file):
             return  # No need to download
 
+        # Call progress callback if provided
+        if show_progress and progress_callback:
+            progress_callback(remote_file)
+
         self.sftp.get(remote_file, local_file)
         # Preserve permissions
         remote_stat = self.sftp.stat(remote_file)
         os.chmod(local_file, remote_stat.st_mode)
 
-    def _download_dir(self, remote_dir: str, local_dir: str):
+    def _download_dir(self, remote_dir: str, local_dir: str, show_progress: bool = False, progress_callback=None):
         """Recursively download a directory."""
         if not os.path.exists(local_dir):
             os.makedirs(local_dir, exist_ok=True)
@@ -238,9 +257,9 @@ class SftpSyncer(BaseSyncer):
             import stat
 
             if stat.S_ISDIR(entry.st_mode):
-                self._download_dir(remote_path, local_path)
+                self._download_dir(remote_path, local_path, show_progress=show_progress, progress_callback=progress_callback)
             else:
-                self._download_file(remote_path, local_path)
+                self._download_file(remote_path, local_path, show_progress=show_progress, progress_callback=progress_callback)
 
 
 class RsyncSyncer(BaseSyncer):
@@ -254,8 +273,9 @@ class RsyncSyncer(BaseSyncer):
         password: Optional[str] = None,
         port: int = 22,
         exclude: List[str] = None,
+        respect_gitignore: bool = True,
     ):
-        super().__init__(local_dir, remote_dir, exclude or [])
+        super().__init__(local_dir, remote_dir, exclude or [], respect_gitignore)
         self.host = host
         self.user = user
         self.key_filename = key_filename
@@ -269,9 +289,20 @@ class RsyncSyncer(BaseSyncer):
             opts += f" -i {self.key_filename}"
         return opts
 
-    def _build_rsync_base(self) -> List[str]:
+    def _build_rsync_base(self, show_progress: bool = False) -> List[str]:
         """Build rsync base command with common options."""
-        cmd = ["rsync", "-azq"]
+        if show_progress:
+            # In progress mode, use -av --info=NAME to show filenames only
+            cmd = ["rsync", "-av", "--info=NAME"]
+        else:
+            # Silent mode
+            cmd = ["rsync", "-azq"]
+
+        # Add gitignore filter if enabled
+        if self.respect_gitignore:
+            gitignore_path = os.path.join(self.local_dir, ".gitignore")
+            if os.path.exists(gitignore_path):
+                cmd.append("--filter=:- .gitignore")
 
         # Add excludes
         for item in self.exclude:
@@ -294,35 +325,115 @@ class RsyncSyncer(BaseSyncer):
             if not shutil.which("sshpass"):
                 raise SyncError("Rsync with password requires 'sshpass'. Please install it or use SSH Key.")
 
-    def _build_rsync_command(self) -> List[str]:
+    def _check_rsync_version(self) -> tuple:
+        """Check local rsync version and return (major, minor, patch) tuple.
+
+        Returns:
+            Tuple of (major, minor, patch) version numbers
+        Raises:
+            SyncError: If rsync is not installed or version cannot be parsed
+        """
+        try:
+            result = subprocess.run(["rsync", "--version"], capture_output=True, text=True, timeout=5)
+            if result.returncode != 0:
+                raise SyncError("Failed to check rsync version. Is rsync installed?")
+
+            # Parse version from first line, e.g., "rsync  version 3.2.5  protocol version 31"
+            first_line = result.stdout.split("\n")[0]
+            import re
+
+            match = re.search(r"version\s+(\d+)\.(\d+)\.(\d+)", first_line)
+            if not match:
+                # Try alternative format: "rsync version 2.6.9 compatible"
+                match = re.search(r"version\s+(\d+)\.(\d+)\.(\d+)", first_line)
+                if not match:
+                    raise SyncError(f"Cannot parse rsync version from: {first_line}")
+
+            major, minor, patch = int(match.group(1)), int(match.group(2)), int(match.group(3))
+            return (major, minor, patch)
+        except FileNotFoundError:
+            raise SyncError("rsync not found. Please install rsync.")
+        except subprocess.TimeoutExpired:
+            raise SyncError("Timeout while checking rsync version.")
+        except Exception as e:
+            raise SyncError(f"Failed to check rsync version: {e}")
+
+    def _is_rsync_version_supported(self, min_version: tuple = (3, 1, 0)) -> bool:
+        """Check if local rsync version meets minimum requirement.
+
+        Args:
+            min_version: Minimum required version as (major, minor, patch) tuple
+        Returns:
+            True if version is supported, False otherwise
+        """
+        try:
+            current_version = self._check_rsync_version()
+            return current_version >= min_version
+        except SyncError:
+            return False
+
+    def _build_rsync_command(self, show_progress: bool = False) -> List[str]:
         """Build rsync command for uploading (local -> remote)."""
         # Ensure local dir ends with / to sync contents, not the dir itself
         src = self.local_dir if self.local_dir.endswith("/") else f"{self.local_dir}/"
         dest = f"{self.user}@{self.host}:{shlex.quote(self.remote_dir)}"
 
-        cmd = self._build_rsync_base()
+        cmd = self._build_rsync_base(show_progress=show_progress)
         cmd.extend([src, dest])
 
         return self._wrap_with_sshpass(cmd)
 
-    def _build_rsync_download_command(self, remote_path: str, local_path: str) -> List[str]:
+    def _build_rsync_download_command(self, remote_path: str, local_path: str, show_progress: bool = False) -> List[str]:
         """Build rsync command for downloading (remote -> local)."""
         src = f"{self.user}@{self.host}:{shlex.quote(remote_path)}"
 
-        cmd = self._build_rsync_base()
+        cmd = self._build_rsync_base(show_progress=show_progress)
         cmd.extend([src, local_path])
 
         return self._wrap_with_sshpass(cmd)
 
-    def sync(self):
+    def sync(self, show_progress: bool = False, progress_callback=None):
         self._check_sshpass()
-        cmd = self._build_rsync_command()
+
+        # Check rsync version if progress mode is requested
+        if show_progress and progress_callback:
+            if not self._is_rsync_version_supported():
+                version = self._check_rsync_version()
+                raise SyncError(
+                    f"rsync version {version[0]}.{version[1]}.{version[2]} is too old. "
+                    f"Progress display requires rsync >= 3.1.0. "
+                    f"Please upgrade rsync or use --no-tty mode."
+                )
+
+        cmd = self._build_rsync_command(show_progress=show_progress)
+
         try:
-            subprocess.run(cmd, check=True)
+            if show_progress and progress_callback:
+                # Run with real-time output parsing for progress display
+                process = subprocess.Popen(
+                    cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True, bufsize=1, universal_newlines=True
+                )
+
+                # Parse rsync output line by line
+                for line in process.stdout:
+                    line = line.strip()
+                    # Skip empty lines and summary lines
+                    if line and not line.startswith("sent") and not line.startswith("total"):
+                        # Extract filename from rsync output
+                        # Rsync --info=NAME outputs filenames directly
+                        if not line.startswith("receiving") and not line.startswith("building"):
+                            progress_callback(line)
+
+                process.wait()
+                if process.returncode != 0:
+                    raise SyncError(f"Rsync failed with exit code {process.returncode}")
+            else:
+                # Silent mode - use subprocess.run
+                subprocess.run(cmd, check=True)
         except subprocess.CalledProcessError as e:
             raise SyncError(f"Rsync failed with exit code {e.returncode}")
 
-    def download(self, remote_path: str, local_path: str):
+    def download(self, remote_path: str, local_path: str, show_progress: bool = False, progress_callback=None):
         """Download file or directory from remote to local."""
         self._check_sshpass()
 
@@ -331,8 +442,29 @@ class RsyncSyncer(BaseSyncer):
         if local_dir and not os.path.exists(local_dir):
             os.makedirs(local_dir, exist_ok=True)
 
-        cmd = self._build_rsync_download_command(remote_path, local_path)
+        cmd = self._build_rsync_download_command(remote_path, local_path, show_progress=show_progress)
         try:
-            subprocess.run(cmd, check=True)
+            if show_progress and progress_callback:
+                # Run with real-time output parsing for progress display
+                process = subprocess.Popen(
+                    cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True, bufsize=1, universal_newlines=True
+                )
+
+                # Parse rsync output line by line
+                for line in process.stdout:
+                    line = line.strip()
+                    # Skip empty lines and summary lines
+                    if line and not line.startswith("sent") and not line.startswith("total"):
+                        # Extract filename from rsync output
+                        # Rsync --info=NAME outputs filenames directly
+                        if not line.startswith("receiving") and not line.startswith("building"):
+                            progress_callback(line)
+
+                process.wait()
+                if process.returncode != 0:
+                    raise SyncError(f"Rsync download failed with exit code {process.returncode}")
+            else:
+                # Silent mode - use subprocess.run
+                subprocess.run(cmd, check=True)
         except subprocess.CalledProcessError as e:
             raise SyncError(f"Rsync download failed with exit code {e.returncode}")

{mtr_cli-0.2.0.dist-info → mtr_cli-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mtr-cli
-Version: 0.2.0
+Version: 0.3.0
 Summary: A CLI tool for seamless local development and remote execution on GPU servers.
 Project-URL: Homepage, https://github.com/lecoan/mtremote
 Project-URL: Repository, https://github.com/lecoan/mtremote
@@ -57,11 +57,21 @@ pip install mtr-cli
 
 MTRemote 需要以下系统命令：
 
-| 命令 | 用途 | 安装方式 |
-|------|------|----------|
-| `ssh` | 交互式 Shell (TTY) | macOS/Linux 自带，或 `brew install openssh` |
-| `rsync` | 快速文件同步 (推荐) | macOS/Linux 自带 |
-| `sshpass` | 密码认证 (可选) | `brew install hudochenkov/sshpass/sshpass` (macOS) / `apt install sshpass` (Ubuntu) |
+| 命令 | 用途 | 安装方式 | 版本要求 |
+|------|------|----------|----------|
+| `ssh` | 交互式 Shell (TTY) | macOS/Linux 自带，或 `brew install openssh` | - |
+| `rsync` | 快速文件同步 (推荐) | macOS/Linux 自带 | **≥ 3.1.0** (TTY 进度显示需要) |
+| `sshpass` | 密码认证 (可选) | `brew install hudochenkov/sshpass/sshpass` (macOS) / `apt install sshpass` (Ubuntu) | - |
+
+**注意**：macOS 自带的 rsync 版本较旧（2.6.9），不支持 TTY 模式下的进度显示。建议通过 Homebrew 安装新版：
+
+```bash
+# macOS 用户建议升级 rsync
+brew install rsync
+
+# 验证版本
+rsync --version  # 应显示 3.1.0 或更高版本
+```
 
 **注意**：交互式 Shell 功能（如 `mtr bash`, `mtr ipython`）**必须**安装 `ssh`。密码认证**必须**安装 `sshpass`。
 

mtr_cli-0.3.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+mtr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mtr/cli.py,sha256=LXoXCdajKQe_oVXlf9FPGgHt7N3P0zQxE-mh9xPwnII,16363
+mtr/config.py,sha256=HA_pZ3rTFPYa6JhgFnEQlf4ukdFovx8obv58UILloWQ,3568
+mtr/logger.py,sha256=9DPKTTzYsNMF7vXnvJ0bJditNYgzhZWHwLKUErtwCBY,3669
+mtr/ssh.py,sha256=fCEXxfEK6ao8YrCU9FBJ_e5zrK93AKz6bgjXWkORQkk,7170
+mtr/sync.py,sha256=xrljWPt8keigyiri7oc1RNvxJxBNBHjJjhgGtXP0F_g,18668
+mtr_cli-0.3.0.dist-info/METADATA,sha256=XFZfTrcxMzhCbvzwY6LQrJWq_r2lnboCqL8SbDSuYnQ,9806
+mtr_cli-0.3.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+mtr_cli-0.3.0.dist-info/entry_points.txt,sha256=8BRK0VoSAWGzovrOdzWqpwwNj-dmjVY1iQcz5MQseV4,36
+mtr_cli-0.3.0.dist-info/licenses/LICENSE,sha256=PkuO1VHNDkFylFSOtMADb93mjExarK6DBTjtCB3kBeU,1067
+mtr_cli-0.3.0.dist-info/RECORD,,

mtr_cli-0.2.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-mtr/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mtr/cli.py,sha256=lhK5hoOlMSp5kAhiqYvmWGfDdyUozELDKgk1x1LjFwI,13910
-mtr/config.py,sha256=v1lUg7z12jb-W0B61KKwiLuP6BO3I6ZLZSqxPSoAi7A,3037
-mtr/logger.py,sha256=9DPKTTzYsNMF7vXnvJ0bJditNYgzhZWHwLKUErtwCBY,3669
-mtr/ssh.py,sha256=fCEXxfEK6ao8YrCU9FBJ_e5zrK93AKz6bgjXWkORQkk,7170
-mtr/sync.py,sha256=LvfGs7wGzlU-RSHsXF8IQ_LK70yYPnw-sqVEGqLknHQ,11799
-mtr_cli-0.2.0.dist-info/METADATA,sha256=ZhfL78GWsse8Q1Ml17SqdOa2V2HUZwS9Tvl6kIKSMeU,9458
-mtr_cli-0.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-mtr_cli-0.2.0.dist-info/entry_points.txt,sha256=8BRK0VoSAWGzovrOdzWqpwwNj-dmjVY1iQcz5MQseV4,36
-mtr_cli-0.2.0.dist-info/licenses/LICENSE,sha256=PkuO1VHNDkFylFSOtMADb93mjExarK6DBTjtCB3kBeU,1067
-mtr_cli-0.2.0.dist-info/RECORD,,