diff options
| author | Sebastian Thiel <byronimo@gmail.com> | 2014-11-17 10:14:43 +0100 |
|---|---|---|
| committer | Sebastian Thiel <byronimo@gmail.com> | 2014-11-17 10:14:43 +0100 |
| commit | e4d8fb73daa82420bdc69c37f0d58f7cb4cd505a (patch) | |
| tree | 38e1241fd6d756f783b6b56dc6628ac3ca41ed4f /git/refs/tag.py | |
| parent | 7aba59a2609ec768d5d495dafd23a4bce8179741 (diff) | |
| parent | c8e70749887370a99adeda972cc3503397b5f9a7 (diff) | |
| download | GitPython-e4d8fb73daa82420bdc69c37f0d58f7cb4cd505a.tar.gz GitPython-e4d8fb73daa82420bdc69c37f0d58f7cb4cd505a.zip | |
Merge pull request #204 from hashar/pep8-linting
Pep8 linting
Diffstat (limited to 'git/refs/tag.py')
| -rw-r--r-- | git/refs/tag.py | 55 |
1 files changed, 27 insertions, 28 deletions
diff --git a/git/refs/tag.py b/git/refs/tag.py index d78d7750..50d2b2af 100644 --- a/git/refs/tag.py +++ b/git/refs/tag.py @@ -3,23 +3,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, + + """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""" @@ -30,62 +30,61 @@ 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): """ - :return: Tag object this tag ref points to or None in case + :return: Tag object this tag ref points to or None in case we are a light weight tag""" obj = self.object 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 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 + 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 + 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 |
