this_version.py

   1 #! python
   2 import os
   3
   4 __version_info = {} # keep a reference to parse VERSION once
   5
   6 def get_version_info():
   7     # read from VERSION
   8     # return dictionary filled with content of version
   9     if not __version_info:
  10         this_file_dir = os.path.dirname(os.path.abspath(__file__))
  11         version_file = os.path.join(this_file_dir, 'VERSION')
  12
  13         if not os.path.isfile(version_file):
  14             raise SystemError("VERSION file not found.")
  15
  16         for l in open(version_file).readlines():
  17             if l.startswith('AUBIO_MAJOR_VERSION'):
  18                 __version_info['AUBIO_MAJOR_VERSION'] = int(l.split('=')[1])
  19             if l.startswith('AUBIO_MINOR_VERSION'):
  20                 __version_info['AUBIO_MINOR_VERSION'] = int(l.split('=')[1])
  21             if l.startswith('AUBIO_PATCH_VERSION'):
  22                 __version_info['AUBIO_PATCH_VERSION'] = int(l.split('=')[1])
  23             if l.startswith('AUBIO_VERSION_STATUS'):
  24                 __version_info['AUBIO_VERSION_STATUS'] = \
  25                     l.split('=')[1].strip()[1:-1]
  26
  27             if l.startswith('LIBAUBIO_LT_CUR'):
  28                 __version_info['LIBAUBIO_LT_CUR'] = int(l.split('=')[1])
  29             if l.startswith('LIBAUBIO_LT_REV'):
  30                 __version_info['LIBAUBIO_LT_REV'] = int(l.split('=')[1])
  31             if l.startswith('LIBAUBIO_LT_AGE'):
  32                 __version_info['LIBAUBIO_LT_AGE'] = int(l.split('=')[1])
  33
  34         if len(__version_info) < 6:
  35             raise SystemError("Failed parsing VERSION file.")
  36
  37         # switch version status with commit sha in alpha releases
  38         if __version_info['AUBIO_VERSION_STATUS'] and \
  39                 '~alpha' in __version_info['AUBIO_VERSION_STATUS']:
  40             AUBIO_GIT_SHA = get_git_revision_hash()
  41             if AUBIO_GIT_SHA:
  42                 __version_info['AUBIO_VERSION_STATUS'] = '~git+' + AUBIO_GIT_SHA
  43
  44     return __version_info
  45
  46 def get_libaubio_version():
  47     verfmt = '%(LIBAUBIO_LT_CUR)s.%(LIBAUBIO_LT_REV)s.%(LIBAUBIO_LT_AGE)s'
  48     return str(verfmt % get_version_info())
  49
  50 def get_aubio_version():
  51     verfmt = '%(AUBIO_MAJOR_VERSION)s.%(AUBIO_MINOR_VERSION)s.%(AUBIO_PATCH_VERSION)s%(AUBIO_VERSION_STATUS)s'
  52     return str(verfmt % get_version_info())
  53
  54 def get_aubio_pyversion():
  55     # convert to version for python according to pep 440
  56     # see https://www.python.org/dev/peps/pep-0440/
  57     # outputs MAJ.MIN.PATCH[a0[+git.<sha>[.mods]]]
  58     aubio_version = get_aubio_version()
  59     if '~git+' in aubio_version:
  60         pep440str = aubio_version.replace('+', '.')
  61         verstr = pep440str.replace('~git.', 'a0+')
  62     elif '~alpha' in aubio_version:
  63         verstr = "a0"
  64     return verstr
  65
  66 def get_git_revision_hash(short=True):
  67     # get commit id, with +mods if local tree is not clean
  68     if not os.path.isdir('.git'):
  69         # print('Version : not in git repository : can\'t get sha')
  70         return None
  71     import subprocess
  72     aubio_dir = os.path.dirname(os.path.abspath(__file__))
  73     if not os.path.exists(aubio_dir):
  74         raise SystemError("git / root folder not found")
  75     gitcmd = ['git', '-C', aubio_dir, 'rev-parse']
  76     if short:
  77         gitcmd.append('--short')
  78     gitcmd.append('HEAD')
  79     try:
  80         gitsha = subprocess.check_output(gitcmd).strip().decode('utf8')
  81     except Exception as e:
  82         print('git command error :%s' % e)
  83         return None
  84     # check if we have a clean tree
  85     gitcmd = ['git', '-C', aubio_dir, 'diff-index', '--quiet']
  86     gitcmd.append('HEAD')
  87     try:
  88         subprocess.check_output(gitcmd).strip().decode('utf8')
  89     except Exception as e:
  90         gitsha += '+mods'
  91     return gitsha
  92
  93 if __name__ == '__main__':
  94     print ('%30s'% 'aubio version:', get_aubio_version())
  95     print ('%30s'% 'python-aubio version:', get_aubio_pyversion())