Avoid API breakage under Python 2

untitaker · untitaker · commit 882fb15f3e59 · 2018-08-24T20:13:28.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,4 @@ docs/_build
 build
 dist
 .cache
+.pytest_cache
diff --git a/atomicwrites/__init__.py b/atomicwrites/__init__.py
@@ -9,7 +9,7 @@
 except ImportError:
     fcntl = None
 
-__version__ = '1.1.5'
+__version__ = '1.2.0'
 
 
 PY2 = sys.version_info[0] == 2
@@ -23,6 +23,9 @@ def _path_to_unicode(x):
     return x
 
 
+DEFAULT_MODE = "wb" if PY2 else "w"
+
+
 _proper_fsync = os.fsync
 
 
@@ -110,7 +113,8 @@ class AtomicWriter(object):
             f.write(...)
 
     :param path: The destination filepath. May or may not exist.
-    :param mode: The filemode for the temporary file.
+    :param mode: The filemode for the temporary file. This defaults to `wb` in
+        Python 2 and `w` in Python 3.
     :param overwrite: If set to false, an error is raised if ``path`` exists.
         Errors are only raised after the file has been written to.  Either way,
         the operation is atomic.
@@ -119,7 +123,8 @@ class AtomicWriter(object):
     subclass.
     '''
 
-    def __init__(self, path, mode='w', overwrite=False, **open_kwargs):
+    def __init__(self, path, mode=DEFAULT_MODE, overwrite=False,
+                 **open_kwargs):
         if 'a' in mode:
             raise ValueError(
                 'Appending to an existing file is not supported, because that '
diff --git a/tests/test_atomicwrites.py b/tests/test_atomicwrites.py
@@ -10,11 +10,11 @@ def test_atomic_write(tmpdir):
     fname = tmpdir.join('ha')
     for i in range(2):
         with atomic_write(str(fname), overwrite=True) as f:
-            f.write(u'hoho')
+            f.write('hoho')
 
     with pytest.raises(OSError) as excinfo:
         with atomic_write(str(fname), overwrite=False) as f:
-            f.write(u'haha')
+            f.write('haha')
 
     assert excinfo.value.errno == errno.EEXIST
 
@@ -34,7 +34,7 @@ def test_teardown(tmpdir):
 def test_replace_simultaneously_created_file(tmpdir):
     fname = tmpdir.join('ha')
     with atomic_write(str(fname), overwrite=True) as f:
-        f.write(u'hoho')
+        f.write('hoho')
         fname.write('harhar')
         assert fname.read() == 'harhar'
     assert fname.read() == 'hoho'
@@ -45,7 +45,7 @@ def test_dont_remove_simultaneously_created_file(tmpdir):
     fname = tmpdir.join('ha')
     with pytest.raises(OSError) as excinfo:
         with atomic_write(str(fname), overwrite=False) as f:
-            f.write(u'hoho')
+            f.write('hoho')
             fname.write('harhar')
             assert fname.read() == 'harhar'
 
@@ -59,11 +59,13 @@ def test_dont_remove_simultaneously_created_file(tmpdir):
 def test_open_reraise(tmpdir):
     fname = tmpdir.join('ha')
     with pytest.raises(AssertionError):
-        with atomic_write(str(fname), overwrite=False) as f:
-            # Mess with f, so commit will trigger a ValueError. We're testing
-            # that the initial AssertionError triggered below is propagated up
-            # the stack, not the second exception triggered during commit.
-            f.close()
+        aw = atomic_write(str(fname), overwrite=False)
+        with aw:
+            # Mess with internals, so commit will trigger a ValueError. We're
+            # testing that the initial AssertionError triggered below is
+            # propagated up the stack, not the second exception triggered
+            # during commit.
+            aw.rollback = lambda: 1 / 0
             # Now trigger our own exception.
             assert False, "Intentional failure for testing purposes"
 
@@ -75,11 +77,11 @@ def test_atomic_write_in_pwd(tmpdir):
         fname = 'ha'
         for i in range(2):
             with atomic_write(str(fname), overwrite=True) as f:
-                f.write(u'hoho')
+                f.write('hoho')
 
         with pytest.raises(OSError) as excinfo:
             with atomic_write(str(fname), overwrite=False) as f:
-                f.write(u'haha')
+                f.write('haha')
 
         assert excinfo.value.errno == errno.EEXIST
 

-Original file line number
+Diff line change
 build
 dist
 .cache
 +.pytest_cache