src: No PyDev warnings

ankostis · ankostis · commit c7f459f7cca3 · 2016-10-04T01:50:28.000+02:00
+ Mark all unused vars and other non-pep8  (PyDev) warnings
+ test_utils:
  + enable &amp; fix forgotten IterableList looped path.
  + unittestize all assertions.
diff --git a/git/__init__.py b/git/__init__.py
@@ -4,7 +4,7 @@
 # This module is part of GitPython and is released under
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
 # flake8: noqa
-
+#@PydevCodeAnalysisIgnore
 import os
 import sys
 import inspect
@@ -32,17 +32,17 @@ def _init_externals():
 
 #{ Imports
 
-from git.config import GitConfigParser
-from git.objects import *
-from git.refs import *
-from git.diff import *
-from git.exc import *
-from git.db import *
-from git.cmd import Git
-from git.repo import Repo
-from git.remote import *
-from git.index import *
-from git.util import (
+from git.config import GitConfigParser  # @NoMove @IgnorePep8
+from git.objects import *               # @NoMove @IgnorePep8
+from git.refs import *                  # @NoMove @IgnorePep8
+from git.diff import *                  # @NoMove @IgnorePep8
+from git.exc import *                   # @NoMove @IgnorePep8
+from git.db import *                    # @NoMove @IgnorePep8
+from git.cmd import Git                 # @NoMove @IgnorePep8
+from git.repo import Repo               # @NoMove @IgnorePep8
+from git.remote import *                # @NoMove @IgnorePep8
+from git.index import *                 # @NoMove @IgnorePep8
+from git.util import (                  # @NoMove @IgnorePep8
     LockFile,
     BlockingLockFile,
     Stats,
diff --git a/git/index/base.py b/git/index/base.py
@@ -170,7 +170,7 @@ def _delete_entries_cache(self):
 
     def _deserialize(self, stream):
         """Initialize this instance with index values read from the given stream"""
-        self.version, self.entries, self._extension_data, conten_sha = read_cache(stream)
+        self.version, self.entries, self._extension_data, conten_sha = read_cache(stream)  # @UnusedVariable
         return self
 
     def _entries_sorted(self):
@@ -404,7 +404,7 @@ def raise_exc(e):
                     continue
             # END glob handling
             try:
-                for root, dirs, files in os.walk(abs_path, onerror=raise_exc):
+                for root, dirs, files in os.walk(abs_path, onerror=raise_exc):  # @UnusedVariable
                     for rela_file in files:
                         # add relative paths only
                         yield os.path.join(root.replace(rs, ''), rela_file)
@@ -599,7 +599,6 @@ def _store_path(self, filepath, fprogress):
         """Store file at filepath in the database and return the base index entry
         Needs the git_working_dir decorator active ! This must be assured in the calling code"""
         st = os.lstat(filepath)     # handles non-symlinks as well
-        stream = None
         if S_ISLNK(st.st_mode):
             # in PY3, readlink is string, but we need bytes. In PY2, it's just OS encoded bytes, we assume UTF-8
             open_stream = lambda: BytesIO(force_bytes(os.readlink(filepath), encoding=defenc))
diff --git a/git/index/fun.py b/git/index/fun.py
@@ -264,7 +264,7 @@ def write_tree_from_cache(entries, odb, sl, si=0):
 
             # enter recursion
             # ci - 1 as we want to count our current item as well
-            sha, tree_entry_list = write_tree_from_cache(entries, odb, slice(ci - 1, xi), rbound + 1)
+            sha, tree_entry_list = write_tree_from_cache(entries, odb, slice(ci - 1, xi), rbound + 1)  # @UnusedVariable
             tree_items_append((sha, S_IFDIR, base))
 
             # skip ahead
diff --git a/git/objects/__init__.py b/git/objects/__init__.py
@@ -3,22 +3,24 @@
 """
 # flake8: noqa
 from __future__ import absolute_import
+
 import inspect
+
 from .base import *
+from .blob import *
+from .commit import *
+from .submodule import util as smutil
+from .submodule.base import *
+from .submodule.root import *
+from .tag import *
+from .tree import *
 # Fix import dependency - add IndexObject to the util module, so that it can be
 # imported by the submodule.base
-from .submodule import util as smutil
 smutil.IndexObject = IndexObject
 smutil.Object = Object
 del(smutil)
-from .submodule.base import *
-from .submodule.root import *
 
 # must come after submodule was made available
-from .tag import *
-from .blob import *
-from .commit import *
-from .tree import *
 
 __all__ = [name for name, obj in locals().items()
            if not (name.startswith('_') or inspect.ismodule(obj))]
diff --git a/git/objects/base.py b/git/objects/base.py
@@ -40,7 +40,7 @@ def __init__(self, repo, binsha):
         assert len(binsha) == 20, "Require 20 byte binary sha, got %r, len = %i" % (binsha, len(binsha))
 
     @classmethod
-    def new(cls, repo, id):
+    def new(cls, repo, id):  # @ReservedAssignment
         """
         :return: New Object instance of a type appropriate to the object type behind
             id. The id of the newly created object will be a binsha even though
diff --git a/git/objects/commit.py b/git/objects/commit.py
@@ -140,7 +140,7 @@ def _get_intermediate_items(cls, commit):
     def _set_cache_(self, attr):
         if attr in Commit.__slots__:
             # read the data in a chunk, its faster - then provide a file wrapper
-            binsha, typename, self.size, stream = self.repo.odb.stream(self.binsha)
+            binsha, typename, self.size, stream = self.repo.odb.stream(self.binsha)  # @UnusedVariable
             self._deserialize(BytesIO(stream.read()))
         else:
             super(Commit, self)._set_cache_(attr)
@@ -267,7 +267,7 @@ def _iter_from_process_or_stream(cls, repo, proc_or_stream):
             hexsha = line.strip()
             if len(hexsha) > 40:
                 # split additional information, as returned by bisect for instance
-                hexsha, rest = line.split(None, 1)
+                hexsha, _ = line.split(None, 1)
             # END handle extra info
 
             assert len(hexsha) == 40, "Invalid line: %s" % hexsha
diff --git a/git/refs/reference.py b/git/refs/reference.py
@@ -50,7 +50,7 @@ def __str__(self):
 
     #{ Interface
 
-    def set_object(self, object, logmsg=None):
+    def set_object(self, object, logmsg=None):  # @ReservedAssignment
         """Special version which checks if the head-log needs an update as well
         :return: self"""
         oldbinsha = None
diff --git a/git/refs/symbolic.py b/git/refs/symbolic.py
@@ -218,7 +218,7 @@ def set_commit(self, commit, logmsg=None):
 
         return self
 
-    def set_object(self, object, logmsg=None):
+    def set_object(self, object, logmsg=None):  # @ReservedAssignment
         """Set the object we point to, possibly dereference our symbolic reference first.
         If the reference does not exist, it will be created
 
@@ -229,7 +229,7 @@ def set_object(self, object, logmsg=None):
         :note: plain SymbolicReferences may not actually point to objects by convention
         :return: self"""
         if isinstance(object, SymbolicReference):
-            object = object.object
+            object = object.object  # @ReservedAssignment
         # END resolve references
 
         is_detached = True
diff --git a/git/repo/fun.py b/git/repo/fun.py
@@ -284,7 +284,7 @@ def rev_parse(repo, rev):
         try:
             if token == "~":
                 obj = to_commit(obj)
-                for item in xrange(num):
+                for _ in xrange(num):
                     obj = obj.parents[0]
                 # END for each history item to walk
             elif token == "^":
diff --git a/git/test/lib/asserts.py b/git/test/lib/asserts.py
@@ -8,18 +8,18 @@
 import stat
 
 from nose.tools import (
-    assert_equal,
-    assert_not_equal,
-    assert_raises,
-    raises,
-    assert_true,
-    assert_false
+    assert_equal,       # @UnusedImport
+    assert_not_equal,   # @UnusedImport
+    assert_raises,      # @UnusedImport
+    raises,             # @UnusedImport
+    assert_true,        # @UnusedImport
+    assert_false        # @UnusedImport
 )
 
 try:
     from unittest.mock import patch
 except ImportError:
-    from mock import patch
+    from mock import patch  # @NoMove @UnusedImport
 
 __all__ = ['assert_instance_of', 'assert_not_instance_of',
            'assert_none', 'assert_not_none',
diff --git a/git/test/performance/test_streams.py b/git/test/performance/test_streams.py
@@ -120,7 +120,7 @@ def test_large_data_streaming(self, rwrepo):
 
             # read all
             st = time()
-            s, t, size, data = rwrepo.git.get_object_data(gitsha)
+            hexsha, otype, size, data = rwrepo.git.get_object_data(gitsha)  # @UnusedVariable
             gelapsed_readall = time() - st
             print("Read %i KiB of %s data at once using git-cat-file in %f s ( %f Read KiB / s)"
                   % (size_kib, desc, gelapsed_readall, size_kib / gelapsed_readall), file=sys.stderr)
@@ -131,7 +131,7 @@ def test_large_data_streaming(self, rwrepo):
 
             # read chunks
             st = time()
-            s, t, size, stream = rwrepo.git.stream_object_data(gitsha)
+            hexsha, otype, size, stream = rwrepo.git.stream_object_data(gitsha)  # @UnusedVariable
             while True:
                 data = stream.read(cs)
                 if len(data) < cs:
diff --git a/git/test/test_commit.py b/git/test/test_commit.py
@@ -123,7 +123,7 @@ def check_entries(d):
         check_entries(stats.total)
         assert "files" in stats.total
 
-        for filepath, d in stats.files.items():
+        for filepath, d in stats.files.items():  # @UnusedVariable
             check_entries(d)
         # END for each stated file
 
diff --git a/git/test/test_docs.py b/git/test/test_docs.py
@@ -70,7 +70,8 @@ def test_init_repo_object(self, rw_dir):
         # heads, tags and references
         # heads are branches in git-speak
         # [8-test_init_repo_object]
-        self.assertEqual(repo.head.ref, repo.heads.master)                  # head is a sym-ref pointing to master
+        self.assertEqual(repo.head.ref, repo.heads.master,  # head is a sym-ref pointing to master
+                         "It's ok if TC not running from `master`.")
         self.assertEqual(repo.tags['0.3.5'], repo.tag('refs/tags/0.3.5'))   # you can access tags in various ways too
         self.assertEqual(repo.refs.master, repo.heads['master'])            # .refs provides all refs, ie heads ...
 
@@ -242,9 +243,9 @@ def test_references_and_objects(self, rw_dir):
         # [8-test_references_and_objects]
         hc = repo.head.commit
         hct = hc.tree
-        hc != hct
-        hc != repo.tags[0]
-        hc == repo.head.reference.commit
+        hc != hct                           # @NoEffect
+        hc != repo.tags[0]                  # @NoEffect
+        hc == repo.head.reference.commit    # @NoEffect
         # ![8-test_references_and_objects]
 
         # [9-test_references_and_objects]
@@ -347,7 +348,7 @@ def test_references_and_objects(self, rw_dir):
         # The index contains all blobs in a flat list
         assert len(list(index.iter_blobs())) == len([o for o in repo.head.commit.tree.traverse() if o.type == 'blob'])
         # Access blob objects
-        for (path, stage), entry in index.entries.items():
+        for (path, stage), entry in index.entries.items():  # @UnusedVariable
             pass
         new_file_path = os.path.join(repo.working_tree_dir, 'new-file-name')
         open(new_file_path, 'w').close()
diff --git a/git/test/test_exc.py b/git/test/test_exc.py
@@ -30,12 +30,12 @@
 )
 _causes_n_substrings = (
     (None,                      None),                          # noqa: E241
-    (7,                         "exit code(7)"),                           # noqa: E241
+    (7,                         "exit code(7)"),                # noqa: E241
     ('Some string',             "'Some string'"),               # noqa: E241
     ('παλιο string',            "'παλιο string'"),              # noqa: E241
     (Exception("An exc."),      "Exception('An exc.')"),        # noqa: E241
     (Exception("Κακια exc."),   "Exception('Κακια exc.')"),     # noqa: E241
-    (object(),                  "<object object at "),         # noqa: E241
+    (object(),                  "<object object at "),          # noqa: E241
 )
 
 _streams_n_substrings = (None, 'steram', 'ομορφο stream', )
diff --git a/git/test/test_git.py b/git/test/test_git.py
@@ -121,7 +121,7 @@ def test_persistent_cat_file_command(self):
 
         # read data - have to read it in one large chunk
         size = int(obj_info.split()[2])
-        data = g.stdout.read(size)
+        g.stdout.read(size)
         g.stdout.read(1)
 
         # now we should be able to read a new object
@@ -131,7 +131,7 @@ def test_persistent_cat_file_command(self):
 
         # same can be achived using the respective command functions
         hexsha, typename, size = self.git.get_object_header(hexsha)
-        hexsha, typename_two, size_two, data = self.git.get_object_data(hexsha)
+        hexsha, typename_two, size_two, data = self.git.get_object_data(hexsha)  # @UnusedVariable
         self.assertEqual(typename, typename_two)
         self.assertEqual(size, size_two)
 
diff --git a/git/test/test_remote.py b/git/test/test_remote.py
@@ -90,7 +90,7 @@ def make_assertion(self):
         assert self._stages_per_op
 
         # must have seen all stages
-        for op, stages in self._stages_per_op.items():
+        for op, stages in self._stages_per_op.items():  # @UnusedVariable
             assert stages & self.STAGE_MASK == self.STAGE_MASK
         # END for each op/stage
 
@@ -331,7 +331,7 @@ def _assert_push_and_pull(self, remote, rw_repo, remote_repo):
         # push new tags
         progress = TestRemoteProgress()
         to_be_updated = "my_tag.1.0RV"
-        new_tag = TagReference.create(rw_repo, to_be_updated)
+        new_tag = TagReference.create(rw_repo, to_be_updated)  # @UnusedVariable
         other_tag = TagReference.create(rw_repo, "my_obj_tag.2.1aRV", message="my message")
         res = remote.push(progress=progress, tags=True)
         assert res[-1].flags & PushInfo.NEW_TAG
@@ -432,7 +432,7 @@ def test_base(self, rw_repo, remote_repo):
             assert remote.rename(other_name) == remote
             assert prev_name != remote.name
             # multiple times
-            for time in range(2):
+            for _ in range(2):
                 assert remote.rename(prev_name).name == prev_name
             # END for each rename ( back to prev_name )
 
diff --git a/git/test/test_repo.py b/git/test/test_repo.py
@@ -809,7 +809,7 @@ def last_commit(repo, rev, path):
         # And we expect to set max handles to a low value, like 64
         # You should set ulimit -n X, see .travis.yml
         # The loops below would easily create 500 handles if these would leak (4 pipes + multiple mapped files)
-        for i in range(64):
+        for _ in range(64):
             for repo_type in (GitCmdObjectDB, GitDB):
                 repo = Repo(self.rorepo.working_tree_dir, odbt=repo_type)
                 last_commit(repo, 'master', 'git/test/test_base.py')
diff --git a/git/test/test_submodule.py b/git/test/test_submodule.py
@@ -98,7 +98,7 @@ def _do_base_tests(self, rwrepo):
 
         # force it to reread its information
         del(smold._url)
-        smold.url == sm.url
+        smold.url == sm.url  # @NoEffect
 
         # test config_reader/writer methods
         sm.config_reader()
@@ -225,7 +225,7 @@ def _do_base_tests(self, rwrepo):
             assert csm.module_exists()
 
             # tracking branch once again
-            csm.module().head.ref.tracking_branch() is not None
+            csm.module().head.ref.tracking_branch() is not None  # @NoEffect
 
             # this flushed in a sub-submodule
             assert len(list(rwrepo.iter_submodules())) == 2
diff --git a/git/test/test_util.py b/git/test/test_util.py
diff --git a/git/util.py b/git/util.py
