lib/bup/compat.py

   1
   2 from __future__ import absolute_import, print_function
   3 from array import array
   4 from traceback import print_exception
   5 import sys
   6
   7 # Please see CODINGSTYLE for important exception handling guidelines
   8 # and the rationale behind add_ex_tb(), add_ex_ctx(), etc.
   9
  10 py_maj = sys.version_info[0]
  11 py3 = py_maj >= 3
  12
  13 if py3:
  14
  15     from os import environb as environ
  16
  17     lc_ctype = environ.get(b'LC_CTYPE')
  18     if lc_ctype and lc_ctype.lower() != b'iso-8859-1':
  19         # Because of argv, options.py, pwd, grp, and any number of other issues
  20         print('error: bup currently only works with ISO-8859-1, not LC_CTYPE=%s'
  21               % lc_ctype.decode(),
  22               file=sys.stderr)
  23         print('error: this should already have been arranged, so indicates a bug',
  24               file=sys.stderr)
  25         sys.exit(2)
  26
  27     from os import fsencode
  28     from shlex import quote
  29     range = range
  30     str_type = str
  31
  32     def add_ex_tb(ex):
  33         """Do nothing (already handled by Python 3 infrastructure)."""
  34         return ex
  35
  36     def add_ex_ctx(ex, context_ex):
  37         """Do nothing (already handled by Python 3 infrastructure)."""
  38         return ex
  39
  40     def items(x):
  41         return x.items()
  42
  43     def argv_bytes(x):
  44         """Return the original bytes passed to main() for an argv argument."""
  45         return fsencode(x)
  46
  47     def bytes_from_uint(i):
  48         return bytes((i,))
  49
  50     byte_int = lambda x: x
  51
  52     def buffer(object, offset=None, size=None):
  53         if size:
  54             assert offset is not None
  55             return memoryview(object)[offset:offset + size]
  56         if offset:
  57             return memoryview(object)[offset:]
  58         return memoryview(object)
  59
  60     def join_bytes(*items):
  61         """Return the concatenated bytes or memoryview arguments as bytes."""
  62         return b''.join(items)
  63
  64 else:  # Python 2
  65
  66     from pipes import quote
  67     from os import environ
  68     range = xrange
  69     str_type = basestring
  70
  71     def add_ex_tb(ex):
  72         """Add a traceback to ex if it doesn't already have one.  Return ex.
  73
  74         """
  75         if not getattr(ex, '__traceback__', None):
  76             ex.__traceback__ = sys.exc_info()[2]
  77         return ex
  78
  79     def add_ex_ctx(ex, context_ex):
  80         """Make context_ex the __context__ of ex (unless it already has one).
  81         Return ex.
  82
  83         """
  84         if context_ex:
  85             if not getattr(ex, '__context__', None):
  86                 ex.__context__ = context_ex
  87         return ex
  88
  89     def dump_traceback(ex):
  90         stack = [ex]
  91         next_ex = getattr(ex, '__context__', None)
  92         while next_ex:
  93             stack.append(next_ex)
  94             next_ex = getattr(next_ex, '__context__', None)
  95         stack = reversed(stack)
  96         ex = next(stack)
  97         tb = getattr(ex, '__traceback__', None)
  98         print_exception(type(ex), ex, tb)
  99         for ex in stack:
 100             print('\nDuring handling of the above exception, another exception occurred:\n',
 101                   file=sys.stderr)
 102             tb = getattr(ex, '__traceback__', None)
 103             print_exception(type(ex), ex, tb)
 104
 105     def items(x):
 106         return x.iteritems()
 107
 108     def argv_bytes(x):
 109         """Return the original bytes passed to main() for an argv argument."""
 110         return x
 111
 112     def bytes_from_uint(i):
 113         return chr(i)
 114
 115     byte_int = ord
 116
 117     buffer = buffer
 118
 119     def join_bytes(x, y):
 120         """Return the concatenated bytes or buffer arguments as bytes."""
 121         if type(x) == buffer:
 122             assert type(y) in (bytes, buffer)
 123             return x + y
 124         assert type(x) == bytes
 125         if type(y) == bytes:
 126             return b''.join((x, y))
 127         assert type(y) in (bytes, buffer)
 128         return buffer(x) + y
 129
 130 def wrap_main(main):
 131     """Run main() and raise a SystemExit with the return value if it
 132     returns, pass along any SystemExit it raises, convert
 133     KeyboardInterrupts into exit(130), and print a Python 3 style
 134     contextual backtrace for other exceptions in both Python 2 and
 135     3)."""
 136     try:
 137         sys.exit(main())
 138     except KeyboardInterrupt as ex:
 139         sys.exit(130)
 140     except SystemExit as ex:
 141         raise
 142     except BaseException as ex:
 143         if py3:
 144             raise
 145         add_ex_tb(ex)
 146         dump_traceback(ex)
 147         sys.exit(1)
 148
 149
 150 # Excepting wrap_main() in the traceback, these should produce similar output:
 151 #   python2 lib/bup/compat.py
 152 #   python3 lib/bup/compat.py
 153 # i.e.:
 154 #   diff -u <(python2 lib/bup/compat.py 2>&1) <(python3 lib/bup/compat.py 2>&1)
 155 #
 156 # Though the python3 output for 'second' will include a stacktrace
 157 # starting from wrap_main, rather than from outer().
 158
 159 if __name__ == '__main__':
 160
 161     def inner():
 162         raise Exception('first')
 163
 164     def outer():
 165         try:
 166             inner()
 167         except Exception as ex:
 168             add_ex_tb(ex)
 169             try:
 170                 raise Exception('second')
 171             except Exception as ex2:
 172                 raise add_ex_ctx(add_ex_tb(ex2), ex)
 173
 174     wrap_main(outer)