summaryrefslogtreecommitdiff
path: root/git/refs/reference.py
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2014-02-09 21:09:00 +0100
committerSebastian Thiel <byronimo@gmail.com>2014-02-09 21:09:00 +0100
commitf573b6840509bf41be822ab7ed79e0a776005133 (patch)
tree11f807845bcbe9901e84efab53aa8585a452022f /git/refs/reference.py
parent0b820e617ab21b372394bf12129c30174f57c5d7 (diff)
downloadgitpython-f573b6840509bf41be822ab7ed79e0a776005133.tar.gz
tabs to 4 spaces - this won't make integrating the patches easier, but it's probably a good idea to go a little more pep8 (and fix sins of my youth ;) )
Diffstat (limited to 'git/refs/reference.py')
-rw-r--r--git/refs/reference.py216
1 files changed, 108 insertions, 108 deletions
diff --git a/git/refs/reference.py b/git/refs/reference.py
index 29d051a6..8cc577a8 100644
--- a/git/refs/reference.py
+++ b/git/refs/reference.py
@@ -2,126 +2,126 @@ from symbolic import SymbolicReference
import os
from git.objects import Object
from git.util import (
- LazyMixin,
- Iterable,
- )
+ LazyMixin,
+ Iterable,
+ )
from gitdb.util import (
- isfile,
- hex_to_bin
- )
+ isfile,
+ hex_to_bin
+ )
__all__ = ["Reference"]
#{ Utilities
def require_remote_ref_path(func):
- """A decorator raising a TypeError if we are not a valid remote, based on the path"""
- def wrapper(self, *args):
- if not self.path.startswith(self._remote_common_path_default + "/"):
- raise ValueError("ref path does not point to a remote reference: %s" % path)
- return func(self, *args)
- #END wrapper
- wrapper.__name__ = func.__name__
- return wrapper
+ """A decorator raising a TypeError if we are not a valid remote, based on the path"""
+ def wrapper(self, *args):
+ if not self.path.startswith(self._remote_common_path_default + "/"):
+ raise ValueError("ref path does not point to a remote reference: %s" % path)
+ return func(self, *args)
+ #END wrapper
+ wrapper.__name__ = func.__name__
+ return wrapper
#}END utilites
class Reference(SymbolicReference, LazyMixin, Iterable):
- """Represents a named reference to any object. Subclasses may apply restrictions though,
- i.e. Heads can only point to commits."""
- __slots__ = tuple()
- _points_to_commits_only = False
- _resolve_ref_on_create = True
- _common_path_default = "refs"
-
- def __init__(self, repo, path, check_path = True):
- """Initialize this instance
- :param repo: Our parent repository
-
- :param path:
- Path relative to the .git/ directory pointing to the ref in question, i.e.
- refs/heads/master
- :param check_path: if False, you can provide any path. Otherwise the path must start with the
- default path prefix of this type."""
- if check_path and not path.startswith(self._common_path_default+'/'):
- raise ValueError("Cannot instantiate %r from path %s" % (self.__class__.__name__, path))
- super(Reference, self).__init__(repo, path)
-
+ """Represents a named reference to any object. Subclasses may apply restrictions though,
+ i.e. Heads can only point to commits."""
+ __slots__ = tuple()
+ _points_to_commits_only = False
+ _resolve_ref_on_create = True
+ _common_path_default = "refs"
+
+ def __init__(self, repo, path, check_path = True):
+ """Initialize this instance
+ :param repo: Our parent repository
+
+ :param path:
+ Path relative to the .git/ directory pointing to the ref in question, i.e.
+ refs/heads/master
+ :param check_path: if False, you can provide any path. Otherwise the path must start with the
+ default path prefix of this type."""
+ if check_path and not path.startswith(self._common_path_default+'/'):
+ raise ValueError("Cannot instantiate %r from path %s" % (self.__class__.__name__, path))
+ super(Reference, self).__init__(repo, path)
+
- def __str__(self):
- return self.name
-
- #{ Interface
+ def __str__(self):
+ return self.name
+
+ #{ Interface
- def set_object(self, object, logmsg = None):
- """Special version which checks if the head-log needs an update as well"""
- oldbinsha = None
- if logmsg is not None:
- head = self.repo.head
- if not head.is_detached and head.ref == self:
- oldbinsha = self.commit.binsha
- #END handle commit retrieval
- #END handle message is set
-
- super(Reference, self).set_object(object, logmsg)
-
- if oldbinsha is not None:
- # /* from refs.c in git-source
- # * Special hack: If a branch is updated directly and HEAD
- # * points to it (may happen on the remote side of a push
- # * for example) then logically the HEAD reflog should be
- # * updated too.
- # * A generic solution implies reverse symref information,
- # * but finding all symrefs pointing to the given branch
- # * would be rather costly for this rare event (the direct
- # * update of a branch) to be worth it. So let's cheat and
- # * check with HEAD only which should cover 99% of all usage
- # * scenarios (even 100% of the default ones).
- # */
- self.repo.head.log_append(oldbinsha, logmsg)
- #END check if the head
+ def set_object(self, object, logmsg = None):
+ """Special version which checks if the head-log needs an update as well"""
+ oldbinsha = None
+ if logmsg is not None:
+ head = self.repo.head
+ if not head.is_detached and head.ref == self:
+ oldbinsha = self.commit.binsha
+ #END handle commit retrieval
+ #END handle message is set
+
+ super(Reference, self).set_object(object, logmsg)
+
+ if oldbinsha is not None:
+ # /* from refs.c in git-source
+ # * Special hack: If a branch is updated directly and HEAD
+ # * points to it (may happen on the remote side of a push
+ # * for example) then logically the HEAD reflog should be
+ # * updated too.
+ # * A generic solution implies reverse symref information,
+ # * but finding all symrefs pointing to the given branch
+ # * would be rather costly for this rare event (the direct
+ # * update of a branch) to be worth it. So let's cheat and
+ # * check with HEAD only which should cover 99% of all usage
+ # * scenarios (even 100% of the default ones).
+ # */
+ self.repo.head.log_append(oldbinsha, logmsg)
+ #END check if the head
- # NOTE: Don't have to overwrite properties as the will only work without a the log
+ # NOTE: Don't have to overwrite properties as the will only work without a the log
- @property
- def name(self):
- """:return: (shortest) Name of this reference - it may contain path components"""
- # first two path tokens are can be removed as they are
- # refs/heads or refs/tags or refs/remotes
- tokens = self.path.split('/')
- if len(tokens) < 3:
- return self.path # could be refs/HEAD
- return '/'.join(tokens[2:])
-
- @classmethod
- def iter_items(cls, repo, common_path = None):
- """Equivalent to SymbolicReference.iter_items, but will return non-detached
- references as well."""
- return cls._iter_items(repo, common_path)
-
- #}END interface
-
-
- #{ Remote Interface
-
- @property
- @require_remote_ref_path
- def remote_name(self):
- """
- :return:
- Name of the remote we are a reference of, such as 'origin' for a reference
- named 'origin/master'"""
- tokens = self.path.split('/')
- # /refs/remotes/<remote name>/<branch_name>
- return tokens[2]
-
- @property
- @require_remote_ref_path
- def remote_head(self):
- """:return: Name of the remote head itself, i.e. master.
- :note: The returned name is usually not qualified enough to uniquely identify
- a branch"""
- tokens = self.path.split('/')
- return '/'.join(tokens[3:])
-
- #} END remote interface
+ @property
+ def name(self):
+ """:return: (shortest) Name of this reference - it may contain path components"""
+ # first two path tokens are can be removed as they are
+ # refs/heads or refs/tags or refs/remotes
+ tokens = self.path.split('/')
+ if len(tokens) < 3:
+ return self.path # could be refs/HEAD
+ return '/'.join(tokens[2:])
+
+ @classmethod
+ def iter_items(cls, repo, common_path = None):
+ """Equivalent to SymbolicReference.iter_items, but will return non-detached
+ references as well."""
+ return cls._iter_items(repo, common_path)
+
+ #}END interface
+
+
+ #{ Remote Interface
+
+ @property
+ @require_remote_ref_path
+ def remote_name(self):
+ """
+ :return:
+ Name of the remote we are a reference of, such as 'origin' for a reference
+ named 'origin/master'"""
+ tokens = self.path.split('/')
+ # /refs/remotes/<remote name>/<branch_name>
+ return tokens[2]
+
+ @property
+ @require_remote_ref_path
+ def remote_head(self):
+ """:return: Name of the remote head itself, i.e. master.
+ :note: The returned name is usually not qualified enough to uniquely identify
+ a branch"""
+ tokens = self.path.split('/')
+ return '/'.join(tokens[3:])
+
+ #} END remote interface