1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
|
# Copyright 2010-2025 The pygit2 contributors
#
# This file is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License, version 2,
# as published by the Free Software Foundation.
#
# In addition to the permissions in the GNU General Public License,
# the authors give you unlimited permission to link the compiled
# version of this file into combinations with other programs,
# and to distribute those combinations without any restriction
# coming from the use of this file. (The General Public License
# restrictions do apply in other respects; for example, they cover
# modification of the file, and distribution when not linked into
# a combined executable.)
#
# This file 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
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; see the file COPYING. If not, write to
# the Free Software Foundation, 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
from __future__ import annotations
from collections.abc import Iterator
from typing import TYPE_CHECKING
from ._pygit2 import Branch, Commit, Oid
from .enums import BranchType, ReferenceType
# Need BaseRepository for type hints, but don't let it cause a circular dependency
if TYPE_CHECKING:
from .repository import BaseRepository
class Branches:
local: 'Branches'
remote: 'Branches'
def __init__(
self,
repository: BaseRepository,
flag: BranchType = BranchType.ALL,
commit: Commit | Oid | str | None = None,
) -> None:
self._repository = repository
self._flag = flag
if commit is not None:
if isinstance(commit, Commit):
commit = commit.id
elif not isinstance(commit, Oid):
commit = self._repository.expand_id(commit)
self._commit = commit
if flag == BranchType.ALL:
self.local = Branches(repository, flag=BranchType.LOCAL, commit=commit)
self.remote = Branches(repository, flag=BranchType.REMOTE, commit=commit)
def __getitem__(self, name: str) -> Branch:
branch = None
if self._flag & BranchType.LOCAL:
branch = self._repository.lookup_branch(name, BranchType.LOCAL)
if branch is None and self._flag & BranchType.REMOTE:
branch = self._repository.lookup_branch(name, BranchType.REMOTE)
if branch is None or not self._valid(branch):
raise KeyError(f'Branch not found: {name}')
return branch
def get(self, key: str) -> Branch:
try:
return self[key]
except KeyError:
return None # type:ignore # next commit
def __iter__(self) -> Iterator[str]:
for branch_name in self._repository.listall_branches(self._flag):
if self._commit is None or self.get(branch_name) is not None:
yield branch_name
def create(self, name: str, commit: Commit, force: bool = False) -> Branch:
return self._repository.create_branch(name, commit, force)
def delete(self, name: str) -> None:
self[name].delete()
def _valid(self, branch: Branch) -> bool:
if branch.type == ReferenceType.SYMBOLIC:
branch_direct = branch.resolve()
else:
branch_direct = branch
return (
self._commit is None
or branch_direct.target == self._commit
or self._repository.descendant_of(branch_direct.target, self._commit)
)
def with_commit(self, commit: Commit | Oid | str | None) -> 'Branches':
assert self._commit is None
return Branches(self._repository, self._flag, commit)
def __contains__(self, name: str) -> bool:
return self.get(name) is not None
|