Skip to content

Fix Repo() autodiscovery in linked worktrees when GIT_DIR is set #2128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
meliezer wants to merge 1 commit into
base: main
Choose a base branch
from
+45 −0
Open

Fix Repo() autodiscovery in linked worktrees when GIT_DIR is set #2128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions git/repo/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,20 @@ def __init__(
# It's important to normalize the paths, as submodules will otherwise
# initialize their repo instances with paths that depend on path-portions
# that will not exist after being removed. It's just cleaner.
if (
Copy link
Copy Markdown
Member

@Byron Byron Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems the comment above this hunk was actually meant for the block below it. So that should be changed. I also think the code block can use some documentation on what it's trying to do.

osp.isfile(osp.join(curpath, "gitdir"))
and osp.isfile(osp.join(curpath, "commondir"))
and osp.isfile(osp.join(curpath, "HEAD"))
):
git_dir = curpath
worktree_gitfile = Path(osp.join(git_dir, "gitdir")).read_text().splitlines()[0].strip()
Copy link
Copy Markdown
Member

@Byron Byron Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read text is probably going to fail given that the path can contain any set of characters without necessarily being in the default encoding.
Is there some utility in the code pase already that can read files that contain a gitdir?

if not osp.isabs(worktree_gitfile):
worktree_gitfile = osp.normpath(osp.join(git_dir, worktree_gitfile))
self._working_tree_dir = osp.dirname(worktree_gitfile)
if "GIT_WORK_TREE" in os.environ:
self._working_tree_dir = os.getenv("GIT_WORK_TREE")
Comment on lines +255 to +256
Copy link
Copy Markdown
Member

@Byron Byron Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The _working_tree_dir probably starts out as None, and should be set by whatever has the final say, probably the environment variable.
Then if it's not yet set, all this extra work can be done to figure out the worktree dir.

break

if is_git_dir(curpath):
git_dir = curpath
# from man git-config : core.worktree
Expand Down
31 changes: 31 additions & 0 deletions test/test_repo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1126,6 +1126,37 @@ def test_git_work_tree_env(self, rw_dir):
self.assertEqual(r.working_tree_dir, repo_dir)
self.assertEqual(r.working_dir, repo_dir)

@with_rw_directory
def test_git_work_tree_env_in_linked_worktree(self, rw_dir):
"""Check that Repo() autodiscovers a linked worktree when GIT_DIR is set."""
git = Git(rw_dir)
if git.version_info[:3] < (2, 5, 1):
raise RuntimeError("worktree feature unsupported (test needs git 2.5.1 or later)")

rw_master = self.rorepo.clone(join_path_native(rw_dir, "master_repo"))
branch = rw_master.create_head("bbbbbbbb")
worktree_path = join_path_native(rw_dir, "worktree_repo")
if Git.is_cygwin():
worktree_path = cygpath(worktree_path)

rw_master.git.worktree("add", worktree_path, branch.name)

git_dir = Git(worktree_path).rev_parse("--git-dir")

with mock.patch.dict(os.environ, {"GIT_DIR": git_dir}, clear=False):
old_cwd = os.getcwd()
try:
os.chdir(worktree_path)

explicit = Repo(os.getcwd())
autodiscovered = Repo()

self.assertTrue(osp.samefile(explicit.working_tree_dir, worktree_path))
self.assertTrue(osp.samefile(autodiscovered.working_tree_dir, worktree_path))
self.assertTrue(osp.samefile(autodiscovered.working_tree_dir, explicit.working_tree_dir))
finally:
os.chdir(old_cwd)

@with_rw_directory
def test_rebasing(self, rw_dir):
r = Repo.init(rw_dir)
Expand Down
Loading