Add option to skip the GC cycle on Repo close

emonty · emonty · commit 60ca325da68f · 2017-03-08T12:12:37.000-06:00
In large environment with thousands of repos and frequent repo opens and
closes, the cost of doing 2 full gc cycles on every Repo destruction can
become crippling.
diff --git a/git/repo/base.py b/git/repo/base.py
@@ -90,7 +90,10 @@ class Repo(object):
     # Subclasses may easily bring in their own custom types by placing a constructor or type here
     GitCommandWrapperType = Git
 
-    def __init__(self, path=None, odbt=DefaultDBType, search_parent_directories=False):
+    def __init__(
+            self, path=None, odbt=DefaultDBType,
+            search_parent_directories=False,
+            gc_on_close=True):
         """Create a new Repo instance
 
         :param path:
@@ -113,9 +116,15 @@ def __init__(self, path=None, odbt=DefaultDBType, search_parent_directories=Fals
 
             Please note that this was the default behaviour in older versions of GitPython,
             which is considered a bug though.
+        :param gc_on_close:
+            Whether to force gc collect and mmap collect on Repo destruction.
+            In some high-volume cases, the cost of doing frequent full gc cycles
+            is extremely expensive. While doing the gc is the safe bet, skipping
+            it can be useful in specific cases. Defaults to True.
         :raise InvalidGitRepositoryError:
         :raise NoSuchPathError:
         :return: git.Repo """
+        self._gc_on_close = gc_on_close
         epath = path or os.getenv('GIT_DIR')
         if not epath:
             epath = os.getcwd()
@@ -191,9 +200,10 @@ def __del__(self):
     def close(self):
         if self.git:
             self.git.clear_cache()
-            gc.collect()
-            gitdb.util.mman.collect()
-            gc.collect()
+            if self._gc_on_close:
+                gc.collect()
+                gitdb.util.mman.collect()
+                gc.collect()
 
     def __eq__(self, rhs):
         if isinstance(rhs, Repo):
