-

cool-RR · cool-RR · commit c35003a51e8d · 2014-02-22T15:24:33.000+02:00
diff --git a/source_py3/python_toolbox/cute_iter_tools.py b/source_py3/python_toolbox/cute_iter_tools.py
@@ -332,7 +332,11 @@ def _fill(iterable, fill_value, fill_value_maker, length):
                 
     
 def call_until_exception(function, exception, lazy_tuple=False):
-    '''Iterate on values returned from `function` until getting `exception`.'''
+    '''
+    Iterate on values returned from `function` until getting `exception`.
+    
+    If `lazy_tuple=True`, returns a `LazyTuple` rather than an iterator.
+    '''
     iterator = _call_until_exception(function, exception)
     if lazy_tuple:
         from python_toolbox import nifty_collections # Avoiding circular import.
diff --git a/source_py3/python_toolbox/misc_tools/misc_tools.py b/source_py3/python_toolbox/misc_tools/misc_tools.py
@@ -298,6 +298,18 @@ def repeat_getattr(thing, query):
 
 
 def set_attributes(**kwargs):
+    '''
+    Decorator to set attributes on a function.
+    
+    Example:
+    
+        @set_attributes(meow='frrr')
+        def f():
+            return 'whatever'
+            
+        assert f.meow == 'frrr'
+        
+    '''
     def decorator(function):
         for key, value in kwargs.items():
             setattr(function, key, value)
@@ -309,6 +321,17 @@ def decorator(function):
 pocket_container.value = None
 @set_attributes(container=pocket_container)
 def pocket(*args):
+    '''
+    Put something in the pocket, or get the value in the pocket.
+
+    Useful for things like this:
+    
+        if pocket(expensive_computation):
+            result = pocket()
+            # Do something with result...
+
+    The contents of the pocket are thread-local.
+    '''
     if args:
         (pocket.container.value,) = args
     else:
diff --git a/source_py3/python_toolbox/sequence_tools.py b/source_py3/python_toolbox/sequence_tools.py
@@ -282,6 +282,7 @@ def get_recurrences(sequence):
     '''
     return {item: n_recurrences for item, n_recurrences in
             collections.Counter(sequence).most_common() if n_recurrences >= 2}
+
     
 ### Not using now, might want in future:
 
diff --git a/source_py3/test_python_toolbox/test_misc_tools/test_name_mangling/test_pocket.py b/source_py3/test_python_toolbox/test_misc_tools/test_name_mangling/test_pocket.py
@@ -0,0 +1,19 @@
+# Copyright 2009-2014 Ram Rachum.
+# This program is distributed under the MIT license.
+
+
+from python_toolbox.misc_tools import pocket
+
+
+def test():
+    assert pocket() == None
+    assert pocket() == None
+    assert pocket(7) == None
+    assert pocket() == 7
+    assert pocket() == 7
+    assert pocket(8) == None
+    assert pocket() == 8
+    assert pocket() == 8
+    if pocket(1+1):
+        pass
+    assert pocket() == 2
