There isn't a wrapper for worktrees yet, but I found using Repo.git.worktree("add", folder, branch) will load the worktree for you.

From there you can navigate into the worktree and use it like you world any other worktree.

To unload the worktree, simply remove the folder and then call Repo.git.worktree("prune").

This works with the latest version.

Full example:

import os
import git
import shutil

os.mkdir(<desired-folder>)

repo = git.Repo()
print (repo) # You'll see the original branch path that you're on here

repo.git.worktree("add", <folder>, <branch>)

test_repo = git.Repo(<folder>)
print (test_repo) # Now you'll see that with this new git.Repo object that it's referencing your worktree
print (repo) # Just to confirm that this is pointing to the original location

# Run a simple command to make sure everythings working - might be better to use the wrapper library to confirm though
print (repo.git.status())
print (test_repo.git.status())

# Remove the worktree like this:
shutil.rmtree(<folder>)
repo.git.worktree("prune")

Uh oh!

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions