fix python code comments from timf

Author: Vladimir Kotal

tools/sync/command.py

@@ -98,13 +98,15 @@ def fileno(self):
             def close(self):
                 os.close(self.write_fd)
 
+        orig_work_dir = None
         if self.work_dir:
+            orig_work_dir = os.getcwd()
             try:
                 os.chdir(self.work_dir)
             except OSError as e:
                 self.state = Command.ERRORED
                 self.logger.error("Cannot change working directory to {}".
-                    format(self.work_dir))
+                                  format(self.work_dir))
                 return
 
         othr = OutputThread()
@@ -135,6 +137,15 @@ def close(self):
             othr.close()
             self.out = othr.getoutput()
 
+        if orig_work_dir:
+            try:
+                os.chdir(orig_work_dir)
+            except OSError as e:
+                self.state = Command.ERRORED
+                self.logger.error("Cannot change working directory back to {}".
+                                  format(orig_work_dir))
+                return
+
     def fill_arg(self, args_append=None, args_subst=None):
         """
         Replace argument names with actual values or append arguments

tools/sync/commands.py

@@ -88,29 +88,29 @@ def run(self):
 
     def check(self, ignore_errors):
         """
-	Check the output of the commands and perform logging.
-	"""
+        Check the output of the commands and perform logging.
+        """
 
         self.logger.debug("Output from {}:".format(self.name))
         for cmd in self.outputs.keys():
             if self.outputs[cmd] and len(self.outputs[cmd]) > 0:
                 self.logger.debug("{}: {}".
-                             format(cmd, self.outputs[cmd]))
+                                  format(cmd, self.outputs[cmd]))
 
         if self.name in ignore_errors:
             return
 
         if any(rv != 0 for rv in self.retcodes.values()):
             self.logger.error("processing of selfect {} failed".
-                         format(self))
+                              format(self))
             indent = "  "
             self.logger.error("{}failed commands:".format(indent))
             failed_cmds = {k: v for k, v in
                            self.retcodes.items() if v != 0}
             indent = "    "
             for cmd in failed_cmds.keys():
                 self.logger.error("{}'{}': {}".
-                             format(indent, cmd, failed_cmds[cmd]))
+                                  format(indent, cmd, failed_cmds[cmd]))
                 out = self.get_cmd_output(cmd,
                                           indent=indent + "  ")
                 if out:
@@ -121,7 +121,7 @@ def check(self, ignore_errors):
                         if "error" in str(v).lower()}
         if len(errored_cmds) > 0:
             self.logger.error("Command output in selfect {}"
-                         " contains errors:".format(self.name))
+                              " contains errors:".format(self.name))
             indent = "  "
             for cmd in errored_cmds.keys():
                 self.logger.error("{}{}".format(indent, cmd))

tools/sync/cvs.py

@@ -23,7 +23,7 @@
 
 from command import Command
 from repository import Repository
-from utils import which
+from shutil import which
 
 
 class CVSRepository(Repository):

tools/sync/git.py

@@ -23,7 +23,8 @@
 
 from command import Command
 from repository import Repository
-from utils import which
+from shutil import which
+
 
 class GitRepository(Repository):
     def __init__(self, logger, path, project, command, env, hooks):
@@ -46,7 +47,7 @@ def reposync(self):
         self.logger.info(cmd.getoutputstr())
         if cmd.getretcode() != 0 or cmd.getstate() != Command.FINISHED:
             self.logger.error("failed to perform pull for {}".
-                format(self.path))
+                              format(self.path))
             return 1
 
         return 0

tools/sync/hook.py

@@ -25,6 +25,7 @@
 from command import Command
 import logging
 
+
 def run_hook(logger, script, path):
     """
     Change a working directory to specified path, run a command
@@ -33,15 +34,7 @@ def run_hook(logger, script, path):
     Return 0 on success, 1 on failure.
     """
 
-    orig_cwd = os.getcwd()
-
-    try:
-        os.chdir(path)
-    except:
-        logger.error("Cannot chdir to {}".format(path))
-        return 1
-
-    cmd = Command([script])
+    cmd = Command([script], work_dir=path)
     cmd.execute()
     if cmd.state is not "finished" or cmd.getretcode() != 0:
         logger.error("failed to execute {}".format(cmd))
@@ -50,10 +43,4 @@ def run_hook(logger, script, path):
 
     logger.info(cmd.getoutput())
 
-    try:
-        os.chdir(orig_cwd)
-    except:
-        logger.error("Cannot chdir to {}".format(orig_cwd))
-        return 1
-
     return 0

tools/sync/mercurial.py

@@ -23,7 +23,7 @@
 
 from command import Command
 from repository import Repository
-from utils import which
+from shutil import which
 
 
 class MercurialRepository(Repository):
@@ -69,10 +69,10 @@ def reposync(self):
         cmd = Command(hg_command, work_dir=self.path, env_vars=self.env)
         cmd.execute()
         self.logger.info(cmd.getoutputstr())
-	#
-	# 'hg incoming' will return 1 if there are no incoming changesets,
-	# so do not check the return value.
-	#
+        #
+        # 'hg incoming' will return 1 if there are no incoming changesets,
+        # so do not check the return value.
+        #
         if cmd.getstate() != Command.FINISHED:
             self.logger.error("failed to run 'hg incoming'")
             return 1

tools/sync/mirror.py

@@ -47,10 +47,11 @@
 from repository import Repository
 from mercurial import MercurialRepository
 from repofactory import get_repository
-from utils import which, is_exe, check_create_dir, get_dict_val
+from utils import is_exe, check_create_dir
 from hook import run_hook
 from readconfig import read_config
 from opengrok import get_repos, get_config_value, get_repo_type
+from shutil import which
 
 
 major_version = sys.version_info[0]
@@ -128,7 +129,7 @@
         # The project has no config, that's fine - defaults will be used.
         pass
 
-    hookdir = get_dict_val(config, 'hookdir')
+    hookdir = config.get('hookdir')
     if hookdir:
         logger.debug("Hook directory = {}".format(hookdir))
 
@@ -137,8 +138,8 @@
     if project_config:
         try:
             if not hookdir:
-                logger.error("Need to have 'hookdir' in the configuration " +
-                    "to run hooks")
+                logger.error("Need to have 'hookdir' in the configuration "
+                             "to run hooks")
                 sys.exit(1)
 
             if not os.path.isdir(hookdir):
@@ -155,12 +156,12 @@
                     logger.debug("post-hook = {}".format(posthook))
                 else:
                     logger.error("Unknown hook name {} for project {}".
-                        format(hookname, args.project))
+                                 format(hookname, args.project))
                     sys.exit(1)
 
                 if not is_exe(hookpath):
-                    logger.error("hook file {} does not exist or not executable".
-                                 format(hookpath))
+                    logger.error("hook file {} does not exist or not "
+                                 "executable".format(hookpath))
                     sys.exit(1)
         except KeyError:
             pass
@@ -181,18 +182,20 @@
         for handler in logging.root.handlers[:]:
             logging.root.removeHandler(handler)
 
-        logging.basicConfig(filename = os.path.join(logdir,
-                            args.project + ".log"), filemode = 'a',
-                            format = '%(asctime)s - %(levelname)s: %(message)s',
-                            datefmt = '%m/%d/%Y %I:%M:%S %p',
-                            level = logging.DEBUG if args.debug else logging.INFO)
+        logging.basicConfig(filename=os.path.join(logdir,
+                            args.project + ".log"), filemode='a',
+                            format='%(asctime)s - %(levelname)s: %(message)s',
+                            datefmt='%m/%d/%Y %I:%M:%S %p',
+                            level=logging.DEBUG if args.debug
+                            else logging.INFO)
         logger = logging.getLogger(os.path.basename(sys.argv[0]))
 
     # We want this to be logged to the log file (if any).
     if project_config:
         try:
             if project_config['disabled']:
-                logger.info("Project {} disabled, exiting".format(args.project))
+                logger.info("Project {} disabled, exiting".
+                            format(args.project))
                 sys.exit(0)
         except KeyError:
             pass
@@ -202,7 +205,8 @@
     try:
         with lock.acquire(timeout=0):
             if prehook and run_hook(logger, prehook,
-                        os.path.join(source_root, args.project)) != 0:
+                                    os.path.join(source_root,
+                                                 args.project)) != 0:
                 logger.error("pre hook failed")
                 logging.shutdown()
                 sys.exit(1)
@@ -225,7 +229,7 @@
                                       source_root + repo_path,
                                       repo_type,
                                       args.project,
-                                      get_dict_val(config, 'commands'),
+                                      config.get('commands'),
                                       config['proxy'] if use_proxy else None,
                                       None)
                 if not repo:
@@ -234,12 +238,13 @@
                     ret = 1
                 else:
                     if repo.sync() != 0:
-                        logger.debug("failed to sync repository {}".
-                            format(repo_path))
+                        logger.error("failed to sync repository {}".
+                                     format(repo_path))
                         ret = 1
 
             if posthook and run_hook(logger, posthook,
-                        os.path.join(source_root, args.project)) != 0:
+                                     os.path.join(source_root,
+                                                  args.project)) != 0:
                 logger.error("post hook failed")
                 logging.shutdown()
                 sys.exit(1)

tools/sync/opengrok.py

@@ -91,4 +91,4 @@ def get_repo_type(logger, path, messages_file):
     line = get_first_line(logger, [messages_file, '-n', 'repository', '-t',
                           path, 'get-repo-type'])
     idx = line.rfind(":")
-    return line[idx + 1]
+    return line[idx + 1:]

tools/sync/readconfig.py

@@ -26,6 +26,7 @@
 import yaml
 import sys
 
+
 def read_config(logger, inputfile):
     """
     Try to interpret inputfile as either JSON or YAML file,
@@ -62,4 +63,3 @@ def read_config(logger, inputfile):
         logger.error("cannot open '{}'".format(inputfile))
 
     return cfg
-

tools/sync/repofactory.py

@@ -26,7 +26,6 @@
 from cvs import CVSRepository
 from svn import SubversionRepository
 from git import GitRepository
-from utils import get_dict_val
 
 
 def get_repository(logger, path, repo_type, project, commands, env, hooks):
@@ -41,23 +40,23 @@ def get_repository(logger, path, repo_type, project, commands, env, hooks):
 
     if repo_lower in ["mercurial", "hg"]:
         return MercurialRepository(logger, path, project,
-                                   get_dict_val(commands, "hg"),
+                                   commands.get("hg"),
                                    env, hooks)
     elif repo_lower in ["teamware", "sccs"]:
         return TeamwareRepository(logger, path, project,
-                                  get_dict_val(commands, "teamware"),
+                                  commands.get("teamware"),
                                   env, hooks)
     elif repo_lower.lower() == "cvs":
         return CVSRepository(logger, path, project,
-                             get_dict_val(commands, "cvs"),
+                             commands.get("cvs"),
                              env, hooks)
     elif repo_lower == "svn":
         return SubversionRepository(logger, path, project,
-                                    get_dict_val(commands, "svn"),
+                                    commands.get("svn"),
                                     env, hooks)
     elif repo_lower == "git":
         return GitRepository(logger, path, project,
-                             get_dict_val(commands, "git"),
+                             commands.get("git"),
                              env, hooks)
     else:
         return None