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