31095981247

Committed 06 Aug 2026 11:07AM UTC coverage: 87.327% (-4.0%) from 91.315%

Build # 31095981247

Build Type

push

github

Committed by

web-flow

Commit Message

feat: support rebasing branches checked out in worktrees (#145)

* feat: support rebasing branches checked out in worktrees

When a branch is checked out in a separate git worktree, `git checkout`
fails with 'already used by worktree'. Instead of checking out such
branches in the main repo, detect them via `git worktree list --porcelain`
and perform the rebase (or fast-forward merge) directly in the worktree
directory.

This handles:
- Fast-forward: runs `git merge --ff-only` in the worktree
- Rebase: stashes worktree changes if dirty, rebases, then unstashes

Fixes the error:
  fatal: '<branch>' is already used by worktree at '<path>'

Co-Authored-By: Oz <oz-agent@warp.dev>

* fix: skip worktree branches that are mid-rebase

When a linked worktree is in the middle of a rebase, git reports it as
'detached' in `git worktree list --porcelain` rather than pointing to
the branch ref. This caused `git checkout <branch>` to fail with exit
code 128 since git still considers the branch locked to that worktree.

Now detached worktrees are inspected for rebase state via
rebase-merge/head-name and rebase-apply/head-name, and any branch found
there is reported as 'rebase in progress' and skipped.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* refactor: address reviewer feedback on worktree support

- Rename mid_rebase_branches -> in_progress_branches; skip worktrees
  mid-cherry-pick, -merge, and -bisect in addition to mid-rebase
- Extract _get_worktree_meta_dir() helper to eliminate duplicated .git
  pointer-file parsing
- Add _worktree_has_in_progress_op() to detect cherry-pick/merge/bisect
- Add suppress_pop to stasher() so the stash is not popped when a
  rebase fails with conflicts
- Simplify _rebase_in_worktree() to use GitWrapper.stasher() and
  GitWrapper.rebase() instead of duplicating that logic

---------

Co-authored-by: Oz <oz-agent@warp.dev>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Markus Siemens <mark... (continued)

Coverage Stats

55 of 82 new or added lines in 2 files covered. (67.07%)

441 of 505 relevant lines covered (87.33%)

13.1 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

83.63

/PyGitUp/gitup.py

from git import Git
from git import GitCommandNotFound

__all__ = ['GitUp']

###############################################################################
# IMPORTS and LIBRARIES SETUP
###############################################################################

# Python libs
import argparse
import codecs
import errno
import sys
import os
import re
import json
import subprocess
from io import StringIO
from tempfile import NamedTemporaryFile
from urllib.error import HTTPError, URLError
from urllib.request import urlopen

# 3rd party libs
try:
    from importlib import metadata
except ImportError:  # pragma: no cover
    metadata = None
    NO_DISTRIBUTE = True
else:  # pragma: no cover
    NO_DISTRIBUTE = False

from packaging.version import InvalidVersion, Version

import colorama
from git import Repo, GitCmdObjectDB
from termcolor import colored

# PyGitUp libs
from PyGitUp.utils import execute, uniq, find
from PyGitUp.git_wrapper import GitWrapper, GitError, RebaseError

ON_WINDOWS = sys.platform == 'win32'

def normalize_path(path):
    if ON_WINDOWS and path and path[0] == '/':
        return execute(['cygpath', '-m', path])

    return path


def prepare_windows_log_hook(log_hook):
    """ Turn a log hook into the body of a batch file.

    Positional arguments become delayed-expansion reads of the GITUP_ARG*
    environment variables. cmd substitutes %1 and %VAR% into a line before
    parsing it, so a branch name containing '&' or '|' would be parsed as
    syntax rather than data; !VAR! is expanded after the line is parsed.
    """
    # Accept $1 and $2 as well, in case the user is used to Bash or sh
    log_hook = re.sub(r'\$(\d+)', r'%\1', log_hook)

    # Escape a lone percent sign, as in 'git log --pretty=format:"%Cred%h"'
    log_hook = re.sub(r'%(?!\d)', '%%', log_hook)

    # Keep literal exclamation marks literal now that delayed expansion is on
    log_hook = log_hook.replace('!', '^!')

    log_hook = re.sub(r'%(\d+)', r'!GITUP_ARG\1!', log_hook)

    # Starting a line with 'echo' would echo a semicolon instead of treating
    # it as a command separator
    log_hook = re.sub(r'; ?', r'\n', log_hook)

    return log_hook

###############################################################################
# Setup of 3rd party libs
###############################################################################

colorama.init(autoreset=True, convert=ON_WINDOWS)

###############################################################################
# Setup constants
###############################################################################

PYPI_URL = 'https://pypi.python.org/pypi/git-up/json'


###############################################################################
# GitUp
###############################################################################

def get_git_dir():
    toplevel_dir = execute(['git', 'rev-parse', '--show-toplevel'])
    toplevel_dir = normalize_path(toplevel_dir)

    if toplevel_dir is not None \
            and os.path.isfile(os.path.join(toplevel_dir, '.git')):
        # Not a normal git repo. Check if it's a submodule, then use
        # toplevel_dir. Otherwise it's a worktree, thus use  common_dir.
        # NOTE: git worktree support only comes with git v2.5.0 or
        # later, on earlier versions toplevel_dir is the best we can do.

        cmd = ['git', 'rev-parse', '--is-inside-work-tree']
        inside_worktree = execute(cmd, cwd=os.path.join(toplevel_dir, '..'))

        if inside_worktree == 'true' or Git().version_info[:3] < (2, 5, 0):
            return toplevel_dir
        else:
            common_dir = execute(['git', 'rev-parse', '--git-common-dir'])
            return normalize_path(common_dir)

    return toplevel_dir


class GitUp:
    """ Conainter class for GitUp methods """

    default_settings = {
        'fetch.prune': True,
        'fetch.all': False,
        'rebase.show-hashes': False,
        'rebase.arguments': None,
        'rebase.auto': True,
        'rebase.log-hook': None,
        'updates.check': True,
        'push.auto': False,
        'push.tags': False,
        'push.all': False,
    }

    def __init__(self, testing=False, sparse=False):
        # Sparse init: config only
        if sparse:
            self.git = GitWrapper(None)

            # Load configuration
            self.settings = self.default_settings.copy()
            self.load_config()
            return

        # Testing: redirect stderr to stdout
        self.testing = testing
        if self.testing:
            self.stderr = sys.stdout  # Quiet testing
        else:  # pragma: no cover
            self.stderr = sys.stderr

        self.states = []
        self.should_fetch = True
        self.pushed = False

        # Check, if we're in a git repo
        try:
            repo_dir = get_git_dir()
        except (OSError, GitCommandNotFound) as e:
            if isinstance(e, GitCommandNotFound) or e.errno == errno.ENOENT:
                exc = GitError("The git executable could not be found")
                raise exc
            else:
                raise
        else:
            if repo_dir is None:
                exc = GitError("We don't seem to be in a git repository.")
                raise exc

            self.repo = Repo(repo_dir, odbt=GitCmdObjectDB)

        # Check for branch tracking information
        if not any(b.tracking_branch() for b in self.repo.branches):
            exc = GitError("Can\'t update your repo because it doesn\'t has "
                           "any branches with tracking information.")
            self.print_error(exc)

            raise exc

        self.git = GitWrapper(self.repo)

        # target_map: map local branch names to remote tracking branches
        #: :type: dict[str, git.refs.remote.RemoteReference]
        self.target_map = dict()

        for branch in self.repo.branches:
            target = branch.tracking_branch()

            if target:
                if target.name.startswith('./'):
                    # Tracking branch is in local repo
                    target.is_local = True
                else:
                    target.is_local = False

                self.target_map[branch.name] = target

        # branches: all local branches with tracking information
        #: :type: list[git.refs.head.Head]
        self.branches = [b for b in self.repo.branches if b.tracking_branch()]
        self.branches.sort(key=lambda br: br.name)

        # remotes: all remotes that are associated with local branches
        #: :type: list[git.refs.remote.RemoteReference]
        self.remotes = uniq(
            # name = '<remote>/<branch>' -> '<remote>'
            [r.name.split('/', 2)[0]
             for r in list(self.target_map.values())]
        )

        # change_count: Number of unstaged changes
        self.change_count = len(
            self.git.status(porcelain=True, untracked_files='no').split('\n')
        )

        # Build worktree map: branch name -> worktree path
        self.worktree_map, self.in_progress_branches = self._build_worktree_map()

        # Load configuration
        self.settings = self.default_settings.copy()
        self.load_config()

    def run(self):
        """ Run all the git-up stuff. """
        try:
            if self.should_fetch:
                self.fetch()

            self.rebase_all_branches()

            if self.settings['push.auto']:
                self.push()

        except GitError as error:
            self.print_error(error)

            # Used for test cases
            if self.testing:
                raise
            else:  # pragma: no cover
                sys.exit(1)
        except KeyboardInterrupt:
            sys.exit(130)

    def rebase_all_branches(self):
        """ Rebase all branches, if possible. """
        col_width = max(len(b.name) for b in self.branches) + 1
        if self.repo.head.is_detached:
            raise GitError("You're not currently on a branch. I'm exiting"
                           " in case you're in the middle of something.")
        original_branch = self.repo.active_branch

        with self.git.stasher() as stasher:
            for branch in self.branches:
                target = self.target_map[branch.name]

                # Print branch name
                if branch.name == original_branch.name:
                    attrs = ['bold']
                else:
                    attrs = []
                print(colored(branch.name.ljust(col_width), attrs=attrs),
                        end=' ')

                # Check, if target branch exists
                try:
                    if target.name.startswith('./'):
                        # Check, if local branch exists
                        self.git.rev_parse(target.name[2:])
                    else:
                        # Check, if remote branch exists
                        _ = target.commit

                except (ValueError, GitError):
                    # Remote branch doesn't exist!
                    print(colored('error: remote branch doesn\'t exist', 'red'))
                    self.states.append('remote branch doesn\'t exist')

                    continue

                # Skip branches whose worktree has an in-progress operation
                if branch.name in self.in_progress_branches:
                    print(colored('operation in progress', 'yellow'))
                    self.states.append('operation in progress')
                    continue

                # Get tracking branch
                if target.is_local:
                    target = find(self.repo.branches,
                                  lambda b: b.name == target.name[2:])

                # Check status and act appropriately
                if target.commit.hexsha == branch.commit.hexsha:
                    print(colored('up to date', 'green'))
                    self.states.append('up to date')

                    continue  # Do not do anything

                base = self.git.merge_base(branch.name, target.name)

                if base == target.commit.hexsha:
                    print(colored('ahead of upstream', 'cyan'))
                    self.states.append('ahead')

                    continue  # Do not do anything

                fast_fastforward = False
                if base == branch.commit.hexsha:
                    print(colored('fast-forwarding...', 'yellow'), end='')
                    self.states.append('fast-forwarding')
                    # Don't fast fast-forward the currently checked-out branch
                    fast_fastforward = (branch.name !=
                                        self.repo.active_branch.name)

                elif not self.settings['rebase.auto']:
                    print(colored('diverged', 'red'))
                    self.states.append('diverged')

                    continue  # Do not do anything
                else:
                    print(colored('rebasing', 'yellow'), end='')
                    self.states.append('rebasing')

                if self.settings['rebase.show-hashes']:
                    print(' {}..{}'.format(base[0:7],
                                           target.commit.hexsha[0:7]))
                else:
                    print()

                self.log(branch, target)
                worktree_path = self.worktree_map.get(branch.name)
                if worktree_path:
                    self._rebase_in_worktree(
                        branch, target, worktree_path, fast_fastforward
                    )
                elif fast_fastforward:
                    branch.commit = target.commit
                else:
                    stasher()
                    self.git.checkout(branch.name)
                    self.git.rebase(target)

            if (self.repo.head.is_detached  # Only on Travis CI,
                    # we get a detached head after doing our rebase *confused*.
                    # Running self.repo.active_branch would fail.
                    or not self.repo.active_branch.name == original_branch.name):
                print(colored(f'returning to {original_branch.name}',
                              'magenta'))
                original_branch.checkout()

    def _build_worktree_map(self):
        """
        Build a map of branch names to worktree paths.

        This allows us to detect branches that are checked out in
        separate worktrees, so we can rebase them in-place instead of
        failing on checkout.
        """
        worktree_map = {}
        in_progress_branches = set()
        try:
            output = self.git._run('worktree', 'list', '--porcelain')
        except GitError:
            return worktree_map, in_progress_branches

        current_path = None
        main_worktree = os.path.realpath(self.repo.working_dir)

        for line in output.split('\n'):
            line = line.rstrip('\r')
            if line.startswith('worktree '):
                current_path = line[len('worktree '):]
            elif line.startswith('branch refs/heads/'):
                branch_name = line[len('branch refs/heads/'):]
                if current_path and \
                        os.path.realpath(current_path) != main_worktree:
                    worktree_map[branch_name] = current_path
                    if self._worktree_has_in_progress_op(current_path):
                        in_progress_branches.add(branch_name)
            elif line == 'detached' and current_path:
                if os.path.realpath(current_path) != main_worktree:
                    branch_name = self._get_rebase_branch(current_path)
                    if branch_name:
                        worktree_map[branch_name] = current_path
                        in_progress_branches.add(branch_name)

        return worktree_map, in_progress_branches

    def _get_worktree_meta_dir(self, worktree_path):
        """Return the git metadata directory for a worktree."""
        git_file = os.path.join(worktree_path, '.git')
        if not os.path.isfile(git_file):
            return None
        with open(git_file, 'r') as f:
            content = f.read().strip()
        if not content.startswith('gitdir: '):
            return None
        meta_dir = content[len('gitdir: '):]
        if not os.path.isabs(meta_dir):
            meta_dir = os.path.join(worktree_path, meta_dir)
        return os.path.realpath(meta_dir)

    def _worktree_has_in_progress_op(self, worktree_path):
        """Return True if the worktree has a cherry-pick, merge, or bisect in progress."""
        meta_dir = self._get_worktree_meta_dir(worktree_path)
        if not meta_dir:
            return False
        for marker in ('CHERRY_PICK_HEAD', 'MERGE_HEAD', 'BISECT_LOG'):
            if os.path.isfile(os.path.join(meta_dir, marker)):
                return True
        return False

    def _get_rebase_branch(self, worktree_path):
        """Return the branch name if a rebase is in progress in the worktree."""
        meta_dir = self._get_worktree_meta_dir(worktree_path)
        if not meta_dir:
            return None
        for subdir in ('rebase-merge', 'rebase-apply'):
            head_name_file = os.path.join(meta_dir, subdir, 'head-name')
            if os.path.isfile(head_name_file):
                with open(head_name_file, 'r') as f:
                    ref = f.read().strip()
                if ref.startswith('refs/heads/'):
                    return ref[len('refs/heads/'):]
        return None

    def _rebase_in_worktree(self, branch, target, worktree_path,
                            fast_forward):
        """
        Rebase or fast-forward a branch checked out in a worktree.

        Instead of checking out the branch (which would fail), we operate
        directly in the worktree directory where the branch is already
        checked out.
        """
        worktree_repo = Repo(worktree_path, odbt=GitCmdObjectDB)
        worktree_git = GitWrapper(worktree_repo)

        if fast_forward:
            worktree_git._run('merge', '--ff-only', target.name)
        else:
            with worktree_git.stasher() as stash:
                stash()
                try:
                    worktree_git.rebase(target)
                except RebaseError:
                    stash.suppress_pop = True
                    raise

    def fetch(self):
        """
        Fetch the recent refs from the remotes.

        Unless git-up.fetch.all is set to true, all remotes with
        locally existent branches will be fetched.
        """
        fetch_kwargs = {'multiple': True}
        fetch_args = []

        if self.is_prune():
            fetch_kwargs['prune'] = True

        if self.settings['fetch.all']:
            fetch_kwargs['all'] = True
        else:
            if '.' in self.remotes:
                self.remotes.remove('.')

                if not self.remotes:
                    # Only local target branches,
                    # `git fetch --multiple` will fail
                    return

            fetch_args.append(self.remotes)

        try:
            self.git.fetch(*fetch_args, **fetch_kwargs)
        except GitError as error:
            error.message = "`git fetch` failed"
            raise error

    def push(self):
        """
        Push the changes back to the remote(s) after fetching
        """
        print('pushing...')
        push_kwargs = {}
        push_args = []

        if self.settings['push.tags']:
            push_kwargs['push'] = True

        if self.settings['push.all']:
            push_kwargs['all'] = True
        else:
            if '.' in self.remotes:
                self.remotes.remove('.')

                if not self.remotes:
                    # Only local target branches,
                    # `git push` will fail
                    return

            push_args.append(self.remotes)

        try:
            self.git.push(*push_args, **push_kwargs)
            self.pushed = True
        except GitError as error:
            error.message = "`git push` failed"
            raise error

    def log(self, branch, remote):
        """ Call a log-command, if set by git-up.fetch.all. """
        log_hook = self.settings['rebase.log-hook']

        if log_hook:
            if ON_WINDOWS:  # pragma: no cover
                # Running a string in CMD from Python is not that easy on
                # Windows. Running 'cmd /C log_hook' produces problems when
                # using multiple statements or things like 'echo'. Therefore,
                # we write the string to a bat file and execute it.

                # Write log_hook to an temporary file and get it's path
                with NamedTemporaryFile(
                        prefix='PyGitUp.', suffix='.bat', delete=False
                ) as bat_file:
                    # Don't echo all commands
                    bat_file.file.write(b'@echo off\n')
                    # Required by the !GITUP_ARG*! reads in the prepared hook
                    bat_file.file.write(b'setlocal enabledelayedexpansion\n')
                    # Run log_hook
                    bat_file.file.write(
                        prepare_windows_log_hook(log_hook).encode('utf-8')
                    )

                # Pass the branch and remote name through the environment
                # rather than as arguments, so they never reach a command line
                # cmd parses.
                env = os.environ.copy()
                env['GITUP_ARG1'] = branch.name
                env['GITUP_ARG2'] = remote.name

                try:
                    state = subprocess.call([bat_file.name], env=env)
                finally:
                    # Clean up file
                    os.remove(bat_file.name)
            else:  # pragma: no cover
                def _escape_positional(value):
                    # Neutralize command substitution/backticks in branch names
                    return value.replace('$', r'\$').replace('`', r'\`')

                # Run log_hook via 'shell -c'
                # Disable globbing and word-splitting to keep $1/$2 safe
                state = subprocess.call(
                    ['sh', '-c', 'set -f; IFS=; ' + log_hook,
                     'git-up', _escape_positional(branch.name),
                     _escape_positional(remote.name)]
                )

            if self.testing:
                assert state == 0, 'log_hook returned != 0'

    def version_info(self):
        """ Tell, what version we're running at and if it's up to date. """

        # Retrive and show local version info
        try:
            local_version_str = metadata.version('git-up')
        except (AttributeError, metadata.PackageNotFoundError):
            print(
                colored(
                    "Please install 'git-up' via pip in order to get version information.",
                    'yellow',
                )
            )
            return

        try:
            local_version = Version(local_version_str)
        except InvalidVersion:
            print('GitUp version is: ' + colored('v' + local_version_str, 'green'))
            return

        print('GitUp version is: ' + colored('v' + local_version_str, 'green'))

        if not self.settings['updates.check']:
            return

        # Check for updates
        print('Checking for updates...', end='')

        try:
            # Get version information from the PyPI JSON API
            reader = codecs.getreader('utf-8')
            details = json.load(reader(urlopen(PYPI_URL)))
            online_version = details['info']['version']
        except (HTTPError, URLError, ValueError):
            recent = True  # To not disturb the user with HTTP/parsing errors
        else:
            try:
                recent = local_version >= Version(online_version)
            except InvalidVersion:
                recent = True

        if not recent:
            # noinspection PyUnboundLocalVariable
            print(
                '\rRecent version is: '
                + colored('v' + online_version, color='yellow', attrs=['bold'])
            )
            print('Run \'pip install -U git-up\' to get the update.')
        else:
            # Clear the update line
            sys.stdout.write('\r' + ' ' * 80 + '\n')

    ###########################################################################
    # Helpers
    ###########################################################################

    def load_config(self):
        """
        Load the configuration from git config.
        """
        for key in self.settings:
            value = self.config(key)
            # Parse true/false
            if value == '' or value is None:
                continue  # Not set by user, go on
            if value.lower() == 'true':
                value = True
            elif value.lower() == 'false':
                value = False
            elif value:
                pass  # A user-defined string, store the value later

            self.settings[key] = value

    def config(self, key):
        """ Get a git-up-specific config value. """
        return self.git.config(f'git-up.{key}')

    def is_prune(self):
        """
        Return True, if `git fetch --prune` is allowed.

        Because of possible incompatibilities, this requires special
        treatment.
        """
        required_version = "1.6.6"
        config_value = self.settings['fetch.prune']

        if self.git.is_version_min(required_version):
            return config_value is not False
        else:  # pragma: no cover
            if config_value == 'true':
                print(colored(
                    "Warning: fetch.prune is set to 'true' but your git"
                    "version doesn't seem to support it ({} < {})."
                    "Defaulting to 'false'.".format(self.git.version,
                                                    required_version),
                    'yellow'
                ))

    def print_error(self, error):
        """
        Print more information about an error.

        :type error: GitError
        """
        print(colored(error.message, 'red'), file=self.stderr)

        if error.stdout or error.stderr:
            print(file=self.stderr)
            print("Here's what git said:", file=self.stderr)
            print(file=self.stderr)

            if error.stdout:
                print(error.stdout, file=self.stderr)
            if error.stderr:
                print(error.stderr, file=self.stderr)

        if error.details:
            print(file=self.stderr)
            print("Here's what we know:", file=self.stderr)
            print(str(error.details), file=self.stderr)
            print(file=self.stderr)


###############################################################################


EPILOG = '''
For configuration options, please see
https://github.com/msiemens/PyGitUp#readme.

\b
Python port of https://github.com/aanand/git-up/
Project Author: Markus Siemens <markus@m-siemens.de>
Project URL: https://github.com/msiemens/PyGitUp
\b
'''


def run():  # pragma: no cover
    """
    A nicer `git pull`.
    """

    parser = argparse.ArgumentParser(description="A nicer `git pull`.", epilog=EPILOG)
    parser.add_argument('-V', '--version', action='store_true',
                        help='Show version (and if there is a newer version).')
    parser.add_argument('-q', '--quiet', action='store_true',
                        help='Be quiet, only print error messages.')
    parser.add_argument('--no-fetch', '--no-f', dest='fetch', action='store_false',
                        help='Don\'t try to fetch from origin.')
    parser.add_argument('-p', '--push', action='store_true',
                        help='Push the changes after pulling successfully.')

    args = parser.parse_args()

    if args.version:
        if NO_DISTRIBUTE:
            print(colored('Please install \'git-up\' via pip in order to '
                          'get version information.', 'yellow'))
        else:
            GitUp(sparse=True).version_info()
        return

    if args.quiet:
        sys.stdout = StringIO()

    try:
        gitup = GitUp()
        gitup.settings['push.auto'] = args.push
        gitup.should_fetch = args.fetch
    except GitError:
        sys.exit(1)  # Error in constructor
    else:
        gitup.run()


if __name__ == '__main__':  # pragma: no cover
    run()

msiemens / PyGitUp / 31095981247

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous