2 from __future__ import absolute_import, print_function
3 from array import array
4 from binascii import hexlify
5 from traceback import print_exception
8 # Please see CODINGSTYLE for important exception handling guidelines
9 # and the rationale behind add_ex_tb(), add_ex_ctx(), etc.
11 py_maj = sys.version_info[0]
16 from os import environb as environ
18 lc_ctype = environ.get(b'LC_CTYPE')
19 if lc_ctype and lc_ctype.lower() != b'iso-8859-1':
20 # Because of argv, options.py, pwd, grp, and any number of other issues
21 print('error: bup currently only works with ISO-8859-1, not LC_CTYPE=%s'
24 print('error: this should already have been arranged, so indicates a bug',
28 from os import fsencode
29 from shlex import quote
36 """Return hex string (not bytes as with hexlify) representation of b."""
40 raise ex.with_traceback(sys.exc_info()[2])
43 """Do nothing (already handled by Python 3 infrastructure)."""
46 def add_ex_ctx(ex, context_ex):
47 """Do nothing (already handled by Python 3 infrastructure)."""
54 """Return the original bytes passed to main() for an argv argument."""
57 def bytes_from_uint(i):
60 def bytes_from_byte(b): # python > 2: b[3] returns ord('x'), not b'x'
63 byte_int = lambda x: x
65 def buffer(object, offset=None, size=None):
67 assert offset is not None
68 return memoryview(object)[offset:offset + size]
70 return memoryview(object)[offset:]
71 return memoryview(object)
73 def join_bytes(*items):
74 """Return the concatenated bytes or memoryview arguments as bytes."""
75 return b''.join(items)
82 from pipes import quote
83 from os import environ
85 from bup.py2raise import reraise
90 int_types = (int, long)
95 """Add a traceback to ex if it doesn't already have one. Return ex.
98 if not getattr(ex, '__traceback__', None):
99 ex.__traceback__ = sys.exc_info()[2]
102 def add_ex_ctx(ex, context_ex):
103 """Make context_ex the __context__ of ex (unless it already has one).
108 if not getattr(ex, '__context__', None):
109 ex.__context__ = context_ex
112 def dump_traceback(ex):
114 next_ex = getattr(ex, '__context__', None)
116 stack.append(next_ex)
117 next_ex = getattr(next_ex, '__context__', None)
118 stack = reversed(stack)
120 tb = getattr(ex, '__traceback__', None)
121 print_exception(type(ex), ex, tb)
123 print('\nDuring handling of the above exception, another exception occurred:\n',
125 tb = getattr(ex, '__traceback__', None)
126 print_exception(type(ex), ex, tb)
132 """Return the original bytes passed to main() for an argv argument."""
135 def bytes_from_uint(i):
138 def bytes_from_byte(b):
145 def join_bytes(x, y):
146 """Return the concatenated bytes or buffer arguments as bytes."""
147 if type(x) == buffer:
148 assert type(y) in (bytes, buffer)
150 assert type(x) == bytes
152 return b''.join((x, y))
153 assert type(y) in (bytes, buffer)
157 def restore_lc_env():
158 # Once we're up and running with iso-8859-1, undo the bup-python
159 # LC_CTYPE hackery, so we don't affect unrelated subprocesses.
160 bup_lc_all = environ.get(b'BUP_LC_ALL')
162 del environ[b'LC_COLLATE']
163 del environ[b'LC_CTYPE']
164 del environ[b'LC_MONETARY']
165 del environ[b'LC_NUMERIC']
166 del environ[b'LC_TIME']
167 del environ[b'LC_MESSAGES']
168 del environ[b'LC_MESSAGES']
169 environ[b'LC_ALL'] = bup_lc_all
171 bup_lc_ctype = environ.get(b'BUP_LC_CTYPE')
173 environ[b'LC_CTYPE'] = bup_lc_ctype
176 """Run main() and raise a SystemExit with the return value if it
177 returns, pass along any SystemExit it raises, convert
178 KeyboardInterrupts into exit(130), and print a Python 3 style
179 contextual backtrace for other exceptions in both Python 2 and
183 except KeyboardInterrupt as ex:
185 except SystemExit as ex:
187 except BaseException as ex:
195 # Excepting wrap_main() in the traceback, these should produce similar output:
196 # python2 lib/bup/compat.py
197 # python3 lib/bup/compat.py
199 # diff -u <(python2 lib/bup/compat.py 2>&1) <(python3 lib/bup/compat.py 2>&1)
201 # Though the python3 output for 'second' will include a stacktrace
202 # starting from wrap_main, rather than from outer().
204 if __name__ == '__main__':
207 raise Exception('first')
212 except Exception as ex:
215 raise Exception('second')
216 except Exception as ex2:
217 raise add_ex_ctx(add_ex_tb(ex2), ex)