feat(#16): use as standard wrapper

h2non · Oct 25, 2016 · 3839329 · 3839329
1 parent 641e0c4
commit 3839329
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/paco/throttle.py b/paco/throttle.py
@@ -48,11 +48,22 @@ def throttle(coro, limit=1, timeframe=1,
 
     Usage::
 
+        # Use as simple wrapper
         task = paco.throttle(coro, limit=1, timeframe=1)
-        task(1)
-        task(1) # ignored!
+        await task(1)
+        await task(2) # ignored!
         time.sleep(1)
-        task(1) # executed!
+        await task(3) # executed!
+
+        # Use as decorator
+        @paco.throttle(limit=1, timeframe=1)
+        async def task(num):
+            return num * 2
+
+        await task(1) # => 2
+        await task(2) # => 2 (ignored)
+        time.sleep(1)
+        await task(3) # => 6
     """
     assert_corofunction(coro=coro)