diff options
Diffstat (limited to 'git/refs')
| -rw-r--r-- | git/refs/__init__.py | 2 | ||||
| -rw-r--r-- | git/refs/head.py | 42 | ||||
| -rw-r--r-- | git/refs/headref.py | 70 | ||||
| -rw-r--r-- | git/refs/log.py | 159 | ||||
| -rw-r--r-- | git/refs/reference.py | 56 | ||||
| -rw-r--r-- | git/refs/remote.py | 24 | ||||
| -rw-r--r-- | git/refs/symbolic.py | 305 | ||||
| -rw-r--r-- | git/refs/tag.py | 38 |
8 files changed, 351 insertions, 345 deletions
diff --git a/git/refs/__init__.py b/git/refs/__init__.py index 97017d5f..e5fb0868 100644 --- a/git/refs/__init__.py +++ b/git/refs/__init__.py @@ -15,7 +15,7 @@ del(headref) import symbolic for item in (HEAD, Head, RemoteReference, TagReference, Reference): - setattr(symbolic.SymbolicReference, item.__name__+'Cls', item) + setattr(symbolic.SymbolicReference, item.__name__ + 'Cls', item) del(symbolic) diff --git a/git/refs/head.py b/git/refs/head.py index dc44c921..686663ae 100644 --- a/git/refs/head.py +++ b/git/refs/head.py @@ -4,76 +4,77 @@ from git.exc import GitCommandError __all__ = ["HEAD"] - + class HEAD(SymbolicReference): + """Provides additional functionality using the git command""" __slots__ = tuple() - + _HEAD_NAME = 'HEAD' _ORIG_HEAD_NAME = 'ORIG_HEAD' __slots__ = tuple() - + def __init__(self, repo, path=_HEAD_NAME): if path != self._HEAD_NAME: raise ValueError("HEAD instance must point to %r, got %r" % (self._HEAD_NAME, path)) super(HEAD, self).__init__(repo, path) - + def orig_head(self): """ :return: SymbolicReference pointing at the ORIG_HEAD, which is maintained to contain the previous value of HEAD""" return SymbolicReference(self.repo, self._ORIG_HEAD_NAME) - - def reset(self, commit='HEAD', index=True, working_tree = False, - paths=None, **kwargs): + + def reset(self, commit='HEAD', index=True, working_tree=False, + paths=None, **kwargs): """Reset our HEAD to the given commit optionally synchronizing the index and working tree. The reference we refer to will be set to commit as well. - + :param commit: Commit object, Reference Object or string identifying a revision we should reset HEAD to. - + :param index: If True, the index will be set to match the given commit. Otherwise it will not be touched. - + :param working_tree: If True, the working tree will be forcefully adjusted to match the given commit, possibly overwriting uncommitted changes without warning. If working_tree is True, index must be true as well - + :param paths: Single path or list of paths relative to the git root directory that are to be reset. This allows to partially reset individual files. - + :param kwargs: Additional arguments passed to git-reset. - + :return: self""" mode = "--soft" add_arg = None if index: mode = "--mixed" - + # it appears, some git-versions declare mixed and paths deprecated # see http://github.com/Byron/GitPython/issues#issue/2 if paths: mode = None # END special case # END handle index - + if working_tree: mode = "--hard" if not index: - raise ValueError( "Cannot reset the working tree if the index is not reset as well") - + raise ValueError("Cannot reset the working tree if the index is not reset as well") + # END working tree handling - + if paths: add_arg = "--" # END nicely separate paths from rest - + try: self.repo.git.reset(mode, commit, add_arg, paths, **kwargs) except GitCommandError, e: @@ -82,6 +83,5 @@ class HEAD(SymbolicReference): if e.status != 1: raise # END handle exception - + return self - diff --git a/git/refs/headref.py b/git/refs/headref.py index 843e897f..c3941d92 100644 --- a/git/refs/headref.py +++ b/git/refs/headref.py @@ -4,9 +4,11 @@ from git.util import join_path __all__ = ["Head"] + class Head(Reference): + """The GitPyhton Head implementation provides more git-command based features - + A Head is a named reference to a Commit. Every Head instance contains a name and a Commit object. @@ -24,28 +26,28 @@ class Head(Reference): >>> head.commit.hexsha '1c09f116cbc2cb4100fb6935bb162daa4723f455'""" __slots__ = tuple() - + _common_path_default = "refs/heads" k_config_remote = "remote" k_config_remote_ref = "merge" # branch to merge from remote - + # will be set by init method ! RemoteReferenceCls = None - + #{ Configuration - + def set_tracking_branch(self, remote_reference): """ Configure this branch to track the given remote reference. This will alter this branch's configuration accordingly. - + :param remote_reference: The remote reference to track or None to untrack any references :return: self""" if remote_reference is not None and not isinstance(remote_reference, self.RemoteReferenceCls): raise ValueError("Incorrect parameter type: %r" % remote_reference) # END handle type - + writer = self.config_writer() if remote_reference is None: writer.remove_option(self.k_config_remote) @@ -57,9 +59,9 @@ class Head(Reference): writer.set_value(self.k_config_remote, remote_reference.remote_name) writer.set_value(self.k_config_remote_ref, Head.to_full_path(remote_reference.remote_head)) # END handle ref value - + return self - + def tracking_branch(self): """ :return: The remote_reference we are tracking, or None if we are @@ -67,39 +69,39 @@ class Head(Reference): reader = self.config_reader() if reader.has_option(self.k_config_remote) and reader.has_option(self.k_config_remote_ref): ref = Head(self.repo, Head.to_full_path(reader.get_value(self.k_config_remote_ref))) - remote_refpath = self.RemoteReferenceCls.to_full_path(join_path(reader.get_value(self.k_config_remote), ref.name)) + remote_refpath = self.RemoteReferenceCls.to_full_path( + join_path(reader.get_value(self.k_config_remote), ref.name)) return self.RemoteReferenceCls(self.repo, remote_refpath) # END handle have tracking branch - + # we are not a tracking branch return None - - + #{ Configruation - + def _config_parser(self, read_only): if read_only: parser = self.repo.config_reader() else: parser = self.repo.config_writer() # END handle parser instance - + return SectionConstraint(parser, 'branch "%s"' % self.name) - + def config_reader(self): """ :return: A configuration parser instance constrained to only read this instance's values""" return self._config_parser(read_only=True) - + def config_writer(self): """ :return: A configuration writer instance with read-and write acccess to options of this head""" return self._config_parser(read_only=False) - + #} END configuration - + @classmethod def delete(cls, repo, *heads, **kwargs): """Delete the given heads @@ -112,48 +114,47 @@ class Head(Reference): if force: flag = "-D" repo.git.branch(flag, *heads) - - + def rename(self, new_path, force=False): """Rename self to a new path - + :param new_path: Either a simple name or a path, i.e. new_name or features/new_name. The prefix refs/heads is implied - + :param force: If True, the rename will succeed even if a head with the target name already exists. - + :return: self :note: respects the ref log as git commands are used""" flag = "-m" if force: flag = "-M" - + self.repo.git.branch(flag, self, new_path) - self.path = "%s/%s" % (self._common_path_default, new_path) + self.path = "%s/%s" % (self._common_path_default, new_path) return self - + def checkout(self, force=False, **kwargs): """Checkout this head by setting the HEAD to this reference, by updating the index to reflect the tree we point to and by updating the working tree to reflect the latest index. - + The command will fail if changed working tree files would be overwritten. - + :param force: If True, changes to the index and the working tree will be discarded. If False, GitCommandError will be raised in that situation. - + :param kwargs: Additional keyword arguments to be passed to git checkout, i.e. b='new_branch' to create a new branch at the given spot. - + :return: The active branch after the checkout operation, usually self unless a new branch has been created. - + :note: By default it is only allowed to checkout heads - everything else will leave the HEAD detached which is allowed and possible, but remains @@ -162,9 +163,6 @@ class Head(Reference): kwargs['f'] = force if kwargs['f'] == False: kwargs.pop('f') - + self.repo.git.checkout(self, **kwargs) return self.repo.active_branch - - - diff --git a/git/refs/log.py b/git/refs/log.py index 70f11b87..fbb3fcf8 100644 --- a/git/refs/log.py +++ b/git/refs/log.py @@ -1,21 +1,21 @@ from git.util import ( - join_path, - Actor, - LockedFD, - LockFile, - assure_directory_exists, - to_native_path, - bin_to_hex, - join, - file_contents_ro_filepath - ) + join_path, + Actor, + LockedFD, + LockFile, + assure_directory_exists, + to_native_path, + bin_to_hex, + join, + file_contents_ro_filepath +) from git.objects.util import ( - parse_date, - Serializable, - utctz_to_altz, - altz_to_utctz_str, - ) + parse_date, + Serializable, + utctz_to_altz, + altz_to_utctz_str, +) import time import os @@ -25,54 +25,55 @@ __all__ = ["RefLog", "RefLogEntry"] class RefLogEntry(tuple): + """Named tuple allowing easy access to the revlog data fields""" _fmt = "%s %s %s <%s> %i %s\t%s\n" _re_hexsha_only = re.compile('^[0-9A-Fa-f]{40}$') __slots__ = tuple() - + def __repr__(self): """Representation of ourselves in git reflog format""" act = self.actor time = self.time - return self._fmt % (self.oldhexsha, self.newhexsha, act.name, act.email, + return self._fmt % (self.oldhexsha, self.newhexsha, act.name, act.email, time[0], altz_to_utctz_str(time[1]), self.message) - + @property def oldhexsha(self): - """The hexsha to the commit the ref pointed to before the change""" + """The hexsha to the commit the ref pointed to before the change""" return self[0] - + @property def newhexsha(self): """The hexsha to the commit the ref now points to, after the change""" return self[1] - + @property def actor(self): """Actor instance, providing access""" return self[2] - + @property def time(self): """time as tuple: - + * [0] = int(time) * [1] = int(timezone_offset) in time.altzone format """ return self[3] - + @property def message(self): """Message describing the operation that acted on the reference""" return self[4] - + @classmethod def new(self, oldhexsha, newhexsha, actor, time, tz_offset, message): """:return: New instance of a RefLogEntry""" if not isinstance(actor, Actor): raise ValueError("Need actor instance, got %s" % actor) - # END check types + # END check types return RefLogEntry((oldhexsha, newhexsha, actor, (time, tz_offset), message)) - + @classmethod def from_line(cls, line): """:return: New RefLogEntry instance from the given revlog line. @@ -82,40 +83,41 @@ class RefLogEntry(tuple): info, msg = line.split('\t', 2) except ValueError: raise ValueError("line is missing tab separator") - #END handle first plit + # END handle first plit oldhexsha = info[:40] newhexsha = info[41:81] for hexsha in (oldhexsha, newhexsha): if not cls._re_hexsha_only.match(hexsha): raise ValueError("Invalid hexsha: %s" % hexsha) # END if hexsha re doesn't match - #END for each hexsha - + # END for each hexsha + email_end = info.find('>', 82) if email_end == -1: raise ValueError("Missing token: >") - #END handle missing end brace - - actor = Actor._from_string(info[82:email_end+1]) - time, tz_offset = parse_date(info[email_end+2:]) - + # END handle missing end brace + + actor = Actor._from_string(info[82:email_end + 1]) + time, tz_offset = parse_date(info[email_end + 2:]) + return RefLogEntry((oldhexsha, newhexsha, actor, (time, tz_offset), msg)) - + class RefLog(list, Serializable): + """A reflog contains reflog entries, each of which defines a certain state of the head in question. Custom query methods allow to retrieve log entries by date or by other criteria. - + Reflog entries are orded, the first added entry is first in the list, the last entry, i.e. the last change of the head or reference, is last in the list.""" - + __slots__ = ('_path', ) - + def __new__(cls, filepath=None): inst = super(RefLog, cls).__new__(cls) return inst - + def __init__(self, filepath=None): """Initialize this instance with an optional filepath, from which we will initialize our data. The path is also used to write changes back using @@ -124,23 +126,23 @@ class RefLog(list, Serializable): if filepath is not None: self._read_from_file() # END handle filepath - + def _read_from_file(self): try: fmap = file_contents_ro_filepath(self._path, stream=True, allow_mmap=True) except OSError: # it is possible and allowed that the file doesn't exist ! return - #END handle invalid log - + # END handle invalid log + try: self._deserialize(fmap) finally: fmap.close() - #END handle closing of handle - + # END handle closing of handle + #{ Interface - + @classmethod def from_file(cls, filepath): """ @@ -149,7 +151,7 @@ class RefLog(list, Serializable): :param filepath: path to reflog :raise ValueError: If the file could not be read or was corrupted in some way""" return cls(filepath) - + @classmethod def path(cls, ref): """ @@ -158,7 +160,7 @@ class RefLog(list, Serializable): file though. :param ref: SymbolicReference instance""" return join(ref.repo.git_dir, "logs", to_native_path(ref.path)) - + @classmethod def iter_entries(cls, stream): """ @@ -169,23 +171,23 @@ class RefLog(list, Serializable): new_entry = RefLogEntry.from_line if isinstance(stream, basestring): stream = file_contents_ro_filepath(stream) - #END handle stream type + # END handle stream type while True: line = stream.readline() if not line: return yield new_entry(line.strip()) - #END endless loop - + # END endless loop + @classmethod def entry_at(cls, filepath, index): """:return: RefLogEntry at the given index :param filepath: full path to the index file from which to read the entry :param index: python list compatible index, i.e. it may be negative to specifiy an entry counted from the end of the list - + :raise IndexError: If the entry didn't exist - + .. note:: This method is faster as it only parses the entry at index, skipping all other lines. Nonetheless, the whole file has to be read if the index is negative @@ -195,26 +197,26 @@ class RefLog(list, Serializable): return RefLogEntry.from_line(fp.readlines()[index].strip()) else: # read until index is reached - for i in xrange(index+1): + for i in xrange(index + 1): line = fp.readline() if not line: break - #END abort on eof - #END handle runup - + # END abort on eof + # END handle runup + if i != index or not line: raise IndexError - #END handle exception - + # END handle exception + return RefLogEntry.from_line(line.strip()) - #END handle index - + # END handle index + def to_file(self, filepath): """Write the contents of the reflog instance to a file at the given filepath. :param filepath: path to file, parent directories are assumed to exist""" lfd = LockedFD(filepath) assure_directory_exists(filepath, is_file=True) - + fp = lfd.open(write=True, stream=True) try: self._serialize(fp) @@ -223,12 +225,12 @@ class RefLog(list, Serializable): # on failure it rolls back automatically, but we make it clear lfd.rollback() raise - #END handle change - + # END handle change + @classmethod def append_entry(cls, config_reader, filepath, oldbinsha, newbinsha, message): """Append a new log entry to the revlog at filepath. - + :param config_reader: configuration reader of the repository - used to obtain user information. May be None :param filepath: full path to the log file @@ -242,44 +244,45 @@ class RefLog(list, Serializable): do not interfere with readers.""" if len(oldbinsha) != 20 or len(newbinsha) != 20: raise ValueError("Shas need to be given in binary format") - #END handle sha type + # END handle sha type assure_directory_exists(filepath, is_file=True) - entry = RefLogEntry((bin_to_hex(oldbinsha), bin_to_hex(newbinsha), Actor.committer(config_reader), (int(time.time()), time.altzone), message)) - + entry = RefLogEntry((bin_to_hex(oldbinsha), bin_to_hex(newbinsha), Actor.committer( + config_reader), (int(time.time()), time.altzone), message)) + lf = LockFile(filepath) lf._obtain_lock_or_raise() - + fd = open(filepath, 'a') try: fd.write(repr(entry)) finally: fd.close() lf._release_lock() - #END handle write operation - + # END handle write operation + return entry - + def write(self): """Write this instance's data to the file we are originating from :return: self""" if self._path is None: raise ValueError("Instance was not initialized with a path, use to_file(...) instead") - #END assert path + # END assert path self.to_file(self._path) return self - + #} END interface - + #{ Serializable Interface def _serialize(self, stream): lm1 = len(self) - 1 write = stream.write - + # write all entries for e in self: write(repr(e)) - #END for each entry - + # END for each entry + def _deserialize(self, stream): self.extend(self.iter_entries(stream)) #} END serializable interface diff --git a/git/refs/reference.py b/git/refs/reference.py index 2aaf185f..c55070d5 100644 --- a/git/refs/reference.py +++ b/git/refs/reference.py @@ -3,66 +3,69 @@ import os from symbolic import SymbolicReference from head import HEAD from git.util import ( - LazyMixin, - Iterable, - isfile, - hex_to_bin - ) + LazyMixin, + Iterable, + 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 + # 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): + + 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+'/'): + 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 set_object(self, object, logmsg = None): + def set_object(self, object, logmsg=None): """Special version which checks if the head-log needs an update as well""" oldbinsha = None head = HEAD(self.repo) if logmsg is not None: if not head.is_detached and head.ref == self: oldbinsha = self.commit.binsha - #END handle commit retrieval - #END handle message is set - + # 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 @@ -77,31 +80,30 @@ class Reference(SymbolicReference, LazyMixin, Iterable): # * scenarios (even 100% of the default ones). # */ head.log_append(oldbinsha, logmsg) - #END check if the head + # END check if the head # 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 + # 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): + 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): @@ -112,7 +114,7 @@ class Reference(SymbolicReference, LazyMixin, Iterable): tokens = self.path.split('/') # /refs/remotes/<remote name>/<branch_name> return tokens[2] - + @property @require_remote_ref_path def remote_head(self): @@ -121,5 +123,5 @@ class Reference(SymbolicReference, LazyMixin, Iterable): a branch""" tokens = self.path.split('/') return '/'.join(tokens[3:]) - + #} END remote interface diff --git a/git/refs/remote.py b/git/refs/remote.py index b4d72f6c..b601c8b2 100644 --- a/git/refs/remote.py +++ b/git/refs/remote.py @@ -1,34 +1,34 @@ import os from headref import Head from git.util import ( - join, - join_path - ) + 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): + 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. @@ -36,8 +36,8 @@ class RemoteReference(Head): 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 + # 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: diff --git a/git/refs/symbolic.py b/git/refs/symbolic.py index 450a0bd9..db429398 100644 --- a/git/refs/symbolic.py +++ b/git/refs/symbolic.py @@ -2,50 +2,52 @@ import os import re from git.objects import ( - Object, - Commit - ) + Object, + Commit +) from git.util import ( - join_path, - join_path_native, - to_native_path_linux, - assure_directory_exists, - join, - dirname, - isdir, - exists, - isfile, - rename, - hex_to_bin, - LockedFD - ) + join_path, + join_path_native, + to_native_path_linux, + assure_directory_exists, + join, + dirname, + isdir, + exists, + isfile, + rename, + hex_to_bin, + LockedFD +) from git.exc import BadObject from log import RefLog __all__ = ["SymbolicReference"] + class SymbolicReference(object): + """Represents a special case of a reference such that this reference is symbolic. It does not point to a specific commit, but to another Head, which itself specifies a commit. - + A typical example for a symbolic reference is HEAD.""" __slots__ = ("repo", "path") - + _resolve_ref_on_create = False _points_to_commits_only = True _common_path_default = "" _remote_common_path_default = "refs/remotes" _id_attribute_ = "name" - + re_hexsha_only = re.compile('^[0-9A-Fa-f]{40}$') - + #{ Configuration # Object class to be used when instantiating objects ObjectCls = Object CommitCls = Commit - + # all of the following are set by the package initializer HEADCls = None HeadCls = None @@ -53,28 +55,28 @@ class SymbolicReference(object): TagReferenceCls = None ReferenceCls = None #}END configuration - + def __init__(self, repo, path): self.repo = repo self.path = path - + def __str__(self): return self.path - + def __repr__(self): return '<git.%s "%s">' % (self.__class__.__name__, self.path) - + def __eq__(self, other): if hasattr(other, 'path'): return self.path == other.path return False - + def __ne__(self, other): - return not ( self == other ) - + return not (self == other) + def __hash__(self): return hash(self.path) - + @property def name(self): """ @@ -82,15 +84,15 @@ class SymbolicReference(object): In case of symbolic references, the shortest assumable name is the path itself.""" return self.path - + @property def abspath(self): return join_path_native(self.repo.git_dir, self.path) - + @classmethod def _get_packed_refs_path(cls, repo): return join(repo.git_dir, 'packed-refs') - + @classmethod def _iter_packed_refs(cls, repo): """Returns an iterator yielding pairs of sha1/path pairs for the corresponding refs. @@ -107,22 +109,22 @@ class SymbolicReference(object): # END abort if we do not understand the packing scheme continue # END parse comment - + # skip dereferenced tag object entries - previous line was actual # tag reference for it if line[0] == '^': continue - + yield tuple(line.split(' ', 1)) # END for each line - except (OSError,IOError): + except (OSError, IOError): raise StopIteration - # END no packed-refs file handling - # NOTE: Had try-finally block around here to close the fp, + # END no packed-refs file handling + # NOTE: Had try-finally block around here to close the fp, # but some python version woudn't allow yields within that. - # I believe files are closing themselves on destruction, so it is + # I believe files are closing themselves on destruction, so it is # alright. - + @classmethod def dereference_recursive(cls, repo, ref_path): """ @@ -134,7 +136,7 @@ class SymbolicReference(object): if hexsha is not None: return hexsha # END recursive dereferencing - + @classmethod def _get_ref_info(cls, repo, ref_path): """Return: (sha, target_ref_path) if available, the sha the file at @@ -146,36 +148,37 @@ class SymbolicReference(object): value = fp.read().rstrip() fp.close() tokens = value.split(" ") - except (OSError,IOError): + except (OSError, IOError): # Probably we are just packed, find our entry in the packed refs file # NOTE: We are not a symbolic ref if we are in a packed file, as these # are excluded explictly for sha, path in cls._iter_packed_refs(repo): - if path != ref_path: continue + if path != ref_path: + continue tokens = (sha, path) break # END for each packed ref # END handle packed refs if tokens is None: raise ValueError("Reference at %r does not exist" % ref_path) - + # is it a reference ? if tokens[0] == 'ref:': return (None, tokens[1]) - + # its a commit if cls.re_hexsha_only.match(tokens[0]): return (tokens[0], None) - + raise ValueError("Failed to parse reference information from %r" % ref_path) - + def _get_object_sha(self): """ :return: The binary sha to the object our ref currently refers to. Refs can be cached, they will always point to the actual object as it gets re-created on each query""" return hex_to_bin(self.dereference_recursive(self.repo, self.path)) - + def _get_object(self): """ :return: @@ -183,11 +186,11 @@ class SymbolicReference(object): # have to be dynamic here as we may be a tag which can point to anything # Our path will be resolved to the hexsha which will be used accordingly return self.ObjectCls.new_from_sha(self.repo, self._get_object_sha()) - - def set_object(self, object_id, logmsg = None): + + def set_object(self, object_id, logmsg=None): """Set the object we point to, possibly dereference our symbolic reference first. If the reference does not exist, it will be created - + :param object: a reference specifier string, a SymbolicReference or an object hex sha. SymbolicReferences will be dereferenced beforehand to obtain the object they point to :param logmsg: If not None, the message will be used in the reflog entry to be @@ -196,21 +199,21 @@ class SymbolicReference(object): :return: self""" if isinstance(object_id, SymbolicReference): object = object.object - #END resolve references - + # END resolve references + is_detached = True try: is_detached = self.is_detached except ValueError: pass # END handle non-existing ones - + if is_detached: return self.set_reference(object_id, logmsg) - + # set the commit on our reference return self._get_reference().set_object(object_id, logmsg) - + def _get_commit(self): """ :return: @@ -219,16 +222,16 @@ class SymbolicReference(object): obj = self._get_object() if obj.type == 'tag': obj = obj.object - #END dereference tag - + # END dereference tag + if obj.type != self.CommitCls.type: raise TypeError("Symbolic Reference pointed to object %r, commit was required" % obj) - #END handle type + # END handle type return obj - - def set_commit(self, commit, logmsg = None): + + def set_commit(self, commit, logmsg=None): """As set_object, but restricts the type of object to be a Commit - + :raise ValueError: If commit is not a Commit object or doesn't point to a commit :return: self""" @@ -243,23 +246,22 @@ class SymbolicReference(object): is_invalid_type = self.repo.resolve_object(commit).type != self.CommitCls.type except BadObject: raise ValueError("Invalid object: %s" % commit) - #END handle exception + # END handle exception # END verify type - + if is_invalid_type: raise ValueError("Need commit, got %r" % commit) - #END handle raise - + # END handle raise + # we leave strings to the rev-parse method below self.set_object(commit, logmsg) - + return self - - + commit = property(_get_commit, set_commit, doc="Query or set commits directly") object = property(_get_object, set_object, doc="Return the object our ref currently refers to") object_binsha = property(_get_object_sha, set_object, doc="Return the object our ref currently refers to") - + def _get_reference(self): """:return: Reference Object we point to :raise TypeError: If this symbolic reference is detached, hence it doesn't point @@ -268,22 +270,22 @@ class SymbolicReference(object): if target_ref_path is None: raise TypeError("%s is a detached symbolic reference as it points to %r" % (self, sha)) return self.from_path(self.repo, target_ref_path) - - def set_reference(self, ref, logmsg = None): + + def set_reference(self, ref, logmsg=None): """Set ourselves to the given ref. It will stay a symbol if the ref is a Reference. Otherwise an Object, given as Object instance or refspec, is assumed and if valid, will be set which effectively detaches the refererence if it was a purely symbolic one. - + :param ref: SymbolicReference instance, hexadecimal sha string or refspec string Only if the ref is a SymbolicRef instance, we will point to it. Everthiny else is dereferenced to obtain the actual object. :param logmsg: If set to a string, the message will be used in the reflog. Otherwise, a reflog entry is not written for the changed reference. The previous commit of the entry will be the commit we point to now. - + See also: log_append() - + :return: self :note: This symbolic reference will not be dereferenced. For that, see ``set_object(...)``""" @@ -296,7 +298,7 @@ class SymbolicReference(object): write_value = ref.hexsha elif isinstance(ref, basestring): try: - obj = self.repo.resolve_object(ref+"^{}") # optionally deref tags + obj = self.repo.resolve_object(ref + "^{}") # optionally deref tags write_value = obj.hexsha except BadObject: raise ValueError("Could not extract object from %s" % ref) @@ -304,41 +306,40 @@ class SymbolicReference(object): else: raise ValueError("Unrecognized Value: %r" % ref) # END try commit attribute - + # typecheck if obj is not None and self._points_to_commits_only and obj.type != Commit.type: raise TypeError("Require commit, got %r" % obj) - #END verify type - + # END verify type + oldbinsha = None if logmsg is not None: try: oldbinsha = self.commit.binsha except ValueError: oldbinsha = Commit.NULL_BIN_SHA - #END handle non-existing - #END retrieve old hexsha - + # END handle non-existing + # END retrieve old hexsha + fpath = self.abspath assure_directory_exists(fpath, is_file=True) - + lfd = LockedFD(fpath) fd = lfd.open(write=True, stream=True) fd.write(write_value) lfd.commit() - + # Adjust the reflog if logmsg is not None: self.log_append(oldbinsha, logmsg) - #END handle reflog - + # END handle reflog + return self - # aliased reference reference = property(_get_reference, set_reference, doc="Returns the Reference we point to") ref = reference - + def is_valid(self): """ :return: @@ -350,7 +351,7 @@ class SymbolicReference(object): return False else: return True - + @property def is_detached(self): """ @@ -362,32 +363,32 @@ class SymbolicReference(object): return False except TypeError: return True - + def log(self): """ :return: RefLog for this reference. Its last entry reflects the latest change applied to this reference - + .. note:: As the log is parsed every time, its recommended to cache it for use instead of calling this method repeatedly. It should be considered read-only.""" return RefLog.from_file(RefLog.path(self)) - + def log_append(self, oldbinsha, message, newbinsha=None): """Append a logentry to the logfile of this ref - + :param oldbinsha: binary sha this ref used to point to :param message: A message describing the change :param newbinsha: The sha the ref points to now. If None, our current commit sha will be used :return: added RefLogEntry instance""" - return RefLog.append_entry(self.repo.config_reader(), RefLog.path(self), oldbinsha, - (newbinsha is None and self.commit.binsha) or newbinsha, - message) + return RefLog.append_entry(self.repo.config_reader(), RefLog.path(self), oldbinsha, + (newbinsha is None and self.commit.binsha) or newbinsha, + message) def log_entry(self, index): """:return: RefLogEntry at the given index :param index: python list compatible positive or negative index - + .. note:: This method must read part of the reflog during execution, hence it should be used sparringly, or only if you need just one index. In that case, it will be faster than the ``log()`` method""" @@ -403,17 +404,17 @@ class SymbolicReference(object): full_ref_path = path if not cls._common_path_default: return full_ref_path - if not path.startswith(cls._common_path_default+"/"): + if not path.startswith(cls._common_path_default + "/"): full_ref_path = '%s/%s' % (cls._common_path_default, path) return full_ref_path - + @classmethod def delete(cls, repo, path): """Delete the reference at the given path - + :param repo: Repository to delete the reference from - + :param path: Short or full path pointing to the reference, i.e. refs/myreference or just "myreference", hence 'refs/' is implied. @@ -427,30 +428,30 @@ class SymbolicReference(object): pack_file_path = cls._get_packed_refs_path(repo) try: reader = open(pack_file_path, 'rb') - except (OSError,IOError): - pass # it didnt exist at all + except (OSError, IOError): + pass # it didnt exist at all else: new_lines = list() made_change = False dropped_last_line = False for line in reader: - # keep line if it is a comment or if the ref to delete is not + # keep line if it is a comment or if the ref to delete is not # in the line - # If we deleted the last line and this one is a tag-reference object, + # If we deleted the last line and this one is a tag-reference object, # we drop it as well if ( line.startswith('#') or full_ref_path not in line ) and \ - ( not dropped_last_line or dropped_last_line and not line.startswith('^') ): + (not dropped_last_line or dropped_last_line and not line.startswith('^')): new_lines.append(line) dropped_last_line = False continue # END skip comments and lines without our path - + # drop this line made_change = True dropped_last_line = True # END for each line in packed refs reader.close() - + # write the new lines if made_change: # write-binary is required, otherwise windows will @@ -459,14 +460,13 @@ class SymbolicReference(object): # END write out file # END open exception handling # END handle deletion - + # delete the reflog reflog_path = RefLog.path(cls(repo, full_ref_path)) if os.path.isfile(reflog_path): os.remove(reflog_path) - #END remove reflog - - + # END remove reflog + @classmethod def _create(cls, repo, path, resolve, reference, force, logmsg=None): """internal method used to create a new symbolic reference. @@ -476,7 +476,7 @@ class SymbolicReference(object): instead""" full_ref_path = cls.to_full_path(path) abs_ref_path = join(repo.git_dir, full_ref_path) - + # figure out target data target = reference if resolve: @@ -488,125 +488,126 @@ class SymbolicReference(object): target = reference.object.hexsha else: target = repo.resolve_object(str(reference)) - #END handle resoltion - #END need resolution - + # END handle resoltion + # END need resolution + if not force and isfile(abs_ref_path): target_data = str(target) if isinstance(target, SymbolicReference): target_data = target.path if not resolve: target_data = "ref: " + target_data - existing_data = open(abs_ref_path, 'rb').read().strip() + existing_data = open(abs_ref_path, 'rb').read().strip() if existing_data != target_data: - raise OSError("Reference at %r does already exist, pointing to %r, requested was %r" % (full_ref_path, existing_data, target_data)) + raise OSError("Reference at %r does already exist, pointing to %r, requested was %r" % + (full_ref_path, existing_data, target_data)) # END no force handling - + ref = cls(repo, full_ref_path) ref.set_reference(target, logmsg) return ref - + @classmethod def create(cls, repo, path, reference='HEAD', force=False, logmsg=None): """Create a new symbolic reference, hence a reference pointing to another reference. - + :param repo: Repository to create the reference in - + :param path: full path at which the new symbolic reference is supposed to be created at, i.e. "NEW_HEAD" or "symrefs/my_new_symref" - + :param reference: The reference to which the new symbolic reference should point to. If it is a commit'ish, the symbolic ref will be detached. - + :param force: if True, force creation even if a symbolic reference with that name already exists. Raise OSError otherwise - + :param logmsg: If not None, the message to append to the reflog. Otherwise no reflog entry is written. - + :return: Newly created symbolic Reference - + :raise OSError: If a (Symbolic)Reference with the same name but different contents already exists. - + :note: This does not alter the current HEAD, index or Working Tree""" return cls._create(repo, path, cls._resolve_ref_on_create, reference, force, logmsg) - + def rename(self, new_path, force=False): """Rename self to a new path - + :param new_path: Either a simple name or a full path, i.e. new_name or features/new_name. The prefix refs/ is implied for references and will be set as needed. In case this is a symbolic ref, there is no implied prefix - + :param force: If True, the rename will succeed even if a head with the target name already exists. It will be overwritten in that case - + :return: self :raise OSError: In case a file at path but a different contents already exists """ new_path = self.to_full_path(new_path) if self.path == new_path: return self - + new_abs_path = join(self.repo.git_dir, new_path) cur_abs_path = join(self.repo.git_dir, self.path) if isfile(new_abs_path): if not force: # if they point to the same file, its not an error - if open(new_abs_path,'rb').read().strip() != open(cur_abs_path,'rb').read().strip(): + if open(new_abs_path, 'rb').read().strip() != open(cur_abs_path, 'rb').read().strip(): raise OSError("File at path %r already exists" % new_abs_path) - # else: we could remove ourselves and use the otherone, but + # else: we could remove ourselves and use the otherone, but # but clarity we just continue as usual # END not force handling os.remove(new_abs_path) # END handle existing target file - + dname = dirname(new_abs_path) if not isdir(dname): os.makedirs(dname) # END create directory - + rename(cur_abs_path, new_abs_path) self.path = new_path - + return self - + @classmethod - def _iter_items(cls, repo, common_path = None): + def _iter_items(cls, repo, common_path=None): if common_path is None: common_path = cls._common_path_default rela_paths = set() - + # walk loose refs - # Currently we do not follow links + # Currently we do not follow links for root, dirs, files in os.walk(join_path_native(repo.git_dir, common_path)): - if 'refs/' not in root: # skip non-refs subfolders - refs_id = [ d for d in dirs if d == 'refs' ] + if 'refs/' not in root: # skip non-refs subfolders + refs_id = [d for d in dirs if d == 'refs'] if refs_id: dirs[0:] = ['refs'] # END prune non-refs folders - + for f in files: abs_path = to_native_path_linux(join_path(root, f)) rela_paths.add(abs_path.replace(to_native_path_linux(repo.git_dir) + '/', "")) # END for each file in root directory # END for each directory to walk - + # read packed refs for sha, rela_path in cls._iter_packed_refs(repo): if rela_path.startswith(common_path): rela_paths.add(rela_path) # END relative path matches common path # END packed refs reading - + # return paths in sorted order for path in sorted(rela_paths): try: @@ -614,9 +615,9 @@ class SymbolicReference(object): except ValueError: continue # END for each sorted relative refpath - + @classmethod - def iter_items(cls, repo, common_path = None): + def iter_items(cls, repo, common_path=None): """Find all refs in the repository :param repo: is the repo @@ -630,11 +631,11 @@ class SymbolicReference(object): :return: git.SymbolicReference[], each of them is guaranteed to be a *only* a symbolic ref, or a derived class which is not detached - + List is lexigraphically sorted The returned objects represent actual subclasses, such as Head or TagReference""" - return ( r for r in cls._iter_items(repo, common_path) if r.__class__ == cls or not r.is_detached ) - + return (r for r in cls._iter_items(repo, common_path) if r.__class__ == cls or not r.is_detached) + @classmethod def from_path(cls, repo, path): """ @@ -645,7 +646,7 @@ class SymbolicReference(object): depending on the given path""" if not path: raise ValueError("Cannot create Reference from %r" % path) - + for ref_type in (cls.HEADCls, cls.HeadCls, cls.RemoteReferenceCls, cls.TagReferenceCls, cls.ReferenceCls, cls): try: instance = ref_type(repo, path) diff --git a/git/refs/tag.py b/git/refs/tag.py index 1fcdb903..25f42ed4 100644 --- a/git/refs/tag.py +++ b/git/refs/tag.py @@ -2,21 +2,23 @@ from reference import Reference __all__ = ["TagReference", "Tag"] + class TagReference(Reference): + """Class representing a lightweight tag reference which either points to a commit ,a tag object or any other object. In the latter case additional information, like the signature or the tag-creator, is available. - + This tag object will always point to a commit object, but may carray additional information in a tag object:: - + tagref = TagReference.list_items(repo)[0] print tagref.commit.message if tagref.tag is not None: print tagref.tag.message""" __slots__ = tuple() _common_path_default = "refs/tags" - + @property def commit(self): """:return: Commit object the tag ref points to""" @@ -27,7 +29,7 @@ class TagReference(Reference): # it is a tag object which carries the commit as an object - we can point to anything return obj.object else: - raise ValueError( "Tag %s points to a Blob or Tree - have never seen that before" % self ) + raise ValueError("Tag %s points to a Blob or Tree - have never seen that before" % self) @property def tag(self): @@ -38,49 +40,49 @@ class TagReference(Reference): if obj.type == "tag": return obj return None - + # make object read-only # It should be reasonably hard to adjust an existing tag object = property(Reference._get_object) - + @classmethod def create(cls, repo, path, ref='HEAD', message=None, force=False, **kwargs): """Create a new tag reference. - + :param path: The name of the tag, i.e. 1.0 or releases/1.0. The prefix refs/tags is implied - + :param ref: A reference to the object you want to tag. It can be a commit, tree or blob. - + :param message: If not None, the message will be used in your tag object. This will also create an additional tag object that allows to obtain that information, i.e.:: - + tagref.tag.message - + :param force: If True, to force creation of a tag even though that tag already exists. - + :param kwargs: Additional keyword arguments to be passed to git-tag - + :return: A new TagReference""" - args = ( path, ref ) + args = (path, ref) if message: - kwargs['m'] = message + kwargs['m'] = message if force: kwargs['f'] = True - + repo.git.tag(*args, **kwargs) return TagReference(repo, "%s/%s" % (cls._common_path_default, path)) - + @classmethod def delete(cls, repo, *tags): """Delete the given existing tag or tags""" repo.git.tag("-d", *tags) - + # provide an alias Tag = TagReference |