dulwich.subtree

module documentation

Git subtree implementation.

Class	`SubtreeMetadata`	Metadata stored in commit trailers for subtree operations.
Function	`add_subtree_metadata`	Add subtree metadata trailers to a commit message.
Function	`create_tree_with_subtree`	Create a new tree with a subtree inserted at the given prefix.
Function	`extract_subtree`	Extract a subtree from a tree at the given prefix path.
Function	`find_subtree_splits`	Find previous subtree split commits in history.
Function	`parse_subtree_metadata`	Parse subtree metadata from commit message trailers.
Function	`_validate_prefix`	Validate that a prefix is a valid path.

def add_subtree_metadata(message: bytes, prefix: bytes, split: ObjectID | None = None, mainline: ObjectID | None = None) -> bytes: ¶

Add subtree metadata trailers to a commit message.

Parameters
message:`bytes`	Original commit message
prefix:`bytes`	Subtree directory path
split:`ObjectID \| None`	Optional split commit SHA
mainline:`ObjectID \| None`	Optional mainline commit SHA

Returns
`bytes`	Commit message with subtree metadata trailers appended

def create_tree_with_subtree(store: BaseObjectStore, base_tree: Tree | None, prefix: bytes, subtree: Tree) -> ObjectID: ¶

Create a new tree with a subtree inserted at the given prefix.

Parameters
store:`BaseObjectStore`	Object store to write to
base_tree:`Tree \| None`	Base tree to insert into (None for empty tree)
prefix:`bytes`	Path where subtree should be inserted (e.g., b"vendor/lib")
subtree:`Tree`	Tree to insert

Returns
`ObjectID`	Object ID of the new tree

Raises
`ValueError`	If prefix is invalid

def extract_subtree(store: BaseObjectStore, tree: Tree, prefix: bytes) -> Tree | None: ¶

Extract a subtree from a tree at the given prefix path.

Parameters
store:`BaseObjectStore`	Object store to read from
tree:`Tree`	Tree object to extract from
prefix:`bytes`	Path to subtree (e.g., b"vendor/lib")

Returns
`Tree \| None`	Tree object for the subtree, or None if path doesn't exist

Raises
`ValueError`	If prefix is invalid

def find_subtree_splits(store: BaseObjectStore, commit: Commit, prefix: bytes, limit: int | None = None) -> list[tuple[ObjectID, ObjectID]]: ¶

Find previous subtree split commits in history.

Parameters
store:`BaseObjectStore`	Object store to read from
commit:`Commit`	Starting commit
prefix:`bytes`	Subtree prefix to search for
limit:`int \| None`	Maximum number of splits to find (None for all)

Returns
`list[tuple[ObjectID, ObjectID]]`	List of (commit_id, split_id) tuples for commits with subtree metadata

def parse_subtree_metadata(commit: Commit) -> SubtreeMetadata: ¶

Parse subtree metadata from commit message trailers.

Parameters
commit:`Commit`	Commit to parse metadata from

Returns
`SubtreeMetadata`	Dictionary with subtree metadata (dir, split, mainline)

def _validate_prefix(prefix: bytes): ¶

Validate that a prefix is a valid path.

Parameters
prefix:`bytes`	Path prefix to validate

Raises
`ValueError`	If prefix is invalid