e59f4d3880642db6f05d183b30b1ec81707dbf19
[bup.git] / lib / bup / compat.py
1
2 from __future__ import absolute_import, print_function
3 from array import array
4 from binascii import hexlify
5 from traceback import print_exception
6 import os, sys
7
8 # Please see CODINGSTYLE for important exception handling guidelines
9 # and the rationale behind add_ex_tb(), add_ex_ctx(), etc.
10
11 py_maj = sys.version_info[0]
12 py3 = py_maj >= 3
13
14 if py3:
15
16     from os import environb as environ
17
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'
22               % lc_ctype.decode(),
23               file=sys.stderr)
24         print('error: this should already have been arranged, so indicates a bug',
25               file=sys.stderr)
26         sys.exit(2)
27
28     from os import fsdecode, fsencode
29     from shlex import quote
30     input = input
31     range = range
32     str_type = str
33     int_types = (int,)
34
35     def hexstr(b):
36         """Return hex string (not bytes as with hexlify) representation of b."""
37         return b.hex()
38
39     def reraise(ex):
40         raise ex.with_traceback(sys.exc_info()[2])
41
42     def add_ex_tb(ex):
43         """Do nothing (already handled by Python 3 infrastructure)."""
44         return ex
45
46     def add_ex_ctx(ex, context_ex):
47         """Do nothing (already handled by Python 3 infrastructure)."""
48         return ex
49
50     def items(x):
51         return x.items()
52
53     def argv_bytes(x):
54         """Return the original bytes passed to main() for an argv argument."""
55         return fsencode(x)
56
57     def bytes_from_uint(i):
58         return bytes((i,))
59
60     def bytes_from_byte(b):  # python > 2: b[3] returns ord('x'), not b'x'
61         return bytes((b,))
62
63     byte_int = lambda x: x
64
65     def buffer(object, offset=None, size=None):
66         if size:
67             assert offset is not None
68             return memoryview(object)[offset:offset + size]
69         if offset:
70             return memoryview(object)[offset:]
71         return memoryview(object)
72
73     def join_bytes(*items):
74         """Return the concatenated bytes or memoryview arguments as bytes."""
75         return b''.join(items)
76
77 else:  # Python 2
78
79     def fsdecode(x):
80         return x
81
82     def fsencode(x):
83         return x
84
85     from pipes import quote
86     from os import environ
87
88     from bup.py2raise import reraise
89
90     input = raw_input
91     range = xrange
92     str_type = basestring
93     int_types = (int, long)
94
95     hexstr = hexlify
96
97     def add_ex_tb(ex):
98         """Add a traceback to ex if it doesn't already have one.  Return ex.
99
100         """
101         if not getattr(ex, '__traceback__', None):
102             ex.__traceback__ = sys.exc_info()[2]
103         return ex
104
105     def add_ex_ctx(ex, context_ex):
106         """Make context_ex the __context__ of ex (unless it already has one).
107         Return ex.
108
109         """
110         if context_ex:
111             if not getattr(ex, '__context__', None):
112                 ex.__context__ = context_ex
113         return ex
114
115     def dump_traceback(ex):
116         stack = [ex]
117         next_ex = getattr(ex, '__context__', None)
118         while next_ex:
119             stack.append(next_ex)
120             next_ex = getattr(next_ex, '__context__', None)
121         stack = reversed(stack)
122         ex = next(stack)
123         tb = getattr(ex, '__traceback__', None)
124         print_exception(type(ex), ex, tb)
125         for ex in stack:
126             print('\nDuring handling of the above exception, another exception occurred:\n',
127                   file=sys.stderr)
128             tb = getattr(ex, '__traceback__', None)
129             print_exception(type(ex), ex, tb)
130
131     def items(x):
132         return x.iteritems()
133
134     def argv_bytes(x):
135         """Return the original bytes passed to main() for an argv argument."""
136         return x
137
138     def bytes_from_uint(i):
139         return chr(i)
140
141     def bytes_from_byte(b):
142         return b
143
144     byte_int = ord
145
146     buffer = buffer
147
148     def join_bytes(x, y):
149         """Return the concatenated bytes or buffer arguments as bytes."""
150         if type(x) == buffer:
151             assert type(y) in (bytes, buffer)
152             return x + y
153         assert type(x) == bytes
154         if type(y) == bytes:
155             return b''.join((x, y))
156         assert type(y) in (bytes, buffer)
157         return buffer(x) + y
158
159
160 def restore_lc_env():
161     # Once we're up and running with iso-8859-1, undo the bup-python
162     # LC_CTYPE hackery, so we don't affect unrelated subprocesses.
163     bup_lc_all = environ.get(b'BUP_LC_ALL')
164     if bup_lc_all:
165         del environ[b'LC_COLLATE']
166         del environ[b'LC_CTYPE']
167         del environ[b'LC_MONETARY']
168         del environ[b'LC_NUMERIC']
169         del environ[b'LC_TIME']
170         del environ[b'LC_MESSAGES']
171         del environ[b'LC_MESSAGES']
172         environ[b'LC_ALL'] = bup_lc_all
173         return
174     bup_lc_ctype = environ.get(b'BUP_LC_CTYPE')
175     if bup_lc_ctype:
176         environ[b'LC_CTYPE'] = bup_lc_ctype
177
178 def wrap_main(main):
179     """Run main() and raise a SystemExit with the return value if it
180     returns, pass along any SystemExit it raises, convert
181     KeyboardInterrupts into exit(130), and print a Python 3 style
182     contextual backtrace for other exceptions in both Python 2 and
183     3)."""
184     try:
185         sys.exit(main())
186     except KeyboardInterrupt as ex:
187         sys.exit(130)
188     except SystemExit as ex:
189         raise
190     except BaseException as ex:
191         if py3:
192             raise
193         add_ex_tb(ex)
194         dump_traceback(ex)
195         sys.exit(1)
196
197
198 # Excepting wrap_main() in the traceback, these should produce similar output:
199 #   python2 lib/bup/compat.py
200 #   python3 lib/bup/compat.py
201 # i.e.:
202 #   diff -u <(python2 lib/bup/compat.py 2>&1) <(python3 lib/bup/compat.py 2>&1)
203 #
204 # Though the python3 output for 'second' will include a stacktrace
205 # starting from wrap_main, rather than from outer().
206
207 if __name__ == '__main__':
208
209     def inner():
210         raise Exception('first')
211
212     def outer():
213         try:
214             inner()
215         except Exception as ex:
216             add_ex_tb(ex)
217             try:
218                 raise Exception('second')
219             except Exception as ex2:
220                 raise add_ex_ctx(add_ex_tb(ex2), ex)
221
222     wrap_main(outer)