# # dulwich - Simple command-line interface to Dulwich # Copyright (C) 2008-2011 Jelmer Vernooij # vim: expandtab # # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later # Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU # General Public License as published by the Free Software Foundation; version 2.0 # or (at your option) any later version. You can redistribute it and/or # modify it under the terms of either of these two licenses. # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # # You should have received a copy of the licenses; if not, see # for a copy of the GNU General Public License # and for a copy of the Apache # License, Version 2.0. # """Simple command-line interface to Dulwich>. This is a very simple command-line wrapper for Dulwich. It is by no means intended to be a full-blown Git command-line interface but just a way to test Dulwich. """ import argparse import logging import os import shutil import signal import subprocess import sys import tempfile from pathlib import Path from typing import Callable, ClassVar, Optional, Union from dulwich import porcelain from .bundle import create_bundle_from_repo, read_bundle, write_bundle from .client import GitProtocolError, get_transport_and_path from .errors import ApplyDeltaError from .index import Index from .objects import valid_hexsha from .objectspec import parse_commit_range from .pack import Pack, sha_to_hex from .repo import Repo class CommitMessageError(Exception): """Raised when there's an issue with the commit message.""" def signal_int(signal, frame) -> None: sys.exit(1) def signal_quit(signal, frame) -> None: import pdb pdb.set_trace() def parse_relative_time(time_str): """Parse a relative time string like '2 weeks ago' into seconds. Args: time_str: String like '2 weeks ago' or 'now' Returns: Number of seconds Raises: ValueError: If the time string cannot be parsed """ if time_str == "now": return 0 if not time_str.endswith(" ago"): raise ValueError(f"Invalid relative time format: {time_str}") parts = time_str[:-4].split() if len(parts) != 2: raise ValueError(f"Invalid relative time format: {time_str}") try: num = int(parts[0]) unit = parts[1] multipliers = { "second": 1, "seconds": 1, "minute": 60, "minutes": 60, "hour": 3600, "hours": 3600, "day": 86400, "days": 86400, "week": 604800, "weeks": 604800, } if unit in multipliers: return num * multipliers[unit] else: raise ValueError(f"Unknown time unit: {unit}") except ValueError as e: if "invalid literal" in str(e): raise ValueError(f"Invalid number in relative time: {parts[0]}") raise def format_bytes(bytes): """Format bytes as human-readable string. Args: bytes: Number of bytes Returns: Human-readable string like "1.5 MB" """ for unit in ["B", "KB", "MB", "GB"]: if bytes < 1024.0: return f"{bytes:.1f} {unit}" bytes /= 1024.0 return f"{bytes:.1f} TB" def launch_editor(template_content=b""): """Launch an editor for the user to enter text. Args: template_content: Initial content for the editor Returns: The edited content as bytes """ # Determine which editor to use editor = os.environ.get("GIT_EDITOR") or os.environ.get("EDITOR") or "vi" # Create a temporary file with tempfile.NamedTemporaryFile(mode="wb", delete=False, suffix=".txt") as f: temp_file = f.name f.write(template_content) try: # Launch the editor subprocess.run([editor, temp_file], check=True) # Read the edited content with open(temp_file, "rb") as f: content = f.read() return content finally: # Clean up the temporary file os.unlink(temp_file) class PagerBuffer: """Binary buffer wrapper for Pager to mimic sys.stdout.buffer.""" def __init__(self, pager): self.pager = pager def write(self, data: bytes): """Write bytes to pager.""" if isinstance(data, bytes): text = data.decode("utf-8", errors="replace") return self.pager.write(text) return self.pager.write(data) def flush(self): """Flush the pager.""" return self.pager.flush() def writelines(self, lines): """Write multiple lines to pager.""" for line in lines: self.write(line) def readable(self): """Return whether the buffer is readable (it's not).""" return False def writable(self): """Return whether the buffer is writable.""" return not self.pager._closed def seekable(self): """Return whether the buffer is seekable (it's not).""" return False def close(self): """Close the pager.""" return self.pager.close() @property def closed(self): """Return whether the buffer is closed.""" return self.pager.closed class Pager: """File-like object that pages output through external pager programs.""" def __init__(self, pager_cmd="cat"): self.pager_process = None self.buffer = PagerBuffer(self) self._closed = False self.pager_cmd = pager_cmd self._pager_died = False def _get_pager_command(self) -> str: """Get the pager command to use.""" return self.pager_cmd def _ensure_pager_started(self): """Start the pager process if not already started.""" if self.pager_process is None and not self._closed: try: pager_cmd = self._get_pager_command() self.pager_process = subprocess.Popen( pager_cmd, shell=True, stdin=subprocess.PIPE, stdout=sys.stdout, stderr=sys.stderr, text=True, ) except (OSError, subprocess.SubprocessError): # Pager failed to start, fall back to direct output self.pager_process = None def write(self, text: str) -> int: """Write text to the pager.""" if self._closed: raise ValueError("I/O operation on closed file") # If pager died (user quit), stop writing output if self._pager_died: return len(text) self._ensure_pager_started() if self.pager_process and self.pager_process.stdin: try: return self.pager_process.stdin.write(text) except (OSError, subprocess.SubprocessError, BrokenPipeError): # Pager died (user quit), stop writing output self._pager_died = True return len(text) else: # No pager available, write directly to stdout return sys.stdout.write(text) def flush(self): """Flush the pager.""" if self._closed or self._pager_died: return if self.pager_process and self.pager_process.stdin: try: self.pager_process.stdin.flush() except (OSError, subprocess.SubprocessError, BrokenPipeError): self._pager_died = True else: sys.stdout.flush() def close(self): """Close the pager.""" if self._closed: return self._closed = True if self.pager_process: try: if self.pager_process.stdin: self.pager_process.stdin.close() self.pager_process.wait() except (OSError, subprocess.SubprocessError): pass self.pager_process = None def __enter__(self): """Context manager entry.""" return self def __exit__(self, exc_type, exc_val, exc_tb): """Context manager exit.""" self.close() # Additional file-like methods for compatibility def writelines(self, lines): """Write a list of lines to the pager.""" if self._pager_died: return for line in lines: self.write(line) @property def closed(self): """Return whether the pager is closed.""" return self._closed def readable(self): """Return whether the pager is readable (it's not).""" return False def writable(self): """Return whether the pager is writable.""" return not self._closed def seekable(self): """Return whether the pager is seekable (it's not).""" return False class _StreamContextAdapter: """Adapter to make streams work with context manager protocol.""" def __init__(self, stream): self.stream = stream # Expose buffer if it exists if hasattr(stream, "buffer"): self.buffer = stream.buffer else: self.buffer = stream def __enter__(self): return self.stream def __exit__(self, exc_type, exc_val, exc_tb): # For stdout/stderr, we don't close them pass def __getattr__(self, name): return getattr(self.stream, name) def get_pager(config=None, cmd_name=None): """Get a pager instance if paging should be used, otherwise return sys.stdout. Args: config: Optional config instance (e.g., StackedConfig) to read settings from cmd_name: Optional command name for per-command pager settings Returns: Either a wrapped sys.stdout or a Pager instance (both context managers) """ # Check global pager disable flag if getattr(get_pager, "_disabled", False): return _StreamContextAdapter(sys.stdout) # Don't page if stdout is not a terminal if not sys.stdout.isatty(): return _StreamContextAdapter(sys.stdout) # Priority order for pager command (following git's behavior): # 1. Check pager. config (if cmd_name provided) # 2. Check environment variables: DULWICH_PAGER, GIT_PAGER, PAGER # 3. Check core.pager config # 4. Fallback to common pagers pager_cmd = None # 1. Check per-command pager config (pager.) if config and cmd_name: try: pager_value = config.get( ("pager",), cmd_name.encode() if isinstance(cmd_name, str) else cmd_name ) except KeyError: pass else: if pager_value == b"false": return _StreamContextAdapter(sys.stdout) elif pager_value != b"true": # It's a custom pager command pager_cmd = ( pager_value.decode() if isinstance(pager_value, bytes) else pager_value ) # 2. Check environment variables if not pager_cmd: for env_var in ["DULWICH_PAGER", "GIT_PAGER", "PAGER"]: pager = os.environ.get(env_var) if pager: if pager == "false": return _StreamContextAdapter(sys.stdout) pager_cmd = pager break # 3. Check core.pager config if not pager_cmd and config: try: core_pager = config.get(("core",), b"pager") except KeyError: pass else: if core_pager == b"false" or core_pager == b"": return _StreamContextAdapter(sys.stdout) pager_cmd = ( core_pager.decode() if isinstance(core_pager, bytes) else core_pager ) # 4. Fallback to common pagers if not pager_cmd: for pager in ["less", "more", "cat"]: if shutil.which(pager): if pager == "less": pager_cmd = "less -FRX" # -F: quit if one screen, -R: raw control chars, -X: no init/deinit else: pager_cmd = pager break else: pager_cmd = "cat" # Ultimate fallback return Pager(pager_cmd) def disable_pager(): """Disable pager for this session.""" get_pager._disabled = True def enable_pager(): """Enable pager for this session.""" get_pager._disabled = False class Command: """A Dulwich subcommand.""" def run(self, args) -> Optional[int]: """Run the command.""" raise NotImplementedError(self.run) class cmd_archive(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--remote", type=str, help="Retrieve archive from specified remote repo", ) parser.add_argument("committish", type=str, nargs="?") args = parser.parse_args(args) if args.remote: client, path = get_transport_and_path(args.remote) client.archive( path, args.committish, sys.stdout.write, write_error=sys.stderr.write, ) else: # Use buffer if available (for binary output), otherwise use stdout outstream = getattr(sys.stdout, "buffer", sys.stdout) porcelain.archive( ".", args.committish, outstream=outstream, errstream=sys.stderr ) class cmd_add(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.add_argument("path", nargs="+") args = parser.parse_args(argv) # Convert '.' to None to add all files paths = args.path if len(paths) == 1 and paths[0] == ".": paths = None porcelain.add(".", paths=paths) class cmd_annotate(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.add_argument("path", help="Path to file to annotate") parser.add_argument("committish", nargs="?", help="Commit to start from") args = parser.parse_args(argv) with Repo(".") as repo: config = repo.get_config_stack() with get_pager(config=config, cmd_name="annotate") as outstream: results = porcelain.annotate(repo, args.path, args.committish) for (commit, entry), line in results: # Show shortened commit hash and line content commit_hash = commit.id[:8] outstream.write(f"{commit_hash.decode()} {line.decode()}\n") class cmd_blame(Command): def run(self, argv) -> None: # blame is an alias for annotate cmd_annotate().run(argv) class cmd_rm(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--cached", action="store_true", help="Remove from index only" ) parser.add_argument("path", type=Path, nargs="+") args = parser.parse_args(argv) porcelain.remove(".", paths=args.path, cached=args.cached) class cmd_mv(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.add_argument( "-f", "--force", action="store_true", help="Force move even if destination exists", ) parser.add_argument("source", type=Path) parser.add_argument("destination", type=Path) args = parser.parse_args(argv) porcelain.mv(".", args.source, args.destination, force=args.force) class cmd_fetch_pack(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.add_argument("--all", action="store_true") parser.add_argument("location", nargs="?", type=str) parser.add_argument("refs", nargs="*", type=str) args = parser.parse_args(argv) client, path = get_transport_and_path(args.location) r = Repo(".") if args.all: determine_wants = r.object_store.determine_wants_all else: def determine_wants(refs, depth: Optional[int] = None): return [y.encode("utf-8") for y in args.refs if y not in r.object_store] client.fetch(path, r, determine_wants) class cmd_fetch(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("location", help="Remote location to fetch from") args = parser.parse_args(args) client, path = get_transport_and_path(args.location) r = Repo(".") def progress(msg: bytes) -> None: sys.stdout.buffer.write(msg) refs = client.fetch(path, r, progress=progress) print("Remote refs:") for item in refs.items(): print("{} -> {}".format(*item)) class cmd_for_each_ref(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("pattern", type=str, nargs="?") args = parser.parse_args(args) for sha, object_type, ref in porcelain.for_each_ref(".", args.pattern): print(f"{sha.decode()} {object_type.decode()}\t{ref.decode()}") class cmd_fsck(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.parse_args(args) for obj, msg in porcelain.fsck("."): print(f"{obj}: {msg}") class cmd_log(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--reverse", action="store_true", help="Reverse order in which entries are printed", ) parser.add_argument( "--name-status", action="store_true", help="Print name/status for each changed file", ) parser.add_argument("paths", nargs="*", help="Paths to show log for") args = parser.parse_args(args) with Repo(".") as repo: config = repo.get_config_stack() with get_pager(config=config, cmd_name="log") as outstream: porcelain.log( repo, paths=args.paths, reverse=args.reverse, name_status=args.name_status, outstream=outstream, ) class cmd_diff(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "committish", nargs="*", default=[], help="Commits or refs to compare" ) parser.add_argument("--staged", action="store_true", help="Show staged changes") parser.add_argument( "--cached", action="store_true", help="Show staged changes (same as --staged)", ) parser.add_argument( "--color", choices=["always", "never", "auto"], default="auto", help="Use colored output (requires pygments)", ) parser.add_argument( "--", dest="separator", action="store_true", help=argparse.SUPPRESS ) parser.add_argument("paths", nargs="*", default=[], help="Paths to limit diff") # Handle the -- separator for paths if "--" in args: sep_index = args.index("--") parsed_args = parser.parse_args(args[:sep_index]) parsed_args.paths = args[sep_index + 1 :] else: parsed_args = parser.parse_args(args) args = parsed_args # Determine if we should use color def _should_use_color(): if args.color == "always": return True elif args.color == "never": return False else: # auto return sys.stdout.isatty() def _create_output_stream(outstream): """Create output stream, optionally with colorization.""" if not _should_use_color(): return outstream.buffer from .diff import ColorizedDiffStream if not ColorizedDiffStream.is_available(): if args.color == "always": raise ImportError( "Rich is required for colored output. Install with: pip install 'dulwich[colordiff]'" ) else: logging.warning( "Rich not available, disabling colored output. Install with: pip install 'dulwich[colordiff]'" ) return outstream.buffer return ColorizedDiffStream(outstream.buffer) with Repo(".") as repo: config = repo.get_config_stack() with get_pager(config=config, cmd_name="diff") as outstream: output_stream = _create_output_stream(outstream) if len(args.committish) == 0: # Show diff for working tree or staged changes porcelain.diff( repo, staged=(args.staged or args.cached), paths=args.paths or None, outstream=output_stream, ) elif len(args.committish) == 1: # Show diff between working tree and specified commit if args.staged or args.cached: parser.error("--staged/--cached cannot be used with commits") porcelain.diff( repo, commit=args.committish[0], staged=False, paths=args.paths or None, outstream=output_stream, ) elif len(args.committish) == 2: # Show diff between two commits porcelain.diff( repo, commit=args.committish[0], commit2=args.committish[1], paths=args.paths or None, outstream=output_stream, ) else: parser.error("Too many arguments - specify at most two commits") # Flush any remaining output if hasattr(output_stream, "flush"): output_stream.flush() class cmd_dump_pack(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("filename", help="Pack file to dump") args = parser.parse_args(args) basename, _ = os.path.splitext(args.filename) x = Pack(basename) print(f"Object names checksum: {x.name()}") print(f"Checksum: {sha_to_hex(x.get_stored_checksum())!r}") x.check() print(f"Length: {len(x)}") for name in x: try: print(f"\t{x[name]}") except KeyError as k: print(f"\t{name}: Unable to resolve base {k}") except ApplyDeltaError as e: print(f"\t{name}: Unable to apply delta: {e!r}") class cmd_dump_index(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("filename", help="Index file to dump") args = parser.parse_args(args) idx = Index(args.filename) for o in idx: print(o, idx[o]) class cmd_init(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--bare", action="store_true", help="Create a bare repository" ) parser.add_argument( "path", nargs="?", default=os.getcwd(), help="Repository path" ) args = parser.parse_args(args) porcelain.init(args.path, bare=args.bare) class cmd_clone(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--bare", help="Whether to create a bare repository.", action="store_true", ) parser.add_argument("--depth", type=int, help="Depth at which to fetch") parser.add_argument( "-b", "--branch", type=str, help="Check out branch instead of branch pointed to by remote HEAD", ) parser.add_argument( "--refspec", type=str, help="References to fetch", action="append", ) parser.add_argument( "--filter", dest="filter_spec", type=str, help="git-rev-list-style object filter", ) parser.add_argument( "--protocol", type=int, help="Git protocol version to use", ) parser.add_argument( "--recurse-submodules", action="store_true", help="Initialize and clone submodules", ) parser.add_argument("source", help="Repository to clone from") parser.add_argument("target", nargs="?", help="Directory to clone into") args = parser.parse_args(args) try: porcelain.clone( args.source, args.target, bare=args.bare, depth=args.depth, branch=args.branch, refspec=args.refspec, filter_spec=args.filter_spec, protocol_version=args.protocol, recurse_submodules=args.recurse_submodules, ) except GitProtocolError as e: print(f"{e}") def _get_commit_message_with_template(initial_message, repo=None, commit=None): """Get commit message with an initial message template.""" # Start with the initial message template = initial_message if template and not template.endswith(b"\n"): template += b"\n" template += b"\n" template += b"# Please enter the commit message for your changes. Lines starting\n" template += b"# with '#' will be ignored, and an empty message aborts the commit.\n" template += b"#\n" # Add branch info if repo is provided if repo: try: ref_names, ref_sha = repo.refs.follow(b"HEAD") ref_path = ref_names[-1] # Get the final reference if ref_path.startswith(b"refs/heads/"): branch = ref_path[11:] # Remove 'refs/heads/' prefix else: branch = ref_path template += b"# On branch %s\n" % branch except (KeyError, IndexError): template += b"# On branch (unknown)\n" template += b"#\n" template += b"# Changes to be committed:\n" # Launch editor content = launch_editor(template) # Remove comment lines and strip lines = content.split(b"\n") message_lines = [line for line in lines if not line.strip().startswith(b"#")] message = b"\n".join(message_lines).strip() if not message: raise CommitMessageError("Aborting commit due to empty commit message") return message class cmd_commit(Command): def run(self, args) -> Optional[int]: parser = argparse.ArgumentParser() parser.add_argument("--message", "-m", help="Commit message") parser.add_argument( "-a", "--all", action="store_true", help="Automatically stage all tracked files that have been modified", ) parser.add_argument( "--amend", action="store_true", help="Replace the tip of the current branch by creating a new commit", ) args = parser.parse_args(args) message: Union[bytes, str, Callable] if args.message: message = args.message elif args.amend: # For amend, create a callable that opens editor with original message pre-populated def get_amend_message(repo, commit): # Get the original commit message from current HEAD try: head_commit = repo[repo.head()] original_message = head_commit.message except KeyError: original_message = b"" # Open editor with original message return _get_commit_message_with_template(original_message, repo, commit) message = get_amend_message else: # For regular commits, use empty template def get_regular_message(repo, commit): return _get_commit_message_with_template(b"", repo, commit) message = get_regular_message try: porcelain.commit(".", message=message, all=args.all, amend=args.amend) except CommitMessageError as e: print(f"error: {e}", file=sys.stderr) return 1 return None class cmd_commit_tree(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("--message", "-m", required=True, help="Commit message") parser.add_argument("tree", help="Tree SHA to commit") args = parser.parse_args(args) porcelain.commit_tree(".", tree=args.tree, message=args.message) class cmd_update_server_info(Command): def run(self, args) -> None: porcelain.update_server_info(".") class cmd_symbolic_ref(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("name", help="Symbolic reference name") parser.add_argument("ref", nargs="?", help="Target reference") parser.add_argument("--force", action="store_true", help="Force update") args = parser.parse_args(args) # If ref is provided, we're setting; otherwise we're reading if args.ref: # Set symbolic reference from .repo import Repo with Repo(".") as repo: repo.refs.set_symbolic_ref(args.name.encode(), args.ref.encode()) else: # Read symbolic reference from .repo import Repo with Repo(".") as repo: try: target = repo.refs.read_ref(args.name.encode()) if target.startswith(b"ref: "): print(target[5:].decode()) else: print(target.decode()) except KeyError: print(f"fatal: ref '{args.name}' is not a symbolic ref") class cmd_pack_refs(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.add_argument("--all", action="store_true") # ignored, we never prune parser.add_argument("--no-prune", action="store_true") args = parser.parse_args(argv) porcelain.pack_refs(".", all=args.all) class cmd_show(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.add_argument("objectish", type=str, nargs="*") args = parser.parse_args(argv) with Repo(".") as repo: config = repo.get_config_stack() with get_pager(config=config, cmd_name="show") as outstream: porcelain.show(repo, args.objectish or None, outstream=outstream) class cmd_diff_tree(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("old_tree", help="Old tree SHA") parser.add_argument("new_tree", help="New tree SHA") args = parser.parse_args(args) porcelain.diff_tree(".", args.old_tree, args.new_tree) class cmd_rev_list(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("commits", nargs="+", help="Commit IDs to list") args = parser.parse_args(args) porcelain.rev_list(".", args.commits) class cmd_tag(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "-a", "--annotated", help="Create an annotated tag.", action="store_true", ) parser.add_argument( "-s", "--sign", help="Sign the annotated tag.", action="store_true" ) parser.add_argument("tag_name", help="Name of the tag to create") args = parser.parse_args(args) porcelain.tag_create( ".", args.tag_name, annotated=args.annotated, sign=args.sign ) class cmd_repack(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.parse_args(args) porcelain.repack(".") class cmd_reflog(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "ref", nargs="?", default="HEAD", help="Reference to show reflog for" ) parser.add_argument( "--all", action="store_true", help="Show reflogs for all refs" ) args = parser.parse_args(args) with Repo(".") as repo: config = repo.get_config_stack() with get_pager(config=config, cmd_name="reflog") as outstream: if args.all: # Show reflogs for all refs for ref_bytes, entry in porcelain.reflog(repo, all=True): ref_str = ref_bytes.decode("utf-8", "replace") short_new = entry.new_sha[:8].decode("ascii") outstream.write( f"{short_new} {ref_str}: {entry.message.decode('utf-8', 'replace')}\n" ) else: ref = ( args.ref.encode("utf-8") if isinstance(args.ref, str) else args.ref ) for i, entry in enumerate(porcelain.reflog(repo, ref)): # Format similar to git reflog short_new = entry.new_sha[:8].decode("ascii") outstream.write( f"{short_new} {ref.decode('utf-8', 'replace')}@{{{i}}}: {entry.message.decode('utf-8', 'replace')}\n" ) class cmd_reset(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() mode_group = parser.add_mutually_exclusive_group() mode_group.add_argument( "--hard", action="store_true", help="Reset working tree and index" ) mode_group.add_argument("--soft", action="store_true", help="Reset only HEAD") mode_group.add_argument( "--mixed", action="store_true", help="Reset HEAD and index" ) parser.add_argument("treeish", nargs="?", help="Commit/tree to reset to") args = parser.parse_args(args) if args.hard: mode = "hard" elif args.soft: mode = "soft" elif args.mixed: mode = "mixed" else: # Default to mixed behavior mode = "mixed" # Use the porcelain.reset function for all modes porcelain.reset(".", mode=mode, treeish=args.treeish) class cmd_revert(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--no-commit", "-n", action="store_true", help="Apply changes but don't create a commit", ) parser.add_argument("-m", "--message", help="Custom commit message") parser.add_argument("commits", nargs="+", help="Commits to revert") args = parser.parse_args(args) result = porcelain.revert( ".", commits=args.commits, no_commit=args.no_commit, message=args.message ) if result and not args.no_commit: print(f"[{result.decode('ascii')[:7]}] Revert completed") class cmd_daemon(Command): def run(self, args) -> None: from dulwich import log_utils from .protocol import TCP_GIT_PORT parser = argparse.ArgumentParser() parser.add_argument( "-l", "--listen_address", default="localhost", help="Binding IP address.", ) parser.add_argument( "-p", "--port", type=int, default=TCP_GIT_PORT, help="Binding TCP port.", ) parser.add_argument( "gitdir", nargs="?", default=".", help="Git directory to serve" ) args = parser.parse_args(args) log_utils.default_logging_config() porcelain.daemon(args.gitdir, address=args.listen_address, port=args.port) class cmd_web_daemon(Command): def run(self, args) -> None: from dulwich import log_utils parser = argparse.ArgumentParser() parser.add_argument( "-l", "--listen_address", default="", help="Binding IP address.", ) parser.add_argument( "-p", "--port", type=int, default=8000, help="Binding TCP port.", ) parser.add_argument( "gitdir", nargs="?", default=".", help="Git directory to serve" ) args = parser.parse_args(args) log_utils.default_logging_config() porcelain.web_daemon(args.gitdir, address=args.listen_address, port=args.port) class cmd_write_tree(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.parse_args(args) sys.stdout.write("{}\n".format(porcelain.write_tree(".").decode())) class cmd_receive_pack(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("gitdir", nargs="?", default=".", help="Git directory") args = parser.parse_args(args) porcelain.receive_pack(args.gitdir) class cmd_upload_pack(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("gitdir", nargs="?", default=".", help="Git directory") args = parser.parse_args(args) porcelain.upload_pack(args.gitdir) class cmd_status(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("gitdir", nargs="?", default=".", help="Git directory") args = parser.parse_args(args) status = porcelain.status(args.gitdir) if any(names for (kind, names) in status.staged.items()): sys.stdout.write("Changes to be committed:\n\n") for kind, names in status.staged.items(): for name in names: sys.stdout.write( f"\t{kind}: {name.decode(sys.getfilesystemencoding())}\n" ) sys.stdout.write("\n") if status.unstaged: sys.stdout.write("Changes not staged for commit:\n\n") for name in status.unstaged: sys.stdout.write(f"\t{name.decode(sys.getfilesystemencoding())}\n") sys.stdout.write("\n") if status.untracked: sys.stdout.write("Untracked files:\n\n") for name in status.untracked: sys.stdout.write(f"\t{name}\n") sys.stdout.write("\n") class cmd_ls_remote(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--symref", action="store_true", help="Show symbolic references" ) parser.add_argument("url", help="Remote URL to list references from") args = parser.parse_args(args) result = porcelain.ls_remote(args.url) if args.symref: # Show symrefs first, like git does for ref, target in sorted(result.symrefs.items()): sys.stdout.write(f"ref: {target.decode()}\t{ref.decode()}\n") # Show regular refs for ref in sorted(result.refs): sys.stdout.write(f"{result.refs[ref].decode()}\t{ref.decode()}\n") class cmd_ls_tree(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "-r", "--recursive", action="store_true", help="Recursively list tree contents.", ) parser.add_argument( "--name-only", action="store_true", help="Only display name." ) parser.add_argument("treeish", nargs="?", help="Tree-ish to list") args = parser.parse_args(args) with Repo(".") as repo: config = repo.get_config_stack() with get_pager(config=config, cmd_name="ls-tree") as outstream: porcelain.ls_tree( repo, args.treeish, outstream=outstream, recursive=args.recursive, name_only=args.name_only, ) class cmd_pack_objects(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--stdout", action="store_true", help="Write pack to stdout" ) parser.add_argument("--deltify", action="store_true", help="Create deltas") parser.add_argument( "--no-reuse-deltas", action="store_true", help="Don't reuse existing deltas" ) parser.add_argument("basename", nargs="?", help="Base name for pack files") args = parser.parse_args(args) if not args.stdout and not args.basename: parser.error("basename required when not using --stdout") object_ids = [line.strip() for line in sys.stdin.readlines()] deltify = args.deltify reuse_deltas = not args.no_reuse_deltas if args.stdout: packf = getattr(sys.stdout, "buffer", sys.stdout) idxf = None close = [] else: packf = open(args.basename + ".pack", "wb") idxf = open(args.basename + ".idx", "wb") close = [packf, idxf] porcelain.pack_objects( ".", object_ids, packf, idxf, deltify=deltify, reuse_deltas=reuse_deltas ) for f in close: f.close() class cmd_unpack_objects(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("pack_file", help="Pack file to unpack") args = parser.parse_args(args) count = porcelain.unpack_objects(args.pack_file) print(f"Unpacked {count} objects") class cmd_prune(Command): def run(self, args) -> Optional[int]: import datetime import time from dulwich.object_store import DEFAULT_TEMPFILE_GRACE_PERIOD parser = argparse.ArgumentParser( description="Remove temporary pack files left behind by interrupted operations" ) parser.add_argument( "--expire", nargs="?", const="2.weeks.ago", help="Only prune files older than the specified date (default: 2.weeks.ago)", ) parser.add_argument( "--dry-run", "-n", action="store_true", help="Only report what would be removed", ) parser.add_argument( "--verbose", "-v", action="store_true", help="Report all actions", ) args = parser.parse_args(args) # Parse expire grace period grace_period = DEFAULT_TEMPFILE_GRACE_PERIOD if args.expire: try: grace_period = parse_relative_time(args.expire) except ValueError: # Try to parse as absolute date try: date = datetime.datetime.strptime(args.expire, "%Y-%m-%d") grace_period = int(time.time() - date.timestamp()) except ValueError: print(f"Error: Invalid expire date: {args.expire}", file=sys.stderr) return 1 # Progress callback def progress(msg): if args.verbose: print(msg) try: porcelain.prune( ".", grace_period=grace_period, dry_run=args.dry_run, progress=progress if args.verbose else None, ) return None except porcelain.Error as e: print(f"Error: {e}", file=sys.stderr) return 1 class cmd_pull(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("from_location", type=str) parser.add_argument("refspec", type=str, nargs="*") parser.add_argument("--filter", type=str, nargs=1) parser.add_argument("--protocol", type=int) args = parser.parse_args(args) porcelain.pull( ".", args.from_location or None, args.refspec or None, filter_spec=args.filter, protocol_version=args.protocol or None, ) class cmd_push(Command): def run(self, argv) -> Optional[int]: parser = argparse.ArgumentParser() parser.add_argument("-f", "--force", action="store_true", help="Force") parser.add_argument("to_location", type=str) parser.add_argument("refspec", type=str, nargs="*") args = parser.parse_args(argv) try: porcelain.push( ".", args.to_location, args.refspec or None, force=args.force ) except porcelain.DivergedBranches: sys.stderr.write("Diverged branches; specify --force to override") return 1 return None class cmd_remote_add(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("name", help="Name of the remote") parser.add_argument("url", help="URL of the remote") args = parser.parse_args(args) porcelain.remote_add(".", args.name, args.url) class SuperCommand(Command): subcommands: ClassVar[dict[str, type[Command]]] = {} default_command: ClassVar[Optional[type[Command]]] = None def run(self, args): if not args: if self.default_command: return self.default_command().run(args) else: print( "Supported subcommands: {}".format( ", ".join(self.subcommands.keys()) ) ) return False cmd = args[0] try: cmd_kls = self.subcommands[cmd] except KeyError: print(f"No such subcommand: {args[0]}") return False return cmd_kls().run(args[1:]) class cmd_remote(SuperCommand): subcommands: ClassVar[dict[str, type[Command]]] = { "add": cmd_remote_add, } class cmd_submodule_list(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.parse_args(argv) for path, sha in porcelain.submodule_list("."): sys.stdout.write(f" {sha} {path}\n") class cmd_submodule_init(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.parse_args(argv) porcelain.submodule_init(".") class cmd_submodule_add(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.add_argument("url", help="URL of repository to add as submodule") parser.add_argument("path", nargs="?", help="Path where submodule should live") parser.add_argument("--name", help="Name for the submodule") args = parser.parse_args(argv) porcelain.submodule_add(".", args.url, args.path, args.name) class cmd_submodule_update(Command): def run(self, argv) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--init", action="store_true", help="Initialize submodules first" ) parser.add_argument( "--force", action="store_true", help="Force update even if local changes exist", ) parser.add_argument( "paths", nargs="*", help="Specific submodule paths to update" ) args = parser.parse_args(argv) paths = args.paths if args.paths else None porcelain.submodule_update(".", paths=paths, init=args.init, force=args.force) class cmd_submodule(SuperCommand): subcommands: ClassVar[dict[str, type[Command]]] = { "add": cmd_submodule_add, "init": cmd_submodule_init, "list": cmd_submodule_list, "update": cmd_submodule_update, } default_command = cmd_submodule_list class cmd_check_ignore(Command): def run(self, args): parser = argparse.ArgumentParser() parser.add_argument("paths", nargs="+", help="Paths to check") args = parser.parse_args(args) ret = 1 for path in porcelain.check_ignore(".", args.paths): print(path) ret = 0 return ret class cmd_check_mailmap(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("identities", nargs="+", help="Identities to check") args = parser.parse_args(args) for identity in args.identities: canonical_identity = porcelain.check_mailmap(".", identity) print(canonical_identity) class cmd_branch(Command): def run(self, args) -> Optional[int]: parser = argparse.ArgumentParser() parser.add_argument( "branch", type=str, help="Name of the branch", ) parser.add_argument( "-d", "--delete", action="store_true", help="Delete branch", ) args = parser.parse_args(args) if not args.branch: print("Usage: dulwich branch [-d] BRANCH_NAME") return 1 if args.delete: porcelain.branch_delete(".", name=args.branch) else: try: porcelain.branch_create(".", name=args.branch) except porcelain.Error as e: sys.stderr.write(f"{e}") return 1 return 0 class cmd_checkout(Command): def run(self, args) -> Optional[int]: parser = argparse.ArgumentParser() parser.add_argument( "target", type=str, help="Name of the branch, tag, or commit to checkout", ) parser.add_argument( "-f", "--force", action="store_true", help="Force checkout", ) parser.add_argument( "-b", "--new-branch", type=str, help="Create a new branch at the target and switch to it", ) args = parser.parse_args(args) if not args.target: print("Usage: dulwich checkout TARGET [--force] [-b NEW_BRANCH]") return 1 try: porcelain.checkout( ".", target=args.target, force=args.force, new_branch=args.new_branch ) except porcelain.CheckoutError as e: sys.stderr.write(f"{e}\n") return 1 return 0 class cmd_stash_list(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.parse_args(args) for i, entry in porcelain.stash_list("."): print("stash@{{{}}}: {}".format(i, entry.message.rstrip("\n"))) class cmd_stash_push(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.parse_args(args) porcelain.stash_push(".") print("Saved working directory and index state") class cmd_stash_pop(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.parse_args(args) porcelain.stash_pop(".") print("Restored working directory and index state") class cmd_bisect(SuperCommand): """Git bisect command implementation.""" subcommands: ClassVar[dict[str, type[Command]]] = {} def run(self, args): parser = argparse.ArgumentParser(prog="dulwich bisect") subparsers = parser.add_subparsers(dest="subcommand", help="bisect subcommands") # bisect start start_parser = subparsers.add_parser("start", help="Start a new bisect session") start_parser.add_argument("bad", nargs="?", help="Bad commit") start_parser.add_argument("good", nargs="*", help="Good commit(s)") start_parser.add_argument( "--no-checkout", action="store_true", help="Don't checkout commits during bisect", ) start_parser.add_argument( "--term-bad", default="bad", help="Term to use for bad commits" ) start_parser.add_argument( "--term-good", default="good", help="Term to use for good commits" ) start_parser.add_argument( "--", dest="paths", nargs="*", help="Paths to limit bisect to" ) # bisect bad bad_parser = subparsers.add_parser("bad", help="Mark a commit as bad") bad_parser.add_argument("rev", nargs="?", help="Commit to mark as bad") # bisect good good_parser = subparsers.add_parser("good", help="Mark a commit as good") good_parser.add_argument("rev", nargs="?", help="Commit to mark as good") # bisect skip skip_parser = subparsers.add_parser("skip", help="Skip commits") skip_parser.add_argument("revs", nargs="*", help="Commits to skip") # bisect reset reset_parser = subparsers.add_parser("reset", help="Reset bisect state") reset_parser.add_argument("commit", nargs="?", help="Commit to reset to") # bisect log subparsers.add_parser("log", help="Show bisect log") # bisect replay replay_parser = subparsers.add_parser("replay", help="Replay bisect log") replay_parser.add_argument("logfile", help="Log file to replay") # bisect help subparsers.add_parser("help", help="Show help") parsed_args = parser.parse_args(args) if not parsed_args.subcommand: parser.print_help() return 1 try: if parsed_args.subcommand == "start": next_sha = porcelain.bisect_start( bad=parsed_args.bad, good=parsed_args.good if parsed_args.good else None, paths=parsed_args.paths, no_checkout=parsed_args.no_checkout, term_bad=parsed_args.term_bad, term_good=parsed_args.term_good, ) if next_sha: print(f"Bisecting: checking out '{next_sha.decode('ascii')}'") elif parsed_args.subcommand == "bad": next_sha = porcelain.bisect_bad(rev=parsed_args.rev) if next_sha: print(f"Bisecting: checking out '{next_sha.decode('ascii')}'") else: # Bisect complete - find the first bad commit with porcelain.open_repo_closing(".") as r: bad_ref = os.path.join(r.controldir(), "refs", "bisect", "bad") with open(bad_ref, "rb") as f: bad_sha = f.read().strip() commit = r.object_store[bad_sha] message = commit.message.decode( "utf-8", errors="replace" ).split("\n")[0] print(f"{bad_sha.decode('ascii')} is the first bad commit") print(f"commit {bad_sha.decode('ascii')}") print(f" {message}") elif parsed_args.subcommand == "good": next_sha = porcelain.bisect_good(rev=parsed_args.rev) if next_sha: print(f"Bisecting: checking out '{next_sha.decode('ascii')}'") elif parsed_args.subcommand == "skip": next_sha = porcelain.bisect_skip( revs=parsed_args.revs if parsed_args.revs else None ) if next_sha: print(f"Bisecting: checking out '{next_sha.decode('ascii')}'") elif parsed_args.subcommand == "reset": porcelain.bisect_reset(commit=parsed_args.commit) print("Bisect reset") elif parsed_args.subcommand == "log": log = porcelain.bisect_log() print(log, end="") elif parsed_args.subcommand == "replay": porcelain.bisect_replay(log_file=parsed_args.logfile) print(f"Replayed bisect log from {parsed_args.logfile}") elif parsed_args.subcommand == "help": parser.print_help() except porcelain.Error as e: print(f"Error: {e}", file=sys.stderr) return 1 except ValueError as e: print(f"Error: {e}", file=sys.stderr) return 1 return 0 class cmd_stash(SuperCommand): subcommands: ClassVar[dict[str, type[Command]]] = { "list": cmd_stash_list, "pop": cmd_stash_pop, "push": cmd_stash_push, } class cmd_ls_files(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.parse_args(args) for name in porcelain.ls_files("."): print(name) class cmd_describe(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.parse_args(args) print(porcelain.describe(".")) class cmd_merge(Command): def run(self, args) -> Optional[int]: parser = argparse.ArgumentParser() parser.add_argument("commit", type=str, help="Commit to merge") parser.add_argument( "--no-commit", action="store_true", help="Do not create a merge commit" ) parser.add_argument( "--no-ff", action="store_true", help="Force create a merge commit" ) parser.add_argument("-m", "--message", type=str, help="Merge commit message") args = parser.parse_args(args) try: merge_commit_id, conflicts = porcelain.merge( ".", args.commit, no_commit=args.no_commit, no_ff=args.no_ff, message=args.message, ) if conflicts: print(f"Merge conflicts in {len(conflicts)} file(s):") for conflict_path in conflicts: print(f" {conflict_path.decode()}") print( "\nAutomatic merge failed; fix conflicts and then commit the result." ) return 1 elif merge_commit_id is None and not args.no_commit: print("Already up to date.") elif args.no_commit: print("Automatic merge successful; not committing as requested.") else: print( f"Merge successful. Created merge commit {merge_commit_id.decode()}" ) return 0 except porcelain.Error as e: print(f"Error: {e}") return 1 class cmd_notes_add(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("object", help="Object to annotate") parser.add_argument("-m", "--message", help="Note message", required=True) parser.add_argument( "--ref", default="commits", help="Notes ref (default: commits)" ) args = parser.parse_args(args) porcelain.notes_add(".", args.object, args.message, ref=args.ref) class cmd_notes_show(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("object", help="Object to show notes for") parser.add_argument( "--ref", default="commits", help="Notes ref (default: commits)" ) args = parser.parse_args(args) note = porcelain.notes_show(".", args.object, ref=args.ref) if note: sys.stdout.buffer.write(note) else: print(f"No notes found for object {args.object}") class cmd_notes_remove(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument("object", help="Object to remove notes from") parser.add_argument( "--ref", default="commits", help="Notes ref (default: commits)" ) args = parser.parse_args(args) result = porcelain.notes_remove(".", args.object, ref=args.ref) if result: print(f"Removed notes for object {args.object}") else: print(f"No notes found for object {args.object}") class cmd_notes_list(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "--ref", default="commits", help="Notes ref (default: commits)" ) args = parser.parse_args(args) notes = porcelain.notes_list(".", ref=args.ref) for object_sha, note_content in notes: print(f"{object_sha.hex()}") class cmd_notes(SuperCommand): subcommands: ClassVar[dict[str, type[Command]]] = { "add": cmd_notes_add, "show": cmd_notes_show, "remove": cmd_notes_remove, "list": cmd_notes_list, } default_command = cmd_notes_list class cmd_cherry_pick(Command): def run(self, args) -> Optional[int]: parser = argparse.ArgumentParser( description="Apply the changes introduced by some existing commits" ) parser.add_argument("commit", nargs="?", help="Commit to cherry-pick") parser.add_argument( "-n", "--no-commit", action="store_true", help="Apply changes without making a commit", ) parser.add_argument( "--continue", dest="continue_", action="store_true", help="Continue after resolving conflicts", ) parser.add_argument( "--abort", action="store_true", help="Abort the current cherry-pick operation", ) args = parser.parse_args(args) # Check argument validity if args.continue_ or args.abort: if args.commit is not None: parser.error("Cannot specify commit with --continue or --abort") return 1 else: if args.commit is None: parser.error("Commit argument is required") return 1 try: commit_arg = args.commit result = porcelain.cherry_pick( ".", commit_arg, no_commit=args.no_commit, continue_=args.continue_, abort=args.abort, ) if args.abort: print("Cherry-pick aborted.") elif args.continue_: if result: print(f"Cherry-pick completed: {result.decode()}") else: print("Cherry-pick completed.") elif result is None: if args.no_commit: print("Cherry-pick applied successfully (no commit created).") else: # This shouldn't happen unless there were conflicts print("Cherry-pick resulted in conflicts.") else: print(f"Cherry-pick successful: {result.decode()}") return None except porcelain.Error as e: print(f"Error: {e}", file=sys.stderr) return 1 class cmd_merge_tree(Command): def run(self, args) -> Optional[int]: parser = argparse.ArgumentParser( description="Perform a tree-level merge without touching the working directory" ) parser.add_argument( "base_tree", nargs="?", help="The common ancestor tree (optional, defaults to empty tree)", ) parser.add_argument("our_tree", help="Our side of the merge") parser.add_argument("their_tree", help="Their side of the merge") parser.add_argument( "-z", "--name-only", action="store_true", help="Output only conflict paths, null-terminated", ) args = parser.parse_args(args) try: # Determine base tree - if only two args provided, base is None if args.base_tree is None: # Only two arguments provided base_tree = None our_tree = args.our_tree their_tree = args.their_tree else: # Three arguments provided base_tree = args.base_tree our_tree = args.our_tree their_tree = args.their_tree merged_tree_id, conflicts = porcelain.merge_tree( ".", base_tree, our_tree, their_tree ) if args.name_only: # Output only conflict paths, null-terminated for conflict_path in conflicts: sys.stdout.buffer.write(conflict_path) sys.stdout.buffer.write(b"\0") else: # Output the merged tree SHA print(merged_tree_id.decode("ascii")) # Output conflict information if conflicts: print(f"\nConflicts in {len(conflicts)} file(s):") for conflict_path in conflicts: print(f" {conflict_path.decode()}") return None except porcelain.Error as e: print(f"Error: {e}", file=sys.stderr) return 1 except KeyError as e: print(f"Error: Object not found: {e}", file=sys.stderr) return 1 class cmd_gc(Command): def run(self, args) -> Optional[int]: import datetime import time parser = argparse.ArgumentParser() parser.add_argument( "--auto", action="store_true", help="Only run gc if needed", ) parser.add_argument( "--aggressive", action="store_true", help="Use more aggressive settings", ) parser.add_argument( "--no-prune", action="store_true", help="Do not prune unreachable objects", ) parser.add_argument( "--prune", nargs="?", const="now", help="Prune unreachable objects older than date (default: 2 weeks ago)", ) parser.add_argument( "--dry-run", "-n", action="store_true", help="Only report what would be done", ) parser.add_argument( "--quiet", "-q", action="store_true", help="Only report errors", ) args = parser.parse_args(args) # Parse prune grace period grace_period = None if args.prune: try: grace_period = parse_relative_time(args.prune) except ValueError: # Try to parse as absolute date try: date = datetime.datetime.strptime(args.prune, "%Y-%m-%d") grace_period = int(time.time() - date.timestamp()) except ValueError: print(f"Error: Invalid prune date: {args.prune}") return 1 elif not args.no_prune: # Default to 2 weeks grace_period = 1209600 # Progress callback def progress(msg): if not args.quiet: print(msg) try: stats = porcelain.gc( ".", auto=args.auto, aggressive=args.aggressive, prune=not args.no_prune, grace_period=grace_period, dry_run=args.dry_run, progress=progress if not args.quiet else None, ) # Report results if not args.quiet: if args.dry_run: print("\nDry run results:") else: print("\nGarbage collection complete:") if stats.pruned_objects: print(f" Pruned {len(stats.pruned_objects)} unreachable objects") print(f" Freed {format_bytes(stats.bytes_freed)}") if stats.packs_before != stats.packs_after: print( f" Reduced pack files from {stats.packs_before} to {stats.packs_after}" ) except porcelain.Error as e: print(f"Error: {e}") return 1 return None class cmd_count_objects(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "-v", "--verbose", action="store_true", help="Display verbose information.", ) args = parser.parse_args(args) if args.verbose: stats = porcelain.count_objects(".", verbose=True) # Display verbose output print(f"count: {stats.count}") print(f"size: {stats.size // 1024}") # Size in KiB assert stats.in_pack is not None print(f"in-pack: {stats.in_pack}") assert stats.packs is not None print(f"packs: {stats.packs}") assert stats.size_pack is not None print(f"size-pack: {stats.size_pack // 1024}") # Size in KiB else: # Simple output stats = porcelain.count_objects(".", verbose=False) print(f"{stats.count} objects, {stats.size // 1024} kilobytes") class cmd_rebase(Command): def run(self, args) -> int: parser = argparse.ArgumentParser() parser.add_argument( "upstream", nargs="?", help="Upstream branch to rebase onto" ) parser.add_argument("--onto", type=str, help="Rebase onto specific commit") parser.add_argument( "--branch", type=str, help="Branch to rebase (default: current)" ) parser.add_argument( "--abort", action="store_true", help="Abort an in-progress rebase" ) parser.add_argument( "--continue", dest="continue_rebase", action="store_true", help="Continue an in-progress rebase", ) parser.add_argument( "--skip", action="store_true", help="Skip current commit and continue" ) args = parser.parse_args(args) # Handle abort/continue/skip first if args.abort: try: porcelain.rebase(".", args.upstream or "HEAD", abort=True) print("Rebase aborted.") except porcelain.Error as e: print(f"Error: {e}") return 1 return 0 if args.continue_rebase: try: new_shas = porcelain.rebase( ".", args.upstream or "HEAD", continue_rebase=True ) print("Rebase complete.") except porcelain.Error as e: print(f"Error: {e}") return 1 return 0 # Normal rebase requires upstream if not args.upstream: print("Error: Missing required argument 'upstream'") return 1 try: new_shas = porcelain.rebase( ".", args.upstream, onto=args.onto, branch=args.branch, ) if new_shas: print(f"Successfully rebased {len(new_shas)} commits.") else: print("Already up to date.") return 0 except porcelain.Error as e: print(f"Error: {e}") return 1 class cmd_filter_branch(Command): def run(self, args) -> Optional[int]: import subprocess parser = argparse.ArgumentParser(description="Rewrite branches") # Supported Git-compatible options parser.add_argument( "--subdirectory-filter", type=str, help="Only include history for subdirectory", ) parser.add_argument("--env-filter", type=str, help="Environment filter command") parser.add_argument("--tree-filter", type=str, help="Tree filter command") parser.add_argument("--index-filter", type=str, help="Index filter command") parser.add_argument("--parent-filter", type=str, help="Parent filter command") parser.add_argument("--msg-filter", type=str, help="Message filter command") parser.add_argument("--commit-filter", type=str, help="Commit filter command") parser.add_argument( "--tag-name-filter", type=str, help="Tag name filter command" ) parser.add_argument( "--prune-empty", action="store_true", help="Remove empty commits" ) parser.add_argument( "--original", type=str, default="refs/original", help="Namespace for original refs", ) parser.add_argument( "-f", "--force", action="store_true", help="Force operation even if refs/original/* exists", ) # Branch/ref to rewrite (defaults to HEAD) parser.add_argument( "branch", nargs="?", default="HEAD", help="Branch or ref to rewrite" ) args = parser.parse_args(args) # Track if any filter fails filter_error = False # Setup environment for filters env = os.environ.copy() # Helper function to run shell commands def run_filter(cmd, input_data=None, cwd=None, extra_env=None): nonlocal filter_error filter_env = env.copy() if extra_env: filter_env.update(extra_env) result = subprocess.run( cmd, shell=True, input=input_data, cwd=cwd, env=filter_env, capture_output=True, ) if result.returncode != 0: filter_error = True return None return result.stdout # Create filter functions based on arguments filter_message = None if args.msg_filter: def filter_message(message): result = run_filter(args.msg_filter, input_data=message) return result if result is not None else message tree_filter = None if args.tree_filter: def tree_filter(tree_sha, tmpdir): from dulwich.objects import Blob, Tree # Export tree to tmpdir with Repo(".") as r: tree = r.object_store[tree_sha] for entry in tree.items(): path = Path(tmpdir) / entry.path.decode() if entry.mode & 0o040000: # Directory path.mkdir(exist_ok=True) else: obj = r.object_store[entry.sha] path.write_bytes(obj.data) # Run the filter command in the temp directory run_filter(args.tree_filter, cwd=tmpdir) # Rebuild tree from modified temp directory def build_tree_from_dir(dir_path): tree = Tree() for name in sorted(os.listdir(dir_path)): if name.startswith("."): continue path = os.path.join(dir_path, name) if os.path.isdir(path): subtree_sha = build_tree_from_dir(path) tree.add(name.encode(), 0o040000, subtree_sha) else: with open(path, "rb") as f: data = f.read() blob = Blob.from_string(data) r.object_store.add_object(blob) # Use appropriate file mode mode = os.stat(path).st_mode if mode & 0o100: file_mode = 0o100755 else: file_mode = 0o100644 tree.add(name.encode(), file_mode, blob.id) r.object_store.add_object(tree) return tree.id return build_tree_from_dir(tmpdir) index_filter = None if args.index_filter: def index_filter(tree_sha, index_path): run_filter(args.index_filter, extra_env={"GIT_INDEX_FILE": index_path}) return None # Read back from index parent_filter = None if args.parent_filter: def parent_filter(parents): parent_str = " ".join(p.hex() for p in parents) result = run_filter(args.parent_filter, input_data=parent_str.encode()) if result is None: return parents output = result.decode().strip() if not output: return [] new_parents = [] for sha in output.split(): if valid_hexsha(sha): new_parents.append(sha) return new_parents commit_filter = None if args.commit_filter: def commit_filter(commit_obj, tree_sha): # The filter receives: tree parent1 parent2... cmd_input = tree_sha.hex() for parent in commit_obj.parents: cmd_input += " " + parent.hex() result = run_filter( args.commit_filter, input_data=cmd_input.encode(), extra_env={"GIT_COMMIT": commit_obj.id.hex()}, ) if result is None: return None output = result.decode().strip() if not output: return None # Skip commit if valid_hexsha(output): return output return None tag_name_filter = None if args.tag_name_filter: def tag_name_filter(tag_name): result = run_filter(args.tag_name_filter, input_data=tag_name) return result.strip() if result is not None else tag_name # Open repo once with Repo(".") as r: # Check for refs/original if not forcing if not args.force: original_prefix = args.original.encode() + b"/" for ref in r.refs.allkeys(): if ref.startswith(original_prefix): print("Cannot create a new backup.") print(f"A previous backup already exists in {args.original}/") print("Force overwriting the backup with -f") return 1 try: # Call porcelain.filter_branch with the repo object result = porcelain.filter_branch( r, args.branch, filter_message=filter_message, tree_filter=tree_filter if args.tree_filter else None, index_filter=index_filter if args.index_filter else None, parent_filter=parent_filter if args.parent_filter else None, commit_filter=commit_filter if args.commit_filter else None, subdirectory_filter=args.subdirectory_filter, prune_empty=args.prune_empty, tag_name_filter=tag_name_filter if args.tag_name_filter else None, force=args.force, keep_original=True, # Always keep original with git ) # Check if any filter failed if filter_error: print("Error: Filter command failed", file=sys.stderr) return 1 # Git filter-branch shows progress if result: print(f"Rewrite {args.branch} ({len(result)} commits)") # Git shows: Ref 'refs/heads/branch' was rewritten if args.branch != "HEAD": ref_name = ( args.branch if args.branch.startswith("refs/") else f"refs/heads/{args.branch}" ) print(f"Ref '{ref_name}' was rewritten") return 0 except porcelain.Error as e: print(f"Error: {e}", file=sys.stderr) return 1 class cmd_lfs(Command): """Git LFS management commands.""" def run(self, argv) -> None: parser = argparse.ArgumentParser(prog="dulwich lfs") subparsers = parser.add_subparsers(dest="subcommand", help="LFS subcommands") # lfs init subparsers.add_parser("init", help="Initialize Git LFS") # lfs track parser_track = subparsers.add_parser( "track", help="Track file patterns with LFS" ) parser_track.add_argument("patterns", nargs="*", help="File patterns to track") # lfs untrack parser_untrack = subparsers.add_parser( "untrack", help="Untrack file patterns from LFS" ) parser_untrack.add_argument( "patterns", nargs="+", help="File patterns to untrack" ) # lfs ls-files parser_ls = subparsers.add_parser("ls-files", help="List LFS files") parser_ls.add_argument("--ref", help="Git ref to check (defaults to HEAD)") # lfs migrate parser_migrate = subparsers.add_parser("migrate", help="Migrate files to LFS") parser_migrate.add_argument("--include", nargs="+", help="Patterns to include") parser_migrate.add_argument("--exclude", nargs="+", help="Patterns to exclude") parser_migrate.add_argument( "--everything", action="store_true", help="Migrate all files above 100MB" ) # lfs pointer parser_pointer = subparsers.add_parser("pointer", help="Check LFS pointers") parser_pointer.add_argument( "--check", nargs="*", dest="paths", help="Check if files are LFS pointers" ) # lfs clean parser_clean = subparsers.add_parser("clean", help="Clean file to LFS pointer") parser_clean.add_argument("path", help="File path to clean") # lfs smudge parser_smudge = subparsers.add_parser( "smudge", help="Smudge LFS pointer to content" ) parser_smudge.add_argument( "--stdin", action="store_true", help="Read pointer from stdin" ) # lfs fetch parser_fetch = subparsers.add_parser( "fetch", help="Fetch LFS objects from remote" ) parser_fetch.add_argument( "--remote", default="origin", help="Remote to fetch from" ) parser_fetch.add_argument("refs", nargs="*", help="Specific refs to fetch") # lfs pull parser_pull = subparsers.add_parser( "pull", help="Pull LFS objects for current checkout" ) parser_pull.add_argument( "--remote", default="origin", help="Remote to pull from" ) # lfs push parser_push = subparsers.add_parser("push", help="Push LFS objects to remote") parser_push.add_argument("--remote", default="origin", help="Remote to push to") parser_push.add_argument("refs", nargs="*", help="Specific refs to push") # lfs status subparsers.add_parser("status", help="Show status of LFS files") args = parser.parse_args(argv) if args.subcommand == "init": porcelain.lfs_init() print("Git LFS initialized.") elif args.subcommand == "track": if args.patterns: tracked = porcelain.lfs_track(patterns=args.patterns) print("Tracking patterns:") else: tracked = porcelain.lfs_track() print("Currently tracked patterns:") for pattern in tracked: print(f" {pattern}") elif args.subcommand == "untrack": tracked = porcelain.lfs_untrack(patterns=args.patterns) print("Remaining tracked patterns:") for pattern in tracked: print(f" {pattern}") elif args.subcommand == "ls-files": files = porcelain.lfs_ls_files(ref=args.ref) for path, oid, size in files: print(f"{oid[:12]} * {path} ({format_bytes(size)})") elif args.subcommand == "migrate": count = porcelain.lfs_migrate( include=args.include, exclude=args.exclude, everything=args.everything ) print(f"Migrated {count} file(s) to Git LFS.") elif args.subcommand == "pointer": if args.paths is not None: results = porcelain.lfs_pointer_check(paths=args.paths or None) for path, pointer in results.items(): if pointer: print( f"{path}: LFS pointer (oid: {pointer.oid[:12]}, size: {format_bytes(pointer.size)})" ) else: print(f"{path}: Not an LFS pointer") elif args.subcommand == "clean": pointer = porcelain.lfs_clean(path=args.path) sys.stdout.buffer.write(pointer) elif args.subcommand == "smudge": if args.stdin: pointer_content = sys.stdin.buffer.read() content = porcelain.lfs_smudge(pointer_content=pointer_content) sys.stdout.buffer.write(content) else: print("Error: --stdin required for smudge command") sys.exit(1) elif args.subcommand == "fetch": refs = args.refs or None count = porcelain.lfs_fetch(remote=args.remote, refs=refs) print(f"Fetched {count} LFS object(s).") elif args.subcommand == "pull": count = porcelain.lfs_pull(remote=args.remote) print(f"Pulled {count} LFS object(s).") elif args.subcommand == "push": refs = args.refs or None count = porcelain.lfs_push(remote=args.remote, refs=refs) print(f"Pushed {count} LFS object(s).") elif args.subcommand == "status": status = porcelain.lfs_status() if status["tracked"]: print(f"LFS tracked files: {len(status['tracked'])}") if status["missing"]: print("\nMissing LFS objects:") for path in status["missing"]: print(f" {path}") if status["not_staged"]: print("\nModified LFS files not staged:") for path in status["not_staged"]: print(f" {path}") if not any(status.values()): print("No LFS files found.") else: parser.print_help() sys.exit(1) class cmd_help(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "-a", "--all", action="store_true", help="List all commands.", ) args = parser.parse_args(args) if args.all: print("Available commands:") for cmd in sorted(commands): print(f" {cmd}") else: print( """\ The dulwich command line tool is currently a very basic frontend for the Dulwich python module. For full functionality, please see the API reference. For a list of supported commands, see 'dulwich help -a'. """ ) class cmd_format_patch(Command): def run(self, args) -> None: parser = argparse.ArgumentParser() parser.add_argument( "committish", nargs="?", help="Commit or commit range (e.g., HEAD~3..HEAD or origin/master..HEAD)", ) parser.add_argument( "-n", "--numbered", type=int, default=1, help="Number of commits to format (default: 1)", ) parser.add_argument( "-o", "--output-directory", dest="outdir", help="Output directory for patches", ) parser.add_argument( "--stdout", action="store_true", help="Output patches to stdout", ) args = parser.parse_args(args) # Parse committish using the new function committish = None if args.committish: with Repo(".") as r: range_result = parse_commit_range(r, args.committish) if range_result: committish = range_result else: committish = args.committish filenames = porcelain.format_patch( ".", committish=committish, outstream=sys.stdout, outdir=args.outdir, n=args.numbered, stdout=args.stdout, ) if not args.stdout: for filename in filenames: print(filename) class cmd_bundle(Command): def run(self, args) -> int: if not args: print("Usage: bundle ") return 1 subcommand = args[0] subargs = args[1:] if subcommand == "create": return self._create(subargs) elif subcommand == "verify": return self._verify(subargs) elif subcommand == "list-heads": return self._list_heads(subargs) elif subcommand == "unbundle": return self._unbundle(subargs) else: print(f"Unknown bundle subcommand: {subcommand}") return 1 def _create(self, args) -> int: parser = argparse.ArgumentParser(prog="bundle create") parser.add_argument( "-q", "--quiet", action="store_true", help="Suppress progress" ) parser.add_argument("--progress", action="store_true", help="Show progress") parser.add_argument( "--version", type=int, choices=[2, 3], help="Bundle version" ) parser.add_argument("--all", action="store_true", help="Include all refs") parser.add_argument("--stdin", action="store_true", help="Read refs from stdin") parser.add_argument("file", help="Output bundle file (use - for stdout)") parser.add_argument("refs", nargs="*", help="References or rev-list args") parsed_args = parser.parse_args(args) repo = Repo(".") progress = None if parsed_args.progress and not parsed_args.quiet: def progress(msg: str) -> None: print(msg, file=sys.stderr) refs_to_include = [] prerequisites = [] if parsed_args.all: refs_to_include = list(repo.refs.keys()) elif parsed_args.stdin: for line in sys.stdin: ref = line.strip().encode("utf-8") if ref: refs_to_include.append(ref) elif parsed_args.refs: for ref_arg in parsed_args.refs: if ".." in ref_arg: range_result = parse_commit_range(repo, ref_arg) if range_result: start_commit, end_commit = range_result prerequisites.append(start_commit.id) # For ranges like A..B, we need to include B if it's a ref # Split the range to get the end part end_part = ref_arg.split("..")[1] if end_part: # Not empty (not "A..") end_ref = end_part.encode("utf-8") if end_ref in repo.refs: refs_to_include.append(end_ref) else: sha = repo.refs[ref_arg.encode("utf-8")] refs_to_include.append(ref_arg.encode("utf-8")) else: if ref_arg.startswith("^"): sha = repo.refs[ref_arg[1:].encode("utf-8")] prerequisites.append(sha) else: sha = repo.refs[ref_arg.encode("utf-8")] refs_to_include.append(ref_arg.encode("utf-8")) else: print("No refs specified. Use --all, --stdin, or specify refs") return 1 if not refs_to_include: print("fatal: Refusing to create empty bundle.") return 1 bundle = create_bundle_from_repo( repo, refs=refs_to_include, prerequisites=prerequisites, version=parsed_args.version, progress=progress, ) if parsed_args.file == "-": write_bundle(sys.stdout.buffer, bundle) else: with open(parsed_args.file, "wb") as f: write_bundle(f, bundle) return 0 def _verify(self, args) -> int: parser = argparse.ArgumentParser(prog="bundle verify") parser.add_argument( "-q", "--quiet", action="store_true", help="Suppress output" ) parser.add_argument("file", help="Bundle file to verify (use - for stdin)") parsed_args = parser.parse_args(args) repo = Repo(".") def verify_bundle(bundle): missing_prereqs = [] for prereq_sha, comment in bundle.prerequisites: try: repo.object_store[prereq_sha] except KeyError: missing_prereqs.append(prereq_sha) if missing_prereqs: if not parsed_args.quiet: print("The bundle requires these prerequisite commits:") for sha in missing_prereqs: print(f" {sha.decode()}") return 1 else: if not parsed_args.quiet: print( "The bundle is valid and can be applied to the current repository" ) return 0 if parsed_args.file == "-": bundle = read_bundle(sys.stdin.buffer) return verify_bundle(bundle) else: with open(parsed_args.file, "rb") as f: bundle = read_bundle(f) return verify_bundle(bundle) def _list_heads(self, args) -> int: parser = argparse.ArgumentParser(prog="bundle list-heads") parser.add_argument("file", help="Bundle file (use - for stdin)") parser.add_argument("refnames", nargs="*", help="Only show these refs") parsed_args = parser.parse_args(args) def list_heads(bundle): for ref, sha in bundle.references.items(): if not parsed_args.refnames or ref.decode() in parsed_args.refnames: print(f"{sha.decode()} {ref.decode()}") if parsed_args.file == "-": bundle = read_bundle(sys.stdin.buffer) list_heads(bundle) else: with open(parsed_args.file, "rb") as f: bundle = read_bundle(f) list_heads(bundle) return 0 def _unbundle(self, args) -> int: parser = argparse.ArgumentParser(prog="bundle unbundle") parser.add_argument("--progress", action="store_true", help="Show progress") parser.add_argument("file", help="Bundle file (use - for stdin)") parser.add_argument("refnames", nargs="*", help="Only unbundle these refs") parsed_args = parser.parse_args(args) repo = Repo(".") progress = None if parsed_args.progress: def progress(msg: str) -> None: print(msg, file=sys.stderr) if parsed_args.file == "-": bundle = read_bundle(sys.stdin.buffer) # Process the bundle while file is still available via stdin bundle.store_objects(repo.object_store, progress=progress) else: # Keep the file open during bundle processing with open(parsed_args.file, "rb") as f: bundle = read_bundle(f) # Process pack data while file is still open bundle.store_objects(repo.object_store, progress=progress) for ref, sha in bundle.references.items(): if not parsed_args.refnames or ref.decode() in parsed_args.refnames: print(ref.decode()) return 0 commands = { "add": cmd_add, "annotate": cmd_annotate, "archive": cmd_archive, "bisect": cmd_bisect, "blame": cmd_blame, "branch": cmd_branch, "bundle": cmd_bundle, "check-ignore": cmd_check_ignore, "check-mailmap": cmd_check_mailmap, "checkout": cmd_checkout, "cherry-pick": cmd_cherry_pick, "clone": cmd_clone, "commit": cmd_commit, "commit-tree": cmd_commit_tree, "count-objects": cmd_count_objects, "describe": cmd_describe, "daemon": cmd_daemon, "diff": cmd_diff, "diff-tree": cmd_diff_tree, "dump-pack": cmd_dump_pack, "dump-index": cmd_dump_index, "fetch-pack": cmd_fetch_pack, "fetch": cmd_fetch, "filter-branch": cmd_filter_branch, "for-each-ref": cmd_for_each_ref, "format-patch": cmd_format_patch, "fsck": cmd_fsck, "gc": cmd_gc, "help": cmd_help, "init": cmd_init, "lfs": cmd_lfs, "log": cmd_log, "ls-files": cmd_ls_files, "ls-remote": cmd_ls_remote, "ls-tree": cmd_ls_tree, "merge": cmd_merge, "merge-tree": cmd_merge_tree, "notes": cmd_notes, "pack-objects": cmd_pack_objects, "pack-refs": cmd_pack_refs, "prune": cmd_prune, "pull": cmd_pull, "push": cmd_push, "rebase": cmd_rebase, "receive-pack": cmd_receive_pack, "reflog": cmd_reflog, "remote": cmd_remote, "repack": cmd_repack, "reset": cmd_reset, "revert": cmd_revert, "rev-list": cmd_rev_list, "rm": cmd_rm, "mv": cmd_mv, "show": cmd_show, "stash": cmd_stash, "status": cmd_status, "symbolic-ref": cmd_symbolic_ref, "submodule": cmd_submodule, "tag": cmd_tag, "unpack-objects": cmd_unpack_objects, "update-server-info": cmd_update_server_info, "upload-pack": cmd_upload_pack, "web-daemon": cmd_web_daemon, "write-tree": cmd_write_tree, } def main(argv=None) -> Optional[int]: if argv is None: argv = sys.argv[1:] # Parse only the global options and command, stop at first positional parser = argparse.ArgumentParser( prog="dulwich", description="Simple command-line interface to Dulwich", add_help=False, # We'll handle help ourselves ) parser.add_argument("--no-pager", action="store_true", help="Disable pager") parser.add_argument("--pager", action="store_true", help="Force enable pager") parser.add_argument("--help", "-h", action="store_true", help="Show help") # Parse known args to separate global options from command args global_args, remaining = parser.parse_known_args(argv) # Apply global pager settings if global_args.no_pager: disable_pager() elif global_args.pager: enable_pager() # Handle help if global_args.help or not remaining: parser = argparse.ArgumentParser( prog="dulwich", description="Simple command-line interface to Dulwich" ) parser.add_argument("--no-pager", action="store_true", help="Disable pager") parser.add_argument("--pager", action="store_true", help="Force enable pager") parser.add_argument( "command", nargs="?", help=f"Command to run. Available: {', '.join(sorted(commands.keys()))}", ) parser.print_help() return 1 # First remaining arg is the command cmd = remaining[0] cmd_args = remaining[1:] try: cmd_kls = commands[cmd] except KeyError: print(f"No such subcommand: {cmd}") return 1 # TODO(jelmer): Return non-0 on errors return cmd_kls().run(cmd_args) def _main() -> None: if "DULWICH_PDB" in os.environ and getattr(signal, "SIGQUIT", None): signal.signal(signal.SIGQUIT, signal_quit) # type: ignore signal.signal(signal.SIGINT, signal_int) sys.exit(main()) if __name__ == "__main__": _main()