Function checkout_commit_with_frid

git_utils.py:169–187

Finds commit with given frid mentioned in the commit message and checks out that commit. If frid argument is not provided (None), repo is checked out to the initial state. In case the base folder doesn't exist, code is checked out to the initial repo commit. Otherwise, the repo is chec

(repo_path: Union[str, os.PathLike], frid: Optional[str] = None)

def checkout_commit_with_frid(repo_path: Union[str, os.PathLike], frid: Optional[str] = None) -> Repo:
    """
    Finds commit with given frid mentioned in the commit message and checks out that commit.

    If frid argument is not provided (None), repo is checked out to the initial state. In case the base folder doesn't exist,
    code is checked out to the initial repo commit. Otherwise, the repo is checked out to the base folder commit.

    It is expected that the repo has at least one commit related to provided frid if frid is not None.
    In case the frid related commit is not found, an exception is raised.
    """
    repo = Repo(repo_path)

    commit = _get_commit(repo, frid)

    if not commit:
        raise InvalidGitRepositoryError("Git repository is in an invalid state. Relevant commit could not be found.")

    repo.git.checkout(commit)
    return repo


def checkout_previous_branch(repo_path: Union[str, os.PathLike]) -> Repo: