Merge pull request #6 from RazerM/capture-kwargs

Add **kwargs to capture and acapture

Author: smurfix

docs/source/tutorial.rst

@@ -7,22 +7,22 @@ Tutorial
 Outcome provides a function for capturing the outcome of a Python
 function call, so that it can be passed around. The basic rule is::
 
-    result = outcome.capture(f, *args)
+    result = outcome.capture(f, *args, **kwargs)
     x = result.unwrap()
 
 is the same as::
 
-    x = f(*args)
+    x = f(*args, **kwargs)
 
 even if ``f`` raises an error.
 
 On Python 3.5+, there's also :func:`acapture`::
 
-    result = await outcome.acapture(f, *args)
+    result = await outcome.acapture(f, *args, **kwargs)
     x = result.unwrap()
 
 which, like before, is the same as::
 
-    x = await f(*args)
+    x = await f(*args, **kwargs)
 
 See the :ref:`api-reference` for the types involved.

src/outcome/_async.py

@@ -7,29 +7,29 @@
 __all__ = ['Error', 'Outcome', 'Value', 'acapture', 'capture']
 
 
-def capture(sync_fn, *args):
-    """Run ``sync_fn(*args)`` and capture the result.
+def capture(sync_fn, *args, **kwargs):
+    """Run ``sync_fn(*args, **kwargs)`` and capture the result.
 
     Returns:
       Either a :class:`Value` or :class:`Error` as appropriate.
 
     """
     # _sync.capture references ErrorBase and ValueBase
     try:
-        return Value(sync_fn(*args))
+        return Value(sync_fn(*args, **kwargs))
     except BaseException as exc:
         return Error(exc)
 
 
-async def acapture(async_fn, *args):
-    """Run ``await async_fn(*args)`` and capture the result.
+async def acapture(async_fn, *args, **kwargs):
+    """Run ``await async_fn(*args, **kwargs)`` and capture the result.
 
     Returns:
       Either a :class:`Value` or :class:`Error` as appropriate.
 
     """
     try:
-        return Value(await async_fn(*args))
+        return Value(await async_fn(*args, **kwargs))
     except BaseException as exc:
         return Error(exc)
 

src/outcome/_sync.py

@@ -9,15 +9,15 @@
 __all__ = ['Error', 'Outcome', 'Value', 'capture']
 
 
-def capture(sync_fn, *args):
-    """Run ``sync_fn(*args)`` and capture the result.
+def capture(sync_fn, *args, **kwargs):
+    """Run ``sync_fn(*args, **kwargs)`` and capture the result.
 
     Returns:
       Either a :class:`Value` or :class:`Error` as appropriate.
 
     """
     try:
-        return Value(sync_fn(*args))
+        return Value(sync_fn(*args, **kwargs))
     except BaseException as exc:
         return Error(exc)
 

tests/test_async.py

@@ -11,11 +11,11 @@
 
 
 async def test_acapture():
-    async def return_arg(x):
+    async def add(x, y):
         await trio.hazmat.checkpoint()
-        return x
+        return x + y
 
-    v = await outcome.acapture(return_arg, 7)
+    v = await outcome.acapture(add, 3, y=4)
     assert v == Value(7)
 
     async def raise_ValueError(x):

tests/test_sync.py

@@ -77,12 +77,12 @@ def test_Value_compare():
 
 
 def test_capture():
-    def return_arg(x):
-        return x
+    def add(x, y):
+        return x + y
 
-    v = outcome.capture(return_arg, 2)
+    v = outcome.capture(add, 2, y=3)
     assert type(v) == Value
-    assert v.unwrap() == 2
+    assert v.unwrap() == 5
 
     def raise_ValueError(x):
         raise ValueError(x)