Source code for craft_parts.utils.git

# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
#
# Copyright 2024 Canonical Ltd.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License version 3 as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""Helpers to use git."""
import shutil
from functools import cache



[docs]
@cache
def get_git_command() -> str:
    """Get the git command to use.

    This function will prefer the "craft.git" binary if available on the system,
    returning its full path. Otherwise, it will always return "git", without
    checking for availability.
    """
    if craft_git := shutil.which("craft.git"):
        return craft_git
    return "git"