more robust versioning

- make version-syncing-thingy (Git ←→ PEP-440) a bit more robust
- use setuptools instead of distutils.core
- make setup.py syntactically legal for Python 2 so I don't get weird errors when I accidentally type pip instead of pip3
- include version in program output so I don't have to ask for it in every… single… issue… report

Author: dlenski

setup.py

@@ -1,7 +1,8 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
+from __future__ import print_function
 import sys, os, re, subprocess as sp
-from distutils.core import setup
+from setuptools import setup
 
 if not sys.version_info[0] == 3:
     sys.exit("Python 2.x is not supported; Python 3.x is required.")
@@ -14,19 +15,21 @@
 
 # Fetch version from git tags, and write to version.py.
 # Also, when git is not available (PyPi package), use stored version.py.
-version_py = os.path.join(os.path.dirname(__file__), 'version.py')
+version_py = os.path.join(os.path.dirname(__file__), 'tetherback', 'version.py')
 
 try:
-    version_git = sp.check_output(["git", "describe", "--tags"]).strip().decode('ascii')
-    final, dev, blob = re.match(r'v?((?:\d+\.)*\d+)(?:-(\d+)-(g[a-z0-9]+))?', version_git).groups()
-    version_pep = final+('.dev%s+%s'%(dev,blob) if dev else '')
-except sp.CalledProcessError:
+    version_git = sp.check_output(["git", "describe", "--tags", "--dirty=_dirty"]).strip().decode('ascii')
+    final, dev, blob, dirty = re.match(r'v?((?:\d+\.)*\d+)(?:-(\d+)-(g[a-z0-9]+))?(_dirty)?', version_git).groups()
+    version_pep = final+('.dev%s+%s'%(dev,blob) if dev else '')+(dirty if dirty else '')
+except:
+    d = {}
     with open(version_py, 'r') as fh:
-        version_pep = open(version_py).read().strip().split('=')[-1][1:-1]
+        exec(fh.read(), d)
+        version_pep = d['__version__']
 else:
     with open(version_py, 'w') as fh:
         print("# Do not edit this file, tetherback versioning is governed by git tags", file=fh)
-        print('__version__="%s"\n' % version_pep, file=fh)
+        print('__version__="%s"' % version_pep, file=fh)
 
 ########################################
 

tetherback/tetherback.py

@@ -15,6 +15,7 @@
 from hashlib import md5
 from collections import namedtuple, OrderedDict as odict
 
+from .version import __version__
 from .adb_wrapper import AdbWrapper
 from .adb_stuff import *
 
@@ -29,6 +30,8 @@
 
 def parse_args(args=None):
     p = argparse.ArgumentParser(description='''Tool to create TWRP and nandroid-style backups of an Android device running TWRP recovery, using adb-over-USB, without touching the device's internal storage or SD card.''')
+    p.version=__version__
+    p.add_argument('--version', action='version')
     p.add_argument('-s', dest='specific', metavar='DEVICE_ID', default=None, help="Specific device ID (shown by adb devices). Default is sole USB-connected device.")
     p.add_argument('-o', '--output-path', default=".", help="Set optional output path for backup files.")
     p.add_argument('-N', '--nandroid', action='store_true', help="Make nandroid backup; raw images rather than tarballs for /system and /data partitions (default is TWRP backup)")
@@ -277,6 +280,8 @@ def main(args=None):
     p, args = parse_args(args)
     adb = AdbWrapper('adb', ('-s',args.specific) if args.specific else ('-d',))
 
+    print('%s v%s' % (p.prog, p.version), file=stderr)
+
     # check adb version, and TWRP recovery
     adbversion = check_adb_version(p, adb)
     args.transport = sensible_transport(args.transport, adbversion)