cola/version.py

   1 # Copyright (C) 2007-2018 David Aguilar and contributors
   2 """Provide git-cola's version number"""
   3 from __future__ import division, absolute_import, unicode_literals
   4 import os
   5 import sys
   6
   7 if __name__ == '__main__':
   8     srcdir = os.path.dirname(os.path.dirname(__file__))
   9     sys.path.insert(1, srcdir)
  10
  11 from .git import STDOUT  # noqa
  12 from .decorators import memoize  # noqa
  13 from ._version import VERSION  # noqa
  14
  15 try:
  16     from ._build_version import BUILD_VERSION
  17 except ImportError:
  18     BUILD_VERSION = ''
  19
  20 # minimum version requirements
  21 _versions = {
  22     # git diff learned --patience in 1.6.2
  23     # git mergetool learned --no-prompt in 1.6.2
  24     # git difftool moved out of contrib in git 1.6.3
  25     'git': '1.6.3',
  26     'python': '2.6',
  27     # new: git cat-file --filters --path=<path> SHA1
  28     # old: git cat-file --filters blob SHA1:<path>
  29     'cat-file-filters-path': '2.11.0',
  30     # git diff --submodule was introduced in 1.6.6
  31     'diff-submodule': '1.6.6',
  32     # git check-ignore was introduced in 1.8.2, but did not follow the same
  33     # rules as git add and git status until 1.8.5
  34     'check-ignore': '1.8.5',
  35     # git push --force-with-lease
  36     'force-with-lease': '1.8.5',
  37     # git submodule update --recursive was introduced in 1.6.5
  38     'submodule-update-recursive': '1.6.5',
  39     # git for-each-ref --sort=version:refname
  40     'version-sort': '2.7.0',
  41     # Qt support for QT_AUTO_SCREEN_SCALE_FACTOR and QT_SCALE_FACTOR
  42     'qt-hidpi-scale': '5.6.0',
  43     # git rev-parse --show-superproject-working-tree was added in 2.13.0
  44     'show-superproject-working-tree': '2.13.0',
  45 }
  46
  47
  48 def get(key):
  49     """Returns an entry from the known versions table"""
  50     return _versions.get(key)
  51
  52
  53 def version():
  54     """Returns the current version"""
  55     return VERSION
  56
  57
  58 def build_version():
  59     """Return the build version, which includes the Git ID"""
  60     return BUILD_VERSION
  61
  62
  63 @memoize
  64 def check_version(min_ver, ver):
  65     """Check whether ver is greater or equal to min_ver"""
  66     min_ver_list = version_to_list(min_ver)
  67     ver_list = version_to_list(ver)
  68     return min_ver_list <= ver_list
  69
  70
  71 @memoize
  72 def check(key, ver):
  73     """Checks if a version is greater than the known version for <what>"""
  74     return check_version(get(key), ver)
  75
  76
  77 def check_git(context, key):
  78     """Checks if Git has a specific feature"""
  79     return check(key, git_version(context))
  80
  81
  82 def version_to_list(value):
  83     """Convert a version string to a list of numbers or strings"""
  84     ver_list = []
  85     for p in value.split('.'):
  86         try:
  87             n = int(p)
  88         except ValueError:
  89             n = p
  90         ver_list.append(n)
  91     return ver_list
  92
  93
  94 @memoize
  95 def git_version_str(context):
  96     """Returns the current GIT version"""
  97     git = context.git
  98     return git.version()[STDOUT].strip()
  99
 100
 101 @memoize
 102 def git_version(context):
 103     """Returns the current GIT version"""
 104     parts = git_version_str(context).split()
 105     if parts and len(parts) >= 3:
 106         result = parts[2]
 107     else:
 108         # minimum supported version
 109         result = '1.6.3'
 110     return result
 111
 112
 113 def cola_version(build=False):
 114     if build:
 115         suffix = build_version() or version()
 116     else:
 117         suffix = version()
 118     return 'cola version %s' % suffix
 119
 120
 121 def print_version(brief=False, build=False):
 122     if brief:
 123         if build:
 124             msg = build_version()
 125         else:
 126             msg = version()
 127     else:
 128         msg = cola_version(build=build)
 129     sys.stdout.write('%s\n' % msg)