summaryrefslogtreecommitdiff
path: root/git/refs/remote.py
blob: b601c8b20b338eab857ec6aefb32105ead5afd85 (plain)
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
import os
from headref import Head
from git.util import (
    join,
    join_path
)

__all__ = ["RemoteReference"]


class RemoteReference(Head):

    """Represents a reference pointing to a remote head."""
    __slots__ = tuple()

    _common_path_default = Head._remote_common_path_default

    @classmethod
    def iter_items(cls, repo, common_path=None, remote=None):
        """Iterate remote references, and if given, constrain them to the given remote"""
        common_path = common_path or cls._common_path_default
        if remote is not None:
            common_path = join_path(common_path, str(remote))
        # END handle remote constraint
        return super(RemoteReference, cls).iter_items(repo, common_path)

    @classmethod
    def create(cls, *args, **kwargs):
        """Used to disable this method"""
        raise TypeError("Cannot explicitly create remote references")

    @classmethod
    def delete(cls, repo, *refs, **kwargs):
        """Delete the given remote references.
        :note:
            kwargs are given for compatability with the base class method as we 
            should not narrow the signature."""
        repo.git.branch("-d", "-r", *refs)
        # the official deletion method will ignore remote symbolic refs - these
        # are generally ignored in the refs/ folder. We don't though
        # and delete remainders manually
        for ref in refs:
            try:
                os.remove(join(repo.git_dir, ref.path))
            except OSError:
                pass
        # END for each ref