Return written path in Blob.write_to_path

newsfragments/152.feature

@@ -0,0 +1 @@
+Return written path in :attr:`Blob.write_to_path` to simplify the usage of this method.

tests/test_trustme.py

@@ -5,7 +5,6 @@
 import sys
 import ssl
 import socket
-import threading
 import datetime
 from concurrent.futures import ThreadPoolExecutor
 
@@ -197,22 +196,22 @@ def test_blob(tmpdir):
 
     # write_to_path
 
-    b.write_to_path(str(tmpdir / "test1"))
-    with (tmpdir / "test1").open("rb") as f:
+    path = b.write_to_path(str(tmpdir / "test1"))
+    with open(path, "rb") as f:
         assert f.read() == test_data
 
     # append=False overwrites
     with (tmpdir / "test2").open("wb") as f:
         f.write(b"asdf")
-    b.write_to_path(str(tmpdir / "test2"))
-    with (tmpdir / "test2").open("rb") as f:
+    path = b.write_to_path(str(tmpdir / "test2"))
+    with open(path, "rb") as f:
         assert f.read() == test_data
 
     # append=True appends
     with (tmpdir / "test2").open("wb") as f:
         f.write(b"asdf")
-    b.write_to_path(str(tmpdir / "test2"), append=True)
-    with (tmpdir / "test2").open("rb") as f:
+    path = b.write_to_path(str(tmpdir / "test2"), append=True)
+    with open(path, "rb") as f:
         assert f.read() == b"asdf" + test_data
 
     # tempfile
@@ -222,6 +221,7 @@ def test_blob(tmpdir):
         with open(path, "rb") as f:
             assert f.read() == test_data
 
+
 def test_ca_from_pem(tmpdir):
     ca1 = trustme.CA()
     ca2 = trustme.CA.from_pem(ca1.cert_pem.bytes(), ca1.private_key_pem.bytes())

trustme/__init__.py

@@ -152,6 +152,8 @@ def write_to_path(self, path, append=False):
           path (str): The path to write to.
           append (bool): If False (the default), replace any existing file
                with the given name. If True, append to any existing file.
+        Returns:
+          The written path.
 
         """
         if append:
@@ -160,6 +162,7 @@ def write_to_path(self, path, append=False):
             mode = "wb"
         with open(path, mode) as f:
             f.write(self._data)
+        return path
 
     @contextmanager
     def tempfile(self, dir=None):