]> arthur.barton.de Git - bup.git/blobdiff - lib/bup/compat.py
Remove Client __del__ in favor of context management
[bup.git] / lib / bup / compat.py
index a8aead44a0bc49168945a0301a937272f9940150..fbeee4a478fd3da42976d8b50a05f03558a2996d 100644 (file)
@@ -1,9 +1,8 @@
 
 from __future__ import absolute_import, print_function
-from array import array
 from binascii import hexlify
 from traceback import print_exception
-import sys
+import os, sys
 
 # Please see CODINGSTYLE for important exception handling guidelines
 # and the rationale behind add_ex_tb(), add_ex_ctx(), etc.
@@ -13,20 +12,15 @@ py3 = py_maj >= 3
 
 if py3:
 
+    # pylint: disable=unused-import
+    from contextlib import nullcontext
     from os import environb as environ
-
-    lc_ctype = environ.get(b'LC_CTYPE')
-    if lc_ctype and lc_ctype.lower() != b'iso-8859-1':
-        # Because of argv, options.py, pwd, grp, and any number of other issues
-        print('error: bup currently only works with ISO-8859-1, not LC_CTYPE=%s'
-              % lc_ctype.decode(),
-              file=sys.stderr)
-        print('error: this should already have been arranged, so indicates a bug',
-              file=sys.stderr)
-        sys.exit(2)
-
-    from os import fsencode
+    from os import fsdecode, fsencode
     from shlex import quote
+    # pylint: disable=undefined-variable
+    # (for python2 looking here)
+    ModuleNotFoundError = ModuleNotFoundError
+    input = input
     range = range
     str_type = str
     int_types = (int,)
@@ -35,6 +29,9 @@ if py3:
         """Return hex string (not bytes as with hexlify) representation of b."""
         return b.hex()
 
+    def reraise(ex):
+        raise ex.with_traceback(sys.exc_info()[2])
+
     def add_ex_tb(ex):
         """Do nothing (already handled by Python 3 infrastructure)."""
         return ex
@@ -43,6 +40,21 @@ if py3:
         """Do nothing (already handled by Python 3 infrastructure)."""
         return ex
 
+    class pending_raise:
+        """If rethrow is true, rethrow ex (if any), unless the body throws.
+
+        (Supports Python 2 compatibility.)
+
+        """
+        def __init__(self, ex, rethrow=True):
+            self.ex = ex
+            self.rethrow = rethrow
+        def __enter__(self):
+            return None
+        def __exit__(self, exc_type, exc_value, traceback):
+            if not exc_type and self.ex and self.rethrow:
+                raise self.ex
+
     def items(x):
         return x.items()
 
@@ -53,6 +65,9 @@ if py3:
     def bytes_from_uint(i):
         return bytes((i,))
 
+    def bytes_from_byte(b):  # python > 2: b[3] returns ord('x'), not b'x'
+        return bytes((b,))
+
     byte_int = lambda x: x
 
     def buffer(object, offset=None, size=None):
@@ -63,19 +78,40 @@ if py3:
             return memoryview(object)[offset:]
         return memoryview(object)
 
-    def join_bytes(*items):
-        """Return the concatenated bytes or memoryview arguments as bytes."""
-        return b''.join(items)
+    def getcwd():
+        return fsencode(os.getcwd())
 
 else:  # Python 2
 
+    from contextlib import contextmanager
+
+    ModuleNotFoundError = ImportError
+
+    def fsdecode(x):
+        return x
+
     def fsencode(x):
         return x
 
     from pipes import quote
-    from os import environ
+    # pylint: disable=unused-import
+    from os import environ, getcwd
+
+    # pylint: disable=unused-import
+    from bup.py2raise import reraise
+
+    @contextmanager
+    def nullcontext(enter_result=None):
+        yield enter_result
+
+    # on py3 this causes errors, obviously
+    # pylint: disable=undefined-variable
+    input = raw_input
+    # pylint: disable=undefined-variable
     range = xrange
+    # pylint: disable=undefined-variable
     str_type = basestring
+    # pylint: disable=undefined-variable
     int_types = (int, long)
 
     hexstr = hexlify
@@ -98,6 +134,30 @@ else:  # Python 2
                 ex.__context__ = context_ex
         return ex
 
+    class pending_raise:
+        """If rethrow is true, rethrow ex (if any), unless the body throws.
+
+        If the body does throw, make any provided ex the __context__
+        of the newer exception (assuming there's no existing
+        __context__).  Ensure the exceptions have __tracebacks__.
+        (Supports Python 2 compatibility.)
+
+        """
+        def __init__(self, ex, rethrow=True):
+            self.ex = ex
+            self.rethrow = rethrow
+        def __enter__(self):
+            if self.ex:
+                add_ex_tb(self.ex)
+        def __exit__(self, exc_type, exc_value, traceback):
+            if exc_value:
+                if self.ex:
+                    add_ex_tb(exc_value)
+                    add_ex_ctx(exc_value, self.ex)
+                return
+            if self.rethrow and self.ex:
+                raise self.ex
+
     def dump_traceback(ex):
         stack = [ex]
         next_ex = getattr(ex, '__context__', None)
@@ -121,23 +181,36 @@ else:  # Python 2
         """Return the original bytes passed to main() for an argv argument."""
         return x
 
-    def bytes_from_uint(i):
-        return chr(i)
+    bytes_from_uint = chr
+
+    def bytes_from_byte(b):
+        return b
 
     byte_int = ord
 
     buffer = buffer
 
-    def join_bytes(x, y):
-        """Return the concatenated bytes or buffer arguments as bytes."""
-        if type(x) == buffer:
-            assert type(y) in (bytes, buffer)
-            return x + y
-        assert type(x) == bytes
-        if type(y) == bytes:
-            return b''.join((x, y))
-        assert type(y) in (bytes, buffer)
-        return buffer(x) + y
+try:
+    import bup_main
+except ModuleNotFoundError:
+    bup_main = None
+
+if bup_main:
+    def get_argvb():
+        "Return a new list containing the current process argv bytes."
+        return bup_main.argv()
+    if py3:
+        def get_argv():
+            "Return a new list containing the current process argv strings."
+            return [x.decode(errors='surrogateescape') for x in bup_main.argv()]
+    else:
+        def get_argv():
+            return bup_main.argv()
+else:
+    def get_argvb():
+        raise Exception('get_argvb requires the bup_main module');
+    def get_argv():
+        raise Exception('get_argv requires the bup_main module');
 
 def wrap_main(main):
     """Run main() and raise a SystemExit with the return value if it