src/git_stats/parse.py

   1 #!/usr/bin/env python
   2
   3 import copy
   4
   5 from git import Repo
   6 from optparse import OptionParser, Option, OptionValueError
   7
   8 def _checkFile(option, opt, value):
   9   """Checks whether value is a valid file and returns it if so
  10   """
  11
  12   return checkFile(value)
  13
  14
  15 def checkFile(value, relative=False):
  16   """Check whether value is a valid file and returns it if so
  17
  18   Args:
  19     value: The value to check.
  20     relative: Whether to treat value as a path relative to the working dir.
  21   """
  22
  23   git = Repo(".").git
  24
  25   file = git.ls_files("--full-name", "--", value, with_keep_cwd=relative)
  26
  27   if not file:
  28     raise OptionValueError("Unknown file '%s'" % value)
  29
  30   splitfile = file.split('\n')
  31
  32   if len(splitfile) > 1:
  33     raise OptionValueError(
  34         "Please specify only one file, '%s' matches more than one" % value)
  35
  36   return splitfile[0]
  37
  38 def _check_commit(option, opt, value):
  39   """Checks whether value is a valid refspec and returns its hash if so
  40   """
  41
  42   git = Repo(".").git
  43   rev = git.rev_parse("--verify", value, with_exceptions=False)
  44
  45   if not rev:
  46     raise OptionValueError("Unknown commit '%s'" % value)
  47
  48   return rev
  49
  50 def _check_bool(option, opt, value):
  51   """Checks whether a value is a boolean and returns it's value
  52
  53   Understands about 'True', 'False', and 'None'.
  54   """
  55
  56   if value == "True":
  57     return True
  58
  59   if value == "False":
  60     return False
  61
  62   if value == "None":
  63     return None
  64
  65   raise OptionValueError("Not a boolean: '%s'" % value)
  66
  67 class GitOption(Option):
  68   """This parser understands three new types:
  69   commit: A commit must specify exactly 1 commit in the current repository.
  70   file: A file must specify exactly 1 tracked file in the current repository.
  71   bool: A bool must be 'True', 'False', or 'None'.
  72   """
  73
  74   # Define the new types
  75   TYPES = Option.TYPES + ("commit",) + ("file",) + ("bool",)
  76
  77   # Copy the type checker list so that we don't keep the default ones
  78   TYPE_CHECKER = copy.copy(Option.TYPE_CHECKER)
  79
  80   # Add our own options
  81   TYPE_CHECKER["commit"] = _check_commit
  82   TYPE_CHECKER["file"] = _checkFile
  83   TYPE_CHECKER["bool"] = _check_bool
  84
  85 def isUnique(options, atLeastOne=False):
  86   """Checks if a list of options is unique
  87
  88   Args:
  89     options: The list of options to check
  90     atLeastOne: If set, when no optiosn are set, return False
  91   """
  92
  93   unique = False
  94
  95   for option in options:
  96     if option:
  97       # If we already found one, it's not unique for sure
  98       if unique:
  99         return False
 100       else:
 101         unique = True
 102
 103   # If there is only one, it's unique
 104   if unique:
 105     return True
 106
 107   # None found, so unique only if we don't require at least one
 108   return not atLeastOne
 109