io: Wrap (probably) allconfig_writers in with blocks

ankostis · ankostis · commit 391a76738aea · 2016-10-04T01:50:43.000+02:00
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst
diff --git a/git/objects/submodule/base.py b/git/objects/submodule/base.py
@@ -398,24 +398,20 @@ def add(cls, repo, name, path, url=None, branch=None, no_checkout=False):
         # otherwise there is a '-' character in front of the submodule listing
         #  a38efa84daef914e4de58d1905a500d8d14aaf45 mymodule (v0.9.0-1-ga38efa8)
         # -a38efa84daef914e4de58d1905a500d8d14aaf45 submodules/intermediate/one
-        writer = sm.repo.config_writer()
-        writer.set_value(sm_section(name), 'url', url)
-        writer.release()
+        with sm.repo.config_writer() as writer:
+            writer.set_value(sm_section(name), 'url', url)
 
         # update configuration and index
         index = sm.repo.index
-        writer = sm.config_writer(index=index, write=False)
-        writer.set_value('url', url)
-        writer.set_value('path', path)
-
-        sm._url = url
-        if not branch_is_default:
-            # store full path
-            writer.set_value(cls.k_head_option, br.path)
-            sm._branch_path = br.path
-        # END handle path
-        writer.release()
-        del(writer)
+        with sm.config_writer(index=index, write=False) as writer:
+            writer.set_value('url', url)
+            writer.set_value('path', path)
+
+            sm._url = url
+            if not branch_is_default:
+                # store full path
+                writer.set_value(cls.k_head_option, br.path)
+                sm._branch_path = br.path
 
         # we deliberatly assume that our head matches our index !
         sm.binsha = mrepo.head.commit.binsha
@@ -542,9 +538,8 @@ def update(self, recursive=False, init=True, to_latest_revision=False, progress=
                     # the default implementation will be offended and not update the repository
                     # Maybe this is a good way to assure it doesn't get into our way, but
                     # we want to stay backwards compatible too ... . Its so redundant !
-                    writer = self.repo.config_writer()
-                    writer.set_value(sm_section(self.name), 'url', self.url)
-                    writer.release()
+                    with self.repo.config_writer() as writer:
+                        writer.set_value(sm_section(self.name), 'url', self.url)
                 # END handle dry_run
             # END handle initalization
 
@@ -731,11 +726,9 @@ def move(self, module_path, configuration=True, module=True):
                 # END handle submodule doesn't exist
 
                 # update configuration
-                writer = self.config_writer(index=index)        # auto-write
-                writer.set_value('path', module_checkout_path)
-                self.path = module_checkout_path
-                writer.release()
-                del(writer)
+                with self.config_writer(index=index) as writer:        # auto-write
+                    writer.set_value('path', module_checkout_path)
+                    self.path = module_checkout_path
             # END handle configuration flag
         except Exception:
             if renamed_module:
@@ -898,13 +891,11 @@ def remove(self, module=True, force=False, configuration=True, dry_run=False):
 
             # now git config - need the config intact, otherwise we can't query
             # information anymore
-            writer = self.repo.config_writer()
-            writer.remove_section(sm_section(self.name))
-            writer.release()
+            with self.repo.config_writer() as writer:
+                writer.remove_section(sm_section(self.name))
 
-            writer = self.config_writer()
-            writer.remove_section()
-            writer.release()
+            with self.config_writer() as writer:
+                writer.remove_section()
         # END delete configuration
 
         return self
@@ -995,18 +986,15 @@ def rename(self, new_name):
             return self
 
         # .git/config
-        pw = self.repo.config_writer()
-        # As we ourselves didn't write anything about submodules into the parent .git/config, we will not require
-        # it to exist, and just ignore missing entries
-        if pw.has_section(sm_section(self.name)):
-            pw.rename_section(sm_section(self.name), sm_section(new_name))
-        # end
-        pw.release()
+        with self.repo.config_writer() as pw:
+            # As we ourselves didn't write anything about submodules into the parent .git/config,
+            # we will not require it to exist, and just ignore missing entries.
+            if pw.has_section(sm_section(self.name)):
+                pw.rename_section(sm_section(self.name), sm_section(new_name))
 
         # .gitmodules
-        cw = self.config_writer(write=True).config
-        cw.rename_section(sm_section(self.name), sm_section(new_name))
-        cw.release()
+        with self.config_writer(write=True) as cw:
+            cw.config.rename_section(sm_section(self.name), sm_section(new_name))
 
         self._name = new_name
 
diff --git a/git/refs/head.py b/git/refs/head.py
@@ -133,18 +133,15 @@ def set_tracking_branch(self, remote_reference):
             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)
-            writer.remove_option(self.k_config_remote_ref)
-            if len(writer.options()) == 0:
-                writer.remove_section()
-            # END handle remove section
-        else:
-            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
-        writer.release()
+        with self.config_writer() as writer:
+            if remote_reference is None:
+                writer.remove_option(self.k_config_remote)
+                writer.remove_option(self.k_config_remote_ref)
+                if len(writer.options()) == 0:
+                    writer.remove_section()
+            else:
+                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))
 
         return self
 
diff --git a/git/repo/base.py b/git/repo/base.py
@@ -924,10 +924,8 @@ def _clone(cls, git, url, path, odb_default_type, progress, **kwargs):
         # sure
         repo = cls(os.path.abspath(path), odbt=odbt)
         if repo.remotes:
-            writer = repo.remotes[0].config_writer
-            writer.set_value('url', repo.remotes[0].url.replace("\\\\", "\\").replace("\\", "/"))
-            # PY3: be sure cleanup is performed and lock is released
-            writer.release()
+            with repo.remotes[0].config_writer as writer:
+                writer.set_value('url', repo.remotes[0].url.replace("\\\\", "\\").replace("\\", "/"))
         # END handle remote repo
         return repo
 
diff --git a/git/test/lib/helper.py b/git/test/lib/helper.py
@@ -237,16 +237,13 @@ def remote_repo_creator(self):
             rw_remote_repo.daemon_export = True
 
             # this thing is just annoying !
-            crw = rw_remote_repo.config_writer()
-            section = "daemon"
-            try:
-                crw.add_section(section)
-            except Exception:
-                pass
-            crw.set(section, "receivepack", True)
-            # release lock
-            crw.release()
-            del(crw)
+            with rw_remote_repo.config_writer() as crw:
+                section = "daemon"
+                try:
+                    crw.add_section(section)
+                except Exception:
+                    pass
+                crw.set(section, "receivepack", True)
 
             # initialize the remote - first do it as local remote and pull, then
             # we change the url to point to the daemon. The daemon should be started
@@ -255,7 +252,8 @@ def remote_repo_creator(self):
             d_remote.fetch()
             remote_repo_url = "git://localhost:%s%s" % (GIT_DAEMON_PORT, remote_repo_dir)
 
-            d_remote.config_writer.set('url', remote_repo_url)
+            with d_remote.config_writer as cw:
+                cw.set('url', remote_repo_url)
 
             temp_dir = osp(_mktemp())
             gd = launch_git_daemon(temp_dir, '127.0.0.1', GIT_DAEMON_PORT)
diff --git a/git/test/test_docs.py b/git/test/test_docs.py
@@ -39,8 +39,8 @@ def test_init_repo_object(self, rw_dir):
 
         # [3-test_init_repo_object]
         repo.config_reader()             # get a config reader for read-only access
-        cw = repo.config_writer()        # get a config writer to change configuration
-        cw.release()                     # call release() to be sure changes are written and locks are released
+        with repo.config_writer():       # get a config writer to change configuration
+            pass                         # call release() to be sure changes are written and locks are released
         # ![3-test_init_repo_object]
 
         # [4-test_init_repo_object]
@@ -398,9 +398,8 @@ def test_references_and_objects(self, rw_dir):
 
         # [26-test_references_and_objects]
         assert origin.url == repo.remotes.origin.url
-        cw = origin.config_writer
-        cw.set("pushurl", "other_url")
-        cw.release()
+        with origin.config_writer as cw:
+            cw.set("pushurl", "other_url")
 
         # Please note that in python 2, writing origin.config_writer.set(...) is totally safe.
         # In py3 __del__ calls can be delayed, thus not writing changes in time.
diff --git a/git/test/test_index.py b/git/test/test_index.py
@@ -412,10 +412,9 @@ def test_index_mutation(self, rw_repo):
 
         uname = u"Thomas Müller"
         umail = "sd@company.com"
-        writer = rw_repo.config_writer()
-        writer.set_value("user", "name", uname)
-        writer.set_value("user", "email", umail)
-        writer.release()
+        with rw_repo.config_writer() as writer:
+            writer.set_value("user", "name", uname)
+            writer.set_value("user", "email", umail)
         self.assertEqual(writer.get_value("user", "name"), uname)
 
         # remove all of the files, provide a wild mix of paths, BaseIndexEntries,
diff --git a/git/test/test_refs.py b/git/test/test_refs.py
@@ -101,15 +101,13 @@ def test_heads(self, rwrepo):
             assert prev_object == cur_object        # represent the same git object
             assert prev_object is not cur_object    # but are different instances
 
-            writer = head.config_writer()
-            tv = "testopt"
-            writer.set_value(tv, 1)
-            assert writer.get_value(tv) == 1
-            writer.release()
+            with head.config_writer() as writer:
+                tv = "testopt"
+                writer.set_value(tv, 1)
+                assert writer.get_value(tv) == 1
             assert head.config_reader().get_value(tv) == 1
-            writer = head.config_writer()
-            writer.remove_option(tv)
-            writer.release()
+            with head.config_writer() as writer:
+                writer.remove_option(tv)
 
             # after the clone, we might still have a tracking branch setup
             head.set_tracking_branch(None)
@@ -175,7 +173,7 @@ def test_is_valid(self):
 
     def test_orig_head(self):
         assert type(self.rorepo.head.orig_head()) == SymbolicReference
-        
+
     @with_rw_repo('0.1.6')
     def test_head_checkout_detached_head(self, rw_repo):
         res = rw_repo.remotes.origin.refs.master.checkout()
diff --git a/git/test/test_remote.py b/git/test/test_remote.py
@@ -267,7 +267,8 @@ def get_info(res, remote, name):
 
         # put origin to git-url
         other_origin = other_repo.remotes.origin
-        other_origin.config_writer.set("url", remote_repo_url)
+        with other_origin.config_writer as cw:
+            cw.set("url", remote_repo_url)
         # it automatically creates alternates as remote_repo is shared as well.
         # It will use the transport though and ignore alternates when fetching
         # assert not other_repo.alternates  # this would fail
@@ -416,13 +417,12 @@ def test_base(self, rw_repo, remote_repo):
                 self.failUnlessRaises(IOError, reader.set, opt, "test")
 
                 # change value
-                writer = remote.config_writer
-                new_val = "myval"
-                writer.set(opt, new_val)
-                assert writer.get(opt) == new_val
-                writer.set(opt, val)
-                assert writer.get(opt) == val
-                del(writer)
+                with remote.config_writer as writer:
+                    new_val = "myval"
+                    writer.set(opt, new_val)
+                    assert writer.get(opt) == new_val
+                    writer.set(opt, val)
+                    assert writer.get(opt) == val
                 assert getattr(remote, opt) == val
             # END for each default option key
 
diff --git a/git/test/test_submodule.py b/git/test/test_submodule.py
