From f5d11b750ecc982541d1f936488248f0b42d75d3 Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Sun, 16 Nov 2014 20:15:50 +0100 Subject: pep8 linting (whitespaces) W191 indentation contains tabs E221 multiple spaces before operator E222 multiple spaces after operator E225 missing whitespace around operator E271 multiple spaces after keyword W292 no newline at end of file W293 blank line contains whitespace W391 blank line at end of file --- git/refs/head.py | 90 +++++++++++++++++++++++++++----------------------------- 1 file changed, 44 insertions(+), 46 deletions(-) (limited to 'git/refs/head.py') diff --git a/git/refs/head.py b/git/refs/head.py index 6e4879fe..1b3e7f00 100644 --- a/git/refs/head.py +++ b/git/refs/head.py @@ -10,75 +10,75 @@ from git.exc import GitCommandError __all__ = ["HEAD", "Head"] - + class HEAD(SymbolicReference): """Special case of a Symbolic Reference as it represents the repository's HEAD reference.""" _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): """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") - + # 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: @@ -87,9 +87,9 @@ class HEAD(SymbolicReference): if e.status != 1: raise # END handle exception - + return self - + class Head(Reference): """A Head is a named reference to a Commit. Every Head instance contains a name @@ -111,7 +111,7 @@ class Head(Reference): _common_path_default = "refs/heads" k_config_remote = "remote" k_config_remote_ref = "merge" # branch to merge from remote - + @classmethod def delete(cls, repo, *heads, **kwargs): """Delete the given heads @@ -124,19 +124,19 @@ class Head(Reference): if force: flag = "-D" repo.git.branch(flag, *heads) - + 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, RemoteReference): 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) @@ -148,10 +148,10 @@ 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 @@ -162,50 +162,50 @@ class Head(Reference): remote_refpath = RemoteReference.to_full_path(join_path(reader.get_value(self.k_config_remote), ref.name)) return RemoteReference(self.repo, remote_refpath) # END handle have tracking branch - + # we are not a tracking branch return None - + 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 @@ -214,33 +214,31 @@ class Head(Reference): kwargs['f'] = force if kwargs['f'] == False: kwargs.pop('f') - + self.repo.git.checkout(self, **kwargs) return self.repo.active_branch - + #{ 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 - + #} END configuration -- cgit v1.2.3 From be34ec23c48d6d5d8fd2ef4491981f6fb4bab8e6 Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Sun, 16 Nov 2014 20:51:04 +0100 Subject: pep8 linting (blank lines expectations) E301 expected 1 blank line, found 0 E302 expected 2 blank lines, found 1 E303 too many blank lines (n) --- git/refs/head.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'git/refs/head.py') diff --git a/git/refs/head.py b/git/refs/head.py index 1b3e7f00..662c2c87 100644 --- a/git/refs/head.py +++ b/git/refs/head.py @@ -10,8 +10,8 @@ from git.exc import GitCommandError __all__ = ["HEAD", "Head"] - class HEAD(SymbolicReference): + """Special case of a Symbolic Reference as it represents the repository's HEAD reference.""" _HEAD_NAME = 'HEAD' @@ -92,6 +92,7 @@ class HEAD(SymbolicReference): class Head(Reference): + """A Head is a named reference to a Commit. Every Head instance contains a name and a Commit object. @@ -151,7 +152,6 @@ class Head(Reference): return self - def tracking_branch(self): """ :return: The remote_reference we are tracking, or None if we are -- cgit v1.2.3 From 614907b7445e2ed8584c1c37df7e466e3b56170f Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Sun, 16 Nov 2014 20:56:53 +0100 Subject: pep8 linting (whitespace before/after) E201 whitespace after '(' E202 whitespace before ')' E203 whitespace before ':' E225 missing whitespace around operator E226 missing whitespace around arithmetic operator E227 missing whitespace around bitwise or shift operator E228 missing whitespace around modulo operator E231 missing whitespace after ',' E241 multiple spaces after ',' E251 unexpected spaces around keyword / parameter equals --- git/refs/head.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'git/refs/head.py') diff --git a/git/refs/head.py b/git/refs/head.py index 662c2c87..958f83fa 100644 --- a/git/refs/head.py +++ b/git/refs/head.py @@ -29,7 +29,7 @@ class HEAD(SymbolicReference): 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, + 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 @@ -71,7 +71,7 @@ class HEAD(SymbolicReference): 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 -- cgit v1.2.3 From c8e70749887370a99adeda972cc3503397b5f9a7 Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Sun, 16 Nov 2014 21:09:47 +0100 Subject: pep8 linting (trailing whitespace) W291 trailing whitespace --- git/refs/head.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'git/refs/head.py') diff --git a/git/refs/head.py b/git/refs/head.py index 958f83fa..2ef7c23e 100644 --- a/git/refs/head.py +++ b/git/refs/head.py @@ -12,7 +12,7 @@ __all__ = ["HEAD", "Head"] class HEAD(SymbolicReference): - """Special case of a Symbolic Reference as it represents the repository's + """Special case of a Symbolic Reference as it represents the repository's HEAD reference.""" _HEAD_NAME = 'HEAD' _ORIG_HEAD_NAME = 'ORIG_HEAD' @@ -25,18 +25,18 @@ class HEAD(SymbolicReference): def orig_head(self): """ - :return: SymbolicReference pointing at the ORIG_HEAD, which is maintained + :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, + 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 + """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 + Commit object, Reference Object or string identifying a revision we should reset HEAD to. :param index: @@ -53,7 +53,7 @@ class HEAD(SymbolicReference): that are to be reset. This allows to partially reset individual files. :param kwargs: - Additional arguments passed to git-reset. + Additional arguments passed to git-reset. :return: self""" mode = "--soft" @@ -131,7 +131,7 @@ class Head(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 + :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, RemoteReference): @@ -154,7 +154,7 @@ class Head(Reference): def tracking_branch(self): """ - :return: The remote_reference we are tracking, or None if we are + :return: The remote_reference we are tracking, or None if we are not a tracking branch""" reader = self.config_reader() if reader.has_option(self.k_config_remote) and reader.has_option(self.k_config_remote_ref): @@ -189,7 +189,7 @@ class Head(Reference): 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 + 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. @@ -231,7 +231,7 @@ class Head(Reference): def config_reader(self): """ - :return: A configuration parser instance constrained to only read + :return: A configuration parser instance constrained to only read this instance's values""" return self._config_parser(read_only=True) -- cgit v1.2.3