OffTopic: DependencyUpdater

eyeo-depup/src/depup.py

 #!/usr/bin/env python
 
 # This file is part of Adblock Plus <https://adblockplus.org/>,
 # Copyright (C) 2006-present eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus is distributed in the hope that it will be useful,
@@ skipping 29 matching lines @@
 
 from src.vcs import Vcs
 
 logging.basicConfig()
 logger = logging.getLogger('eyeo-depup')
 
 
 class DepUpdate(object):
     """The main class used to process dependency updates.
 
-    TODO: CLARIFY ME!
-
+    DepUpdate provides an argument parser and subcommand routing for the
+    commands 'diff', 'issue', 'changes' and 'commit'. Each command may require
+    it's own set of parameters and parse them accordingly.
+
+    When parsing is successufl and all required parameters are provided,
+    DepUpdate will execute the corresponding command and will either print the
+    output to STDOUT or to the given filename.
     """
 
     VCS_EXECUTABLE = ('hg', '--config', 'defaults.log=', '--config',
                       'defaults.pull=')
     ISSUE_NUMBER_REGEX = re.compile(r'\b(issue|fixes)\s+(\d+)\b', re.I)
     NOISSUE_REGEX = re.compile(r'^noissue\b', re.I)
 
     def __init__(self, *args):
         """Construct a DepUpdate object.
 
         During initialization, DepUpdate will invoke the appropriate VCS to
         fetch a list of changes, parse them and (if not otherwise specified)
         get the matching revisions from the mirrored repository.
 
         Parameters: *args - Passed down to the argparse.ArgumentParser instance
 
         """
         self._cwd = os.getcwd()
 
-        self.root_repo = Vcs.factory(self._cwd)
-
         self._base_revision = None
         self._parsed_changes = None
         self.arguments = None
 
         self._dep_config = None
 
         default_template = os.path.join(
             os.path.dirname(os.path.realpath(__file__)), 'templates',
             'default.trac')
 
         # Initialize and run the internal argument parser
         self._make_arguments(default_template, *args)
 
         # Check if root repository is dirty
+        self.root_repo = Vcs.factory(self._cwd)
         if not self.root_repo.repo_is_clean():
             logger.error('Your repository is dirty')
             exit(1)
 
         # Initialize the main VCS and the list of changes
         self._main_vcs = Vcs.factory(os.path.join(self._cwd,
                                      self.arguments.dependency))
         self.changes = self._main_vcs.change_list(self.base_revision,
                                                   self.arguments.new_revision)
         if len(self.changes) == 0:
@@ skipping 84 matching lines @@
         # Add the command and options for creating an issue body
         issue_parser = subs.add_parser(
                 'issue', parents=[options_parser, advanced_parser],
                 help='Render an issue body',
                 description=('Render an issue subject and an issue body, '
                              'according to the given template.'))
         issue_parser.add_argument(
                 '-t', '--template', dest='tmpl_path',
                 default=default_template,
                 help=('The template to use. Defaults to the provided '
-                      'default.trac (Used only with -i/--issue).')
+                      'default.trac.')
         )
 
         # Add the command for printing a list of changes
         subs.add_parser(
                 'changes', parents=[options_parser, advanced_parser],
                 help='Generate a list of commits between two revisions',
                 description=('Generate a list of commit hashes and commit '
                              "messages between the dependency's current "
                              'revision and a given new revision.'))
 
@@ skipping 255 matching lines @@
         if self.arguments.lookup_inotes:
             self.lookup_integration_notes()
 
         output = action_map[self.arguments.action]()
         if self.arguments.filename is not None:
             with io.open(self.arguments.filename, 'w', encoding='utf-8') as fp:
                 fp.write(output)
             print('Output writen to ' + self.arguments.filename)
         else:
             print(output)